On this page:  |
|
|
Auto-generating a table of contents for page content
It is important to make it easy for viewers to jump to the section of a Confluence page that they are most interested in. The Table of Contents macro helps people navigate lengthy pages by summarising the content structure and providing links to headings used on the page.
- You document the Release Notes for the latest version of your product in a Confluence page.
- Each feature in the release is a heading on the page.
- You can generate a list of hyperlinks to each of the features in the release notes by inserting the Table of Contents macro:
 - The image below shows the Table of Contents macro inserted at the top of the 'Release Notes' page. Note that we have excluded the 'Highlights of Confluence 4.0' heading from the table of contents by modifying the macro's parameters.
 - The image below shows the macro parameters specified in the macro browser. Note the 'Minimum Heading Level' and 'Maximum Heading Level' parameters.
|
Return to top of page
Drawing attention to elements of a page
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 following macros that help you focus a viewer's attention to a note, information, tip or warning.
Note macroデータ | 例 |
|---|
The Note macro allows you to highlight a note on a Confluence page.
It creates a yellow coloured box surrounding your text, as shown to the right. See Note Macro for more examples and instructions. | This document is a draft and is under development. |
|
Info macroデータ | 例 |
|---|
The Info macro allows you to highlight helpful information on a Confluence page.
It creates a blue coloured box surrounding your text, as shown to the right. See Info Macro for more examples and instructions. | Confluence is the best wiki ever. |
|
Tip macroデータ | 例 |
|---|
The Tip macro allows you to highlight a helpful tip on a Confluence page.
It creates a green coloured box surrounding your text, as shown to the right. See Tip Macro for more examples and instructions. | |
Warning macroデータ | 例 |
|---|
The Warning macro allows you to highlight a warning note on a Confluence page.
It creates a red coloured box surrounding your text, as shown to the right. See Warning Macro for more examples and instructions. | This page is a draft in progress and visible to Atlassian staff only. |
|
|
Return to top of page
Putting content inside customisable Panels
Using the Panel macro, you can place content inside a customisable coloured panel. This is particularly useful when you want to clearly separate elements on a page.
- You are documenting a procedure which involves a number of steps.
- You want to call out the steps of the procedure from the rest of the page by placing it inside a coloured box, or panel.
- You can create a coloured panel using the Panel macro.
- The image below shows the parameters set for the panel using the macro browser.
|
Return to top of page
Inserting anchor links on pages
Anchor links can be especially useful when navigating between sections of a long document or when you want to link to a segment of a page from another page. The Anchor macro allows you to link to specific parts of a page.
Return to top of page
Structuring content using sections and columns
Sometimes it is necessary to structure content into sections and columns. The details are in Working with Page Layouts and Columns and Sections.
- Page layouts allow you to add sections to your page and then apply pre-defined column layouts to each section (for example, 2 column, three column). You can add multiple sections to a page.
- The Section and Column macros allow more flexibility. You can set the width of the columns, and put the sections and columns in any part of the page. Each section can contain any number of columns, created using the Column macro.
- Columns can either have a fixed width, specified in pixels, or a dynamic width, specified as a percentage of the page width.
- Note: whether you are using page layouts or macros, a column is always created inside a section.
Return to top of page
Making your documentation more engaging by embedding videos
Pictures can be worth a thousand words. The same can be said for videos. Often, it's easy to explain a concept or demonstrate a procedure using a video. The Widget macro allows you to embed web content, including YouTube and Vimeo videos, in a Confluence page.
Return to top of page
次のステップ
Take a look at Confluence Add-ons for Technical Documentation.
