D 2018-12-31T02:05:10.586
L branch/describe-objects-using-wiki
U drh
W 2071
The describe-objects-using-wiki branch is an experiment in
linking branches, checkins, and tags to wiki pages by using wiki
pages with special names. This idea was originally introduced
[https://fossil-scm.org/forum/forumpost/4a78ad2b3c|on the Fossil Forum].
Linkages implemented so far:
* On the /timeline?r=<i>BRANCH</i> page, if there is a wiki page
named "branch:<i>BRANCH</i>" then the text of that wiki page is
shown above the normal timeline of the graph.
Example: [/timeline?r=graph-test-branch]
* On the /timeline?t=<i>TAG</i> page, if there is a wiki page named
"tag:<i>TAG</i>" then the text of that wiki page is shown above the
normal timeline graph.
Example: [/timeline?t=cvs2fossil-complete]
* On the /info/<i>HASH</i> page for checkin <i>HASH</i>.
if there is a wiki page named
"checkin:<i>FULLHASH</i>" (where <i>FULLHASH</i> must be the complete SHA1
or SHA3-256 hash of the checkin for which <i>HASH</i> is a prefix)
then the text of
that wiki page appears under a new "About" section.
Example: [/info/dcf93d034143f49ef]
In addition to these primary linkages, there are other enhancements:
* This linkage mechanism can be completely disabled by a setting on
the Setup/Wiki page. It defaults to on, though.
* The /wiki and /wikiedit screens for the specially-named wiki pages have
titles that reflect their special usage, and submenu links to the
corresponding branch, checkin, or tag.
* The "nowiki" query parameter will disable the display of linked wiki
pages for a particular URL.
* The /info page has an added "Edit Wiki:" line in its Overview section
(visible only to users that have the ability to edit wiki) that allows
one to view are alter Wiki pages associated with the checkin being displayed,
or any branch or tag attached to that checkin.
* The /timeline page has an added "Wiki" submenu link that links to the
corresponding /wiki page, if there is one.
Z 685d0973d87b6e4c2ba75e963a361970