3. Tables
| Column 1, Line 1 | Column 2, Line 1 | Column 3, Line 1 |
|---|---|---|
Column 1, Line 2 |
Column 2, Line 2 |
Column 3, Line 2 |
Column 1, Line 2 |
Column 2, Line 3 |
Column 3, Line 3 |
| Column 1, Line 1 | Column 2, Line 1 | Column 3, Line 1 | Column 4, Line 1 |
|---|---|---|---|
Column 1, Line 2 |
Column 2, Line 2 |
Column 3, Line 2 |
Column 4, Line 2 |
Column 1, Line 2 |
Column 2, Line 3 |
Column 3, Line 3 |
Column 4, Line 3 |
4. Steps and lists
4.1. Steps
To write Steps for a process use "1::, 2::, 3::, x::" with "[horizontal]" attribute on top:
| 1 |
Step 1 |
| 2 |
Step 2 |
| 3 |
Step 3 |
5. Text formatting
5.2. Colors
To color some text, use the following syntax:
[color-name]#the text you want to color#For example:
-
this is a blue text
-
this is a green text with some italic
-
this is a red text with some bold
-
this is a purple text with bold and italic
-
this is a yellow text
-
and finally some fuchsia text
You can use any of the following colors:
-
white
-
silver
-
gray
-
black
-
red
-
maroon
-
yellow
-
olive
-
lime
-
green
-
aqua
-
teal
-
blue
-
navy
-
fuchsia
-
purple
5.3. Superscripts and Subscripts
Put ^carets on either^ side of the text to be superscripted, put ~tildes on either side~ of text to be subscripted. For example:
-
eπi +1 = 0
-
H2O
-
x10
-
Some supertext and subtext
6. Codeblocks
Plain codeblock, not used so much
Codeblock in a shell.Codeblock with java scriptCodeblock with xml script7. Callouts
Callout numbers (aka callouts) provide a means to add annotations to lines in a verbatim block.
Callout in shell codeblock. (1)| 1 | Some text. |
8. Images
Image inline with text.
The images should be stored in a folder images on the same level as the adoc file.
9. Admonitions
| Note about something |
| Tip for something |
| Important information about something |
| Caution |
| Warning regarding something |
Admonitions can also encapsulate any block content:
|
Feeding the Werewolves
While werewolves are hardy community members, keep in mind the following dietary concerns:
|
10. Internal cross-references
To create a link to a heading, just include the heading title in <<>>.
For details, see section <<Appendix>>.
It will be automatically resolved as link to the respective section.
To create a link anywhere in the document, just insert [[someID]] where you need to reference to, and <<someID,optionaltextshown>> where you want to place the link. Make sure the ID is unique and does not contain any special characters. The ID is also case-sensitive.
For example, this is a link to the colors list.
12. Include files
You can include content from another file into the current AsciiDoc document using the include directive. The included content can be AsciiDoc or it can be any other text format. Where that content is included in the document determines how it will be processed.
An include directive must be placed on a line by itself with the following syntax:
The leveloffset, lines, tag(s)`, indent, and opts attributes are optional, making the simplest case look like:
Unresolved directive in Product_Documentation_Template.adoc - include::content.adoc[]
- Offset Section Levels
-
The
leveloffsetattribute can help here by pushing all headings in the included document down by the specified number of levels. This allows you to publish each chapter as a standalone document (complete with a document title), but still be able to include the chapters into a primary document (which has its own document title).
= My Book
Unresolved directive in Product_Documentation_Template.adoc - include::chapter01.adoc[leveloffset=+1]
Unresolved directive in Product_Documentation_Template.adoc - include::chapter02.adoc[leveloffset=+1]
Unresolved directive in Product_Documentation_Template.adoc - include::chapter03.adoc[leveloffset=+1]