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 Think about where your page should go within the established hierarchy (see Tree Categories, above).If it needs a new page, title it simply but recognizably, and consider whether other existing or forthcoming pages might be within its scope (this would affect the titling).
. In this ECOS Help wiki, each application has a parent page, and everything else is either content on the parent page or a child page of it.
Required if your page has at least three headings and requires much scrolling, like this one! (So almost always.)
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.|
|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 can be, for example, a helpful tip.
|This is a warning! (like, Achtung! Verboten! Don't do this! Caveat Emptor! 'S death!)|
|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. (And sometimes, the spacing gets weird with Notes and tables, and won't stay saved once you open the editor again; haven't figured out how to make it behave.)|
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.
Images can be plucked from Word (copy/paste) or captured and then copied/pasted from those made with SnagIt or similar. There are a couple things you can do once it's in Confluence (add a black border, resize), but if you are using added-on circles and arrows on figures, do those in the capture software and then grab the whole image and place it in Confluence. (For any screenshots I added, I applied a medium blue border (and any circles, boxes, or arrows around particular parts of the image) in SnagIt to all newly captured images—stands out better and looks nicer—before pasting it onto the Confluence page.)
To resize, add a border, link to other content, or apply an interesting "effect," click on the image and then, in the tool bar that appears above or below it (depending on where your view is):
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):
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: