Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use this section to define and discuss the topic of the document and give any relevant information pertaining to the document.  

Heading 2 for a New Section

Sub-Section Header Using Heading 3

Below is a Horizontal Rule to help divide sections. Put these above new sections that start with a "Heading 2" Section Title. 


...

Section Header using Heading 2

Sub-Section Header Using Heading 3

It's essential to link from one page to another and to specific sections on a page. You can add any URL to a Confluence page and Confluence will automatically detect it and turn it into a link.

If you paste the URL for another page in your Confluence site, Confluence will display the link text as the page name and turn it into a relative link, meaning if the name of the page changes, Confluence will adjust the link so it doesn't break.

Topic Header using Heading 4

Add and Link to Anchors

The anchor macro allows you to create anchors in your documentation, which can be linked to or from anywhere. 

...

If you want to anchor or link, make sure you correctly anchor or  link to another page or to a specific line of the document. Add the anchor immediately above the corresponding section title and/or link to the correct word or section. 


...

Adding Images

Be sure when adding images that they are very clear, especially if they contain text, and try to only capture a close up of the important thing you are referencing.  You may need to overlay a few screenshots depending on what you are doing.  If you need help capturing what you need ask for assistance as a different capture tool may help immensely.

...

Then, be sure to click the "Original" button, and the "Border" button.  The Original button will ensure the image is sized as the original, which should have be large enough to read clearly.  If needed, you can adjust the size after that, but larger is okay if it helps clarity.  The border button will put a box around the image to help delineate it from the white background, which is really useful on some screen shots that also have a lot of white on the edge.


...

Useful macros

Use macros when needed to help draw attention to particular information. Here's a few:

Tip, Note, Info, Warning, and Panel Macros

Often when creating documentation, there are elements of a page that you want to highlight or draw the the viewers' attention to. Confluence ships with the Tip, Info, Warning, Note and Panel macros, which will help you focus a viewer's attention on a particular part of your content.

...

Here is a table you can use.

TermDescription 







...

In this section...

Page Tree
expandCollapseAlltrue
root@parent

...