Fossil SCM

branch/describe-objects-using-wiki

7 years, 3 months ago by drh

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 on the Fossil Forum.

Linkages implemented so far:

  • On the /timeline?r=BRANCH page, if there is a wiki page named "branch:BRANCH" 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=TAG page, if there is a wiki page named "tag:TAG" then the text of that wiki page is shown above the normal timeline graph. Example: [/timeline?t=cvs2fossil-complete]

  • On the /info/HASH page for checkin HASH. if there is a wiki page named "checkin:FULLHASH" (where FULLHASH must be the complete SHA1 or SHA3-256 hash of the checkin for which HASH 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 "Wiki:" line in its Overview section (visible only to users that have the ability to read wiki) that allows one to view (and edit with appropriate privileges) 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 element that links to the corresponding /wiki page, if there is one.

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button