About This Guide #

Target Audience
Available Documentation
Feedback
Documentation Conventions
About the Making of This Document

DAPS (DocBook Authoring and Publishing Suite) helps technical writers to author and publish documentation written in DocBook XML. DAPS is a command line based software for Linux* and released as open source.

1 Target Audience #

This document is intended for users who want to make efficient use of DocBook XML for editing and publishing their documentation—be it documentation sets, individual books, or articles. Key knowledge of XML and DocBook and of using the Bash Shell (or command line interfaces in general) is required.

2 Available Documentation #

This guide contains links to additional documentation resources. The following manuals are available for DAPS:

Quick Start: The DAPS Quick Start is a short introduction to DAPS for technical writers. It includes step-by-step instructions for key editing and publishing tasks.
User Guide: The DAPS User Guide is a comprehensive guide for technical writers using DAPS. It guides you through creating, editing, managing and publishing your documents—be it a short article by a single author or a large documentation project written by multiple authors.

3 Feedback #

We want to hear your comments and suggestions about DocBook Authoring and Publishing Suite (including this guide and the other documentation included with DAPS). You can contact us on the #opensuse-doc IRC channel on irc.freenode.net or in the discussion forum at https://github.com/openSUSE/daps/discussions. For bugs or enhancement requests, open an issue at https://github.com/openSUSE/daps/issues/new. A user account at https://github.com is needed.

Patches and user contributions are welcome!

4 Documentation Conventions #

The following typographical conventions are used in this manual:

/etc/passwd: directory names and file names
placeholder: replace placeholder with the actual value
PATH: the environment variable PATH
ls, --help: commands, options, and parameters
user: users or groups
Alt, Alt–F1: a key to press or a key combination; keys are shown in uppercase as on a keyboard
File, File › Save As: menu items, buttons
Dancing Penguins (Chapter Penguins, ↑Another Manual): This is a reference to a chapter in another manual.

5 About the Making of This Document #

This documentation is written in DocBook (see http://www.docbook.org) and generated by DAPS.

Print this page