1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet
href="urn:x-daps:xslt:profiling:docbook45-profile.xsl"
type="text/xml"
title="Profiling step"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
[<!ENTITY % entities SYSTEM "entity-decl.ent">
%entities;
]>
<chapter id="cha.daps.user.review">
<title>Review and Translation Processes</title>
<abstract>
<para>
This chapter describes how to simplify review and translation processes
with &dapsacr; 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.
</para>
</abstract>
<sect1 id="sec.daps.user.review.output.special">
<title>Including Remarks and Draft Watermarks in the Output</title>
<para>
&dapsacr; offers several features to simplify review and translation
processes. For example, you can insert <sgmltag>remark</sgmltag> elements
in the source code (for editorial remarks or questions to the proofreader)
and generate an output format that either includes or suppresses
<remark>dpopov 2016-10-12: perhaps shows/hides is more descriptive than
includes/suppresses?</remark> these remarks. You can also generate preview
versions of your documentation with a <literal>DRAFT</literal> watermark
appearing on the HTML or PDF output.
</para>
<para>
If you use &dm; in addition to &dapsacr;, you can <quote>flag</quote>
your XML files with meta information (such as the workflow status). &dapsacr;
offers an option to also display this meta information in the generated
output.
</para>
&daps-note-output-adv;
<para>
Find a few example commands below:
</para>
<variablelist>
<varlistentry>
<term>Including Remarks in the Output</term>
<listitem>
<screen>&prompt.user;&dapscmd; -d <replaceable>PATH_TO_&dc;_FILE</replaceable> pdf --remarks</screen>
&daps-output-remarks;
</listitem>
</varlistentry>
<varlistentry>
<term>Building PDFs with a <literal>DRAFT</literal> Watermark</term>
<listitem>
<screen>&prompt.user;&dapscmd; -d <replaceable>PATH_TO_&dc;_FILE</replaceable> pdf --draft</screen>
<para>
Generates a PDF that has a <literal>DRAFT</literal> watermark printed
on each page.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Including Metadata in the Output</term>
<listitem>
<screen>&prompt.user;daps -d <replaceable>PATH_TO_&dc;_FILE</replaceable> html --meta</screen>
<para>
Adds the file name of the current file below section titles.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="sec.daps.user.review.bigfile">
<title>Creating XML Big Files</title>
<para> Instead of sending multiple XML files to a proofreader for review, you can transform all
files included in your <sgmltag>book</sgmltag> or <sgmltag>set</sgmltag> into one huge DocBook
XML file (big file). Use the following command: </para>
<screen>&prompt.user;&dapscmd; -d <replaceable>PATH_TO_&dc;_FILE</replaceable> bigfile</screen>
<para> &dapsacr; resolves all XIncludes (replaces them with the referenced content) to create
the big file. A message is shown where to find the generated output. </para>
<para>
Sometimes error messages point to a line containing an
<sgmltag><xi:include/></sgmltag> tag and the real error is hidden
somewhere inside the included file. Using the option
<option>--novalid</option> 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:
</para>
<screen>&prompt.user;&dapscmd; -d <replaceable>PATH_TO_&dc;_FILE</replaceable> bigfile --novalid</screen>
</sect1>
<sect1 id="sec.daps.user.review.locdrop">
<title>Creating TAR Archives For Localization</title>
<para> If you have a huge documentation project of which only individual books or files are to be
translated, you can mark the respective files as translation-relevant with
the <sgmltag>dm:translation</sgmltag> element of &dm;.
You can then use the <command>&dapscmd; locdrop</command> command to generate the
following archives for distribution to the translators or translation agency: </para>
<itemizedlist>
<listitem>
<para>One TAR archive contains the graphics.</para>
</listitem>
<listitem>
<para>One TAR archive contains all XML files that need to be localized.</para>
</listitem>
<listitem>
<para>One TAR archive contains the remaining files of the set. The remaining files are
needed for solving any cross-references between translated and untranslated content during
generation of output.</para>
</listitem>
</itemizedlist>
<screen>&prompt.user;daps -d <replaceable>PATH_TO_&dc;_FILE</replaceable> locdrop</screen>
<para> For further options related to creating distributable archives with &dapsacr;, run
<command>daps -/-help</command> or see <xref linkend="cha.daps.user.deploy"/> for more
information. </para>
</sect1>
</chapter>
|
