Documentation examplesSection Title goes hereThis Section covers something of interest to a limited number of people and shows a 1st level sectionExample Itemized List
Here is an example of an itemized list
Item you don't care about
Item you might care about
Item you do care about Example ordered list
All good documents need ordered lists.First itemSecond itemfirst indented item second indented itemThird itemExample figure with embedded graphic
Here is how you embed a graphic.Raw images such as the bitmap (bmp) file above may become blurry as they are scaled.
Scalable graphic formats like SVG (Scalable Vector Graphics) embed and scale the best.Example tableOf course all good documents need tables. Here's how you build a basic table.
Example Table Title1st Column Heading2nd Column Heading3rd Column Heading4th Column HeadingYesRedGreenBlueCustom (Amber)MAIN_JunkMore_Junkmerged cells horizontalcell_stuffMerge cells verticalfillermerge cells both waysfiller 2How about we put a list in the table cellitem 1item 2item 2Another CellYet Another CellFinally the last cell
Example of crossreferences and footnotesTo reference another section or table is pretty easy. For example: see for how tables look.Lists are shown in and if you need to make a footnote
The footnote text goes here and can reference something like for additional explanation.
For clarification that is easy. Of course you might want an additional reference to the footnote which can also be done easily.Lastly you probably want to mark text by making it italic text example or Bold Text Example.Example of code citations and user inputWhen showing user input, you want a nice sceen-looking layout, a prompt, monospace text, and a way to differentiate input from output. Here's an example:
$ echo "Hello world"
Hello world
$ Docbook also allows for formatting and display of common languages, allowing for whitespace
and line returns just as they are written. Here's a sample snippet of C code with line numbering enabled:
main()
{
printf("Hello world\n");
}]]>If code formatting is not quite what you need, simply displaying text "literally" may suffice as follows: This is my literal
text. It ignores whitespace.Examples of OpenPOWER Foundation Docbook extensionsThe OpenPOWER Foundation Maven Plugin supports a number of extensions that are not pure Docbook. These are:Setting text color explicitlyText color can be controlled using <phrase role="color"> tags. For example, this
text:A red sentence.]]> produces this sentence:
A red sentence.Valid colors include either a keyword color name or a numerical RGB specification. Keyword names are common with the HTML 4 specificiation:
aqua, black, blue, fuchsia, gray,
green, lime, maroon, navy, olive,
purple, red, silver, teal, white,
and yellow. Additionally, RGB values can be #nnnnnn where nnnnnn is a hexidecimal color value or
rgb(n1, n2, n3) where n1, n2, and n3 are intergers 0-255.Inserting line breaksLine breaks can be introduced using <?linebreak?> tags. For example, this
text:A line break in the middle of text]]> produces this sentence:
A line break in the middle of textThis tag becomes useful in table text spacing.Inserting page breaksPage breaks can be introduced using <?hard-pagebreak?> tags. For example, this
text:A page breakBetween two paragraphs]]> produces this sentence:
A page breakBetween two paragraphsThis tag becomes useful in placing tables on page. Placing this statement before a large table may prevent it from spanning a page.Because the XSL template behind the Processing Instruction generates
a ]]> in
the book FO output, this instruction should be used in the outer most blocks of a section to work effectively. Use inside lists and other structural
components may result in the text after the break being dropped. User beware!.