diff --git a/template/bk_main.xml b/template/bk_main.xml index 86246d5..c44675b 100644 --- a/template/bk_main.xml +++ b/template/bk_main.xml @@ -54,7 +54,7 @@ OpenPOWER Foundation - Revision 1.1.0_pre2 + Revision 1.1.0_pre3 OpenPOWER @@ -105,7 +105,12 @@ Add optional font installation step to getting started. - Provide example usage of OPF Docbook extensions. + Provide samples of how to access symbols by value, including extension for + new symbol library. + + + Provide example usage of OPF Docbook extensions -- hard page breaks, soft line breaks, + font-size changes, setting text color, and explicitly using symbol library. Extend explanation of versioning policy. diff --git a/template/ch_example.xml b/template/ch_example.xml index f6552b2..2f81fb1 100644 --- a/template/ch_example.xml +++ b/template/ch_example.xml @@ -30,9 +30,20 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_template_examples"> Here is an example of an itemized list + A list title is completely optional Item you don't care about + + + Perhaps you'd like a sub-list + + + Oooh, here's about another + + + + @@ -49,6 +60,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_template_examples"> All good documents need ordered lists. + Another purely optional title First item @@ -126,10 +138,10 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_template_examples"> Yes - Red - Green - Blue - Custom (Amber) + Red + Green + Blue + Custom (Amber) MAIN_Junk @@ -215,10 +227,22 @@ main() 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. +
+ Example of special characters in text + Sometimes in text you need special characters. These can be provided using their UNICODE values such as ≠ (&#8800), + Ω (&#x2126), and ∆ (∆). + These can be "coded" using the form &#ddddd; where ddddd is + the up to five digit decimal representation of the character. The form &#xhhhh; where + hhhh is the up to 4 digit hexidecimal representation of the character. + This formatting works well as long as the symbol to which you are referring is contained in the font set + used for the document -- Arimo for standard text and Cousine for monospace. If when building a document, you see a message like + "WARNING, Glyph...not available in font 'Arimo'," + see in for details on using the provided symbol fonts explicitly. +
-
+
Examples of OpenPOWER Foundation Docbook extensions The OpenPOWER Foundation Maven Plugin supports a number of extensions that are not pure Docbook. These are: @@ -226,15 +250,19 @@ text. It ignores whitespace. Setting text color explicitly - Text color can be controlled using <phrase role="color"> tags. For example, this - text:A red sentence.]]> produces this sentence: - A red sentence. + Text color can be controlled using <phrase role="color:color_name"> + tag where color_name contains the color setting. For example, this + text:A red sentence contains a blue word.]]> produces this sentence: + A red sentence contains a blue word. 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. + rgb(n1, n2, n3) where n1, n2, and n3 are integers 0-255. + This tag has also been implemented on the following tags: <thead>, + <tbody>, and <tfoot>. + This parameter should only be used for tags listed above. @@ -248,14 +276,47 @@ text. It ignores whitespace. Inserting page breaks Page breaks can be introduced using <?hard-pagebreak?> tags. For example, this - text:A page break Between two paragraphs]]> produces this sentence: + text:A page break Between two paragraphs]]> produces this output: A page break Between two paragraphs This 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!. - + + + + Varying the font size + Font sizes can also be set using the + <phrase role="font-size:size"> + tag where size contains a size value such as "6pt" or "50%" or "1.5em". + For example, a paragraph can be made to be 6 point as follows:A sentence that contains some 6pt font, +50% font, and +1.5em font in it.]]> produces this output: + A sentence that contains some 6pt font, + 50% font, and 1.5em font in it. + This tag has also been implemented on the following tags: <para>, + <thead>, <tbody>, and <tfoot>. + This parameter should only be used for tags listed above. + + + + Using additional symbols + If you find that the Arimo and Cousine fonts do not contain the special symbol you need + for your document, you may use the additional symbol font provided for document (STIX Two Math). + Due to an unimplemented feature in the Apach FO Processor, selection of this + font needs to be explicitly performed using the + <symbol role="symbolfont"> wrapper around your symbol value. + + For example, the symbol coding of should produce + a circle with a cross in here "⨁", but instead creates a "Glyph...not available in font 'Arimo'" error + on document build and the PDF renders as a "#". + + Re-coding this to use ⨁]]> produces + the correct symbole here "⨁". + If this still does not provide the symbol you expected, double check the code and the font maps found at + http://www.stixfonts.org/charactertable.html. +