|
Formatting text in comments and in the Content area of op docs can be done
by use of special markers in the text and / or use of HTML. Typically the
special markers are much simpler to use and will provide most of the
functionality needed for writing instructional documents. The simple
formatting markers provide an easy way to:
- Bold text
- Italicize text
- Underline text
- Strike text
- Create multi-level section headings
- Create tables
- Created multi-level numbered lists
- Created multi-level bulleted lists
- Create web links
Each of these operations has a quick and easy short cut as described in more detail in the subsections below.
In-Line Items
These can be used anywhere in the text to achieve the desired effect.
|
Effect |
How to achieve the effect
|
|
Bold
|
Surround the text to be bolded with the * (asterisk), as in *word
or phrase to bold*.
If you wish to bold the first phrase of a paragraph, you must place a space before the first
asterisk or it will be interpreted as a numbered list (see below).
|
|
Italic
|
Surround the text to be italicized with the ^, as in ^word or
phrase to italicize^.
|
|
Underline
|
Surround the text be underlined with the _, as in _word or phrase
to underline_.
|
|
Strike Through
|
Surround the text to be stricken with the -, as in -word or phrase
to strike-.
|
If you need to actually use an asterks, underscore, dash, carot, etc. you can do so by placing
two directly adjacent to each other with no space, as in this is an asterisk. When it is displayed,
only one asterisk will be displayed.
Block Items
These must be used as the first character(s) on a new line (there must be a
blank line above these to start a new table, heading, list, etc.).
|
Effect
|
How to achieve the effect
|
|
Tables
|
Use the vertical bar "|" to separate table cells. As in
| row 1, cell 1 | row 1, cell 2 | row 1, cell 3 |
| row 2, cell 1 | row 2, cell 2 | row 2, cell 3 |
Note: You may not use the bar "|" within a table other than
as a cell divider. Additionally, you may not nest tables (put tables within tables),
without using HTML.
By default, table cell contents are center-aligned. To left align a cell, use
"|<" instead of just a "|". To right align a cell, use "|>" instead of
just "|". For example, the table created from the following text would have
three cells, the first would be left aligned, the second right aligned and the
third center aligned: "|< Left Stuff |> Right Stuff | Centered Stuff |".
|
|
Headings
|
Use a @ as the first character of a new line followed by a space
for a top level heading, a @@ as the first characters of a new line
followed by a space for a second level heading, etc.
|
|
Bullets
|
Use a * as the first character of a new line followed by a space for a top level bullet, a ** as the first characters of a new line followed by a space for a second level bullet, etc.
|
|
Numbered List
|
Use a # as the first character of a new line followed by a space
for a top level number, a ## as the first characters of a new line
followed by a space for a second level numbering, etc.
|
|
Op Doc Link
|
Use the "Insert Op Doc Link" button below the editor area. Alternatively you can
use the following [!DOC <num>, <title>] as in [!DOC 12, The title that I want shown].
|
|
Web Link
|
Use the following [!WEB <address>, <title>] as in
[!WEB https://ambitionality.com, Ambitionality Website].
|
|
Exhibit Link
|
Use the "Insert Exhibit Link" button below the editor area. This will
allow you to upload a file and it will create a piece of text in the
form [!EXH <filename>, <title>] in the content area, as in [!EXH somefile.jpg, My File Title].
|
|
