Technical Notes

What Is A "Technote"?

In Fossil, a "technical note" or "technote" (formerly called an "event") is a special kind of wiki page that is associated with a point in time rather than having a page name. Each technote causes a single entry to appear on the Timeline Page. Clicking on the timeline link will display the text of the technote. The wiki content, the timeline entry text, the time of the technote, and the timeline background color can all be edited.

As with check-ins, wiki, and tickets, all technotes automatically synchronize to other repositories. Hence, technotes can be viewed, created, and edited off-line. And the complete edit history for technotes is maintained for auditing purposes.

Possible uses for technotes include:

No project is required to use technotes. But technotes can help many projects stay better organized and provide a better historical record of the development progress.

Viewing Technotes

Because technotes are considered a special kind of wiki, users must have permission to read wiki in order read technotes. Enable the "j" permission under the /Setup/Users menu in order to give specific users or user classes the ability to view wiki and technotes.

Technotes show up on the timeline. Click on the hyperlink beside the technote title to see the complete text.

Creating And Editing Technotes

There is a hyperlink under the /wikihelp menu that can be used to create new technotes. And there is a submenu hyperlink on technote displays for editing existing technotes.

Users must have check-in privileges (permission "i") in order to create or edit technotes. In addition, users must have create-wiki privilege (permission "f") to create new technotes and edit-wiki privilege (permission "k") in order to edit existing technotes.

Technote content may be formatted as Fossil wiki, Markdown, or a plain text.