Miscellaneous updates.
For Doc Devel Guide: - Clarify first build documentation - Add documententation how to publish - AWT exception workaround for users - Clarify which document tags need updating for new docs - Expand description of how to get started - Minor updates to reference to document directory from "template/" to "doc_dev_guide/" For project: - Add new document template (doc_template) for creating new specifications - Add new document template for create errata (WG Notes) - Rename the template/ directory to doc_devel_guide/ - Update README for new content and contact people Signed-off-by: Jeff Scheel <scheel@us.ibm.com>master
Jeff Scheel
6 years ago
parent
b74af890cf
commit
bea197bca4
|
Before Width: | Height: | Size: 648 KiB After Width: | Height: | Size: 648 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 55 KiB |
@ -0,0 +1,30 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
-->
|
||||||
|
<appendix xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
|
version="5.0"
|
||||||
|
xml:id="app_template">
|
||||||
|
<?dbhtml stop-chunking?>
|
||||||
|
<title>Appendix template</title>
|
||||||
|
<para>This is the first paragraph of a new appendix...</para>
|
||||||
|
<section xml:id="sample-app-section">
|
||||||
|
<title>Section title</title>
|
||||||
|
<para>Section text...</para>
|
||||||
|
</section>
|
||||||
|
</appendix>
|
||||||
@ -0,0 +1,109 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- The following entity variable is used to reflect the version of the
|
||||||
|
template document master used for building a document. This value
|
||||||
|
should be set by copy of the of template used to create a new
|
||||||
|
document and should not be changed. Use of this value is in
|
||||||
|
in the Abstract section in this file. -->
|
||||||
|
<!DOCTYPE book [
|
||||||
|
<!ENTITY template_version "1.0.0">
|
||||||
|
]>
|
||||||
|
|
||||||
|
<book xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
|
version="5.0"
|
||||||
|
xml:id="bk_main">
|
||||||
|
|
||||||
|
<!-- TODO: Pick a Title for the new document -->
|
||||||
|
<title>Title</title>
|
||||||
|
<!-- TODO: Either add a subtitle or remove the following line -->
|
||||||
|
<subtitle>Sub-title</subtitle>
|
||||||
|
|
||||||
|
<info>
|
||||||
|
<author>
|
||||||
|
<!-- TODO: Set the correct Work Group Name and email id for WG Chair -->
|
||||||
|
<personname>
|
||||||
|
TBD Work Group Name
|
||||||
|
</personname>
|
||||||
|
<email>tbd-chair@openpowerfoundation.org</email>
|
||||||
|
<affiliation>
|
||||||
|
<orgname>OpenPower Foundation</orgname>
|
||||||
|
</affiliation>
|
||||||
|
</author>
|
||||||
|
<copyright>
|
||||||
|
<year>2018</year>
|
||||||
|
<holder>OpenPOWER Foundation</holder>
|
||||||
|
</copyright>
|
||||||
|
<!-- TODO: Set the correct document releaseinfo -->
|
||||||
|
<releaseinfo>Revision 1.0_pre1</releaseinfo>
|
||||||
|
<productname>OpenPOWER</productname>
|
||||||
|
<pubdate/>
|
||||||
|
|
||||||
|
<legalnotice role="apache2">
|
||||||
|
<!--legalnotice role="opfExternal"-->
|
||||||
|
|
||||||
|
<annotation>
|
||||||
|
<remark>Copyright details are filled in by the template.</remark>
|
||||||
|
</annotation>
|
||||||
|
</legalnotice>
|
||||||
|
|
||||||
|
<!-- TODO: Update the following text with the correct document description (first paragraph),
|
||||||
|
Work Group name, and Work Product track (both in second paragraph). -->
|
||||||
|
<abstract>
|
||||||
|
<!-- TODO: remove "phrase" tags (2) and text below and insert proper information -->
|
||||||
|
<para>The purpose of this document is to <phrase role="color:red"><emphasis role="bold">...TBD describe the document</emphasis></phrase></para>
|
||||||
|
<para>This document is a Standard Track, Workgroup Specification work product owned by the
|
||||||
|
<phrase role="color:red"><emphasis role="bold">TBD Workgroup</emphasis></phrase> and handled in compliance with the requirements outlined in the
|
||||||
|
<citetitle>OpenPOWER Foundation Work Group (WG) Process</citetitle> document. It was
|
||||||
|
created using the <citetitle>Master Template Guide</citetitle> version &template_version;.
|
||||||
|
Comments, questions, etc. can be submitted to the
|
||||||
|
public mailing list for the parent specification at
|
||||||
|
<email>tbd@mailinglist.openpowerfoundation.org</email>.</para>
|
||||||
|
</abstract>
|
||||||
|
|
||||||
|
<revhistory>
|
||||||
|
<revision>
|
||||||
|
<!-- TODO: Set correct date and remove "phrase" tags (1) and text below and insert proper information -->
|
||||||
|
<date>2018-08-29</date>
|
||||||
|
<revdescription>
|
||||||
|
<itemizedlist spacing="compact">
|
||||||
|
<listitem>
|
||||||
|
<para><phrase role="color:red"><emphasis role="bold">TODO: Describe your initial draft, e.g. from where it came if not created from scratch</emphasis></phrase></para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</revdescription>
|
||||||
|
</revision>
|
||||||
|
</revhistory>
|
||||||
|
</info>
|
||||||
|
|
||||||
|
<!-- The ch_preface.xml file is required by all documents -->
|
||||||
|
<xi:include href="../../Docs-Master/common/ch_preface.xml"/>
|
||||||
|
|
||||||
|
<!-- TODO: Add your chapter heading files here. Remove both files and insert your own. -->
|
||||||
|
<!-- See the template document for naming conventions and location of files. -->
|
||||||
|
<xi:include href="ch_example.xml"/>
|
||||||
|
|
||||||
|
<!-- The app_foundation.xml appendix file is required by all documents. -->
|
||||||
|
<xi:include href="../../Docs-Master/common/app_foundation.xml"/>
|
||||||
|
|
||||||
|
<!-- TODO: The following template document may be modified to create additional appendices as needed. -->
|
||||||
|
<xi:include href="app_template.xml"/>
|
||||||
|
|
||||||
|
</book>
|
||||||
@ -0,0 +1,323 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
-->
|
||||||
|
<chapter version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_template_examples">
|
||||||
|
|
||||||
|
<!-- Chapter Title goes here. -->
|
||||||
|
<title>Documentation examples</title>
|
||||||
|
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<title>Section Title goes here</title>
|
||||||
|
<para>This Section covers something of interest to a limited number of people and shows a 1st level section</para>
|
||||||
|
|
||||||
|
<section xml:id="list_example_label">
|
||||||
|
<title>Example Itemized List</title>
|
||||||
|
<para>
|
||||||
|
Here is an example of an itemized list</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<title>A list title is completely optional</title>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Item you don't care about</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>Perhaps you'd like a sub-list</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>Oooh, here's about another</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Item you might care about </para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Item you do care about </para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Example ordered list</title>
|
||||||
|
<para>
|
||||||
|
All good documents need ordered lists.</para>
|
||||||
|
<orderedlist>
|
||||||
|
<title>Another purely optional title</title>
|
||||||
|
<listitem>
|
||||||
|
<para>First item</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Second item</para>
|
||||||
|
<orderedlist numeration="loweralpha">
|
||||||
|
<listitem>
|
||||||
|
<para>first indented item</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para> second indented item</para>
|
||||||
|
</listitem>
|
||||||
|
</orderedlist>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Third item</para>
|
||||||
|
</listitem>
|
||||||
|
</orderedlist>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<title>Example figure with embedded graphic</title>
|
||||||
|
<para>
|
||||||
|
Here is how you embed a graphic.</para>
|
||||||
|
<figure pgwide="1" xml:id="figure_label">
|
||||||
|
<title>Example figure</title>
|
||||||
|
<mediaobject>
|
||||||
|
<imageobject>
|
||||||
|
<imagedata fileref="figures/example_graphic.bmp" format="BMP" scalefit="1" width="100%" />
|
||||||
|
</imageobject>
|
||||||
|
</mediaobject>
|
||||||
|
</figure>
|
||||||
|
<note><para>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.</para></note>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<title>Example table</title>
|
||||||
|
<para>Of course all good documents need tables. Here's how you build a basic table.</para>
|
||||||
|
|
||||||
|
<table frame="all" pgwide="1" xml:id="table_label">
|
||||||
|
<title>Example Table Title</title>
|
||||||
|
<tgroup cols="4">
|
||||||
|
<colspec colname="c1" colwidth="25*" />
|
||||||
|
<colspec colname="c2" colwidth="25*" />
|
||||||
|
<colspec colname="c3" colwidth="25*" />
|
||||||
|
<colspec colname="c4" colwidth="25*" />
|
||||||
|
<thead>
|
||||||
|
<row>
|
||||||
|
<entry>
|
||||||
|
<para>
|
||||||
|
<emphasis role="bold">1st Column Heading</emphasis>
|
||||||
|
</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>
|
||||||
|
<emphasis role="bold">2nd Column Heading</emphasis>
|
||||||
|
</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>
|
||||||
|
<emphasis role="bold">3rd Column Heading</emphasis>
|
||||||
|
</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>
|
||||||
|
<emphasis role="bold">4th Column Heading</emphasis>
|
||||||
|
</para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<row>
|
||||||
|
<entry>
|
||||||
|
<para>Yes</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para><phrase role="color:red">Red</phrase></para>
|
||||||
|
<para><phrase role="color:green">Green</phrase></para>
|
||||||
|
<para><phrase role="color:blue">Blue</phrase></para>
|
||||||
|
<para><phrase role="color:#FFBF00">Custom (Amber)</phrase></para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>MAIN_Junk</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>More_Junk</para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
<row>
|
||||||
|
<entry namest='c1' nameend='c3' align='center'>
|
||||||
|
<para>merged cells horizontal</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>cell_stuff</para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
<row>
|
||||||
|
<entry morerows='1'>
|
||||||
|
<para>Merge cells vertical</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>filler</para>
|
||||||
|
</entry>
|
||||||
|
<entry namest='c3' nameend='c4' morerows='1' align='center'>
|
||||||
|
<para>merge cells both ways</para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
<row>
|
||||||
|
<entry>
|
||||||
|
<para>filler 2</para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
<row>
|
||||||
|
<entry>
|
||||||
|
<para>How about we put a list in the table cell</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>item 1</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>item 2</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>item 2</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>Another Cell</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>Yet Another Cell</para>
|
||||||
|
</entry>
|
||||||
|
<entry>
|
||||||
|
<para>Finally the last cell</para>
|
||||||
|
</entry>
|
||||||
|
</row>
|
||||||
|
</tbody>
|
||||||
|
</tgroup>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Example of crossreferences and footnotes</title>
|
||||||
|
<para>To reference another section or table is pretty easy. For example: see <xref linkend="table_label" /> for how tables look.</para>
|
||||||
|
<para>Lists are shown in <xref linkend="list_example_label" /> and if you need to make a footnote
|
||||||
|
<footnote xml:id="foot_id"><para>The footnote text goes here and can reference something like <xref linkend="figure_label" /> for additional explanation.</para></footnote>
|
||||||
|
For clarification that is easy. Of course you might want an additional reference to the footnote <footnoteref linkend="foot_id"/> which can also be done easily.</para>
|
||||||
|
<para>Lastly you probably want to mark text by making it <emphasis>italic text example</emphasis> or <emphasis role='bold'>Bold Text Example</emphasis>.</para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Example of code citations and user input</title>
|
||||||
|
<para>When 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:
|
||||||
|
<screen><prompt>$ </prompt><userinput>echo "Hello world"</userinput>
|
||||||
|
Hello world
|
||||||
|
<prompt>$ </prompt></screen>
|
||||||
|
</para>
|
||||||
|
<para>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:<programlisting linenumbering="numbered"><![CDATA[#include<stdio.h>
|
||||||
|
main()
|
||||||
|
{
|
||||||
|
printf("Hello world\n");
|
||||||
|
}]]></programlisting></para>
|
||||||
|
<para>If code formatting is not quite what you need, simply displaying text "literally" may suffice as follows: <literal>This is my literal
|
||||||
|
text. It ignores whitespace.</literal></para>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<title>Example of special characters in text</title>
|
||||||
|
<para>Sometimes in text you need special characters. These can be provided using their UNICODE values such as ≠ (&#8800),
|
||||||
|
Ω (&#x2126), and ∆ (&#8710;).
|
||||||
|
These can be "coded" using the form <literal>&#</literal><emphasis>ddddd</emphasis><literal>;</literal> where <emphasis>ddddd</emphasis> is
|
||||||
|
the up to five digit decimal representation of the character. The form <literal>&#x</literal><emphasis>hhhh</emphasis><literal>;</literal> where
|
||||||
|
<emphasis>hhhh</emphasis> is the up to 4 digit hexidecimal representation of the character.</para>
|
||||||
|
<para>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 <xref linkend="symbol_font" /> in <xref linkend="docbook_extensions" /> for details on using the provided symbol fonts explicitly.</para>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<xi:include href="sec_example.xml"/>
|
||||||
|
|
||||||
|
<section xml:id="docbook_extensions">
|
||||||
|
<title>Examples of OpenPOWER Foundation Docbook extensions</title>
|
||||||
|
|
||||||
|
<para>The OpenPOWER Foundation Maven Plugin supports a number of extensions that are not pure Docbook. These are:</para>
|
||||||
|
|
||||||
|
<simplesect>
|
||||||
|
<title>Setting text color explicitly</title>
|
||||||
|
|
||||||
|
<para>Text color can be controlled using <literal><phrase role="color:</literal><emphasis>color_name</emphasis><literal>"></literal>
|
||||||
|
tag where <emphasis>color_name</emphasis> contains the color setting. For example, this
|
||||||
|
text:<programlisting><![CDATA[<para role="color:red">A red sentence contains a <phrase role="color:blue">blue</phrase> word.</para>]]></programlisting> produces this sentence:</para>
|
||||||
|
<para role="color:red">A red sentence contains a <phrase role="color:blue">blue</phrase> word.</para>
|
||||||
|
<para>Valid colors include either a keyword color name or a numerical RGB specification. Keyword names are common with the HTML 4 specificiation:
|
||||||
|
<literal>aqua</literal>, <literal>black</literal>, <literal>blue</literal>, <literal>fuchsia</literal>, <literal>gray</literal>,
|
||||||
|
<literal>green</literal>, <literal>lime</literal>, <literal>maroon</literal>, <literal>navy</literal>, <literal>olive</literal>,
|
||||||
|
<literal>purple</literal>, <literal>red</literal>, <literal>silver</literal>, <literal>teal</literal>, <literal>white</literal>,
|
||||||
|
and <literal>yellow</literal>. Additionally, RGB values can be <literal>#nnnnnn</literal> where <literal>nnnnnn</literal> is a hexidecimal color value or
|
||||||
|
<literal>rgb(n1, n2, n3)</literal> where <literal>n1</literal>, <literal>n2</literal>, and <literal>n3</literal> are integers 0-255.</para>
|
||||||
|
<para>This tag has also been implemented on the following tags: <literal><thead></literal>,
|
||||||
|
<literal><tbody></literal>, and <literal><tfoot></literal>.</para>
|
||||||
|
<warning><para>This parameter should only be used for tags listed above.</para></warning>
|
||||||
|
</simplesect>
|
||||||
|
|
||||||
|
<simplesect>
|
||||||
|
<title>Inserting line breaks</title>
|
||||||
|
<para>Line breaks can be introduced using <literal><?linebreak?></literal> tags. For example, this
|
||||||
|
text:<programlisting><![CDATA[<para>A line break <?linebreak?> in the middle of text</para>]]></programlisting> produces this sentence:</para>
|
||||||
|
<para>A line break <?linebreak?> in the middle of text</para>
|
||||||
|
<para>This tag becomes useful in table text spacing.</para>
|
||||||
|
</simplesect>
|
||||||
|
|
||||||
|
<simplesect>
|
||||||
|
<title>Inserting page breaks</title>
|
||||||
|
<para>Page breaks can be introduced using <literal><?hard-pagebreak?></literal> tags. For example, this
|
||||||
|
text:<programlisting><![CDATA[<para>A page break</para> <?hard-pagebreak?> <para>Between two paragraphs</para>]]></programlisting> produces this output:</para>
|
||||||
|
<para>A page break</para> <?hard-pagebreak?> <para>Between two paragraphs</para>
|
||||||
|
<para>This tag becomes useful in placing tables on page. Placing this statement before a large table may prevent it from spanning a page.</para>
|
||||||
|
<warning><para>Because the XSL template behind the Processing Instruction generates
|
||||||
|
a <programlisting><![CDATA[<fo:block break-after='page'/>]]></programlisting> 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. <emphasis role="bold">User beware!</emphasis>.</para></warning>
|
||||||
|
</simplesect>
|
||||||
|
|
||||||
|
<simplesect>
|
||||||
|
<title>Varying the font size</title>
|
||||||
|
<para>Font sizes can also be set using the
|
||||||
|
<literal><phrase role="font-size:</literal><emphasis>size</emphasis><literal>"></literal>
|
||||||
|
tag where <emphasis>size</emphasis> contains a size value such as "6pt" or "50%" or "1.5em".</para>
|
||||||
|
<para>For example, a paragraph can be made to be 6 point as follows:<programlisting><![CDATA[<para>A sentence that contains some <phrase role="font-size:6pt">6pt font</phrase>,
|
||||||
|
<phrase role="font-size:50%">50% font</phrase>, and
|
||||||
|
<phrase role="font-size:1.5em">1.5em font</phrase> in it.</para>]]></programlisting> produces this output:</para>
|
||||||
|
<para>A sentence that contains some <phrase role="font-size:6pt">6pt font</phrase>,
|
||||||
|
<phrase role="font-size:50%">50% font</phrase>, and <phrase role="font-size:1.5em">1.5em font</phrase> in it.</para>
|
||||||
|
<para>This tag has also been implemented on the following tags: <literal><para></literal>,
|
||||||
|
<literal><thead></literal>, <literal><tbody></literal>, and <literal><tfoot></literal>.</para>
|
||||||
|
<warning><para>This parameter should only be used for tags listed above.</para></warning>
|
||||||
|
</simplesect>
|
||||||
|
|
||||||
|
<simplesect xml:id="symbol_font">
|
||||||
|
<title>Using additional symbols</title>
|
||||||
|
<para>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
|
||||||
|
<literal><symbol role="symbolfont"></literal> wrapper around your symbol value.</para>
|
||||||
|
|
||||||
|
<para>For example, the symbol coding of <programlisting><![CDATA[⨁]]></programlisting> 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 "#".</para>
|
||||||
|
|
||||||
|
<para>Re-coding this to use <programlisting><![CDATA[<symbol role="symbolfont">⨁</symbol>]]></programlisting> produces
|
||||||
|
the correct symbole here "<symbol role="symbolfont">⨁</symbol>".</para>
|
||||||
|
<para>If this still does not provide the symbol you expected, double check the code and the font maps found at
|
||||||
|
<link xlink:href="http://www.stixfonts.org/charactertable.html">http://www.stixfonts.org/charactertable.html</link>.</para>
|
||||||
|
</simplesect>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</chapter>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 648 KiB |
@ -0,0 +1,161 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
-->
|
||||||
|
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||||
|
<parent>
|
||||||
|
|
||||||
|
<groupId>org.openpowerfoundation.docs</groupId>
|
||||||
|
<artifactId>workgroup-pom</artifactId>
|
||||||
|
<version>1.0.0-SNAPSHOT</version>
|
||||||
|
<relativePath>../pom.xml</relativePath>
|
||||||
|
</parent>
|
||||||
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the artifactID field to some appropriate for your new document -->
|
||||||
|
<artifactId>todo-artifact_id</artifactId>
|
||||||
|
|
||||||
|
<packaging>jar</packaging>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the name field to some appropriate for your new document -->
|
||||||
|
<name>todo-name</name>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<!-- This is set by Jenkins according to the branch. -->
|
||||||
|
<release.path.name></release.path.name>
|
||||||
|
<comments.enabled>0</comments.enabled>
|
||||||
|
</properties>
|
||||||
|
<!-- ################################################ -->
|
||||||
|
<!-- USE "mvn clean generate-sources" to run this POM -->
|
||||||
|
<!-- ################################################ -->
|
||||||
|
<build>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
|
||||||
|
<groupId>org.openpowerfoundation.docs</groupId>
|
||||||
|
|
||||||
|
<artifactId>openpowerdocs-maven-plugin</artifactId>
|
||||||
|
<!-- version set in ../pom.xml -->
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>generate-webhelp</id>
|
||||||
|
<goals>
|
||||||
|
<goal>generate-webhelp</goal>
|
||||||
|
</goals>
|
||||||
|
<phase>generate-sources</phase>
|
||||||
|
<configuration>
|
||||||
|
<!-- These parameters only apply to webhelp -->
|
||||||
|
<enableDisqus>${comments.enabled}</enableDisqus>
|
||||||
|
<disqusShortname>openpower-template-guide</disqusShortname>
|
||||||
|
<enableGoogleAnalytics>1</enableGoogleAnalytics>
|
||||||
|
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
|
||||||
|
<generateToc>
|
||||||
|
appendix toc,title
|
||||||
|
article/appendix nop
|
||||||
|
article toc,title
|
||||||
|
book toc,title,figure,table,example,equation
|
||||||
|
book/appendix nop
|
||||||
|
book/chapter nop
|
||||||
|
chapter toc,title
|
||||||
|
chapter/section nop
|
||||||
|
section toc
|
||||||
|
part toc,title
|
||||||
|
reference toc,title
|
||||||
|
set toc,title
|
||||||
|
</generateToc>
|
||||||
|
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
|
||||||
|
<sectionAutolabel>1</sectionAutolabel>
|
||||||
|
<tocSectionDepth>1</tocSectionDepth>
|
||||||
|
<sectionLabelIncludesComponentLabel>1</sectionLabelIncludesComponentLabel>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the webhelpDirname field to the new directory for new document -->
|
||||||
|
<webhelpDirname>todo-builddir-name</webhelpDirname>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the pdfFilenameBase field to the PDF name for new document -->
|
||||||
|
<pdfFilenameBase>todo-pdfFile-name</pdfFilenameBase>
|
||||||
|
|
||||||
|
<!-- TODO: Define the appropriate work product type. These values are defined by the IPR Policy.
|
||||||
|
Consult with the Work Group Chair or a Technical Steering Committee member if you have
|
||||||
|
questions about which value to select.
|
||||||
|
|
||||||
|
If no value is provided below, the document will default to "Work Group Notes".-->
|
||||||
|
<!--workProduct>workgroupNotes</workProduct-->
|
||||||
|
<workProduct>workgroupSpecification</workProduct>
|
||||||
|
<!-- workProduct>candidateStandard</workProduct -->
|
||||||
|
<!-- workProduct>openpowerStandard</workProduct -->
|
||||||
|
|
||||||
|
<!-- TODO: Set the appropriate security policy for the document. For documents
|
||||||
|
which are not "public" this will affect the document title page and
|
||||||
|
create a vertical running ribbon on the internal margin of the
|
||||||
|
security status in all CAPS. Values and definitions are formally
|
||||||
|
defined by the IPR policy. A layman's definition follows:
|
||||||
|
|
||||||
|
public = this document may be shared outside the
|
||||||
|
foundation and thus this setting must be
|
||||||
|
used only when completely sure it allowed
|
||||||
|
foundationConfidential = this document may be shared freely with
|
||||||
|
OpenPOWER Foundation members but may not be
|
||||||
|
shared publicly
|
||||||
|
workgroupConfidential = this document may only be shared within the
|
||||||
|
work group and should not be shared with
|
||||||
|
other Foundation members or the public
|
||||||
|
|
||||||
|
The appropriate starting security for a new document is "workgroupConfidential". -->
|
||||||
|
<security>workgroupConfidential</security>
|
||||||
|
<!-- security>foundationConfidential</security -->
|
||||||
|
<!-- security>public</security -->
|
||||||
|
|
||||||
|
<!-- TODO: Set the appropriate work flow status for the document. For documents
|
||||||
|
which are not "published" this will affect the document title page
|
||||||
|
and create a vertical running ribbon on the internal margin of the
|
||||||
|
security status in all CAPS. Values and definitions are formally
|
||||||
|
defined by the IPR policy. A layman's definition follows:
|
||||||
|
|
||||||
|
published = this document has completed all reviews and has
|
||||||
|
been published
|
||||||
|
draft = this document is actively being updated and has
|
||||||
|
not yet been reviewed
|
||||||
|
review = this document is presently being reviewed
|
||||||
|
|
||||||
|
The appropriate starting security for a new document is "draft". -->
|
||||||
|
<documentStatus>draft</documentStatus>
|
||||||
|
<!-- documentStatus>review</documentStatus -->
|
||||||
|
<!-- documentStatus>published</documentStatus -->
|
||||||
|
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
<configuration>
|
||||||
|
<!-- These parameters apply to pdf and webhelp -->
|
||||||
|
<xincludeSupported>true</xincludeSupported>
|
||||||
|
<sourceDirectory>.</sourceDirectory>
|
||||||
|
<includes>
|
||||||
|
<!-- TODO: If you desire, you may change the following filename to something more appropriate for the new document -->
|
||||||
|
bk_main.xml
|
||||||
|
</includes>
|
||||||
|
|
||||||
|
<!-- **TODO: Set to the correct project URL. This likely needs input from the TSC. -->
|
||||||
|
<!-- canonicalUrlBase>http://openpowerfoundation.org/docs/template-guide/content</canonicalUrlBase -->
|
||||||
|
<glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
|
||||||
|
<includeCoverLogo>1</includeCoverLogo>
|
||||||
|
<coverUrl>www.openpowerfoundation.org</coverUrl>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
</project>
|
||||||
@ -0,0 +1,25 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
-->
|
||||||
|
<section version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_example">
|
||||||
|
|
||||||
|
<title>Sample section include </title>
|
||||||
|
<para>This section was developed in a separate file but included in the document by using the following
|
||||||
|
text:<programlisting><![CDATA[ <xi:include href="sec_example.xml"/>]]></programlisting>
|
||||||
|
where <literal>sec_example.xml</literal> is the source file name.</para>
|
||||||
|
|
||||||
|
</section>
|
||||||
@ -0,0 +1,117 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the GNU Free Documentation License, Version 1.3;
|
||||||
|
with no Invariants Sections, with no Front-Cover Texts,
|
||||||
|
and with no Back-Cover Texts (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.gnu.org/licenses/fdl-1.3.txt
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- The following entity variable is used to reflect the version of the
|
||||||
|
template document master used for building a document. This value
|
||||||
|
should be set by copy of the of template used to create a new
|
||||||
|
document and should not be changed. Use of this value is in
|
||||||
|
in the Abstract section in this file. -->
|
||||||
|
<!DOCTYPE book [
|
||||||
|
<!ENTITY template_version "1.1.0">
|
||||||
|
]>
|
||||||
|
|
||||||
|
<book xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
|
version="5.0"
|
||||||
|
xml:id="bk_main">
|
||||||
|
|
||||||
|
<!-- TODO: Replace the text between the brackets <...> (2) with the appropriate information about the base document -->
|
||||||
|
<title><TBD Base Document Name> Errata</title>
|
||||||
|
<subtitle>For <TBD Base Document Name and version></subtitle>
|
||||||
|
|
||||||
|
<info>
|
||||||
|
<author>
|
||||||
|
<!-- TODO: Set the correct Work Group Name and email id for WG Chair -->
|
||||||
|
<!-- **Note: these values should match the base document -->
|
||||||
|
<personname>
|
||||||
|
TBD Work Group Name
|
||||||
|
</personname>
|
||||||
|
<email>tbd-chair@openpowerfoundation.org</email>
|
||||||
|
<affiliation>
|
||||||
|
<orgname>OpenPower Foundation</orgname>
|
||||||
|
</affiliation>
|
||||||
|
</author>
|
||||||
|
<copyright>
|
||||||
|
<year>2018</year>
|
||||||
|
<holder>OpenPOWER Foundation</holder>
|
||||||
|
</copyright>
|
||||||
|
<releaseinfo>Revision 1.0</releaseinfo>
|
||||||
|
<productname>OpenPOWER</productname>
|
||||||
|
<pubdate/>
|
||||||
|
|
||||||
|
<!-- TODO: Select one of the two following legalnotice role= values:
|
||||||
|
"apache2" for an Apache V2 license or
|
||||||
|
"opfExternal" for an official OpenPOWER Foundation external license text.
|
||||||
|
If you don't know which one to select, change to "opfExternal" and ask your TSC representative. -->
|
||||||
|
<!-- **Note: these values should match the base document -->
|
||||||
|
<!-- legalnotice role="apache2" -->
|
||||||
|
<!-- legalnotice role="opfExternal" -->
|
||||||
|
<!-- legalnotice role="gnuFreeDoc"-->
|
||||||
|
<legalnotice role="apache2">
|
||||||
|
|
||||||
|
<annotation>
|
||||||
|
<remark>Copyright details are filled in by the template.</remark>
|
||||||
|
</annotation>
|
||||||
|
</legalnotice>
|
||||||
|
|
||||||
|
<abstract>
|
||||||
|
<!-- TODO: remove "phrase" tags (3) and text below and insert proper information -->
|
||||||
|
<para>This document provides errata against version
|
||||||
|
<phrase role="color:red"><emphasis role="bold">#.#.#</emphasis></phrase> of the
|
||||||
|
<citetitle><phrase role="color:red"><emphasis role="bold">Base Document Title</emphasis></phrase></citetitle>
|
||||||
|
specification. These errata should be considered part of said specification until such
|
||||||
|
time as a newer version of the full specification is published.</para>
|
||||||
|
<para>This document is a Non-standard Track, Work Group Note work
|
||||||
|
product owned by the
|
||||||
|
<phrase role="color:red"><emphasis role="bold">TBD Workgroup</emphasis></phrase>
|
||||||
|
and handled in compliance with the requirements outlined in the
|
||||||
|
<citetitle>OpenPOWER Foundation Work Group (WG) Process</citetitle> document. It was
|
||||||
|
created using the <citetitle>Master Template Guide</citetitle> version &template_version;.
|
||||||
|
Comments, questions, etc. can be submitted to the
|
||||||
|
public mailing list for the parent specification at
|
||||||
|
<!-- TODO: Set the mailing list email below -->
|
||||||
|
<!-- **Note: these values should match the base document -->
|
||||||
|
<email>tbd@mailinglist.openpowerfoundation.org</email>.</para>
|
||||||
|
</abstract>
|
||||||
|
|
||||||
|
<revhistory>
|
||||||
|
<revision>
|
||||||
|
<!-- TODO: Set correct date and remove "phrase" tags (1) and text below and insert proper information -->
|
||||||
|
<date>2018-08-29</date>
|
||||||
|
<revdescription>
|
||||||
|
<itemizedlist spacing="compact">
|
||||||
|
<listitem>
|
||||||
|
<para><phrase role="color:red"><emphasis role="bold">TODO: Describe your initial draft, e.g. from where it came if not created from scratch</emphasis></phrase></para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</revdescription>
|
||||||
|
</revision>
|
||||||
|
</revhistory>
|
||||||
|
</info>
|
||||||
|
|
||||||
|
<!-- The ch_preface.xml file is required by all documents -->
|
||||||
|
<xi:include href="../../Docs-Master/common/ch_preface.xml"/>
|
||||||
|
|
||||||
|
<!-- TODO: Add your chapter heading files here. Remove both files and insert your own. -->
|
||||||
|
<!-- See the template document for naming conventions and location of files. -->
|
||||||
|
<xi:include href="ch_errata.xml"/>
|
||||||
|
|
||||||
|
<!-- The app_foundation.xml appendix file is required by all documents. -->
|
||||||
|
<xi:include href="../../Docs-Master/common/app_foundation.xml"/>
|
||||||
|
|
||||||
|
<!-- TODO: The following template document may be modified to create additional appendices as needed. -->
|
||||||
|
<!-- xi:include href="app_template.xml"/ -->
|
||||||
|
|
||||||
|
</book>
|
||||||
@ -0,0 +1,78 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the GNU Free Documentation License, Version 1.3;
|
||||||
|
with no Invariants Sections, with no Front-Cover Texts,
|
||||||
|
and with no Back-Cover Texts (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.gnu.org/licenses/fdl-1.3.txt
|
||||||
|
|
||||||
|
-->
|
||||||
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en"
|
||||||
|
xml:id="dbdoclet.50655240_pgfId-1156194">
|
||||||
|
|
||||||
|
<title>Errata</title>
|
||||||
|
|
||||||
|
<!-- TODO: remove "phrase" tags (2) and text below and insert proper information -->
|
||||||
|
<para>The following statements in version
|
||||||
|
<phrase role="color:red"><emphasis role="bold">#.#.#</emphasis></phrase>
|
||||||
|
of the
|
||||||
|
<citetitle><phrase role="color:red"><emphasis role="bold">Base Document Title</emphasis></phrase></citetitle>
|
||||||
|
specification are incorrect, and should be considered corrected as specified.</para>
|
||||||
|
|
||||||
|
<!-- TODO: For each updated section in the referenced section, create a section of the following template -->
|
||||||
|
<section>
|
||||||
|
<!-- TODO: replace the <..> information with information from the base document -->
|
||||||
|
<title>Section <#.#>, <Section Name></title>
|
||||||
|
<para>
|
||||||
|
<emphasis role="underline">Problem</emphasis>:
|
||||||
|
<!-- TODO: Explain the problem in the section by removing the <phrase> tag and adding appropriate text -->
|
||||||
|
<phrase role="color:red">TBD: Describe the problem here. For example,
|
||||||
|
"Paragraph 2 contains a statement that makes use of undefined behavior according to the C standard."
|
||||||
|
Then, cite the offending text in the next paragraph block.</phrase>
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<!-- TODO: Quote the offending text. Again remove <phrase> tag and replace with appropriate text. -->
|
||||||
|
<blockquote>
|
||||||
|
<para>
|
||||||
|
<phrase role="color:red">
|
||||||
|
Regardless of the alignment rules for the allocation of data types,
|
||||||
|
pointers to both aligned and unaligned data of each data type shall
|
||||||
|
return the value corresponding to a data type starting at the specified
|
||||||
|
address when accessed with either the pointer dereference operator * or
|
||||||
|
the array reference operator [ ].
|
||||||
|
</phrase>
|
||||||
|
</para>
|
||||||
|
</blockquote>
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<!-- TODO: Describe the resolution. Remove <phrase> tag and replace with appropriate text-->
|
||||||
|
<emphasis role="underline">Resolution</emphasis>:
|
||||||
|
<phrase role="color:red">TBD: Describe resolution. For example,
|
||||||
|
"Paragraph 2 is stricken from the text." If needed, add a block quote of the
|
||||||
|
updated text like below.</phrase>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<!-- TODO: If needed, quote the new text, by removing <phrase> tag and replace with appropriate text.
|
||||||
|
If not needed, remove the outter <para> tag and all contained text. -->
|
||||||
|
<para>
|
||||||
|
<blockquote>
|
||||||
|
<para>
|
||||||
|
<phrase role="color:red">
|
||||||
|
C pointer types have an emperical and undefined behavior which applications
|
||||||
|
should simply tolerate. Therefore and regardless of the alignment rules for
|
||||||
|
the allocation of data types, pointers to both aligned and unaligned data of
|
||||||
|
each data type shall return the value corresponding to a data type starting at the specified
|
||||||
|
address when accessed with either the pointer dereference operator * or
|
||||||
|
the array reference operator [ ]. Anything that doesn't work is somebody else's
|
||||||
|
problem.
|
||||||
|
</phrase>
|
||||||
|
</para>
|
||||||
|
</blockquote>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</chapter>
|
||||||
@ -0,0 +1,159 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!--
|
||||||
|
Copyright (c) 2016 OpenPOWER Foundation
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
-->
|
||||||
|
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||||
|
<parent>
|
||||||
|
|
||||||
|
<groupId>org.openpowerfoundation.docs</groupId>
|
||||||
|
<artifactId>workgroup-pom</artifactId>
|
||||||
|
<version>1.0.0-SNAPSHOT</version>
|
||||||
|
<relativePath>../pom.xml</relativePath>
|
||||||
|
</parent>
|
||||||
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the artifactID field to some appropriate for your new document -->
|
||||||
|
<artifactId>todo-errata</artifactId>
|
||||||
|
|
||||||
|
<packaging>jar</packaging>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the name field to some appropriate for your new document -->
|
||||||
|
<name>todo-errata</name>
|
||||||
|
|
||||||
|
<properties>
|
||||||
|
<!-- This is set by Jenkins according to the branch. -->
|
||||||
|
<release.path.name></release.path.name>
|
||||||
|
<comments.enabled>0</comments.enabled>
|
||||||
|
</properties>
|
||||||
|
<!-- ################################################ -->
|
||||||
|
<!-- USE "mvn clean generate-sources" to run this POM -->
|
||||||
|
<!-- ################################################ -->
|
||||||
|
<build>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
|
||||||
|
<groupId>org.openpowerfoundation.docs</groupId>
|
||||||
|
|
||||||
|
<artifactId>openpowerdocs-maven-plugin</artifactId>
|
||||||
|
<!-- version set in ../pom.xml -->
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>generate-webhelp</id>
|
||||||
|
<goals>
|
||||||
|
<goal>generate-webhelp</goal>
|
||||||
|
</goals>
|
||||||
|
<phase>generate-sources</phase>
|
||||||
|
<configuration>
|
||||||
|
<!-- These parameters only apply to webhelp -->
|
||||||
|
<enableDisqus>${comments.enabled}</enableDisqus>
|
||||||
|
<disqusShortname>openpower-template-guide</disqusShortname>
|
||||||
|
<enableGoogleAnalytics>1</enableGoogleAnalytics>
|
||||||
|
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
|
||||||
|
<generateToc>
|
||||||
|
appendix toc,title
|
||||||
|
article/appendix nop
|
||||||
|
article toc,title
|
||||||
|
book toc,title,figure,table,example,equation
|
||||||
|
book/appendix nop
|
||||||
|
book/chapter nop
|
||||||
|
chapter toc,title
|
||||||
|
chapter/section nop
|
||||||
|
section toc
|
||||||
|
part toc,title
|
||||||
|
reference toc,title
|
||||||
|
set toc,title
|
||||||
|
</generateToc>
|
||||||
|
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
|
||||||
|
<sectionAutolabel>1</sectionAutolabel>
|
||||||
|
<tocSectionDepth>3</tocSectionDepth>
|
||||||
|
<sectionLabelIncludesComponentLabel>1</sectionLabelIncludesComponentLabel>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the webhelpDirname field to the new directory for new document -->
|
||||||
|
<webhelpDirname>todo-errata</webhelpDirname>
|
||||||
|
|
||||||
|
<!-- TODO: Rename the pdfFilenameBase field to the PDF name for new document -->
|
||||||
|
<pdfFilenameBase>todo-pdfFile-errata</pdfFilenameBase>
|
||||||
|
|
||||||
|
<!-- TODO: Define the appropriate work product type. These values are defined by the IPR Policy.
|
||||||
|
Consult with the Work Group Chair or a Technical Steering Committee member if you have
|
||||||
|
questions about which value to select.
|
||||||
|
|
||||||
|
If no value is provided below, the document will default to "Work Group Notes".-->
|
||||||
|
<workProduct>workgroupNotes</workProduct>
|
||||||
|
<!-- workProduct>workgroupSpecification</workProduct -->
|
||||||
|
<!-- workProduct>candidateStandard</workProduct -->
|
||||||
|
<!-- workProduct>openpowerStandard</workProduct -->
|
||||||
|
|
||||||
|
<!-- TODO: Set the appropriate security policy for the document. For documents
|
||||||
|
which are not "public" this will affect the document title page and
|
||||||
|
create a vertical running ribbon on the internal margin of the
|
||||||
|
security status in all CAPS. Values and definitions are formally
|
||||||
|
defined by the IPR policy. A layman's definition follows:
|
||||||
|
|
||||||
|
public = this document may be shared outside the
|
||||||
|
foundation and thus this setting must be
|
||||||
|
used only when completely sure it allowed
|
||||||
|
foundationConfidential = this document may be shared freely with
|
||||||
|
OpenPOWER Foundation members but may not be
|
||||||
|
shared publicly
|
||||||
|
workgroupConfidential = this document may only be shared within the
|
||||||
|
work group and should not be shared with
|
||||||
|
other Foundation members or the public
|
||||||
|
|
||||||
|
The appropriate starting security for a new document is "workgroupConfidential". -->
|
||||||
|
<security>workgroupConfidential</security>
|
||||||
|
<!-- security>foundationConfidential</security -->
|
||||||
|
<!-- security>public</security-->
|
||||||
|
|
||||||
|
<!-- TODO: Set the appropriate work flow status for the document. For documents
|
||||||
|
which are not "published" this will affect the document title page
|
||||||
|
and create a vertical running ribbon on the internal margin of the
|
||||||
|
security status in all CAPS. Values and definitions are formally
|
||||||
|
defined by the IPR policy. A layman's definition follows:
|
||||||
|
|
||||||
|
published = this document has completed all reviews and has
|
||||||
|
been published
|
||||||
|
draft = this document is actively being updated and has
|
||||||
|
not yet been reviewed
|
||||||
|
review = this document is presently being reviewed
|
||||||
|
|
||||||
|
The appropriate starting security for a new document is "draft". -->
|
||||||
|
<documentStatus>draft</documentStatus>
|
||||||
|
<!-- documentStatus>review</documentStatus -->
|
||||||
|
<!-- documentStatus>published</documentStatus -->
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
<configuration>
|
||||||
|
<!-- These parameters apply to pdf and webhelp -->
|
||||||
|
<xincludeSupported>true</xincludeSupported>
|
||||||
|
<sourceDirectory>.</sourceDirectory>
|
||||||
|
<includes>
|
||||||
|
bk_main.xml
|
||||||
|
</includes>
|
||||||
|
|
||||||
|
<!-- **TODO: Set to the correct project URL. This likely needs input from the TSC. -->
|
||||||
|
<!-- canonicalUrlBase>http://openpowerfoundation.org/docs/template-guide/content</canonicalUrlBase -->
|
||||||
|
<glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
|
||||||
|
<includeCoverLogo>1</includeCoverLogo>
|
||||||
|
<coverUrl>www.openpowerfoundation.org</coverUrl>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
</project>
|
||||||
Binary file not shown.
Loading…
Reference in New Issue