DAPS

NAME

daps-init - A command to set up a DAPS documentation directory.

SYNOPSIS

daps-init {--docdir PATH_TO_DOC_DIR} [OPTIONS]

DESCRIPTION

daps-init is used to create a DAPS documentation project from scratch. It automatically sets up the key files and directory structure needed and creates an example DocBook 4 or 5 document which can be used to explore DAPS' functionality.

Specifying the project directory with --docdir is mandatory, all other options are optional. Specifying a name for the document with --name is recommended—it will be used in filenames. Setting the title of the document with --title is also recommended.

OPTIONS

--docdir DIR

Path to the project directory under which the DAPS environment will be set up. If the directory does not exists, it will be created. Mandatory.

--dapsroot DIR

Specify the path to the directory where daps-init can find the template files (directory init-templates/). This is only necessary if you have installed DAPS in a custom directory. Default: /usr/share/daps

--date YYYY-MM-DD

Specify a date in the format YYYY-MM-DD. Will be used to set the publication date of the document. (<date/> in the document's info section). Default: Current date (<?dbtimestamp format=\"B d, Y\"?>)

--docbook4

Create a document in DocBook 4 format (default).

--docbook5

Create a document in DocBook 5 format.

--name NAME

String that will be used in filenames (e.g. when generating PDF or HTML output). Only use letters, digits, dashes and underscores [A-Za-z0-9-_]. Default: daps-example

--productname "PRODUCT"

Specify a name for the product the document describes. Will be used in the subtitle of the document (<productname/> in the document's info section).

--productnumber "PRODUCT_VERSION"

Specify a version for the product the document describes. Will be used in the subtitle of the document (<productnumber/> in the document's info section). Requires --productname.

--rootelement article|book

DocBook root element of the example document. Currently supported are "book" and "article" (default).

--title "TITLE"

Title of the document. Default: "DAPS Example"

SEE ALSO

https://opensuse.github.io/daps/

DAPS project homepage

AUTHOR

Frank Sundermeyer <fsundermeyer@opensuse.org>

Developer