Versions Compared

Key

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

...

This article demonstrates useful macros for the Knowledge Base and explains best practices for using their functionality.

Info

Info

For information on how to find and insert these macros, see What are Macros?

...

  1. Create your new page.

  2. Select the "+" in the toolbar. 

  3. Select the macro you want to use from the drop-down menu. Alternatively, you can select View More at the bottom of the menu to see the full suite of macros. 

  4. Once you are in the suite of macros, you can browse through the different categories on the left or use the Search bar at the top.

...

The Tip macro is used when providing information that will enhance the reader's abilities. 

Tip
Tip

When creating macros, title the macro for what it is (e.g., title a tip macro "Tip"). This will help the reader understand the purpose of the information.

...

The Info macro is used when providing information that may be of interest to the reader but that is not necessary to understand. 

Info
Info

Confluence allows article writers to easily move the macros around the page by clicking and dragging.

...

The Note macro is used when providing information that is necessary for users to understand. 

...

Macros should only be used when providing information that should be represented separately from the rest of the article content. Avoid using macros to provide information that would easily fit in the regular content of your article.

...

The Warning macro is used when you need to alert your readers to an exceedingly important detail. Warning macros are for cautionary messages and should be used only when the information being conveyed is urgent. 

Warning
Note

Make sure you are working on the "IT Knowledge Base" space.

...

The Error macro is used when providing the reader with critical information pertaining to the article. The information usually consists of consequences or a way to tell the readers something that could go wrong.

Error
Warning

If you click the Trash icon when editing helpful macros, then the macro will be deleted.

...

(plus) Tip: you can change an already inserted bar using Left-Click.

...

 The "Content by Label" Macro

...

  1. Scroll to the bottom of the page.

  2. Click on the area you wish to insert the macro.

  3. Click on the “+Icon icon and type “Content by Label” into the Search bar.

It should then bring you to an Edit Menu that looks like this:

...

  1. Sort By: You can sort how the labels relate to other articles, it can be by the title, by their creation date (newest to oldest), or the most recently modified version of the article.

  2. Maximum Number of Pages: You can set how many pages the “Content by Label” macro is, with the default being 15.

  3. List Title: This allows you to add a title to the macro.

  4. Excerpt Display: This changes how the excerpts are displayed for each page. You can use:

    1. None: Only shows the links to each article.

    2. Simple: Adds specific labels underneath each article.

    3. Rich: Makes the macro much more detailed, adding notes and information about each link.

...

Warning
Note

Be careful with typos, as they will not be autocorrected once they have been input as a label.

...

The Expand macro is a great way to condense and categorize your content. If you have lists, bullet points, or section-specific information that you do not want to clutter your article, you can condense this into a clickable link that will display your content. For example, click the blue text below. 

...

Once the Expand macro is inserted into your article, you can begin typing your text, inserting photos, charts, visuals, or creating lists. 

Warning
Warning

Although it was available in the previous version of Confluence, you cannot add an expand macro within another expand macro.

...

The Table of Contents macro chooses the links to display solely based on the headings and heading numbers. You only have to set - up the table of contents macro to choose the correct headings (see below). 

...

  1. You can change "Maximum Heading Level" to as many headers as you need. This ensures that the table of contents will only contain links to sections according to the amount number of headings within your article.

  2. Under "Exclude Headings," type Table of Contents. This will ensure that there will not a be a link to the Table of Contents in the Table of Contents. 

...

For a complete list of Confluence macros and other time-savings saving tips, see Confluence Macros and Confluence Keyboard Shortcuts.

...

Filter by label (Content by label)
showLabelsfalse
max10
showSpacefalse
cqllabel in ( "macros" , "macro" , "insert" , "confluence" ) and space = "IKB"
Page Properties
hiddentrue