fediwiki

Fediverse Universial Wiki Site


Project maintained by mitchellurgero Hosted on GitHub Pages — Theme by mattgraham

Back to home

EVENTS

GNU Social’s EVENT documentation.

Current GNU Social Events

InitializePlugin: a chance to initialize a plugin in a complete environment

CleanupPlugin: a chance to cleanup a plugin at the end of a program

StartActionExecute: Right before the “prepare” call of the current Action

EndActionExecute: Right after the “handle” call of the current Action

StartPrimaryNav: Showing the primary nav menu

EndPrimaryNav: At the end of the primary nav menu

StartSecondaryNav: Showing the secondary nav menu

EndSecondaryNav: At the end of the secondary nav menu

StartShowStyles: Showing Style links; good place to add UA style resets

EndShowStyles: End showing Style links; good place to add custom styles

StartShowStylesheets: Showing stylesheet links

EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles

StartShowUAStyles: Showing custom User-Agent style links

EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles

StartShowScripts: Showing JavaScript links

EndShowScripts: End showing JavaScript links; good place to add custom links

StartShowJQueryScripts: Showing JQuery script links

EndShowJQueryScripts: End showing JQuery script links

StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)

EndShowStatusNetScripts: End showing StatusNet script links

StartShowSections: Start the list of sections in the sidebar

EndShowSections: End the list of sections in the sidebar

StartShowHeader: Showing before the header container

EndShowHeader: Showing after the header container

StartShowFooter: Showing before the footer container

EndShowFooter: Showing after the footer container

StartShowContentBlock: Showing before the content container

EndShowContentBlock: Showing after the content container

StartShowAside: Showing before the Aside container

EndShowAside: Showing after the Aside container

StartShowNoticeFormData: Showing before the notice form data

EndShowNoticeFormData: Showing after the notice form data

StartNoticeSave: before inserting a notice (good place for content filters)

EndNoticeSave: after inserting a notice and related code

StartShowLocalNavBlock: Showing the local nav menu

EndShowLocalNavBlock: At the end of the local nav menu

StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties

EndShowHTML: Showing after the html element

StartPublicGroupNav: Showing the public group nav menu

EndPublicGroupNav: At the end of the public group nav menu

StartSubGroupNav: Showing the subscriptions group nav menu

EndSubGroupNav: At the end of the subscriptions group nav menu

StartInitializeRouter: Before the router instance has been initialized; good place to add routes

RouterInitialized: After the router instance has been initialized

StartLogout: Before logging out

EndLogout: After logging out

ArgsInitialize: After the argument array has been initialized

StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)

EndAddressData: At the end of <address>

StartShowSiteNotice: Before showing site notice

EndShowSiteNotice: After showing site notice

StartLoginGroupNav: Before showing the login and register navigation menu

EndLoginGroupNav: After showing the login and register navigation menu

StartAccountSettingsNav: Before showing the account settings menu

EndAccountSettingsNav: After showing the account settings menu

StartAccountSettingsProfileMenuItem: Before showing the Profile menu item

EndAccountSettingsProfileMenuItem: After showing the Profile menu item

StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item

EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item

StartAccountSettingsPasswordMenuItem: Before showing the Password menu item

EndAccountSettingsPasswordMenuItem: After showing the Password menu item

StartAccountSettingsEmailMenuItem: Before showing the Email menu item

EndAccountSettingsEmailMenuItem: After showing the Email menu item

StartAccountSettingsDesignMenuItem: Before showing the Design menu item

EndAccountSettingsDesignMenuItem: After showing the Design menu item

StartAccountSettingsOtherMenuItem: Before showing the Other menu item

EndAccountSettingsOtherMenuItem: After showing the Other menu item

Autoload: When trying to autoload a class

SensitiveAction: determines if an action is ‘sensitive’ and should use SSL

LoginAction: determines if an action is a ‘login’ action (OK for public view in private mode)

StartShowHead: called before showing the <head> element and children

EndShowHead: called after showing the <head> element (and </head>)

StartShowBody: called before showing the <body> element and children

EndShowBody: called after showing the <body> element (and </body>)

StartPersonalGroupNav: beginning of personal group nav menu

EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)

StartGroupGroupNav: Showing the group nav menu

EndGroupGroupNav: At the end of the group nav menu

StartEndHTML: just before the </html> tag

EndEndHTML: just after the </html> tag

FinalAction: After prepare() (and possible handle) in Action class.

StartShowDesign: just before showing a site, user, or group design

EndShowDesign: just after showing a site, user, or group design

StartShowExportData: just before showing the <div> with export data (feeds)

EndShowExportData: just after showing the <div> with export data (feeds)

StartShowNoticeItem: just before showing the notice item

EndShowNoticeItem: just after showing the notice item

StartShowNoticeItemNotice: just before outputting the “top” notice part of a NoticeListItem to HTML

EndShowNoticeItemNotice: just after outputting the “top” notice part of a NoticeListItem to HTML

StartShowNoticeContent: just before outputting the content part of a Notice

EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually

StartShowNoticeInfo: just before showing notice info

EndShowNoticeInfo: just after showing notice info

StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.

EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.

StartShowPageNotice: just before showing the page notice (instructions or error)

EndShowPageNotice: just after showing the page notice (instructions or error)

StartShowPageTitle: just before showing the main h1 title of a page (only for registration)

StartProfileFormData: just before showing text entry fields on profile settings page

EndProfileFormData: just after showing text entry fields on profile settings page

StartProfileSaveForm: before starting to save a profile settings form

EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)

StartEmailFormData: just before showing form input fields on email settings page

EndEmailFormData: just after showing form input fields on email settings page

StartEmailSaveForm: before starting to save a email settings form

EndEmailSaveForm: after saving a email settings form (after commit)

StartRegistrationFormData: just before showing text entry fields on registration page

EndRegistrationFormData: just after showing text entry fields on registration page

StartRegistrationTry: before validating and saving a new user

EndRegistrationTry: after saving a new user (note: no profile or user object!)

StartAvatarFormData: before displaying avatar form

EndAvatarFormData: after displaying avatar form

StartAvatarSaveForm: before saving the avatar

EndAvatarSaveForm: after saving the avatar

StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes

RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)

StartLoadDoc: before loading a help doc (hook this to show your own documentation)

EndLoadDoc: after loading a help doc (hook this to modify other documentation)

StartApiRss: after the rss <channel> element is started

StartApiAtom: after the <feed> element is started

StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)

EndEnqueueNotice: after adding a notice to the queues

UnqueueHandleNotice: Handle a notice when no queue manager is available

GetValidDaemons: Just before determining which daemons to run

HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)

StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces

EndHtmlElement: Right after outputting the HTML element

StartShowHeadElements: Right after the <head> tag

EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>

CheckSchema: chance to check the schema

StartProfileRemoteSubscribe: Before showing the link to remote subscription

EndProfileRemoteSubscribe: After showing the link to remote subscription

StartGroupSubscribe: Before showing the link to remote subscription

EndGroupSubscribe: After showing the link to remote subscription

StartProfilePageProfileSection: Starting to show the section of the profile page with the actual profile data; hook to prevent showing the profile (e.g.)

StartProfilePageProfileElements: inside the section, before the first element; prepend elements here

EndProfilePageProfileElements: inside the section, after the last element; append elements here

EndProfilePageProfileSection: After showing the section of the profile page with the profile elements

StartProfilePageActionsSection: Starting to show the section of the profile page with action links; hook to hide them (for example)

StartProfilePageActionsElements: inside the list, before the first element; prepend elements here

EndProfilePageActionsElements: inside the list, after the last element; append elements here

EndProfilePageActionsSection: After showing the section of the profile page with the entity actions

StartProfilePageAvatar: before showing the avatar on the profile page

EndProfilePageAvatar: after showing the avatar on the profile page

StartProfilePageNickname: before showing the nickname on the profile page

EndProfilePageNickname: after showing the nickname on the profile page

StartProfilePageFullName: before showing the fullname on the profile page

EndProfilePageFullName: after showing the fullname on the profile page

StartProfilePageLocation: before showing the location on the profile page

EndProfilePageLocation: after showing the location on the profile page

StartProfilePageHomepage: before showing the homepage link on the profile page

EndProfilePageHomepage: after showing the homepage on the profile page

StartProfilePageBio: before showing the bio on the profile page

EndProfilePageBio: after showing the bio on the profile page

StartProfilePageProfileTags: before showing the tags on the profile page

EndProfilePageProfileTags: after showing the tags on the profile page

StartProfileList: when starting a list of profiles (before <ul>)

EndProfileList: when ending a list of profiles (after </ul>)

StartProfileListItem: when starting to show a profile list item

EndProfileListItem: after showing a profile list item

StartProfileListItemProfile: the profile data part of the item

EndProfileListItemProfile: the profile data part of the item

StartProfileListItemActions: the actions (buttons) for an item

EndProfileListItemActions: the actions (buttons) for an item

StartProfileListItemProfileElements: inside the <div>

EndProfileListItemProfileElements: inside the <div>

StartProfileListItemAvatar: Showing a profile list avatar

EndProfileListItemAvatar: Showing a profile list avatar

StartProfileListItemFullName: Showing the profile list full name

EndProfileListItemFullName: Showing the profile list full name

StartProfileListItemLocation: Showing the profile list location

EndProfileListItemLocation: Showing the profile list location

StartProfileListItemHomepage: Showing the profile list homepage

EndProfileListItemHomepage: Showing the profile list homepage

StartProfileListItemBio: Showing the profile list bio

EndProfileListItemBio: Showing the profile list bio

StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)

EndProfileListItemActionElements: Showing profile list actions (append a button here)

StartUserXRDS: Start XRDS output (right after the opening XRDS tag)

EndUserXRDS: End XRDS output (right before the closing XRDS tag)

StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)

EndPublicXRDS: End XRDS output (right before the closing XRDS tag)

StartCheckPassword: Check a username/password

EndCheckPassword: After checking a username/password pair

StartChangePassword: Before changing a password

EndChangePassword: After changing a password

StartHashPassword: Generate a hashed version of the password (like a salted crypt)

StartSetUser: Before setting the currently logged in user

EndSetUser: After setting the currently logged in user

StartSetApiUser: Before setting the current API user

EndSetApiUser: After setting the current API user

StartHasRole: Before determing if the a profile has a given role

EndHasRole: Before determing if the a profile has a given role

UserDeleteRelated: Specify additional tables to delete entries from when deleting users

GetUrlShorteners: Specify URL shorteners that are available for use

StartShortenUrl: About to shorten a URL

EndShortenUrl: After a URL has been shortened

StartCssLinkElement: Before a <link rel="stylesheet"..> element is written

EndCssLinkElement: After a <link rel="stylesheet"..> element is written

StartStyleElement: Before a <style...> element is written

EndStyleElement: After a <style...> element is written

StartScriptElement: Before a <script...> element is written

EndScriptElement: After a <script...> element is written

StartInlineScriptElement: Before a <script...> element is written

EndInlineScriptElement: After a <script...> element is written

StartLog: Before writing to the logs

EndLog: After writing to the logs

StartBlockProfile: when we’re about to block

EndBlockProfile: when a block has succeeded

StartUnblockProfile: when we’re about to unblock

EndUnblockProfile: when an unblock has succeeded

StartSubscribe: when a subscription is starting

EndSubscribe: when a subscription is finished

StartUnsubscribe: when an unsubscribe is starting

EndUnsubscribe: when an unsubscribe is done

StartJoinGroup: when a user is joining a group

EndJoinGroup: when a user finishes joining a group

StartLeaveGroup: when a user is leaving a group

EndLeaveGroup: when a user has left a group

StartShowContentLicense: Showing the default license for content

EndShowContentLicense: Showing the default license for content

GetImTransports: Get IM transports that are available

NormalizeImScreenname: Normalize an IM screenname

ValidateImScreenname: Validate an IM screenname

SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname

StartUserRegister: When a new user is being registered

EndUserRegister: When a new user has been registered

StartRobotsTxt: Before outputting the robots.txt page

EndRobotsTxt: After the default robots.txt page (good place for customization)

StartGetProfileUri: When determining the canonical URI for a given profile

EndGetProfileUri: After determining the canonical URI for a given profile

StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)

EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)

StartFindMentions: start finding mentions in a block of text

StartShowSubscriptionsContent: before showing the subscriptions content

EndShowSubscriptionsContent: after showing the subscriptions content

StartShowUserGroupsContent: before showing the user groups content

EndShowUserGroupsContent: after showing the user groups content

StartShowAllContent: before showing the all (you and friends) content

EndShowAllContent: after showing the all (you and friends) content

StartShowSubscriptionsMiniList: at the start of subscriptions mini list

EndShowSubscriptionsMiniList: at the end of subscriptions mini list

StartShowGroupsMiniList: at the start of groups mini list

EndShowGroupsMiniList: at the end of groups mini list

StartDeleteUserForm: starting the data in the form for deleting a user

EndDeleteUserForm: Ending the data in the form for deleting a user

StartDeleteUser: handling the post for deleting a user

EndDeleteUser: handling the post for deleting a user

StartNoticeAsActivity: before converting a notice to an activity

EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)

StartNoticeSaveWeb: before saving a notice through the Web interface

EndNoticeSaveWeb: after saving a notice through the Web interface

StartRssEntryArray: at the start of copying a notice to an array

EndRssEntryArray: at the end of copying a notice to an array

NoticeDeleteRelated: at the beginning of deleting related fields to a notice

FileDeleteRelated: at the beginning of deleting related fields to a File

StartShowHeadTitle: when beginning to show the <title> element

EndShowHeadTitle: when done showing the <title>

StartShowPageTitle: when beginning to show the page title <h1>

EndShowPageTitle: when done showing the page title <h1>

StartDeleteOwnNotice: when a user starts to delete their own notice

EndDeleteOwnNotice: when a user has deleted their own notice

StartShowFeedLinkList: before showing the feed list in the sidebar

EndShowFeedLinkList: after showing the feed list in the sidebar

StartShowFeedLink: before showing an individual feed item

EndShowFeedLink: after showing an individual feed

StartShowNoticeForm: before showing the notice form (before <form>)

EndShowNoticeForm: after showing the notice form (after <form>)

StartShowEntryForms: microapp entry form tab data

StartGrantRole: when a role is being assigned

EndGrantRole: when a role has been successfully assigned

StartRevokeRole: when a role is being revoked

EndRevokeRole: when a role has been revoked

StartAtomPubNewActivity: When a new activity comes in through Atom Pub API

EndAtomPubNewActivity: When a new activity comes in through Atom Pub API

AdminPanelCheck: When checking whether the current user can access a given admin panel

StartAdminPanelNav: Before displaying the first item in the list of admin panels

EndAdminPanelNav: After displaying the last item in the list of admin panels

StartActivityObjectFromNotice: When converting a notice to an activity:object

EndActivityObjectFromNotice: After converting a notice to an activity:object

StartActivityObjectFromProfile: When converting a profile to an activity:object

EndActivityObjectFromProfile: After converting a profile to an activity:object

StartActivityObjectFromGroup: When converting a group to an activity:object

EndActivityObjectFromGroup: After converting a group to an activity:object

StartImportActivity: when we start to import an activity

EndImportActivity: when we finish importing an activity

StartProfileSettingsActions: when we’re showing account-management action list

EndProfileSettingsActions: when we’re showing account-management action list

StartOpenNoticeListItemElement: Before the opening <li> of a notice list element

EndOpenNoticeListItemElement: After the opening <li> of a notice list element

StartCloseNoticeListItemElement: Before the closing </li> of a notice list element

EndCloseNoticeListItemElement: After the closing </li> of a notice list element

StartGroupEditFormData: Beginning the group edit form entries

EndGroupEditFormData: Ending the group edit form entries

StartGroupSave: After initializing but before saving a group

EndGroupSave: After saving a group, aliases, and first member

StartInterpretCommand: Before running a command

EndInterpretCommand: Before running a command

StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)

EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)

StartGroupProfileElements: Start showing stuff about the group on its profile page

EndGroupProfileElements: Start showing stuff about the group on its profile page

StartShowProfileTagContent: When showing a people tag page

EndShowProfileTagContent: After showing the contents of a people tag page

StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles

EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles

StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers

EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers

StartTagProfileAction: When starting to show profile tagging page

EndTagProfileAction: After showing profile tagging page

StartProfileCompletionSearch: When starting a profile search for autocompletion

EndProfileCompletionSearch: After search results for profile autocompletion have been found

StartShowTagProfileForm: When showing people tagging form

EndShowTagProfileForm: After showing people tagging form

StartSavePeopletags: When starting to save people tags

EndSavePeopletags: After saving people tags

StartProfiletagGetUri: when generating the Uri for a people tag

EndProfiletagGetUri: after generating the uri for a people tag

StartUserPeopletagHomeUrl: when generating the homepage url for a people tag

EndUserPeopletagHomeUrl: after generating the homepage url for a people tag

StartProfiletagPermalink: when generating the permalink url for a people tag

EndProfiletagPermalink: after generating the permalink url for a people tag

StartTagProfile: when tagging a profile

EndTagProfile: after tagging a profile

StartUntagProfile: when deleting a people tag

EndUntagProfile: after deleting a people tag

StartSubscribePeopletag: when subscribing to a people tag

EndSubscribePeopletag: after subscribing to a people tag

StartUnsubscribePeopletag: when unsubscribing to a people tag

EndUnsubscribePeopletag: after unsubscribing to a people tag

StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag

EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag

StartPeopletagGroupNav: Showing the people tag nav menu

EndPeopletagGroupNav: after showing the people tag nav menu

StartShowPeopletagItem: when showing a people tag

EndShowPeopletagItem: after showing a people tag

StartSubscribePeopletagForm: when showing people tag subscription form

EndSubscribePeopletagForm: after showing the people tag subscription form

StartShowPeopletags: when showing a textual list of people tags

EndShowPeopletags: after showing a textual list of people tags

StartProfileListItemTags: when showing people tags in a profile list item widget

EndProfileListItemTags: after showing people tags in a profile list item widget

StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you’re responsible for calling the matching End event if so)

EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>

StartActivityObjectOutputJson: Called at start of JSON output generation for ActivityObject chunks: the array has not yet been filled out. Cancel the event to take over its output completely (you’re responsible for calling the matching End event if so)

EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.

StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule notices to go to particular profiles that would otherwise not have reached them. Canceling will take over the entire addressing operation. Be aware that output can be cached or used several times, so should remain idempotent.

EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here. Be aware that output can be cached or used several times, so should remain idempotent.

StartDefaultLocalNav: When showing the default local nav

EndDefaultLocalNav: When showing the default local nav

StartShowAccountProfileBlock: When showing the profile block for an account

EndShowAccountProfileBlock: After showing the profile block for an account

StartShowGroupProfileBlock: When showing the profile block for a group

EndShowGroupProfileBlock: After showing the profile block for a group

StartShowConversation: start the listing of a conversation

EndShowConversation: after the listing of a conversation

StartShowThreadedNoticeTail: when showing the replies etc. to a notice

EndShowThreadedNoticeTail: when showing the replies etc. to a notice

StartShowThreadedNoticeSub: when showing a reply to a notice

EndShowThreadedNoticeSub: when showing a reply to a notice

StartAddEmailAddress: when adding an email address through the Web UI

EndAddEmailAddress: done adding an email address through the Web UI

StartValidateEmailInvite: when validating an email address for invitations

EndValidateEmailInvite: after validating an email address for invitations

StartLocalURL: before resolving a local url for an action

EndLocalURL: before resolving a local url for an action

StartProfileGetAvatar: When getting an avatar for a profile

EndProfileGetAvatar: After getting an avatar for a profile

StartRegisterSuccess: Before showing the registration success message

StartRegisterSuccess: After showing the registration success message

StartDocFileForTitle: Before searching for a doc or mail template

EndDocFileForTitle: After searching for a doc or mail template

StartReadWriteTables: when noting which tables must be read-write, even on read-only actions

EndReadWriteTables: after noting which tables must be read-write, even on read-only actions

StartShowInviteForm: Right before displaying the invitations form

EndShowInviteForm: After displaying the invitations form

StartSendInvitations: Right before sending invitations

EndSendInvitations: Right after sending invitations

StartShowInvitationSuccess: Right before showing invitations success msg

EndShowInvitationSuccess: After showing invitations success msg

StartUpgrade: when starting a site upgrade

EndUpgrade: when ending a site upgrade; good place to do your own upgrades

HaveIMPlugin: is there an IM plugin loaded?

StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div

EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div

StartNoticeInScope: Before checking if a notice should be visible to a user

EndNoticeInScope: After checking if a notice should be visible to a user

StartNoticeListPrefill: Before pre-filling a list of notices with extra data

EndNoticeListPrefill: After pre-filling a list of notices with extra data

OtherAccountProfiles: Hook to add account profiles to a user account profile block

CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File

StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.

FillImageFileMetadata: Get more metadata about the ImageFile if it is perhaps not a real local file

StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).

EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.

ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).

StartNotifyMentioned: During notice distribution, we send notifications (email, im…) to the profiles who were somehow mentioned.

EndNotifyMentioned: During notice distribution, we send notifications (email, im…) to the profiles who were somehow mentioned.

StartHomeStubNavItems: Go back Home nav items. Default includes just one item ‘home’

EndHomeStubNavItems:

StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML

EndSubMenu: After outputting a submenu (including enclosing tags) to HTML

StartDocNav: Before outputting the docs Nav

EndDocNav: After outputting the docs Nav