Merge "Adding a bunch of hooks from wikiHow into DifferenceEngine"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Wed, 29 Jun 2016 22:54:48 +0000 (22:54 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Wed, 29 Jun 2016 22:54:48 +0000 (22:54 +0000)
1  2 
docs/hooks.txt

diff --combined docs/hooks.txt
@@@ -371,8 -371,7 +371,8 @@@ $user: Current use
  &$message: API usage message to die with, as a message key or array
    as accepted by ApiBase::dieUsageMsg.
  
 -'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
 +'APIEditBeforeSave': DEPRECATED! Use EditFilterMergedContent instead.
 +Before saving a page with api.php?action=edit, after
  processing request parameters. Return false to let the request fail, returning
  an error message or an <edit result="Failure"> tag if $resultArr was filled.
  Unlike for example 'EditFilterMergedContent' this also being run on undo.
@@@ -1136,6 -1135,85 +1136,85 @@@ $page: SpecialPage object for DeletedCo
  $row: the DB row for this line
  &$classes: the classes to add to the surrounding <li>
  
+ 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as patrolled" link
+ which is shown both on the diff header as well as on the bottom of a page, usually
+ wrapped in a span element which has class="patrollink".
+ $differenceEngine: DifferenceEngine object
+ &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
+ $rcid: Recent change ID (rc_id) for this change (int)
+ $token: Patrol token; $rcid is used in generating this variable
+ 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the rcid parameter.
+ For example the rcid might be set to zero due to the user being the same as the
+ performer of the change but an extension might still want to show it under certain
+ conditions.
+ &$rcid: rc_id (int) of the change or 0
+ $differenceEngine: DifferenceEngine object
+ $change: RecentChange object
+ $user: User object representing the current user
+ 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader variable, which
+ contains information about the new revision, such as the revision's author, whether
+ the revision was marked as a minor edit or not, etc.
+ $differenceEngine: DifferenceEngine object
+ &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
+ include things like revision author info, revision comment, RevisionDelete link and more
+ $formattedRevisionTools: Array containing revision tools, some of which may have
+ been injected with the DiffRevisionTools hook
+ $nextlink: String containing the link to the next revision (if any); also included in $newHeader
+ $rollback: Rollback link (string) to roll this revision back to the previous one, if any
+ $newminor: String indicating if the new revision was marked as a minor edit
+ $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
+ whether we should show just the diff; passed in as a query string parameter to the
+ various URLs constructed here (i.e. $nextlink)
+ $rdel: RevisionDelete link for the new revision, if the current user is allowed
+ to use the RevisionDelete feature
+ $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
+ 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader variable, which
+ contains information about the old revision, such as the revision's author, whether
+ the revision was marked as a minor edit or not, etc.
+ $differenceEngine: DifferenceEngine object
+ &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
+ include things like revision author info, revision comment, RevisionDelete link and more
+ $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
+ $oldminor: String indicating if the old revision was marked as a minor edit
+ $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
+ whether we should show just the diff; passed in as a query string parameter to the
+ various URLs constructed here (i.e. $prevlink)
+ $ldel: RevisionDelete link for the old revision, if the current user is allowed
+ to use the RevisionDelete feature
+ $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
+ 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases when
+ there is no old revision
+ &$oldHeader: empty string by default
+ 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the parser output.
+ Return false to not add parser output via OutputPage's addParserOutput method.
+ $differenceEngine: DifferenceEngine object
+ $out: OutputPage object
+ $parserOutput: ParserOutput object
+ $wikiPage: WikiPage object
+ 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into this hook
+ point and return false to not show the final "mark as patrolled" link on the bottom
+ of a page.
+ This hook has no arguments.
+ 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
+ eventually gets sent to the OutputPage object.
+ $differenceEngine: DifferenceEngine object
+ 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff table
+ body (without header) in cases when there is no old revision or the old and new
+ revisions are identical.
+ $differenceEngine: DifferenceEngine object
+ 'DifferenceEngineShowDiffPage': Add additional output via the available OutputPage
+ object into the diff view
+ $out: OutputPage object
  'DiffRevisionTools': Override or extend the revision tools available from the
  diff view, i.e. undo, etc.
  $newRev: Revision object of the "new" revision
@@@ -3285,8 -3363,8 +3364,8 @@@ added to the descripto
  &$radio: Boolean, if source type should be shown as radio button
  $selectedSourceType: The selected source type
  
 -'UploadVerification': Additional chances to reject an uploaded file. Consider
 -using UploadVerifyFile instead.
 +'UploadVerification': DEPRECATED! Use UploadVerifyFile instead.
 +Additional chances to reject an uploaded file.
  $saveName: (string) destination file name
  $tempName: (string) filesystem path to the temporary file for checks
  &$error: (string) output: message key for message to show if upload canceled by