Generally the page title is the first-order heading, and the main page subtitles begin with Heading 2. Further subheadings are used as needed. Logical headings are important for scanning a page as well as for a helpful Table of Contents. Headings are set in the existing template.
If the headings go really deep (say, to fourth and fifth levels), then consider starting with level one instead of level two.
Think about the structure/presentation of your topic and how it will look in a Table of Contents – which you should use if your page requires much scrolling. Tables of Contents, where topical headings and subheadings are well thought out, help viewers quickly find what they need right at the top of the page.
First, use the Search function to ensure that someone hasn't already added a similar page.
If not, think about where your page should go within the established hierarchy (see Tree Categories, above).
Required if your page requires much scrolling, like this one!
You can view the change history of any document by going to its page and clicking Tools > Page History. However, if the document is being created by more than one person, requires approval, or might be audited, it might be best to add a Change History macro below the Table of Contents:
Please use for all code documentation. Be precise with the spacing: please use 4-space increments to indent a line of code.
|In the editor, delete any spaces such that the code block immediately follows the text describing it. Once you save, a little more space will be added. Otherwise you get large gaps on the page. You can use "Preview" button at the lower right of the editor to check out the final appearance before deciding and saving.|
These pull out text that is especially important to make it stand out rather than be lost in a sea of characters. Find them under Insert > Other Macros > Formatting, then scroll to the appropriate option (these four have icons, but there are other options for setting off text). For example:
This callout is good for extra information, say, about the version or history of an app or document and where to go for supplemental information, that you want to stand out from the rest of the text.
|This can be, for example, a helpful tip.|
|In the help documents, we are using this callout for "Note:" statements, as for a cautionary or other important note—an extra detail, something to pay attention to—but is short of a warning.|
This is a warning! (like, Achtung! Verboten! Don't do this! Caveat Emptor! 'S death!)
The "Insert" button on the editing toolbar is your source for all kinds of items and macros, from emoticons to a table of contents to any of a plethora of handy macros. For macros, a few common ones are on the dropdown menus, and many more are under the "Other Macros" option, which itself has sets of macros for different types of needs. Several especially useful ones are described below.
Attachments, especially if you want to provide several, will stand out best (and are easily managed) using the Attachment macro, usually at the top or bottom of a given page. To insert this macro:
Looks like this (notice that the attachments embedded throughout this page are displayed here):
You or anyone can now attach documents directly on the page using the macro.
If you just want to add just one attachment, or embed attachments in-text:
Note: If there also is an Attachment macro on the page, each embedded attachment will automatically be uploaded to it.
Links work much like individual attachments: