JBoss.orgCommunity Documentation

JBoss Documentation Guide

The canonical reference for JBoss developers and writers

PressGang Logo


Preface
1. License
2. Document Conventions
2.1. Typographic Conventions
2.2. Pull-quote Conventions
2.3. Notes and Warnings
3. Your feedback is vital
4. Acknowledgements
1. Introduction
2. eXtensible Markup Language
2.1. Advantages
2.2. Role in JBoss Middleware
2.3. XML References
3. Authoring Tools
3.1. Syntext Serna
3.2. oXygen XML Editor
3.3. XML Copy Editor
3.4. Project Documentation Editor
4. Publishing Tools
4.1. Maven jDocBook
4.2. Publican
5. JDocBook and Publican Interoperability
5.1. Introduction
5.2. Prerequisites
5.2.1. Install Maven
5.2.2. Install Publican
5.3. Create Book Repository
5.4. Build with Publican
5.5. Build with jDocBook
5.5.1. DTD or XSD Validation
5.5.2. Change Author_Group.xml Structure
5.5.3. xi:include Fallbacks
5.5.4. Insert .ent Parameter Entities
5.5.5. Configure pom.xml
5.5.6. Publish with jDocBook
5.5.7. Begin Authoring
5.5.8. Troubleshooting
6. Structure Guidelines
6.1. Disallowed Elements and Attributes
6.1.1. Disallowed elements
6.1.2. Disallowed attributes
6.2. Entities
6.3. Chapters and Sections
6.4. Lists
6.5. Procedures
6.6. Tables
6.7. Emphasis (Bold, Italic, Underline)
6.8. Graphics and Screenshots
6.9. Admonitions (Warning, Important, Note)
6.9.1. Default Titles
6.9.2. Custom Titles
6.10. Special Characters (Symbols)
6.11. Applications and Utilities
6.12. Menus, Buttons, and Labels
6.13. Code Examples
6.14. Links and References
7. Language Guidelines
7.1. Write Concisely
7.2. Dictionary
7.3. Active Voice
7.4. Tense
7.5. Gender References
7.6. Sentence Structure
A. pom.xml Multi-Profile
B. Sample Project
B.1. Default Directory Structure
B.2. Book Components
B.3. Customizing Book Structure
C. Revision History