Writerside Help

Paragraphs

In semantic markup use the <p> tag to create paragraphs. In Markdown, use one or more lines of consecutive text with one or more blank lines between them. Do not indent paragraphs in Markdown with spaces or tabs — indented text is treated like a code block.

Paragraphs are implicitly added inside blocks (tips, notes, warnings, table cells, list items, procedure steps, etc.). If you want to have more than just one paragraph, wrap fragments of text with <p> tags.

<p id="unique-id"> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. </p> <p> Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. </p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. {id="unique-id"} Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

The p element has the following attributes:

id

Specify a unique identifier to use as a link anchor and generate a meaningful URL for this paragraph. You can reference and reuse any element that has an ID.

filter

Define a set of custom filters for conditionally including this paragraph.

instance

Define a set of instances for conditionally filtering this paragraph.

switcher-key

Make this paragraph switchable depending on the selected key.

In Writerside you can format the text elements by indicating the text style (format) or meaning (control, ui-path, path, shortcut).

control

Use the control tag to refer to UI elements such as buttons, dialogs, checkboxes, and so on.

Markup

Result

<p> If the Welcome screen opens, click <control> Check out from Version Control </control>, then select <control>Git</control>. </p>

If the Welcome screen opens, click Check out from Version Control, then select Git.

emphasis

Use the emphasis tag when introducing new terms or to draw the user's attention to some words or phrases.

Markup

Result

<p> A Writerside <emphasis>project</emphasis> consists of a set of documentation topics and configuration files that define the project and preview settings, glossaries, and the documentation structure. </p>

A Writerside project consists of a set of documentation topics and configuration files that define the project and preview settings, glossaries, and the documentation structure.

ui-path

Use the ui-path tag to specify a path to a menu option.

Markup

Result

Go to <ui-path>Settings/Preferences | Tools | Writerside</ui-path>.

Go to Settings/Preferences | Tools | Writerside.

path

Use the path tag for paths to directories and files on your computer or file extensions.

Markup

Result

The list of categories is stored in the <path>c.list</path> file within the module directory.

The list of categories is stored in the c.list file within the module directory.

The TOC is stored in the product's <path>.tree</path> file.

The TOC is stored in the product's .tree file.

shortcut

Use the <shortcut> tag to specify a keyboard shortcut, either directly or by referencing it from a keymap file.

Press <shortcut>Ctrl+C</shortcut> to copy.

Press Ctrl+C to copy.

Press <shortcut key="$Copy"/> to copy.

Press Ctrl+C to copy.

For more information, see Tutorial: Reference shortcuts from keymap file.

format

Use a format tag to specify the text's visual appearance, like style or color.

It has the following attributes:

style=[bold, italic, strikethrough, underline, superscript, subscript]

Specify the text style.

color

Specify the text color name — start typing the color name and select the suitable one from the list.

Markup

Result

<format style="bold" color="RosyBrown">Hello, world!</format>

Hello, world!

<format style="subscript" color="Red">Hello, world!</format>

Hello, world!

Last modified: 20 November 2023