7 Review and Translation Processes #

7.1 Including Remarks or Draft Watermarks in the Output
7.2 Creating XML Big Files

This chapter describes how to simplify review and translation processes with DAPS either by including remarks, or draft watermarks in the output, or by transforming the multiple DocBook files in your project into one big XML file.

7.1 Including Remarks or Draft Watermarks in the Output #

DAPS offers several features to simplify review and translation processes. For example, you can insert remark elements in the source code (for editorial remarks or questions to the proofreader) and generate an output format that either includes or suppresses these remarks. You can also generate preview versions of your documentation with a DRAFT watermark appearing on the HTML or PDF output.

Note: Availability of Advanced Output Options

Advanced output options are only supported for selected formats. For example, --draft and --remarks are only available in HTML, HTML-single, PDF, and EPUB output.

Using the --remarks option automatically turns draft mode on.

By default, DAPS adds a string to the base name of the output file to flag output formats generated with special options. Example file names are *_draft_en.pdf or *_remarks_*_draft_en.pdf.

Find a few example commands below:

Including Remarks in the Output

tux:~> daps -d PATH_TO_DC_FILE pdf --remarks

When generating PDFs with FOP, the contents of the remark elements is shown in italics within the text. XEP supports conversion of remark elements into PDF annotations. This feature is enabled in DAPS by default, but if you want XEP to treat remark elements like FOP does, you can change the respective DAPS parameter. In HTML, HTML-single and EPUB output, the contents of the remark elements is shown in red within the text.

Building PDFs with a DRAFT Watermark

tux:~> daps -d PATH_TO_DC_FILE pdf --draft

Generates a PDF that has a DRAFT watermark printed on each page.

7.2 Creating XML Big Files #

Instead of sending multiple XML files to a proofreader for review, you can transform all files included in your book or set into one huge DocBook XML file (big file). Use the following command:

tux:~> daps -d PATH_TO_DC_FILE bigfile

DAPS resolves all XIncludes (replaces them with the referenced content) to create the big file. A message is shown where to find the generated output.

Sometimes error messages point to a line containing an <xi:include/> tag and the real error is hidden somewhere inside the included file. Using the option --novalid allows you to build and validate a single XML file where error messages points to their occurrences in the bigfile. Use the following command as an example:

tux:~> daps -d PATH_TO_DC_FILE bigfile --novalid

Print this page