Document toolboxDocument toolbox

(v1) Get the most out of your documentation space

Owned by John McKeever
Apr 18, 2024
4 min read

Get the most out of your documentation space

Labels are key words that you can add to pages and attachments to make them easier to group and find. For example, you could add the recruiting label to all pages related to finding and hiring new talent. That would allow you to easily see, display, and search for related pages.

Anyone with permission to edit a page can add labels to it. You can add labels to a page while youre editing it or after its published, when youre viewing the page.

You can also insert a list of different labels to make it easy for people to find important pages. Choose from:

  • Popular labels: a list of the most popular labels in your space

  • Labels list: list all labels in your space in alphabetical order

  • Content by label: list all pages tagged with a specific label

When editing, type ' / ' to find and add each list of dynamic content

Take your Confluence space to the next level

Extend the capabilities of your Confluence pages by adding extra functionality or including dynamic content.

To add functionality:

  1. Type ' / ' to open the list of items available to use

  2. Find the item to be inserted and select it

  3. Select Insert

 

Useful elements for Documentation space

Livesearch

Add the Livesearch to a page to provide a fully customizable search field. When someone starts typing into the search field, Confluence will suggest matching pages, blogs, or comments.

To add Livesearch:

  1. When editing, type ' / '

  2. Find the item to be inserted and select it

  3. Select Insert

To edit Livesearch:

  1. Select the element placeholder. The floating toolbar appears.

  2. Select Edit. The right panel opens.

  3. Modify the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

 

 

 

 

 

 

 

Recently updated content

Add Recently updated content to a page to show a list of pages, blogs, files, and comments that have been created or edited recently. 

To add the Recently updated content:

  1. When editing, type ' / '

  2. Find the item to be inserted and select it

  3. Select Insert

To edit the Recently Updated parameters:

  1. Select the element placeholder. The floating toolbar appears.

  2. Select Edit. The right panel opens.

  3. Modify the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

Excerpt and Excerpt include

Add Excerpt to a page to define a snippet of content to be re-used on another page.

This is great single sourcing important information. For example you could provide the contact details and dates from each project page on a summary page. When the info is updated in the excerpt, it will flow through to all the other places it is used.

  1. In the Confluence editor, select View more

  2. Find the Excerpt element and select it. The placeholder is added and the right panel opens.

  3. Give it a name so you can reference it on another page using the Excerpt Include element. If you don't give the element a name, you will only be able to include the content from the first Excerpt on this page.

  4. Select the Hide Excerpted Content check box if you want the content to be hidden when this page is published.

  5. Add your content inside the Excerpt placeholder in the page. Most of the formatting options can be used, and elements in the toolbar can be inserted.

You can also type  /  into the page to bring up the same list you'd see by selecting from the toolbar.

To add the Excerpt Include to a page:

  1. When editing, type ' / '

  2. Find the item to be inserted and select it

  3. Select Insert

 

 

 

 

 

 

© 2015-2024 Data Migrators Pty Ltd.