Typographical conventions

When writing lab manuals, follow the recommended typographical conventions:

  • Boldface indicates selectable GUI control, including buttons, checkboxes, icons, list items, menus, sliders, and tabs.

Example: Select File > Save As.

Example: Select the Configuration tab.

  • A code block with text in a monospace font indicates command names, command options, parameters, and other text that you enter in a command line. 

    To add a code block, select >_  in the left pane (editing toolbar), 

Example:  

1. Extract the files from the agent bundle.

tar -zxvf Omnissa-horizonagent-linux-x86_64-2503-8.15.0-14301895253.tar.gz  

  • Monospace font indicates user entry text.

    To style text in monospace font, select the user entry text, right-click the text, and select Code Run in the context menu.

Example: In the Name text box, enter Employee Owned.

You can also apply Code Run to short commands that appear inline. For example, "Run the - list command."

Avoid using color (blue, green) as a typographical convention.

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.