Docmenta Tutorial and Reference

Introduction and Reference to the Single Source Publishing System

www.docmenta.org
Produced with Docmenta Publishing System V1.9 © 2017
Version 1.9
2017-05-12

Table of Contents

1. Tutorial
1.1. Installation and basic concepts
1.1.1. Products
1.1.2. Versions
1.1.3. Publications
1.1.4. Output Configurations
1.1.5. Translation Mode
1.2. Creating a new product
1.3. Creating content and styles
1.3.1. Sections, paragraphs and predefined styles
1.3.2. Lists
1.3.3. Tables
1.3.4. Images
1.3.5. User-defined styles
1.4. Linking content
1.4.1. Referencing sections
1.4.2. Referencing images and tables
1.4.3. External links
1.4.4. Referencing files
1.5. Tracking the completion status
1.6. Versions and revisions
1.7. Translating content
1.8. Exporting publications
1.8.1. Publications
1.8.2. Output configurations
1.8.3. Export an HTML publication
1.8.4. Export a PDF publication
1.8.5. Export a translated publication
1.9. Templates
1.9.1. Static Templates
1.9.2. Dynamic Templates
1.10. Filtering content
1.10.1. Node filtering
1.10.2. Node variants
1.11. Inclusions
1.11.1. Structural inclusions
1.11.2. Inline inclusions
1.12. Managing user accounts
1.13. Advanced Tasks
1.13.1. Styling the title-page
1.13.2. Creating a cover-page
1.13.3. Adapting the PDF page design
1.13.3.1. Setting the page margins
1.13.3.2. Styling the chapter header
1.13.3.3. Defining the header/footer content
1.13.3.4. Styling the header and footer
1.13.4. Gentext settings
1.13.5. Inter-publication links
1.13.6. Creating index entries
1.13.7. Creating footnotes
1.13.8. Labeled blocks
1.13.9. Formatting of listings
1.13.10. Syntax highlighting
1.13.11. Creating HTML preview images
1.13.12. Customizing the Web-Help design
1.13.13. Creating a new Web-Help layout
1.13.14. Export, import and migration
1.13.15. Integration with other systems
1.13.16. Creating a plug-in
2. User Manual
2.1. Installation
2.1.1. Requirements
2.1.2. Download
2.1.3. Package installation
2.1.3.1. Installing the war package
2.1.3.2. Installing the Docmenta+Tomcat zip package
2.1.3.3. Installing the Windows installer package
2.1.3.4. Upgrading
2.1.4. Setup
2.2. Main window
2.3. Content workspace
2.3.1. Product-tree
2.3.2. Root folders
2.3.3. Node types
2.3.3.1. Section-nodes
2.3.3.2. Content-nodes
2.3.3.3. Image-files
2.3.3.4. Data-file
2.3.3.5. Inclusion-nodes
2.3.3.6. Image-folder
2.3.3.7. File-folder
2.3.4. Context menu
2.3.4.1. Inserting and editing nodes
2.3.4.2. Cut, copy, paste and delete
2.3.4.3. Preview PDF
2.3.4.4. File upload and download
2.3.4.5. Revision history
2.3.4.6. Searching and replacing text
2.3.4.7. Finding nodes
2.3.4.8. Consistency-Check
2.3.5. Translating nodes
2.3.6. Gentext configuration
2.3.7. Toolbar
2.3.8. Editing content
2.3.8.1. Basic editing
2.3.8.2. Applying styles
2.3.8.3. Aligning paragraphs
2.3.8.4. Indenting paragraphs
2.3.8.5. Lists
2.3.8.6. Tables
2.3.8.7. Images
2.3.8.8. Links
2.3.8.9. Quick-Links
2.3.8.10. Anchors
2.3.8.11. Special characters
2.3.8.12. Templates
2.3.8.13. Editing the HTML source
2.3.8.14. Controlling page breaks
2.4. Styles workspace
2.4.1. Inline- and block styles
2.4.2. Pre-defined styles
2.4.3. Creating a user-defined style
2.4.4. Editing styles
2.4.5. Deleting styles
2.4.6. Using style variants
2.4.7. Creating a style variant
2.4.8. Exporting styles
2.4.9. Importing styles
2.5. Versioning workspace
2.5.1. Versioning concept
2.5.2. Creating a new version
2.5.3. Releasing a version
2.5.4. Unreleasing a version
2.5.5. Renaming a version
2.5.6. Deleting a version
2.5.7. Clear revisions
2.5.8. Show connected users
2.6. Publishing workspace
2.6.1. Publication configuration
2.6.1.1. Creating a publication configuration
2.6.1.2. Editing a publication configuration
2.6.1.3. Deleting a publication configuration
2.6.1.4. Copying a publication configuration
2.6.2. Output configuration
2.6.2.1. Editing an output configuration
2.6.2.2. Creating an output configuration
2.6.2.3. Deleting an output configuration
2.6.2.4. Copying an output configuration
2.6.3. Publication export
2.6.3.1. Starting a new export
2.6.3.2. The export queue
2.6.3.3. Editing an export
2.6.3.4. Deleting an export
2.6.4. Applicability configuration
2.7. Administration workspace
2.7.1. Managing products
2.7.1.1. Storage types
2.7.1.2. Creating a new product
2.7.1.3. Adding a product
2.7.1.4. Editing a product
2.7.1.5. Deleting a product
2.7.1.6. Copying a product
2.7.1.7. Disabling and enabling products
2.7.2. Managing users
2.7.2.1. Creating new users
2.7.2.2. Editing the user profile
2.7.2.3. Deleting users
2.7.3. Managing user groups
2.7.3.1. User groups
2.7.3.2. Access rights
2.7.3.3. Members
2.7.4. Defining character entities
2.7.5. Installing Plug-ins
2.7.6. Rule configuration
2.7.6.1. Pre-defined rules
2.7.6.2. Editing the rule configuration
2.7.6.3. Adding new rules
2.7.7. Auto-Format class registration
2.7.8. Application settings
2.8. Auto-Format Class Reference
2.8.1. org.docma.plugin.examples.ApplyTemplate
2.8.2. org.docma.plugin.examples.FormatLines
2.8.3. org.docma.plugin.examples.RegExpHighlight
2.8.4. org.docma.plugin.examples.XSLTAutoFormat
3. XHTML Reference
3.1. Introduction
3.2. General Rules
3.3. Paragraphs and Blocks
3.4. Links
3.4.1. Referencing Sections and Content Nodes
3.4.2. Referencing Figures, Tables and other Content
3.4.3. Referencing Files
3.4.4. Referencing Internet Resources
3.4.5. Link Text Replacement
3.5. Inline Formatting
3.6. Images and Figures
3.6.1. Inline Images
3.6.2. Figures
3.7. Lists
3.8. Tables
3.9. Footnotes
3.10. Index Terms
3.11. Controlling Page Breaks
3.11.1. Avoiding Page Breaks within Blocks
3.11.2. Inserting Page Breaks
3.11.2.1. Hard Page Breaks
3.11.2.2. Conditional Page Breaks
3.12. Non-supported Elements
4. Plug-in Developer Guide
4.1. Introduction
4.2. Creating a plug-in package
4.3. Plug-in API
4.3.1. Lifecycle methods
4.3.2. Adding menu items
4.3.3. Adding a dialog
4.3.3.1. Plain JavaScript Dialogs
4.3.3.2. ZK Dialogs
4.3.4. Adding a tab
4.3.5. JSP integration
4.3.6. Accessing content
4.4. Editor and viewer plug-ins
4.4.1. Content Handlers
4.4.2. Viewer Plug-ins
4.4.2.1. initialize
4.4.2.2. getApplicationId
4.4.2.3. getApplicationName
4.4.2.4. getSupportedViewExtensions
4.4.2.5. getSupportedEditExtensions
4.4.2.6. getPreviewURL
4.4.2.7. openViewer
4.4.2.8. openEditor
4.4.2.9. setCharEntities
4.4.2.10. The complete viewer class
4.4.2.11. The view.jsp page
4.4.2.12. Creating the viewer plug-in
4.4.2.13. Installing the viewer plug-in
4.4.3. Editor Plug-ins
4.4.3.1. getSupportedEditExtensions
4.4.3.2. openEditor
4.4.3.3. The complete editor class
4.4.3.4. The edit.jsp page
4.4.3.5. Creating the editor plug-in
4.5. Rule plug-ins
4.5.1. getShortInfo
4.5.2. getLongInfo
4.5.3. getCheckIds
4.5.4. getCheckTitle
4.5.5. supportsAutoCorrection
4.5.6. getDefaultLogLevel
4.5.7. configure
4.5.8. startBatch
4.5.9. finishBatch
4.5.10. apply
4.5.11. The complete example
4.5.12. Creating the Rule Plug-in
4.6. AutoFormat plug-ins
4.6.1. AutoFormat Transformations
4.6.2. AutoFormat Example
4.6.3. Creating an AutoFormat Plug-in
4.7. Output plug-ins
4.8. PDF stylesheet customization
4.8.1. Customizing the transformation to DocBook
4.8.2. Customizing the DocBook stylesheets
4.8.3. Creating the stylesheet plug-in