Op Doc Wizard

For a quick introduction to the text editing features of the Op Doc Wizard, see our "How can I format text" FAQ. This tutorial will go over using these formatting features in more detail.

The content of op docs can be formatted using simple formatting symbols or advanced HTML. The simple formatting system provides a quick and easy way to perform the majority of tasks required in writing instructional documents without knowing HTML. It is recommended to use this system instead of HTML when possible, since other users of the system may not be familiar with HTML and may therefore be unable to revise HTML marked up op docs in the future. Since HTML editing is a broad topic that is covered extensively on the Internet, we will not discuss it here. Instead this tutorial will focus on the simple text editor markup.

Simple formatting is broken into three categories: line formatting, character formatting, and substitutions.

• Line formatting is used to change the way an entire line or set of lines is displayed.
  • Headings
  • Bulleted Lists
  • Numbered Lists
  • Tables
• Character formatting is used to change the way a sequence of characters appears.
  • Bold text
  • Italicized text
  • Underlined text
  • Stricken text
• Substitutions are special sequences that are replaced with a special feature automatically. Substitutions include:
  • Web Links
  • Op Doc Links
  • Exhibit Links

Creating Headings

A section heading may be created by using or more '@' characters at the beginning of a line, followed by a space and then the text of the heading. For example:

Will produce:

There must be a blank line above and below the heading line or it may not display correctly.

Creating Bullet Lists

You may create single and multi-level bulleted lists by using one or more '*' characters at the beginning of a line, followed by a space and then the text to be bulleted. For example:

* first level item 1
* first level item 2
** second level item 1
** second level item 2
* first level item 3

Would produce:

There may NOT be blank lines in between bullet lines of the same list. Placing a blank line between bullet lines will start a new bullet list.

Creating Numbered Lists

You may create single and multi-level numbered lists by using one or more '#' characters at the beginning of a line, followed by a space and then the text to be numbered. For example:

# Item 1
# Item 2
## Item 2.a
## Item 2.b
# Item 3

Would produce:

There may NOT be blank lines in between lines of the same numbered list. Placing a blank line between list lines will start a new numbered list.

Creating Tables

You may create tables by separating "cell" contents with a bar '|' (or '|<' or '|>') character. Using the '|' character by itself creates a cell with its contents centered. Using a '|<' sequence creates a cell with its contents left aligned. Using a '|>' sequence creates a cell with its contents right aligned. For example:

| Row 1, Column 1 Here  is some stuff | Row 1, Column 2 Here is some more stuff | Row 1, Column 3 And some other stuff here |
|< Row 2, Column 1 (Left Aligned) |> Row 2, Column 2 (Right Aligned) | Row 2, Column 3 |
| Row 3, Column 1 | Row 3, Column 2 | Row 3, Column 3 |

Would produce:

There may NOT be blank lines in between lines of the same table. Placing a blank line between table will start a new table. Also note that the '|' (or '|<' or '|>') must be separated from the cell contents by a space.

Bolding Text

Text can be bolded by surrounding a word or phrase with the '*' symbol. For example:

*a bold phrase* regular text, then a *bold phrase* , normal words, and a *bold* word

Would produce:

Note: the opening '*' symbol (the one on the left of the phrase or word) may NOT have a space directly after it and the closing '*' symbol (the one on the right of the phrase or word) may NOT have a space directly before it. Also, to produce a regular '*' without it creating a bold effect, just use '**' and it will display as a single '*' without bolding anything.

Italicizing Text

Text can be italicized in exactly the same manner as text is bolded except that rather than using the '*' symbol, the '^' is used. See bolding text.

Underlining Text

Text can be underlined in exactly the same manner as text is bolded except that rather than using the '*' symbol, the '_' is used. See bolding text.

Striking Text

Text can be stricken in exactly the same manner as text is bolded except that rather than using the '*' symbol, the '-' is used. See bolding text.

Web Links

A web link (hyper link to a web site) may be created by using the special sequence [!WEB <address>, <title>], where <address> is the actual website address and <title> is the text to be shown for the link. When a user clicks on the resulting web link, a new browser window or tab will open and load the specified address. For example:

See the [!WEB https://ambitionality.com/, Ambitionality Website] for more details.

Would produce:

Op Doc Links

An op doc link (hyper link to a specific op doc) may be created by using the special sequence [!DOC <op doc number>, <title>], where <op doc number> is the number of the op doc to link and <title> is the text to be shown for the link. When a user clicks on the resulting op doc link, the op doc will be loaded in the same browser window. For example:

See [!DOC 12, Greeting Clients] for more details.

Would produce:

Exhibit Links

An exhibit link (hyper link to an uploaded exhibit) may be created by using the special sequence [!EHX <exhibit file name>, <title>], where <exhibit file name> is the name of the file (as it was named when it was uploaded) to link and <title> is the text to be shown for the link. When a user clicks on the resulting exhibit link, the exhibit will be loaded in a new browser window. The preferred way to create exhibit links is to use the "Insert Exhibit" link located just beneath the Content area of the op doc edit screen. For example:

See the [!EXH abc.jpg, Process Flow Chart] for more details.

Would produce: