1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
|
---|
3 | <concept id="concept_rcv_xbp_xg">
|
---|
4 | <title><parmname>generate.outer.copy</parmname> parameter</title>
|
---|
5 | <shortdesc>Elaboration on how the <parmname>generate.outer.copy</parmname> parameter
|
---|
6 | functions.</shortdesc>
|
---|
7 | <conbody>
|
---|
8 | <section>
|
---|
9 | <title>Background</title>
|
---|
10 | <p>This is an issue in the following situations:<ul>
|
---|
11 | <li>The DITA map is in a directory that is a peer to directories that contain referenced
|
---|
12 | objects.</li>
|
---|
13 | <li>The DITA map is in a directory that is below the directories that contain the referenced
|
---|
14 | objects.</li>
|
---|
15 | </ul></p>
|
---|
16 | <p>Let's assume that the directory structure for the DITA content looks like the
|
---|
17 | following:<pre>maps
|
---|
18 | topics
|
---|
19 | images</pre>The DITA map is in the <filepath>maps</filepath>
|
---|
20 | directory, the topics are in the<filepath> topics</filepath> directory, and the images are in
|
---|
21 | the <filepath>images</filepath> directory.</p></section>
|
---|
22 | <section> <title>Setting the <parmname>generate.outer.copy</parmname> parameter to
|
---|
23 | <option>1</option></title>
|
---|
24 | <p>Let's assume that you run the XHTML transformation and specify an output directory of
|
---|
25 | <filepath>C:\A-test</filepath>. By default, The DITA-OT uses the
|
---|
26 | <parmname>generate.outer.copy</parmname> parameter with a value of <option>1</option>.
|
---|
27 | Output is not built for the topics. You receive only the following
|
---|
28 | output:<pre>A-test
|
---|
29 | --- dita.list
|
---|
30 | --- dita.xml.properties
|
---|
31 | --- index.html
|
---|
32 | --- commonltr.css
|
---|
33 | --- commonrtl.css</pre>The
|
---|
34 | <filepath>index.html</filepath> file contains the navigation structure, but all the links
|
---|
35 | are broken, since no XHTML files were built for the topics.</p>
|
---|
36 | <p>How do you fix this? By specifying a value of <option>2</option> or <option>3</option> for the
|
---|
37 | <parmname>generate.outer.copy</parmname> parameter. </p>
|
---|
38 | </section>
|
---|
39 | <section>
|
---|
40 | <title>Setting the <parmname>generate.outer.copy</parmname> parameter to
|
---|
41 | <option>2</option></title>
|
---|
42 | <p>Let's assume that you run the XHTML transformation again and specify the following parameters:<ul>
|
---|
43 | <li>The <parmname>generate.outer.copy</parmname> parameter is set to <option>2</option>.</li>
|
---|
44 | <li>The <parmname>output.dir</parmname> parameter is set to
|
---|
45 | <filepath>C:\A-test</filepath>.</li>
|
---|
46 | </ul></p>
|
---|
47 | <p>This is what your output looks
|
---|
48 | like:<pre>C:\A-test
|
---|
49 | --- dita.list
|
---|
50 | --- dita.xml.properties
|
---|
51 | --- index.html
|
---|
52 | --- commonltr.css
|
---|
53 | --- commonrtl.css
|
---|
54 | ...
|
---|
55 | C:\images
|
---|
56 | ...
|
---|
57 | C:\topics</pre></p>
|
---|
58 | <p>The links in the output all work properly. However, depending on how many other directories
|
---|
59 | are located at the same level of your build system as the output directory, it might not be easy
|
---|
60 | gather all the output together if you need to copy it elsewhere.</p>
|
---|
61 | </section>
|
---|
62 | <section>
|
---|
63 | <title>Setting the <parmname>generate.outer.copy</parmname> parameter to
|
---|
64 | <option>3</option></title>
|
---|
65 | <p>Now your output directory structure looks like
|
---|
66 | this:<pre>C:\A-test
|
---|
67 | --- images\
|
---|
68 | --- maps\
|
---|
69 | --- topics\</pre>The index.html file is in the maps
|
---|
70 | directory, and the CSS and other files are located in the output directory,
|
---|
71 | <filepath>C:\A-test</filepath>. Copying the output directory is simplified.</p>
|
---|
72 | </section>
|
---|
73 | </conbody>
|
---|
74 | </concept>
|
---|