Create technical training documentation

Owned by Praveena Manohar
Last updated: Sept 04, 2023
3 min read

Scenario

Create training documentation by adding formulas and referring to formulas that you have already mentioned using LaTeX Math features. Also, create a unit for your examples in the documentation.

Steps

The following steps demonstrate how to create and reuse the content using the LaTeX Math Block, LaTeX Math Block Reference, and LaTeX Unit macro features:

 

Step 1

As a Confluence user:

  1. Navigate to the documentation page and click edit.

  2. Go to the content where you need to insert the formula.

  3. Type ‘/' and search for the LaTeX Math Block macro or use the '+’ option in the main toolbar and search for the LaTeX Math Block macro.

  4. Select the LaTeX Math Block macro.

  5. Type the equation in LaTeX formatted math. A preview is generated.

  6. Specify an anchor. By specifying the anchor you can refer to the equation on a different page(s) or the same page.

  7. Click Insert.

Specify the right names for each anchor created across the page so that you can reference them on a different page or the same page.

 

Step 2

Add the LaTeX Math Block Reference macros to refer to the formula on the different page(s) or the same page:

  1. Navigate to where you want to refer to the formula.

  2. Type ‘/' and search for the LaTeX Math Block Reference macro or use the '+’ option in the editor’s main toolbar and search for the LaTeX Math Block Reference macro.

  3. Select the LaTeX Math Block Reference macro.

  4. Specify the anchor of the equation that you mentioned earlier in step one.
    NOTE You must remember the anchor of the equation. Make sure you mention the relevant anchor name so you can remember easily to refer to them whenever required.

  5. Type and select the Confluence page. The reference is automatically generated.

 

Step 3

Follow steps one and two. Create and link the formulas in as many locations as you want.

 

 

Step 4

Add the LaTeX Unit macros to create a perfect unit for the examples in the documentation.

  1. Navigate to the location where you want to create the unit.

  2. Type ‘/' and search for the LaTeX Unit macro or use the '+’ option in the editor’s main toolbar and search for the LaTeX Unit.

  3. Select the LaTeX Unit.

  4. Type the unit in LaTeX formatted math. A preview is generated.

  5. Click Insert.

 

 

Step 5

  1. Follow step three. Create unit references where ever required.

  2. Once all of the formulas have been added, Update the page to ensure that all of the formulas are displayed.