###########################
# DAPS configuration file #
###########################
#
# Copyright (C) 2012-2020 SUSE Software Solutions Germany GmbH
#
# Author:
# Frank Sundermeyer <fsundermeyer at opensuse dot org>
#

#------------------------------------------------------------
# Syntax
# The following works:
#
# KEY=VALUE
# KEY = VALUE
# KEY = VALUE # comment

# KEY = "VALUE1 VALUE2"
# KEY = 'VALUE1 VALUE2'
# KEY = 'VALUE1 VALUE2' #comment
#
# The following rules apply:
#
# * escape-character will be removed: \# becomes #
#   ** if you need escapes, use \\\: \\\# becomes \#
#      Example: "c:\\\windows\\\foo" becomes c:\windows\foo 
#
# * When not quoting values, leading spaces will be cut
# * Each KEY/Value pair should to be on a single line
#   ** using \ for continuation works; leading spaces on the second line
#      are not cut
#
# * comments on the same line will be cut
# * comment characters (#) in values are not supported !!!
#   ** the value will be cut at the first occurrence of #
#   ** \\\# is supported and will be transferred to \#
#
# Concatenating values:
#
# It is possible to add additional VALUES to an already existing
# KEY with the "+=" notation. This is e. g. useful to increase
# readability when VALUE is rather log:
#
# XSLTPARAM = '--stringparam "foo=bar"'
# XSLTPARAM += '--stringparam "baz=foo"
#
# The same rules as for regular KEY/VALUE pairs apply
#


#------------------------------------------------------------
# Customizing:
#
# Override any setting below in
# $HOME/.config/daps/dapsrc (also see section "Syntax" above)
# or on the command line
#------------------------------------------------------------
#
# The environment is set up using the following hierarchy
# (command line always wins)
#
# 1. Command line
# 2. DC-file
# 3. $HOME/.config/daps/.dapsrc (user config file)
# 4. $DAPSROOT/etc/config

## Key: ADOC_FAILURE_LEVEL
## -----------------------
## Description: AsciiDoctor error level on which DAPS will exit
##              when processing adoc files
## Type:        String
## VALUE:       FATAL|ERROR|WARN|INFO (empty value not allowed)
## Default:     WARN
#
# By default, AsciiDoctor only returns != 0 on FATAL errors. However, when
# converting to DocBook, errors of the level WARN usually prevent from
# generating valid DocBook. Therefore DAPS sets the failure level to WARN and
# therefore exits on AsciiDoctor error levels FATAL, ERROR, and WARN.
#
# It is recommended to keep the default. If required, override it in a DC-file
#
ADOC_FAILURE_LEVEL="WARN"

## Key: ADOC_IMG_DIR
## --------------------
## Description: Directory hosting images for the AsciiDoc documents
## Type:        absolute path
## Default:     ""
#
# If set, DAPS will automatically generate the image structure
# required for XML processing. The directory needs to host all
# images on a flat level; subdirectories will be ignored
#
# Set this value in a DC-file or on the command-line with
# --adocimgdir
#
ADOC_IMG_DIR=""

## Key: ADOC_POST
## --------------------
## Description: Do post-processing on AsciiDoctor-generated XML?
## Type:        yesno
## Default:     "no"
#
# If set to "yes", the DocBook XML asciidoctor produces
# will be processed again by a stylesheet defined with ADOC_POST_STYLE
# Only valid for AsciiDoc sources
#
# See also: ADOC_POST_STYLE
#
# Set this value in a DC-file
#
ADOC_POST="no"

## Key: ADOC_POST_STYLE
## --------------------
## Description: Path to the stylesheet for post-processing the DocBook
## XML AsciiDoctor produces
## Type:        path to stylesheet
## Default:     "@pkgdatadir@/daps-xslt/asciidoc/postprocess.xsl"
#
# This stylesheet will be applied to the DocBook file produced from adoc
# by asciidoctor (build/.adoc/*.xml). The result will be written
# to build/.profiled/noprofile/ and be used for further processing. Use
# this if you need to change the DocBook file. Make sure it produces
# valid DocBook.
# The stylesheet will only be applied if you set ADOC_POST to "yes"
#
# By default, this value is set to a stylesheet DAPS ships. It only does
# minimal changes. It is suggested to keep the  system-wide value and to
# only overwrite this in a DC-file or in ~/.config/dapsrc
#
# See also: ADOC_POST
#
ADOC_POST_STYLE="@pkgdatadir@/daps-xslt/asciidoc/postprocess.xsl"

## Key: ADOC_SET
## --------------------
## Description: Convert multipart AsciiDoc book into set?
## Type:        yesno
## Default:     "no"
#
# If set to "yes", the DocBook XML asciidoctor produces
# will be processed again by a stylesheet defined with ADOC_SET_STYLE
# and turned into a DocBook set. This requires an AsciiDoc multipart book.
# Only valid for AsciiDoc sources
#
# See also: ADOC_SET_STYLE
#
# Set this value in a DC-file
ADOC_SET="no"

## Key: ADOC_SET_STYLE
## --------------------
## Description: Path to the stylesheet that creates a DocBook set from
## an AsciiDoc multipart book
## Type:        path to stylesheet
## Default:     "@pkgdatadir@/daps-xslt/asciidoc/setify.xsl"
#
# This stylesheet will be applied to the DocBook file produced from adoc
# by asciidoctor (build/.adoc/*.xml). The result will be written
# to build/.adoc/ and be used for profiling.
#
# By default, this value is set to a stylesheet DAPS ships. There should
# be no need to overwrite this default.
#
ADOC_SET_STYLE="@pkgdatadir@/daps-xslt/asciidoc/setify.xsl"

## Key: ADOC_TYPE
## --------------------
## Description: Document type that will be generated when processing
##              an AsciiDoc document
##              adoc to DocBook5
## Type:        String 
## Default:     article
#
# Valid values: article, book, manpage
#
# NOTE: Same option as you would set by --doctype with asciidoctor
#       Do not use "inline" as it will not work with
#       DAPS. Setting "manpage" requires manpage-specific content,
#       otherwise processing the source will fail.
#       This setting will override the :doctype: definition in the
#       AsciiDoc source document
#
ADOC_TYPE="article"

## Key:         BUILD_DIR
## ----------------------
## Description: Build directory where all daps generated files will go
## Type:        Path to directory (without a trailing slash)
## Default:     ""
#
# Allows to completely separate the output daps generates from the sources
# If not set it is automatically resolved to $DOC_DIR/build/$BOOK
BUILD_DIR=""

## Key:         CB_OPTIONS
## ------------------------
## Description: Command line options for /usr/bin/checkbot
## Type:        String
## Default:     "--dontwarn \"(301|302|902)\" --sleep 0 --timeout 60"
#
#
# Also see 'man 1 checkbot'. Do not change unless you really know what you do.
#
CB_OPTIONS="--dontwarn  \"(301|302|902)\" --sleep 0 --timeout 60"

## Key:         COLOR
## ------------------
## Description: Colored output?
## Type:        yesno
## Default:     "yes"
#
# By default errors, results, warnings and certain info messages are printed
# in color using bash color codes. In cron jobs and scripts you probably want to
# turn off this behavior by setting COLOR to "no"
#
COLOR="yes"

## Key:         CONF_PREFIX
## ------------------------
## Description: Common prefix for all doc config files
## Type:        String
## Default:     "DC-"
#
# Also see OUTPUTNAME
#
CONF_PREFIX="DC-"

## Key:         CONVERT_OPTS_JPG
## -------------------------
## Description: Command line options for "convert" to convert color JPGs
##              to grayscale
## Type:        String
## Default:     "-type grayscale"
#
# Do not change unless you really know what you do.
#
CONVERT_OPTS_JPG="-type grayscale"

## Key:         CONVERT_OPTS_PNG
## -------------------------
## Description: Command line options for "convert" to convert color PNGs
##              to grayscale
## Type:        String
## Default:     "-type grayscale -colors 256"
#
# Do not change unless you really know what you do.
#
CONVERT_OPTS_PNG="-type grayscale -colors 256"

## Key:         DOCCONF_DEFAULT
## -----------------------------
## Description: Specify a default DC-file that is used whenever
##              no DC-file is specified on the command line or via
##              DOCCONF_NAME in the DC-FILE
## Type:        String
## Default:     ""
#
# This value is usually set in a book specific DC-file
#
DOCCONF_DEFAULT=""

## Key:         DIA_OPTIONS
## -------------------------
## Description: Command line options for dia to convert DIA to SVG
## Type:        String
## Default:     "-t cairo-svg"
#
# Do not change unless you really know what you do.
#
DIA_OPTIONS="-t cairo-svg"

## Key: DOCBOOK4_PROFILE_URN
## -------------------------
## Description: URN to a DocBook 4 profiling stylesheet
## Type:        URN
## Default:     "urn:x-daps:xslt:profiling:docbook45-profile.xsl"
#
# URN to a stylesheet used to profile DocBook 4 content. The stylesheet
# should match the DocBook version you are using, see comments below for
# possible values
#
#
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook41-profile.xsl"
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook42-profile.xsl"
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook43-profile.xsl"
#DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook44-profile.xsl"
DOCBOOK4_PROFILE_URN="urn:x-daps:xslt:profiling:docbook45-profile.xsl"

## Key: DOCBOOK4_STYLE_URI
## ------------------
## Description: URI to DocBook 4 stylesheets
## Type:        URI
## Default:     "http://docbook.sourceforge.net/release/xsl/current/"
#
# URI to the DocBook 4 stylesheets that can be resolved by xmlcatalog
# There should be no need to change this entry
# Note:
# URI _must_ end with a "/", otherwise it will not be resolved on Ubuntu
# WARNING:
# This value needs to point to the original DocBook stylesheets. It will
# ensure that there always is a fallback in case the stylesheets specified
# elsewhere do not provide the requested output format. These styles are
# also used to generate text output. Only change if the default value
# cannot be resolved by xmlcatalog.
#
DOCBOOK4_STYLE_URI="http://docbook.sourceforge.net/release/xsl/current/"

## Key: DOCBOOK5_PROFILE_URN
## -------------------------
## Description: URN to a DocBook 5 profiling stylesheet
## Type:        URN
## Default:     "urn:x-daps:xslt:profiling:docbook51-profile.xsl"
#
# URN to a stylesheet used to profile DocBook 5 content. The stylesheet
# should match the DocBook version you are using, see comments below for
# possible values
#
#
#DOCBOOK5_PROFILE_URN="urn:x-daps:xslt:profiling:docbook50-profile.xsl"
DOCBOOK5_PROFILE_URN="urn:x-daps:xslt:profiling:docbook51-profile.xsl"

## Key: DOCBOOK5_RNG_URI
## ------------------
## Description: URI to DocBook 5 Relax NG schema
## Type:        URI
## Default:     "http://docbook.org/xml/@db5version@/rng/docbook.rng"
#
# URI to the DocBook 5 Relax NG schema that can be resolved by xmlcatalog
# There should be no need to change this entry
# In case you use a git checkout the DB5 version will be masked with 
# \@db5version\@. This string will automatically be replaced with "5.1" if
# DocBook 5.1 is installed, otherwise it will be set to "5.0"
# If you do not like this, replace the value with one of the commented lines
#
#DOCBOOK5_RNG_URI="http://docbook.org/xml/5.0/rng/docbookxi.rng"
#DOCBOOK5_RNG_URI="http://docbook.org/xml/5.1/rng/docbookxi.rng"
DOCBOOK5_RNG_URI="http://docbook.org/xml/@db5version@/rng/docbookxi.rng"

## Key: DOCBOOK5_STYLE_URI
## ------------------
## Description: URI to DocBook 5 stylesheets
## Type:        URI
## Default:     "http://docbook.sourceforge.net/release/xsl-ns/current/"
#
# URI to the DocBook 5 stylesheets that can be resolved by xmlcatalog
# There should be no need to change this entry
# Note:
# URI _must_ end with a "/", otherwise it will not be resolved on Ubuntu
#
# WARNING:
# This value needs to point to the original DocBook stylesheets. It will
# ensure that there always is a fallback in case the stylesheets specified
# elsewhere do not provide the requested output format. These styles are
# also used to generate text output. Only change if the default value
# cannot be resolved by xmlcatalog.
#
DOCBOOK5_STYLE_URI="http://docbook.sourceforge.net/release/xsl-ns/current/"

## Key:         DRAFT
## ------------------
## Description: Print "DRAFT" watermarks in HTML or PDF builds
## Type:        yesno
## Default:     "no"
#
# Turns on DRAFT watermarks in PDF or HTML builds when set to "yes"
# Is ignored for any other output format and has no effect on profiling.
# This value can be set to "yes" using the -d switch on the command line
# Also see COMMENTS and REMARKS
#
DRAFT="no"

## Key:         DRAFT_STR
## ----------------------
## Description: String to be appended to file/directory names when draft
##              is turned on
## Type:        String
## Default:     "_draft"
#
#
DRAFT_STR="_draft"

## Key:         EPUB_CHECK
## ------------------------
## Description: Check generated EPUB file with epubcheck
## Type:        yesno
## Default:     "no"
#
# Useful to find errors within an EPUB file when developing stylesheets
#
EPUBCHECK="no"

## Key:         EPUB_CSS
## ------------------------
## Description: Absolute path to CSS file for EPUB builds
## Type:        Path to file
## Default:     ""
#
EPUB_CSS=""

## Key:         FALLBACK_STYLEROOT
## ----------------------
## Description: Fallback styleroot directory.
## Type:        Path to directory (without a trailing slash)
## Default:     ""
#
# When having specified custom stylesheets with STYLEROOT, the fallback
# for styles not specified in the custom STYLEROOT are the DocBook stylesheets
# Specify an alternative fallback with this option. Useful if you have a
# fork of e.g. your custom FO stylesheets. When setting STYLEROOT to this
# for directory that only has FO styles, HTML versions of that document would
# be build with the DocBook stylesheets. Setting FALLBACK_STYLEROOT to the
# directory containing your original custom stylesheets (which also have
# HTML stylesheets) will create HTML versions with your custom styles. The
# DocBook stylesheets remain as a last fallback resort.
#
# This option is ignored when not specifying STYLEROOT at the same time.
# Also see STYLEROOT
#
FALLBACK_STYLEROOT=""

## Key:         FOP_CONFIG_FILE
## -----------------------
## Description: Configuration file for the FOP PDF formatter
## Type:        Path
## Default:     ""

#
# Specify an XML config file for FOP. A template is available in
# @sysconfdir@/daps/fop/fop-daps.xml
# Also see FORMATTER, FOP-*
#
# FOP_CONFIG_FILE="@sysconfdir@/daps/fop/fop-daps.xml"
FOP_CONFIG_FILE=""

## Key:         FOP_CMD_OPTIONS
## -----------------------
## Description: Command line options for the FOP PDF formatter
## Type:        String
## Default:     ""
#
# Specify command line options for the FOP formatter.
# Also see FORMATTER, FOP-*
#
FOP_CMD_OPTIONS=""

## Key:         FOP_JAVA_FLAGS
## ----------------------------
## Description: Additional java properties for running fop
## Type:        String (-D<prop>)
## Default:     ""
#
FOP_JAVA_FLAGS=""

## Key:         FOP_JAVA_JARS
## ---------------------------
## Description: Additional Jars for running fop
## Type:        String
## Default:     ""
#
FOP_JAVA_JARS=""

## Key:         FOP_JAVA_OPTIONS
## ------------------------------
## Description: Additional java options for running fop
## Type:        String (-X<option>), see java -X for help
## Default:     ""
#
FOP_JAVA_OPTIONS=""

## Key:         FOP_WRAPPER
## -----------------------
## Description: Wrapper script for the FOP PDF formatter
## Type:        PATH to script
## Default:     "@pkgdatadir@/libexec/daps-fop""
#
# Optional wrapper script for calling fop. If set to "fop", it will run
# the first fop executable found in your path (usually this will be
# /usr/bin/fop)
#
# The default will probably not work on Debian/Ubuntu, since they
# use a different way to set Java options. Setting up a custom wrapper
# script for Ubuntu/Debian might be needed (not tested)
#
FOP_WRAPPER="@pkgdatadir@/libexec/daps-fop"

## Key:         FORMATTER
## --------------------
## Description: Specify the PDF formatter to use
## Type:        String (fop,xep)
## Default:     "fop"
#
# Specify which PDF formatter to use. Currently only fop or xep are supported
# Also see FOP_*, XEP_*
#
FORMATTER="fop"

## Key:         GZIP_MAN
## ------------------
## Description: Compress man pages with gzip
## Type:        yesno
## Default:     "yes"
#
# By default man pages created with the "man" target will be compressed with
# gzip
#
GZIP_MAN="yes"


## Key:         JING_JAVA_FLAGS
## ----------------------------
## Description: Additional java properties for running jing
## Type:        String (-D<prop>)
## Default:     ""
#
JING_JAVA_FLAGS=""

## Key:         JING_JAVA_JARS
## ---------------------------
## Description: Additional Jars for running jing
## Type:        String
## Default:     ""
#
JING_JAVA_JARS=""

## Key:         JING_JAVA_OPTIONS
## ------------------------------
## Description: Additional java options for running jing
## Type:        String (-X<option>), see java -X for help
## Default:     ""
#
JING_JAVA_OPTIONS=""

## Key:         JING_WRAPPER
## -------------------------
## Description: Wrapper script for Jing
## Type:        PATH to script
## Default:     "@pkgdatadir@/libexec/daps-jing"
#
# Optional wrapper script for calling jing. If set to "jing", it will run
# the first jing executable found in your path (usually this will be
# /usr/bin/jing)
#
# The default will probably not work on Debian/Ubuntu, since they
# use a different way to set Java options. Setting up a custom wrapper
# script for Ubuntu/Debian might be needed (not tested)
#
# Also see JING_*
#
JING_WRAPPER="@pkgdatadir@/libexec/daps-jing"

## Key:         HTML5
## ------------------------
## Description: Use XHTML5 instead of XHTML1 for HTML output
## Type:        yesno
## Default:     no
#
HTML5="no"

## Key:         HTML_CSS
## ------------------------
## Description: Absolute path to CSS file for HTML builds
## Type:        Path to file
## Default:     ""
#
HTML_CSS=""

## Key:         IMG_VIEWER
## ------------------------
## Description: Image viewer to be used with target getimages
## Type:        String
## Default:     ""
#
# Command (gpicview) or full path (/usr/bin/gpicview) to an image viewer
#
IMG_VIEWER=""

## Key:         INCLUDE_MANIFEST
## -----------------------------
## Description: Include a manifest file to the archive created by dist-html
##              containing  list of included HTML files
## Type:        Bool
## Default:     ""
#
# Only affects the dist-html subcommand
#
INCLUDE_MANIFEST=""

## Key:         INK_OPTIONS
## ------------------------
## Description: Command line options for Inkscape >= 1.0 to convert SVG to PNG
## Type:        String
## Default:     ""
#
# Do not change unless you really know what you do.
# For Inkscape >= 1.0 only, do not use the old command line switches!
#
INK_OPTIONS=""

## Key:         JING_FLAGS
## ------------------------
## Description: Flags for jing
## Type:        String, whitespace-separated
## Default:     "-Dorg.apache.xerces.xni.parser.XMLParserConfiguration=org.apache.xerces.parsers.XIncludeParserConfiguration"
#
# The default flag enables jing to follow xi:includes
# Do not change unless you really know what you do.
#
JING_FLAGS="-Dorg.apache.xerces.xni.parser.XMLParserConfiguration=org.apache.xerces.parsers.XIncludeParserConfiguration"

## Key:         MAIN
## -----------------
## Description: Filename of the set/book defining XML file
## Type:        filename (filename only, no absolute path)
## Default:     ""
#
# Name of the MAIN XML file. Mandatory.
# This value is usually set in a book specific DC-file.
#
MAIN=""


## Key:         META
## --------------------
## Description: Print meta information in HTML and PDF builds
## Type:        yesno
## Default:     "no"
#
# Adds the file name of the source file below section titles in HTML output.
# Useful for proofreading.
# Implies that remarks are turned on.
# This value can be set to "yes" using the -m switch on the command line
# Also see REMARKS
#
META="no"


## Key:         META_STR
## ----------------------
## Description: String to be appended to file/directory names when meta
##              is turned on
## Type:        String
## Default:     "_meta"
#
#
META_STR="_meta"

# Key:         OUTPUTNAME
## --------------------
## Description: Custom name for generated files
## Type:        String
## Default:     ""
#
# By default the directory/filenames will be generated by stripping the
# CONF_PREFIX from the DC-file's name. Use this setting to choose a custom
# name.
# This value is usually set in a book specific DC-file.
# ATTENTION: Do not specify this value in a global config file if you generate
#            more than a single book, otherwise previous book builds will
#            always be overwritten by a new build
#
OUTPUTNAME=""

## Key:         PDFNAME
## --------------------
## Deprecated. Use OUTPUTNAME instead (see there)



## Key:         PROFARCH
## ---------------------
## Description: Profiling values for the attribute arch=""
## Type:        String (e.g. i386, x86_64)
## Default:     ""
#
# This value is usually set in a book specific DC-file.
#
PROFARCH=""

## Key:         PROFCONDITION
## ---------------------------
## Description: Profiling values for the attribute condition=""
## Type:        String
## Default:     ""
#
# This value is usually set in a book specific DC-file.
#
PROFCONDITION=""

## Key:         PROFILE_URN
## ---------------------------
## Description: URN for profiling stylesheet
## Type:        urn (String)
## Default:     ""
#
# In order to use profiling, the urn to a profiling stylesheet _either_ has
# to be specified in the header of the main file ($MAIN) via <?xml-stylesheet/>
# or via this variable. Valid urns can be found in the DAPS installation
# directory in etc/catalog.xml
PROFILE_URN=""

## Key:         PROFOS
## -------------------
## Description: Profiling values for the attribute os=""
## Type:        String
## Default:     ""
#
# This value is usually set in a book specific DC-file.
#
PROFOS=""

## Key:         PROFOUTPUTFORMAT
## -------------------
## Description: Profiling values for the attribute outputformat=""
## Type:        String
## Default:     ""
#
# This value is usually set in a book specific DC-file.
#
PROFOUTPUTFORMAT=""

## Key:         PROFVENDOR
## -----------------------
## Description: Profiling values for the attribute vendor=""
## Type:        String
## Default:     ""
#
# This value is usually set in a book specific DC-file.
#
PROFVENDOR=""

## Key:         REMARK
## -------------------
## Description: Generate books with remarks?
## Type:        yesno
## Default:     "no"
#
# By default remarks are ignored when generating books. Set this parameter to
# "yes" to include remarks. Useful for proofreading.
# This value can be set to "yes" using the -r switch on the command line
# Also see COMMENTS and DRAFT
#
REMARKS="no"

## Key:         REMARKS_STR
## ------------------------
## Description: String to be appended to file/directory names when remarks
##              are turned on
## Type:        String
## Default:     "_remarks"
#
REMARK_STR="_remarks"

## Key:         ROOTID
## -------------------
## Description: ID of the book/chapter/etc. to generate
## Type:        String (must be a valid id from the set defined in MAIN)
## Default:     ""
#
# When not set, the complete book defined in MAIN is build. If MAIN defines a
# set of several books, you need to specify the id of a book (<book id="">) in
# order to build the single book. daps also supports building single
# articles, parts, and chapters.
# This value is usually set in a book specific DC-file and can also be set
# using the command line switch --rootid=""
#
ROOTID=""

## Key:         SPELL_CHECKER
## ----------------------
## Description: Spellchecker application to use
## Type:        Name of the spellchecker's binary
## Default:     DAPS performs a lookup for aspell and hunspell. If only one
##              of these packages is installed, it will be used automatically.
##              If both are installed, aspell will be used.
##              If you want to force using one of the two spellcheckers, specify
##              it here.
##
SPELL_CHECKER=""

## Key:         SPELL_CHECKER
## ----------------------
## Description: Spellchecker application to use
## Type:        Name of the spellchecker's binary
## Default:     "aspell"
#
SPELL_CHECKER="aspell"

## Key:         SPELL_EXTRA_DICT
## ----------------------
## Description: Additional dictionary for spell checker
## Type:        Absolute path to dictionary
## Default:     ""
#
# Refer to the aspell / hunspell documentation on how to build custom
# dictionaries (the process differs for each spell checker)
#
# NOTE:Differences between aspell and hunspell
#      aspell:
#        An extra dictionary for aspell can reside anywhere in the
#        file system and you need to specify the absolute path to
#        this directory with SPELL_EXTRA_DICT or with --extra-dict
#      hunspell:
#        An extra dictionary for hunspell needs to reside in
#        hunspell's search path (check with hunspell -D) and needs
#        to be specified with the file's base name only:
#        Example: /usr/share/hunspell/en_US-suse-doc.dic => en_US-suse-doc
#        If you specify a non-existing dictionary or if it
#        cannot be found by hunspell, it will silently be ignored
#
# Specify an additional (custom) dictionary (will always be used in
# addition to the default dictionary for the given language)
#
SPELL_EXTRA_DICT=""

## Key:         SPELL_LANG
## ----------------------
## Description: Language for spell checker
## Type:        String
## Default:     ""
#
# NOTE:  Language to use for spellchecker.
#  	 aspell:
#          It uses the same format as the
#          LANG environmental variable: It consists of  the two letter ISO 639
#          language code (e.g. 'en' for English) and an optional two letter
#          ISO 3166 country code after an underscore (e.g. en_GB for British
#          English). Make sure the respective dictionary for aspell is installed.
#          By default, DAPS tries to get the language from the "lang" attribute
#          of the MAIN file.
#        hunspell:
#          Consists of the two letter ISO 639 (e.g. 'en' for English) and a
#          mandatory two letter ISO 3166 country code after an underscore
#          (e.g. en_GB for British English)
#          In case the language is not specified with --lang or SPELL_LANG,
#          the value from the xml:lang attribute of the MAIN file will be
#          used in case it complies with the format. If not, spellcheck will
#          abort and ask for the language.
#
SPELL_LANG=""

## Key:         SPELL_SKIP_TAGS
## ----------------------
## Description: list of DocBook XML tags which content should _not_ be
##              spell-checked. Only works with aspell (hunspell does not
##              support this).
## Type:        List
## Default:     "author command email envar filename firstname guimenu \
##               keycap literal option package remark screen surname \
##               systemitem tag ulink varname xref"
#
SPELL_SKIP_TAGS="author command email envar filename firstname guimenu keycap literal option package remark replaceable screen surname systemitem tag ulink varname xref"

## Key:      STATIC_DIR
## -------------------
## Description: Custom static/ directory containing CSS and JS files
##              as well as images referenced from the CSS file and
##              the stylesheets
## Type:        Path to directory (without a trailing slash)
## Default:     ""
#
#
# If present, DAPS uses a directory <STYLEROOT>/static hosting CSS and JS
# files as well as images reference from the stylesheets and copies it to
# the resulting HTML directory. This variable allows to permanently set a
# custom directory.
# To be set in the DC file or via command line with --statdir.
#
# See also STYLEROOT, FALLBACK_STYLEROOT
#
STATIC_DIR=""

## Key:      STYLEDEVEL
## -------------------
## Description: Custom stylesheets directory for development purposes.
## Type:        Path to directory (without a trailing slash)
## Default:     ""
#
#
# By default, daps uses the DocBook stylesheets to create output. If you are
# developing your own set of stylesheets, you may want to set STYLEDEVEL in
# ~/.config/daps/dapsrc. If set STYLEDEVEL _always_ takes precedence over
# STYLEROOT!
# You may also want to set FALLBACK_STYLEROOT alongside with STYLEDEVEL
#
# See also STYLEROOT, FALLBACK_STYLEROOT
#
# Do NOT use unless you really know what you are doing.
#
STYLEDEVEL=""

## Key:      STYLEROOT
## -------------------
## Description: Custom stylesheets directory.
## Type:        Path to directory (without a trailing slash)
## Default:     ""
#
# By default, daps uses the DocBook stylesheets to create output. If you have
# your own set of stylesheets, specify the absolute path to the stylesheet
# directory here. The DocBook stylesheets will be used as a fallback in case
# styles are not defined for all output formats.
#
# See also: FALLBACK_STYLEROOT
#
STYLEROOT=""

## Key:         TXT_IGNORE_STYLEROOT
## ---------------------------------
## Description: Ignore styleroot and rather use the original DocBook
##              stylesheets for text output?
## Type:        yesno
## Default:     "no"
#
# Text output is generated by creating a single file HTML page parsing
# the result with w3m. This ensures that e.g. tables are properly
# displayed in the .txt file. Default is to use the stylesheets provided
# via STYLEROOT or --styleroot to build the HTML. Set this option to
# "yes" to ignore the STYLEROOT and to use the original DocBook
# stylesheets instead.
#
# NOTE: This will also work if STYLEROOT points to the original
#       DocBook stylesheets.
#
# See also: TXT_PARAMS
#
TXT_IGNORE_STYLEROOT="no"


## Key:         TXT_PARAMS
## -------------------
## Description: XSL parameters for text file generation
## Type:        string
## Default:     '--param="generate.permalinks=0" --param="section.autolabel=1" --param="section.label.includes.component.label=2"'
#
# Text output is generated by creating a single file HTML page parsing
# the result with w3m. This ensures that e.g. tables are properly
# displayed in the .txt file. This configuration option can be used to set
# custom XSL parameters - the HTML stylesheets are not necessarily
# configured in a way that is suitable for text output.
# The default value for TXT_PARAMS turns on labeling and makes sure
# admonitions have a text label. Other parameters turn off stuff that is
# of no use in text output.
# For a reference of all HTML parameters refer to
# http://docbook.sourceforge.net/release/xsl/current/doc/html/index.html
#
# NOTE: Make sure to use single quotes to quote the complete string, since it
#       contains double quotes
#
TXT_PARAMS='--param="admon.textlabel=1" --param="section.autolabel=1" --param="section.label.includes.component.label=2" --param="optimize.plain.text=1"'

## Key:         VALID_ROOTELEMENTS
## --------------------
## Description: Top level root elements allowed when specifying --rootid
## Type:        String (list of space separated tags)
## Default:     appendix article bibliography book chapter colophon \
##              dedication glossary index part preface refentry reference \
##              set setindex
#
# Stylesheets for PDF/HTML/EPUB etc. usually expect certain top level elements
# when transforming XML files. It makes little sense to process a document with
# <envar> as a root element. Specify the list of top-level elements your scripts
# support, here. In case a document with a root element not specified here is
# parsed, DAPS will exit with an error. This is also true when specifying the
# --rootid parameter: If the specified rootid belongs to an element not listed
# here, DAPS throws an error.
# Set to an empty value to allow all elements (e.g. when you prefer to do the
# error handling from within the scripts).
#
VALID_ROOTELEMENTS="appendix article bibliography book chapter colophon dedication glossary index part preface refentry reference set setindex"

## Key:         WH_SEARCH
## --------------------
## Description: Enable/disable webhelp search feature
## Type:        yesno
## Default:     yes
#
#
WH_SEARCH="yes"

## Key:         XEP_CONFIG_FILE
## -----------------------
## Description: Configuration file for the XEP PDF formatter
## Type:        Path
## Default:     "@sysconfdir@/daps/xep/xep-daps.xml"
#
# Specify a config file for XEP
# Also see FORMATTER, XEP-*
#
# The xep executable will automatically use the file specified
# with the XEP_CONFIG_FILE environment variable (if exported). There
# is no such option as -c or --config for the xep executable.
#
# NOTE: This value may be overwritten by either of the following files, if they
#       exist:
#       (1) $STYLEROOT/formatter-config/xep/xep-daps.xml
#       (2) $HOME/.config/daps/xep-config.xml
#       The order of precedence is: (1), (2), $XEP_CONFIG_FILE setting.
#
XEP_CONFIG_FILE="@sysconfdir@/daps/xep/xep-daps.xml"

## Key:         XEP_CMD_OPTIONS
## -----------------------
## Description: Command line options for the XEP PDF formatter
## Type:        String
## Default:     ""
#
# Specify command line options for the XEP formatter.
# Also see FORMATTER, XEP-*
#
XEP_CMD_OPTIONS=""

## Key:         XEP_JAVA_FLAGS
## ----------------------------
## Description: Additional java properties for running xep
## Type:        String (-D<prop>)
## Default:     ""
#
XEP_JAVA_FLAGS=""

## Key:         XEP_JAVA_JARS
## ---------------------------
## Description: Additional Jars for running xep
## Type:        String
## Default:     ""
#
XEP_JAVA_JARS=""

## Key:         XEP_JAVA_OPTIONS
## ------------------------------
## Description: Additional java options for running xep
## Type:        String (-X<option>), see java -X for help
## Default:     ""
#
XEP_JAVA_OPTIONS=""

## Key:         XEP_WRAPPER
## -----------------------
## Description: Wrapper script for the XEP PDF formatter
## Type:        PATH to script
## Default:     "@pkgdatadir@/libexec/daps-xep"
#
# Optional wrapper script for calling xep. If set to "xep", it will run
# the first xep executable found in your path (usually this will be
# /usr/bin/xep)
#
# The default will probably not work on Debian/Ubuntu, since they
# use a different way to set Java options. Setting up a custom wrapper
# script for Ubuntu/Debian might be needed (not tested)
#
XEP_WRAPPER="@pkgdatadir@/libexec/daps-xep"

## Key:         XML_MAIN_CATALOG
## -----------------------
## Description: Main XML catalog file
## Type:        PATH to file
## Default:     "/etc/xml/catalog"
#
# Path to the main XML catalog used to resolve URIs. /etc/xml/catalog is
# the standard location used by most (all?) Linux distributions. Only
# change if the main catalog is located elsewhere on you distribution or if
# you want to use a custom catalog.
#
XML_MAIN_CATALOG="/etc/xml/catalog"

## Key:         XML_USER_CATALOGS
## -----------------------
## Description: User defined catalog files
## Type:        PATH to file
## Default:     ""
#
# Path to one or more (space-separated) XML catalogs to be queried before
# XML_MAIN_CATALOG.
#
XML_USER_CATALOGS=""

## Key: XMLFORMAT_CONFIG_FILE
## --------------------
## Description: Path to config file for xmlformat
## Type:        PATH to file
## Default:     "@default@"
#
# xmlformat can prettify XML sources (daps xmlformat).
# This is ensures readability and consistent diffs even when using different
# editors. DAPS provides configuration files for DocBook (the default setting)
# for different versions of xmlformat. By default, DAPS chooses an
# appropriate file from @sysconfdir@/daps/docbook-xmlformat-*.conf depending on
# the installed version of xmlformat. To use an own configuration file,
# provide an absolute path to that file here.
#
# Can also be placed into a DC-file if used as a per-book setting
#
XMLFORMAT_CONFIG_FILE="@default@"

## Key: XSLTPARAM
## --------------------
## Description: String passed to xsltproc for HTML and PDF builds
## Type:        number
## Default:     ""
#
# With XSLTPARAM you can overwrite stylesheet settings without having
# to touch the stylesheet files directly. You may overwrite parameters
# by specifying "--stringparam <PARAM_NAME> <NEW_VALUE>"
# Example:
# Set the page size for PDFs to 200x100 mm
# XSLTPARAM="--stringparam page.height 200mm --stringparam page.width 100mm"
#
# Can also be placed in a DC-file if used as a per-book setting
#
XSLTPARAM=""

## Key: XSLTPROCESSOR
## --------------------
## Description: Path to XSLT processor.
## Type:        Path to executable
## Default:     "/usr/bin/xsltproc"
#
# Define which XSLT processor to use. Currently supports "xsltproc" and
# "saxon". Saxon needs to be Saxon 6, Saxon 8 and 9 are not supported.
#
XSLTPROCESSOR="/usr/bin/xsltproc"