Fixed syntax error. :-(

[quix0rs-gnu-social.git] / EVENTS.txt
diff --git a/EVENTS.txt b/EVENTS.txt

index a9057e7f6a752f1cda64a8d97dc56d287f1d2871..255869afda41845dd1cd1654358d443f37aaf599 100644 (file)
--- a/EVENTS.txt
+++ b/EVENTS.txt
@@ -216,7 +216,9 @@ EndShowBody: called after showing the <body> element (and </body>)
  - $action: action object being shown
  
  StartPersonalGroupNav: beginning of personal group nav menu
-- $action: action object being shown
+- $menu: Menu list object being shown
+- $target: Profile for whom it is shown
+- $scoped: Profile of currently logged in user (or null)
  
  EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
  - $action: action object being shown
@@ -288,19 +290,21 @@ StartProfileSaveForm: before starting to save a profile settings form
  EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
  - $action: action object being shown
  
-StartEmailFormData: just before showing text entry fields on email settings page
-- $action: action object being shown
+StartEmailFormData: just before showing form input fields on email settings page
+- $action: Action object being shown
+- $scoped: Profile for whom settings are being configured
  
-EndEmailFormData: just after showing text entry fields on email settings page
+EndEmailFormData: just after showing form input fields on email settings page
  - $action: action object being shown
+- $scoped: Profile for whom settings are being configured
  
  StartEmailSaveForm: before starting to save a email settings form
  - $action: action object being shown
-- &$user: user being saved
+- $scoped: Profile user having their email settings saved
  
  EndEmailSaveForm: after saving a email settings form (after commit)
  - $action: action object being shown
-- &$user: user being saved
+- $scoped: Profile user having their email settings saved
  
  StartRegistrationFormData: just before showing text entry fields on registration page
  - $action: action object being shown
@@ -1435,3 +1439,11 @@ EndShowAttachmentRepresentation: Executed after Attachment representation, despi
  ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
  - $out:     HTMLOutputter class to use for outputting HTML.
  - $file:    'File' object which we're going to show representation for.
+
+StartNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
+- $stored:         Notice object that is being distributed.
+- &$mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.
+
+EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
+- $stored:         Notice object that is being distributed.
+- $mentioned_ids:  Array of profile IDs (not just for local users) who got mentioned by the notice.