OpenPOWER Library

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 limited permissions granted above are perpetual and will not be revoked by OpenPOWER or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis AND TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE OpenPOWER Foundation AS WELL AS THE AUTHORS AND DEVELOPERS OF THIS STANDARDS FINAL DELIVERABLE OR OTHER DOCUMENT HEREBY DISCLAIM ALL OTHER WARRANTIES AND CONDITIONS, EITHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES, DUTIES OR CONDITIONS OF MERCHANTABILITY, OF FITNESS FOR A PARTICULAR PURPOSE, OF ACCURACY OR COMPLETENESS OF RESPONSES, OF RESULTS, OF WORKMANLIKE EFFORT, OF LACK OF VIRUSES, OF LACK OF NEGLIGENCE OR NON-INFRINGEMENT.

OpenPOWER, the OpenPOWER logo, and openpowerfoundation.org are trademarks or registered trademarks of OpenPOWER Foundation, Inc., registered in many jurisdictions worldwide. Other company, product, and service names may be trademarks or service marks of others.

Abstract

The purpose of this document is to provide a guide for OpenPOWER documentation writers. As such, it provides directions, policies, references, and examples of the XML Docbook environment. It is intended to be used both in final product form (PDF and html) as a document and in source form as a template for new documents.

This document is a Non-standard Track, Work Group Note work product owned by the System Software Workgroup and handled in compliance with the requirements outlined in the OpenPOWER Foundation Work Group (WG) Process document. It was created using the Document Development Guide version 1.1.0. Comments, questions, etc. can be submitted to the public mailing list for this document at . Additionally, the #doc-devel channel in the OpenPOWER Foundation Slack room (openpowerfoundation.slack.com) can be used to answer more interactive questions.


Contents

Preface
1. Conventions
2. Document change history
1. Document development overview
1.1. Getting started
1.1.1. Installing tools
1.1.2. Installing fonts
1.1.3. Creating accounts
1.1.4. Cloning master document information
1.1.5. Building the first document
1.2. Understanding the project structure
1.3. Creating a new document
1.3.1. Cloning a project
1.3.1.1. Cloning an existing project
1.3.1.2. Creating a new project locally
1.3.2. Finding a document framework
1.3.2.1. Moving the template document into your new document framework
1.3.2.2. Copying an existing document as a new document framework
1.3.2.3. Copying the Document Development Guide as a new document framework
1.3.3. Modifying core project files
1.3.4. Adding new content
1.4. Modifying an existing document
1.5. Debugging build failures
1.5.1. Project structure errors
1.5.2. Docbook validation errors
1.5.3. Build failures
1.5.4. FO validation failures
1.5.5. Java AWT exception
1.6. Publishing OpenPOWER Documents
1.6.1. Understanding document marking variables in the pom.xml file
1.6.2. Navigating the OpenPOWER Foundation documentation publishing process
1.6.3. Understanding the specific steps of Standard Work Product documents
1.6.4. Packaging the document for publish
1.7. Policies and conventions
1.8. Frequently asked questions
1.9. Common git commands
1.10. Finding more information
2. Documentation examples
2.1. Section Title goes here
2.1.1. Example Itemized List
2.1.2. Example ordered list
2.1.3. Example variable list
2.1.4. Example figure with embedded graphic
2.1.5. Example table
2.1.6. Example of crossreferences and footnotes
2.1.7. Example of code citations and user input
2.1.8. Example of special characters in text
2.1.9. Sample section include
2.1.10. Examples of OpenPOWER Foundation Docbook extensions
A. OpenPOWER Foundation overview
A.1. Foundation documentation
A.2. Technical resources
A.3. Contact the foundation
B. Appendix template
B.1. Section title

List of Tables

2.1. Example Table Title

loading table of contents...