| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE html
|
|---|
| 3 | PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|
| 4 | <html xml:lang="en-us" lang="en-us">
|
|---|
| 5 | <head>
|
|---|
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|---|
| 7 | <meta name="copyright" content="(C) Copyright 2005"/>
|
|---|
| 8 | <meta name="DC.rights.owner" content="(C) Copyright 2005"/>
|
|---|
| 9 | <meta name="DC.Type" content="concept"/>
|
|---|
| 10 | <meta name="DC.Title" content="generate.outer.copy parameter"/>
|
|---|
| 11 | <meta name="abstract" content="Elaboration on how the generate.outer.copy parameter functions."/>
|
|---|
| 12 | <meta name="description" content="Elaboration on how the generate.outer.copy parameter functions."/>
|
|---|
| 13 | <meta name="DC.Relation" scheme="URI" content="../readme/ant-parameters-common-html-transtypes.html"/>
|
|---|
| 14 | <meta name="DC.Format" content="XHTML"/>
|
|---|
| 15 | <meta name="DC.Identifier" content="concept_rcv_xbp_xg"/>
|
|---|
| 16 | <link rel="stylesheet" type="text/css" href="../commonltr.css"/>
|
|---|
| 17 | <link rel="stylesheet" type="text/css" href="../dita-ot-doc.css"/>
|
|---|
| 18 | <title>generate.outer.copy parameter</title>
|
|---|
| 19 | </head>
|
|---|
| 20 | <body id="concept_rcv_xbp_xg">
|
|---|
| 21 |
|
|---|
| 22 |
|
|---|
| 23 | <h1 class="title topictitle1"><span class="keyword parmname">generate.outer.copy</span> parameter</h1>
|
|---|
| 24 |
|
|---|
| 25 |
|
|---|
| 26 | <div class="body conbody"><p class="shortdesc">Elaboration on how the <span class="keyword parmname">generate.outer.copy</span> parameter
|
|---|
| 27 | functions.</p>
|
|---|
| 28 |
|
|---|
| 29 | <div class="section"><h2 class="title sectiontitle">Background</h2>
|
|---|
| 30 |
|
|---|
| 31 | <div class="p">This is an issue in the following situations:<ul class="ul">
|
|---|
| 32 | <li class="li">The DITA map is in a directory that is a peer to directories that contain referenced
|
|---|
| 33 | objects.</li>
|
|---|
| 34 |
|
|---|
| 35 | <li class="li">The DITA map is in a directory that is below the directories that contain the referenced
|
|---|
| 36 | objects.</li>
|
|---|
| 37 |
|
|---|
| 38 | </ul>
|
|---|
| 39 | </div>
|
|---|
| 40 |
|
|---|
| 41 | <div class="p">Let's assume that the directory structure for the DITA content looks like the
|
|---|
| 42 | following:<pre class="pre">maps
|
|---|
| 43 | topics
|
|---|
| 44 | images</pre>
|
|---|
| 45 | The DITA map is in the <span class="ph filepath">maps</span>
|
|---|
| 46 | directory, the topics are in the<span class="ph filepath"> topics</span> directory, and the images are in
|
|---|
| 47 | the <span class="ph filepath">images</span> directory.</div>
|
|---|
| 48 | </div>
|
|---|
| 49 |
|
|---|
| 50 | <div class="section"><h2 class="title sectiontitle">Setting the <span class="keyword parmname">generate.outer.copy</span> parameter to
|
|---|
| 51 | <span class="keyword option">1</span></h2>
|
|---|
| 52 | <div class="p">Let's assume that you run the XHTML transformation and specify an output directory of
|
|---|
| 53 | <span class="ph filepath">C:\A-test</span>. By default, The DITA-OT uses the
|
|---|
| 54 | <span class="keyword parmname">generate.outer.copy</span> parameter with a value of <span class="keyword option">1</span>.
|
|---|
| 55 | Output is not built for the topics. You receive only the following
|
|---|
| 56 | output:<pre class="pre">A-test
|
|---|
| 57 | --- dita.list
|
|---|
| 58 | --- dita.xml.properties
|
|---|
| 59 | --- index.html
|
|---|
| 60 | --- commonltr.css
|
|---|
| 61 | --- commonrtl.css</pre>
|
|---|
| 62 | The
|
|---|
| 63 | <span class="ph filepath">index.html</span> file contains the navigation structure, but all the links
|
|---|
| 64 | are broken, since no XHTML files were built for the topics.</div>
|
|---|
| 65 |
|
|---|
| 66 | <p class="p">How do you fix this? By specifying a value of <span class="keyword option">2</span> or <span class="keyword option">3</span> for the
|
|---|
| 67 | <span class="keyword parmname">generate.outer.copy</span> parameter. </p>
|
|---|
| 68 |
|
|---|
| 69 | </div>
|
|---|
| 70 |
|
|---|
| 71 | <div class="section"><h2 class="title sectiontitle">Setting the <span class="keyword parmname">generate.outer.copy</span> parameter to
|
|---|
| 72 | <span class="keyword option">2</span></h2>
|
|---|
| 73 |
|
|---|
| 74 | <div class="p">Let's assume that you run the XHTML transformation again and specify the following parameters:<ul class="ul">
|
|---|
| 75 | <li class="li">The <span class="keyword parmname">generate.outer.copy</span> parameter is set to <span class="keyword option">2</span>.</li>
|
|---|
| 76 |
|
|---|
| 77 | <li class="li">The <span class="keyword parmname">output.dir</span> parameter is set to
|
|---|
| 78 | <span class="ph filepath">C:\A-test</span>.</li>
|
|---|
| 79 |
|
|---|
| 80 | </ul>
|
|---|
| 81 | </div>
|
|---|
| 82 |
|
|---|
| 83 | <div class="p">This is what your output looks
|
|---|
| 84 | like:<pre class="pre">C:\A-test
|
|---|
| 85 | --- dita.list
|
|---|
| 86 | --- dita.xml.properties
|
|---|
| 87 | --- index.html
|
|---|
| 88 | --- commonltr.css
|
|---|
| 89 | --- commonrtl.css
|
|---|
| 90 | ...
|
|---|
| 91 | C:\images
|
|---|
| 92 | ...
|
|---|
| 93 | C:\topics</pre>
|
|---|
| 94 | </div>
|
|---|
| 95 |
|
|---|
| 96 | <p class="p">The links in the output all work properly. However, depending on how many other directories
|
|---|
| 97 | are located at the same level of your build system as the output directory, it might not be easy
|
|---|
| 98 | gather all the output together if you need to copy it elsewhere.</p>
|
|---|
| 99 |
|
|---|
| 100 | </div>
|
|---|
| 101 |
|
|---|
| 102 | <div class="section"><h2 class="title sectiontitle">Setting the <span class="keyword parmname">generate.outer.copy</span> parameter to
|
|---|
| 103 | <span class="keyword option">3</span></h2>
|
|---|
| 104 |
|
|---|
| 105 | <div class="p">Now your output directory structure looks like
|
|---|
| 106 | this:<pre class="pre">C:\A-test
|
|---|
| 107 | --- images\
|
|---|
| 108 | --- maps\
|
|---|
| 109 | --- topics\</pre>
|
|---|
| 110 | The index.html file is in the maps
|
|---|
| 111 | directory, and the CSS and other files are located in the output directory,
|
|---|
| 112 | <span class="ph filepath">C:\A-test</span>. Copying the output directory is simplified.</div>
|
|---|
| 113 |
|
|---|
| 114 | </div>
|
|---|
| 115 |
|
|---|
| 116 | </div>
|
|---|
| 117 |
|
|---|
| 118 | <div class="related-links">
|
|---|
| 119 | <div class="familylinks">
|
|---|
| 120 | <div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../readme/ant-parameters-common-html-transtypes.html" title="Certain parameters apply to all the HTML-based transformation types: Eclipse content, Eclipse help, HTML Help, JavaHelp, TocJS, and XHTML.">Ant parameters: Common HTML-based transformations</a></div>
|
|---|
| 121 | </div>
|
|---|
| 122 | </div>
|
|---|
| 123 |
|
|---|
| 124 | </body>
|
|---|
| 125 | </html>
|
|---|
