Elements & Features
Text Formatting
Text is input into the XML editor in an identical manner to other documentation applications, such as Word, Google Sheets etc. Any text input into the editor is subject to the formatting defined in the stylesheet associated to the topic.
Search Engine Optimization will always use a styles ranking from h1 to h3 to prioritize search results.
Blocks of text are selected by clicking onto the 'tag' at the left edge of the editor, providing the left structure bar is activated, shown below.
Changes made to a style in the associated stylesheet will result in updates to all instances of the style in the documentation.
Below are the most frequent styles formatted into the topic's associated stylesheet :
h1
This is the style generally referred to as the banner headline of the page. It is larger in content, with significant spacing below for the next line.
h2
This is the style which headlines the main articles within the topic. This is typically the item which is referenced in the associated table of contents to which the topic is linked.
h3
This is a sub-heading style which is used to headline sub-articles within the topic.
h4 and h5
This is the style used to annotate images or tables inserted into the editor. h4 is a centre-aligned text and h5 is a left-aligned text.
p
This is the text body of the article
Text formats are changed by left-clicking into the text to change then navigating to Home > Style and selecting the new style from the dropdown list.
Bullets and Numbering
All text in the editor can be indented by the use of bullets or numbering. To do this, select a row or a block of text, then navigate to Home > Bullet List found in the navigational ribbon. Custom lists can be created if required. Below is a sample of square-bulleted text.
-
sample 1 of square-bullet indents
-
sample 2 of square-bullet indents
-
sample 3 of square-bullet indents
-
sample 4 of square-bullet indents
Numbering
All text rows and blocks of paragraph text can be numbered using the method described above. The following rules apply to both bullets and numbering.
Adding Numbering
Select the row or block of text then navigate to Home > Numbered List found in the navigational ribbon.
-
sample 1 of square-bullet indents
-
sample 2 of square-bullet indents
-
sample 3 of square-bullet indents
-
sample 4 of square-bullet indents
To create sub-numbering, select the numbered text row and use the Home > Numbered List > Indent tool. An example is shown below.
-
sample 1 of square-bullet indents
-
sample 2 of square-bullet indents
-
sample 2-1 of square-bullet indents
-
sample 2-2 of square-bullet indents
-
-
sample 3 of square-bullet indents
-
sample 4 of square-bullet indents
To remove a number from a list, left-click into the row, then navigate to Home > Numbered List > Outdent.
To continue a numbering sequence after non-numbered text or images has been inserted, re-number the text, then right click on the <ol> tag in the left structure bar and select Continue Sequence from the context menu.
See Also