Old documentation | |
|
If you want to learn how to document for Tiki, you probably want to work for Polaris on doc.tiki.org, which has it's own conventions page : Formatting Standards
| |
Old content | |
|
How to Document a Feature
To document a feature correctly, the documentation team needs to create a range of pages, including a ))FeatureXGlosspage (defining the feature), aFeatureXpage that lists what the feature can do, aFeatureXDocspage with step-by-step instructions, aFeatureXAdminpage with step-by-step administrative procedures and tips, and aFeatureXSettings(( page that provides a quick overview of the feature's administrative settings. For more information and examples, click the plus sign. | |
| [+]
In brief, each Tiki feature needs the following pages (replace FeatureX with the feature's name):
| |
How To Write Great Documentation | |
|
It's easy — just follow a few simple rules. The following guidelines are suggested for ))FeatureXDocandFeatureXAdmin(( pages. Click the plus sign to view the guidelines. | |
| [+]
| |
Annotated Example | |
|
Click the plus sign to see some documentation that implements the guidelines (presented above). | |
| [+]
Creating bulleted, numbered, and definition lists ➡️ Use action words ("creating," "changing," "removing," etc. in titles. In Wiki pages and other contexts that support Wiki formatting (including articles, forums, and blogs), you can easily create bulleted, numbered, and definition lists. In numbered lists, Tiki numbers the items automatically. You can also create nested lists. ➡️ Note: The above is included from WikiListGloss. The following sections explain the details; see the Quick Reference for an overview. Scroll down to Help! if something goes wrong. ➡️ Note how the above section anticipates and replicates the structure of the following sub-sections. Note the level of abstraction and generality. Quick reference: List formatting codes
Tip If you forget which of the above list-formatting codes to use while you're editing, click the Wiki Quick Help tab. This tab appears when you're editing a Wiki page. ➡️ Keep this short. Creating a bulleted list
➡️ Describes (a) where to go to start and (b) what this feature is for If you type an asterisk (*) at the beginning of a line, Tiki places a bullet (a black dot) at the beginning of the line. The line is indented and formatted with a hanging indent, so that second and subsequent lines are indented and aligned with the first line. ➡️ Describes how this feature works To create a bulleted list, do the following:
Did something go wrong?
Note Administrators can configure Tiki so that beginning-of-line spaces are not interpreted as the beginning of preformatted (monospace) text. On the Application Menu, click Admin and click the Wiki tab. Uncheck the Automonospaced Text option. ➡️ Consider how Tiki might work differently depending on the administrative options that have been chosen. Indicate how administrative options might affect what the user sees.
| ||||||
Documentation Conventions | |
|
For consistency's sake, typographical conventions — formatting rules to follow when writing documentation — make very good sense. Click the plus sign to view the recommended conventions. | |
| [+]
More information
FeatureX
| ||