created:2021-05-14
author:Foobär
top:README:Settings:Hooks
sort:016
title:Table Of Available Hooks

<p><pre>
   ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
   ┃ Function Name                      │ Called                                             │ Available Local Variables            │ Usage Examples                ┃
   ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
   ┃ hook_error                         │ When a fatal error has occured                     │ $@   The error message (usually just │ Clean-up before exit          ┃
   ┃                                    │ After the error message has bee printed            │        one string, so $1)            │ Send out a notification       ┃
   ┃                                    │ Before the temporary directory gets cleared        │ $str The error message in one string │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_redirect                      │ When an HTML file is created that redirects to     │ $1 Path of created HTML file         │ Additional file operations    ┃
   ┃                                    │ another URL, before the file is written            │ $2 Relative path of target           │   related to HTML redirection ┃
   ┃                                    │                                                    │                                      │   (e.g. file system links)    ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_prepare                       │ After all preparations have been made              │ -                                    │ Create or copy files idepen-  ┃
   ┃                                    │ Before anything gets generated                     │                                      │   dantly of what SBWG will do ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_files                         │ When and after the web site's files directory gets │ -                                    │ Copy additional files when-   ┃
   ┃                                    │ copied from the source directory to the output dir │                                      │   ever SBWG copies files dir  ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_head                          │ When the head portion of an HTML file is generated │ $outfile  The HTML file that is cur- │ Inject tags into the HTML     ┃
   ┃                                    │ After the hardcoded tags in the &lt;head&gt; tag         │             rently being generated   │   &lt;head&gt; tag (e.g. link JS)   ┃
   ┃                                    │ Before the &lt;head&gt; tag is closed                    │                                      │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_start                   │ When an entry page gets generated                  │ $outfile  The HTML file that is cur- │ Additional preparations of an ┃
   ┃                                    │ After the entry file has been checked              │             rently being generated   │   entry before any HTML is    ┃
   ┃                                    │ After tags have been extracted from the entry file │ $entry    Name of the current entry  │   generated                   ┃
   ┃                                    │ Before any tags are processed                      │ $tags     List of the entry's tags   │                               ┃
   ┃                                    │ Before anything gets written to the HTML file      │ $author   Name of the entry's author │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_title_start             │ When an entry page gets generated                  │ See hook above.                      │ Inject HTML at the beginning  ┃
   ┃                                    │ Inside (at the beginning of) the title wrapper     │                                      │   of the title-wrapper of an  ┃
   ┃                                    │ After the title wrapper tag has been opened        │                                      │   entry page                  ┃
   ┃                                    │ Before the title and meta-information are printed  │                                      │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_title_tags_before       │ When an entry page gets generated                  │ See hook above.                      │ Inject HTML at the beginning  ┃
   ┃                                    │ Inside the title wrapper                           │ Additionally:                        │   of the tags in the title-   ┃
   ┃                                    │ After the created (and edited) date(s) are printed │ $created  The entry's created date v.│   wrapper of an entry page    ┃
   ┃                                    │ Before the tags are printed                        │ $edited   It's edited date value     │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_title_tag_before        │ When a tag gets printed inside the title wrapper   │ See hook above.                      │ Inject HTML before certain or ┃
   ┃                                    │   of an entry page                                 │ Additionally:                        │   all tags in the title-      ┃
   ┃                                    │ Before it was checked whether it is a tag that     │ $tag    The currently processed tag  │   wrapper of an entry page    ┃
   ┃                                    │   will be printed or not                           │                                      │                               ┃
   ┃                                    │ Before the its surrounding HTML tags are printed   │                                      │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_title_tag_after         │ When a tag gets printed inside the title wrapper   │ See hook above.                      │ Inject HTML after certain or  ┃
   ┃                                    │   of an entry page                                 │ Additionally:                        │   all tags in the title-      ┃
   ┃                                    │ After the tag has been printed                     │ $tag    The currently processed tag  │   wrapper of an entry page    ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_title_tags_after        │ When an entry page gets generated                  │ Same as three hooks above.           │ Inject HTML at the end of the ┃
   ┃                                    │ After the tags have been printed                   │   (hook_entry_title_tags_before)     │   tags in the title-wrapper   ┃
   ┃                                    │ Before the title wrapper is closed                 │                                      │   of an entry page            ┃
   ┃                                    │ Before the content is printed                      │                                      │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_before                  │ When an entry page gets generated                  │ Same as six hooks above.             │ Inject HTML at the beginning  ┃
   ┃                                    │ After the title wrapper is printed and closed      │   (hook_entry_start)                 │   of the content of the       ┃
   ┃                                    │ After the content div is opened                    │                                      │   content of an entry on the  ┃
   ┃                                    │ After the reference lines (if any) have been been  │                                      │   entry page                  ┃
   ┃                                    │   printed                                          │                                      │                               ┃
   ┃                                    │ Before the entry content is printed                │                                      │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_after                   │ When an entry page gets generate                   │ See hook above.                      │ Inject HTML at the end of the ┃
   ┃                                    │ After the entry content is printed                 │                                      │   content of an entry on the  ┃
   ┃                                    │ Before the content div is closed                   │                                      │   entry page                  ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entry_end                     │ When an entry page gets generated                  │ See hook above.                      │ Additional file operations    ┃
   ┃                                    │ After everything concerning this entry is done and │                                      │   after an entry page has     ┃
   ┃                                    │   the HTML file is completed and closed            │                                      │   been generated that don't   ┃
   ┃                                    │                                                    │                                      │   afftect generation          ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entries_start                 │ When generating entries                            │ -                                    │ Additional operations per-    ┃
   ┃                                    │ Before any entry has been generated or prepared    │                                      │   formed if and before any    ┃
   ┃                                    │                                                    │                                      │   entry pages are generated   ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_entries_end                   │ When generating entries                            │ -                                    │ Additional operations per-    ┃
   ┃                                    │ After all entries have been generated/completed    │                                      │   formed if and after all     ┃
   ┃                                    │                                                    │                                      │   entry pages are generated   ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_gallery_start                 │ When a gallery page gets generated                 │ $outfile  The HTML file that is cur- │             ┃
   ┃                                    │ After gallery generation has been prepared         │             rently being generated   │             ┃
   ┃                                    │ After the gallery has been checked                 │ $gallery  Name of the gallery that is│             ┃
   ┃                                    │ Before anything gets written to the HTML file      │             currently being generated│             ┃
   ┃                                    │                                                    │ $images   List of file names of all  │             ┃
   ┃                                    │                                                    │             images in this gallery   │             ┃
   ┃                                    │                                                    │ $tags     If there is a corrospon-   │             ┃
   ┃                                    │                                                    │             ding entry: list of all  │             ┃
   ┃                                    │                                                    │             tags of that entry       │             ┃
   ┃                                    │                                                    │ $title    If there is a corrospon-   │             ┃
   ┃                                    │                                                    │             ding entry: Entry's title│             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_gallery_before                │ When a gallery page gets generated                 │ See hook above.                      │             ┃
   ┃                                    │ After the navigation bar and page header have been │                                      │             ┃
   ┃                                    │   generated                                        │                                      │             ┃
   ┃                                    │ Before the image thumbnails are written to the     │                                      │             ┃
   ┃                                    │   HTML file                                        │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_gallery_image_before          │ When an image is placed in a gallery page          │ See hook above.                      │             ┃
   ┃                                    │ After the image file has been checked              │ Additionally:                        │             ┃
   ┃                                    │ Before the image preview is placed in the HTML file│ $image   Path and file name of the   │             ┃
   ┃                                    │                                                    │            currently processed image │             ┃
   ┃                                    │                                                    │ $img     Its file name without path  │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_gallery_image_after           │ When an image is placed in a gallery page          │ See hook above.                      │             ┃
   ┃                                    │ After the image preview has been placed in the     │                                      │             ┃
   ┃                                    │   HTML file                                        │                                      │             ┃
   ┃                                    │ Before the "Go to top" link is placed in the file  │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_gallery_after                 │ When a gallery page gets generated                 │ Same as three hooks above.           │             ┃
   ┃                                    │ After the last image has been placed in the        │   (hook_gallery_before)              │             ┃
   ┃                                    │   generated HTML output file                       │                                      │             ┃
   ┃                                    │ Before the main section is closed and the footrer  │                                      │             ┃
   ┃                                    │   printed to the generated HTML output file        │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_gallery_end                   │ When a gallery page gets generated                 │ See hook above.                      │             ┃
   ┃                                    │ After the gallery page HTML file has been finished │                                      │             ┃
   ┃                                    │ After everything conserning this gallery is done   │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_galleries_start               │ When image galleries are generated                 │ -                                    │             ┃
   ┃                                    │ Before it gets decided which galleries will be     │                                      │             ┃
   ┃                                    │   generated                                        │                                      │             ┃
   ┃                                    │ Before any of the galleries have been checked,     │                                      │             ┃
   ┃                                    │   prepared or generated                            │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_galleries_end                 │ When image galleries are generated                 │ -                                    │             ┃
   ┃                                    │ After every gallery has been generated             │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_page_start                    │ When a SBWG page gets generated                    │ $outfile  The HTML file that is cur- │             ┃
   ┃                                    │ After the page file has been checked               │             rently being generated   │             ┃
   ┃                                    │ After tags have been extracted from the page file  │ $tags     List of the page's tags    │             ┃
   ┃                                    │ Before any tags are processed                      │ $title    The page's title if tag set│             ┃
   ┃                                    │ Before anything gets written to the HTML file      │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_page_title_before             │ When a SBWG page gets generated                    │ See hook above.                      │             ┃
   ┃                                    │ If the page has a title tag                        │                                      │             ┃
   ┃                                    │ After the header and navigation bar have been      │                                      │             ┃
   ┃                                    │   added to the generated output file               │                                      │             ┃
   ┃                                    │ Right before the title gets printed on the page    │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_page_title_after              │ When a SBWG page gets generated                    │ See hook above.                      │             ┃
   ┃                                    │ If the page has a title tag                        │                                      │             ┃
   ┃                                    │ Right after the title gets printed on the page     │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_page_content_before           │ When a SBWG page gets generated                    │ See hook above.                      │             ┃
   ┃                                    │ Right before the content gets printed on the page  │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_page_content_after            │ When a SBWG page gets generated                    │ See hook above.                      │             ┃
   ┃                                    │ Right after the content gets printed on the page   │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_page_end                      │ When a SBWG page gets generated                    │ See hook above.                      │             ┃
   ┃                                    │ After everything concerning this page has been     │                                      │             ┃
   ┃                                    │   done                                             │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_pages_start                   │ When SBWG pages are generated                      │ -                                    │             ┃
   ┃                                    │ Before any pages are prepared or generated         │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_pages_end                     │ When SBWG pages are generated                      │ -                                    │             ┃
   ┃                                    │ After all pages have been generated                │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_start                  │ Before any HTML pages are generated                │                                      │             ┃
   ┃                                    │ If any HTML pages will be generated in this run    │                                      │             ┃
   ┃                                    │ When the navigation bar is generated               │                                      │             ┃
   ┃                                    │ Before any preparations for the navigation bar     │                                      │             ┃
   ┃                                    │   generation have been done                        │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_before                 │ When the navigation bar is generated (once per     │ $outfile  Path of the navbar file in │             ┃
   ┃                                    │   run of the script)                               │             the temporary directory  │             ┃
   ┃                                    │ After the &lt;nav&gt; tag has been opened                │             during the generation of │             ┃
   ┃                                    │ Before anything gets printed to the navigation bar │             the navigation bar       │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_item_before            │ When the navigation bar is generated (once per     │ See hook above.                      │             ┃
   ┃                                    │   run of the script)                               │ Additionally:                        │             ┃
   ┃                                    │ For each tag that occurs at least once in an entry │ $item   Tag that is currently being  │             ┃
   ┃                                    │ Before the tag type has been checked               │           processed (e.g. "cat:foo") │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_item_after             │ When the navigation bar is generated (once per     │ See hook above.                      │             ┃
   ┃                                    │   run of the script)                               │                                      │             ┃
   ┃                                    │ For each tag that occurs at least once in an entry │                                      │             ┃
   ┃                                    │ After the tag type has been checked and the tag    │                                      │             ┃
   ┃                                    │   been processed if of a tag type that is included │                                      │             ┃
   ┃                                    │   in the navigation bar by default                 │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_item_change            │ When the navigation bar is generated (once per     │ See hook above.                      │             ┃
   ┃                                    │   run of the script)                               │                                      │             ┃
   ┃                                    │ For the last tag of each tag type that occurs at   │                                      │             ┃
   ┃                                    │   least once in an entry                           │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_galleries_before       │ When the navigation bar is generated (once per     │ Same as four hooks above.            │             ┃
   ┃                                    │   run of the script)                               │   (hook_navbar_before)               │             ┃
   ┃                                    │ After all tags have been processed                 │                                      │             ┃
   ┃                                    │ Right before the list of galleries is generated    │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_gallery_before         │ When the navigation bar is generated (once per     │ See hook above. Additianlly:         │             ┃
   ┃                                    │   run of the script)                               │ $gallery  Name of the currently      │             ┃
   ┃                                    │ Before a gallery gets printed to the output file   │             being added to the list  │             ┃
   ┃                                    │                                                    │             in the navigation bar    │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_gallery_after          │ When the navigation bar is generated (once per     │ See hook above.                      │             ┃
   ┃                                    │   run of the script)                               │                                      │             ┃
   ┃                                    │ After a gallery gets printed to the output file    │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_galleries_after        │ When the navigation bar is generated (once per     │ Same as six hooks above.             │             ┃
   ┃                                    │   run of the script)                               │   (hook_navbar_before)               │             ┃
   ┃                                    │ After the list of galleries has been printed to    │                                      │             ┃
   ┃                                    │   the generated HTML output file                   │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_after                  │ When the navigation bar is generated (once per     │ See hook above.                      │             ┃
   ┃                                    │   run of the script)                               │                                      │             ┃
   ┃                                    │ After all content that is included in the          │                                      │             ┃
   ┃                                    │   navigation bar by default has been added to it   │                                      │             ┃
   ┃                                    │ Before the &lt;nav&gt; tag is closed                     │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_navbar_end                    │ When the navigation bar is generated (once per     │ See hook above.                      │             ┃
   ┃                                    │   run of the script)                               │                                      │             ┃
   ┃                                    │ After everything concerning the navigation bar     │                                      │             ┃
   ┃                                    │   generation has been processed                    │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_start                 │ When a tagpage is generated                        │ $outfile    Path of the tagpage HTML │             ┃
   ┃                                    │ After the output file has been checked             │               file that is currently │             ┃
   ┃                                    │ Before anything gets written to the generated      │               being generated        │             ┃
   ┃                                    │  tagpage HTML output file                          │ $tag        Name of the tag for which│             ┃
   ┃                                    │                                                    │               the tagpage is cur-    │             ┃
   ┃                                    │                                                    │               rently being generated │             ┃
   ┃                                    │                                                    │ $lastentry  Number of entries that   │             ┃
   ┃                                    │                                                    │               are included on this   │             ┃
   ┃                                    │                                                    │               tagpage                │             ┃
   ┃                                    │                                                    │ $lastpage   Number of additional     │             ┃
   ┃                                    │                                                    │               pages if this tagpage  │             ┃
   ┃                                    │                                                    │               will have a pager/more │             ┃
   ┃                                    │                                                    │               than one HTML page     │             ┃
   ┃                                    │                                                    │ $pagecount  Number of the pge that   │             ┃
   ┃                                    │                                                    │               is currently being     │             ┃
   ┃                                    │                                                    │               processed (out of      │             ┃
   ┃                                    │                                                    │               $lastpage pages)       │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_before                │ When a tagpage is generated                        │ See hook above. Additionally:        │             ┃
   ┃                                    │ After the heade and navigation bar of the          │ $secs    List of tags for which      │             ┃
   ┃                                    │   generated HTML page have been generated          │            combined tagpages will    │             ┃
   ┃                                    │ Right after the content &lt;div&gt; tag is opened        │            be generated (if any)     │             ┃
   ┃                                    │ Before thr content of the tagpage is written       │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_entry_top_before      │ When a topic tagpage is generated                  │ See hook above. Additionally:        │             ┃
   ┃                                    │ Inside the title-wrapper div                       │ $entrycount   Number of the entry    │             ┃
   ┃                                    │ Before the title of an entry is printed to HTML    │                 is currently being   │             ┃
   ┃                                    │                                                    │                 processed (out of    │             ┃
   ┃                                    │                                                    │                 $lastentry pages)    │             ┃
   ┃                                    │                                                    │ $tags         List of all tag lines  │             ┃
   ┃                                    │                                                    │                 of the currently     │             ┃
   ┃                                    │                                                    │                 processed entry      │             ┃
   ┃                                    │                                                    │ $author       Name of the author     │             ┃
   ┃                                    │                                                    │                 of the current entry │             ┃
   ┃                                    │                                                    │ $target       Name of an entry the   │             ┃
   ┃                                    │                                                    │                 current entry will   │             ┃
   ┃                                    │                                                    │                 redirect to (if any) │             ┃
   ┃                                    │                                                    │ $entryname    Name of the cuttently  │             ┃
   ┃                                    │                                                    │                 processed entry      │             ┃
   ┃                                    │                                                    │ $created      Created date value of  │             ┃
   ┃                                    │                                                    │                 the current entry    │             ┃
   ┃                                    │                                                    │ $edited       Edited date value of   │             ┃
   ┃                                    │                                                    │                 the current entry    │             ┃
   ┃                                    │                                                    │ $title        Title of the current-  │             ┃
   ┃                                    │                                                    │                 ly processed entry   │             ┃
   ┃                                    │                                                    │ $sortby       Sort value of the      │             ┃
   ┃                                    │                                                    │                 current entry        │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_entry_top_after       │ When a topic tagpage is generated                  │ See hook above.                      │             ┃
   ┃                                    │ Inside the title-wrapper div                       │                                      │             ┃
   ┃                                    │ After the created and edited dates have been       │                                      │             ┃
   ┃                                    │   printed to the generated HTML file               │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_entry_title_before    │ When a tagpage (not topic tagpage) is generated    │ See hook above.                      │             ┃
   ┃                                    │ For each entry that on this tagpage except for     │                                      │             ┃
   ┃                                    │   stickied entries                                 │                                      │             ┃
   ┃                                    │ Inside the title-wrapper div                       │                                      │             ┃
   ┃                                    │ Before the entry's title is written to the HTML    │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_entry_title_after     │ When a tagpage (not topic tagpage) is generated    │ See hook above.                      │             ┃
   ┃                                    │ For each entry that on this tagpage except for     │                                      │             ┃
   ┃                                    │   stickied entries                                 │                                      │             ┃
   ┃                                    │ Inside the title-wrapper div                       │                                      │             ┃
   ┃                                    │ After the entry's title is written to the HTML     │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_entry_stickied        │ When a tagpage (not topic tagpage) is generated    │ See hook above.                      │             ┃
   ┃                                    │ For each stickied entry on this tagpage            │                                      │             ┃
   ┃                                    │ Before the entry's content is printed to the HTML  │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_entry_content_before  │ When a tagpage (not topic tagpage) is generated    │ See hook above.                      │             ┃
   ┃                                    │ Inside the entry-content-wrapper div               │                                      │             ┃
   ┃                                    │ Before the entry's content is printed to the HTML  │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_entry_content_after   │ When a tagpage (not topic tagpage) is generated    │ See hook above.                      │             ┃
   ┃                                    │ Inside the entry-content-wrapper div               │                                      │             ┃
   ┃                                    │ After the entry's content is printed to the HTML   │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_after                 │ When a tagpage is generated                        │ Same as eight hooks above.           │             ┃
   ┃                                    │ After all entries have been added to the generated │   (hook_tagpage_before)              │             ┃
   ┃                                    │   HTML file in the output directory                │                                      │             ┃
   ┃                                    │ Before content &lt;div&gt; tag has been closed           │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpage_end                   │ When a tagpage is generated                        │ See hook above.                      │             ┃
   ┃                                    │ After all entries concerning this tagpage have     │                                      │             ┃
   ┃                                    │   been processed                                   │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpages_entry                │ When tagpage generation is prepared                │ $entry    Name of entry currently    │ Influence tagpage sorting by  ┃
   ┃                                    │ For each entry that exists on the web site         │             being examined           │   changing $sortby of entries ┃
   ┃                                    │ After the entry source file has been checked       │ $tags     List of all tags of the    │             ┃
   ┃                                    │ After some meta information has been retrieved     │             currently examined entry │             ┃
   ┃                                    │   from the entry's tags                            │ $created  Created date value of the  │             ┃
   ┃                                    │ After the entry's sorting value has been determined│             currently examined entry │             ┃
   ┃                                    │ Before all tags have been checked                  │ $edited   Edited date value of the   │             ┃
   ┃                                    │ Before the entry is assigned to any tagpage        │             currently examined value │             ┃
   ┃                                    │ Before any tagpages get generated                  │ $author   Name of the author of the  │             ┃
   ┃                                    │                                                    │             currently examined entry │             ┃
   ┃                                    │                                                    │ $sortby    Sort value of the         │             ┃
   ┃                                    │                                                    │             currently examined entry │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpages_start                │ When tagpages get generated                        │ -                                    │             ┃
   ┃                                    │ After tagpage generation has been prepared         │                                      │             ┃
   ┃                                    │ Before it is determined chich tagpages to generate │                                      │             ┃
   ┃                                    │ Before any tagpages get generated                  │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_tagpages_end                  │ When tagpages get generated                        │ -                                    │             ┃
   ┃                                    │ After all tagpagges that are generated in this run │                                      │             ┃
   ┃                                    │   of the script have been completely generated     │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_rss_start                     │ When an RSS file gets generated                    │ $outfile    Path of the RSS file     │             ┃
   ┃                                    │ Before anything is concerning the RSS feed         │               being generated        │             ┃
   ┃                                    │ Before the RSS file is generated                   │                                      │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_rss_channel                   │ When an RSS file gets generated                    │ See hook above.                      │ Restrict which entries will   ┃
   ┃                                    │ After the blog's meta information have been added  │                                      │   be included (e.g. number    ┃
   ┃                                    │ Before any entries are added to the feed           │                                      │   of entries in the feed)     ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_rss_entry                     │ When an RSS file gets generated                    │ See hook above. Additionally:        │             ┃
   ┃                                    │ For each entry that is added to the feed           │ $entry        │             ┃
   ┃                                    │ Before any data concerning this entry is added     │                 │             ┃
   ┃                                    │                                                    │ $entryname                │             ┃
   ┃                                    │                                                    │                 │             ┃
   ┃                                    │                                                    │ $tags                │             ┃
   ┃                                    │                                                    │                 │             ┃
   ┃                                    │                                                    │ $author                │             ┃
   ┃                                    │                                                    │                 │             ┃
   ┃                                    │                                                    │ $title                │             ┃
   ┃                                    │                                                    │                 │             ┃
   ┃                                    │                                                    │ $pubdate                │             ┃
   ┃                                    │                                                    │                 │             ┃
   ┃                                    │                                                    │ $content                │             ┃
   ┃                                    │                                                    │                 │             ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_rss_end                       │ When an RSS file gets generated                    │ See hook above.                      │ Add additional content        ┃
   ┃                                    │ After the last entry has been added to the feed    │                                      │   (channels, items/entries)   ┃
   ┃                                    │ Before the &lt;rss&gt; tag is closed                     │                                      │                               ┃
   ┠────────────────────────────────────┼────────────────────────────────────────────────────┼──────────────────────────────────────┼───────────────────────────────┨
   ┃ hook_end                           │ After everything that is generated in this run of  │ -                                    │ Perform additional operations ┃
   ┃                                    │   of the script has been done                      │                                      │   on the final product        ┃
   ┃                                    │ Before cleanup (removal of temporary files)        │                                      │ Send out a notification       ┃
   ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
</pre></p>
