DITA-messages-details.html 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="reference"><meta name="description" content="This topic lists each error message generated by the toolkit and provides additional information that might be helpful in understanding and resolving the error condition. If your toolkit installation includes custom plug-ins that define additional messages, you can add to this list by rebuilding the DITA-OT documentation."><meta name="DC.Format" content="HTML5"><meta name="DC.Identifier" content="errormessages"><meta name="DC.Language" content="en-US"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA-OT error messages</title></head><body id="errormessages"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">DITA-OT error messages</h1>
  8. <div class="body refbody"><p class="shortdesc">This topic lists each error message
  9. generated by the toolkit and provides additional information that might be helpful in understanding and resolving
  10. the error condition. If your toolkit installation includes custom plug-ins that define additional messages, you can
  11. add to this list by rebuilding the DITA-OT documentation.</p>
  12. <section class="section" id="errormessages__overview">
  13. <p class="p">Each message ID is composed of a message prefix, a message number, and a letter that indicates the severity
  14. level (I, W, E, or F). </p>
  15. <p class="p">The toolkit uses the following severity scale:</p>
  16. <dl class="dl" id="errormessages__severity-levels">
  17. <dt class="dt dlterm">Info (I)</dt>
  18. <dd class="dd">Informational messages highlight the progress of transformation and call attention to conditions of which
  19. you should be aware. For example, draft comments are enabled and will be rendered in the output.</dd>
  20. <dt class="dt dlterm">Warning (W)</dt>
  21. <dd class="dd">The toolkit encountered a problem that should be corrected. Processing will continue, but the output might
  22. not be as expected.</dd>
  23. <dt class="dt dlterm">Error (E)</dt>
  24. <dd class="dd">The toolkit encountered a more severe problem, and the output is affected. For example, some content is
  25. missing or invalid, or the content is not rendered in the output</dd>
  26. <dt class="dt dlterm">Fatal (F)</dt>
  27. <dd class="dd">The toolkit encountered a severe condition, processing stopped, and no output is generated.</dd>
  28. </dl>
  29. <p class="p">Plug-ins may be used to add additional messages to the toolkit; for more information, see <a class="xref" href="rebuilding-the-dita-ot-documentation.html" title="The DITA-OT ships with Ant scripts that enable you to rebuild the toolkit documentation. This is especially helpful if your environment contains plug-ins that add new extension points, messages, or parameters to the toolkit.">Rebuilding the DITA-OT documentation</a>.</p>
  30. </section>
  31. <table class="simpletable"><colgroup><col style="width:100%"></colgroup><thead><tr class="sthead">
  32. <th class="stentry" scope="col">Individual cells in this table may be used to push additional explanations for any existing error
  33. message into the generated message topic.</th>
  34. </tr></thead><tbody><tr class="strow">
  35. <td class="stentry">To add additional explanation to any message, add the explanation to this table in a single cell, and
  36. set the the following attributes on the <code class="keyword markupname xmlelement">&lt;stentry&gt;</code> tag:
  37. <ul class="ul">
  38. <li class="li"><code class="ph codeph">conref="DITA-messages.xml#msgs/MESSAGEID-extra"</code> -- for example, use the following to
  39. add additional info to message DOTX001F:
  40. <code class="ph codeph">conref="DITA-messages.xml#msgs/DOTX001F-extra"</code></li>
  41. <li class="li"><code class="ph codeph">conaction="pushreplace"</code></li>
  42. </ul></td>
  43. </tr><tr class="strow">
  44. <td class="stentry">Default transformation types
  45. that ship with the toolkit include dita, eclipsehelp, html5, htmlhelp, markdown variants, pdf (or pdf2),
  46. tocjs, troff, xhtml, and xhtml. Additional transformation types may be available if toolkit plug-ins are
  47. installed.</td>
  48. </tr><tr class="strow">
  49. <td class="stentry">The input parameter was not
  50. specified, so there is no DITA or DITAMAP file to transform. Ensure the parameter is set properly; see <a class="xref" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">DITA-OT common parameters (args.input)</a> if you are unsure how to specify the
  51. input file.</td>
  52. </tr><tr class="strow">
  53. <td class="stentry">An alternate stylesheet was
  54. specified to run in place of the default XSLT output process, but that stylesheet could not be loaded. Please
  55. correct the parameter to specify a valid stylesheet.</td>
  56. </tr><tr class="strow">
  57. <td class="stentry">This optional parameter is used
  58. to set an extension for DITA topic documents in the temporary processing directory. Only "dita", ".dita",
  59. "xml", or ".xml" are allowed.</td>
  60. </tr><tr class="strow">
  61. <td class="stentry">If the CSSPATH uses an absolute
  62. path, it should be one that can still be accessed after the files are moved to another system (such as
  63. <code class="ph codeph">http://www.example.org/</code>). Absolute paths on the local file system will be broken if the
  64. content is moved to a new system.</td>
  65. </tr><tr class="strow">
  66. <td class="stentry">The running footer file, which
  67. contains content to be added to the bottom of each XHTML output topic, cannot be located or read. This is
  68. usually caused by a typo in the parameter value. You should also ensure that the value is not specified with
  69. "file:" as a prefix.</td>
  70. </tr><tr class="strow">
  71. <td class="stentry">The running header file, which
  72. contains content to be added to the top of each XHTML output topic, cannot be located or read. This is usually
  73. caused by a typo in the parameter value. You should also ensure that the value is not specified with "file:"
  74. as a prefix.</td>
  75. </tr><tr class="strow">
  76. <td class="stentry">The running heading file, which
  77. contains content to be added to the <code class="keyword markupname xmlelement">&lt;head&gt;</code> section of each HTML output topic, cannot be
  78. located or read. This is usually caused by a typo in the parameter value. You should also ensure that the
  79. value is not specified with "file:" as a prefix.</td>
  80. </tr><tr class="strow">
  81. <td class="stentry">An alternate stylesheet was
  82. specified to run in place of the default XSL-FO output process, but that stylesheet could not be loaded.
  83. Please correct the parameter to specify a valid stylesheet.</td>
  84. </tr><tr class="strow">
  85. <td class="stentry">According to the OASIS DITA
  86. Specification, the <code class="keyword markupname xmlelement">&lt;index-see&gt;</code> element should be ignored if the parent
  87. <code class="keyword markupname xmlelement">&lt;indexterm&gt;</code> contains other <code class="keyword markupname xmlelement">&lt;indexterm&gt;</code> children.</td>
  88. </tr><tr class="strow">
  89. <td class="stentry">According to the OASIS DITA
  90. Specification, the <code class="keyword markupname xmlelement">&lt;index-see-also&gt;</code> element should be ignored if the parent
  91. <code class="keyword markupname xmlelement">&lt;indexterm&gt;</code> contains other <code class="keyword markupname xmlelement">&lt;indexterm&gt;</code> children.</td>
  92. </tr><tr class="strow">
  93. <td class="stentry">Please ensure that the input
  94. file path and file name were entered correctly.</td>
  95. </tr><tr class="strow">
  96. <td class="stentry"></td>
  97. </tr><tr class="strow">
  98. <td class="stentry">The transform was unable to
  99. create files properly during the transform; results may not be as expected.</td>
  100. </tr><tr class="strow">
  101. <td class="stentry">This message may indicate an
  102. invalid input file (such as accidentally specifying a PDF file as input rather than a DITA map file), an input
  103. file that uses elements which are not allowed, are not part or a DITA file that has errors and cannot be
  104. parsed as XML. You could also be using a specialized DITA document type that needs external plug-ins in order
  105. to be parsed correctly. The message issued by the XML parser should provide additional information to help
  106. diagnose the cause.</td>
  107. </tr><tr class="strow">
  108. <td class="stentry">This message may indicate a
  109. reference to an invalid file (such as accidentally referencing a PDF or unknown XML file as if it was DITA), a
  110. referenced file that uses elements which are not allowed, or a referenced DITA file that has errors and cannot
  111. be parsed as XML. You could also be using a specialized DITA document type that needs external plug-ins in
  112. order to be parsed correctly. The message issued by the XML parser should provide additional information to
  113. help diagnose the cause.</td>
  114. </tr><tr class="strow">
  115. <td class="stentry">An empty
  116. <code class="keyword markupname xmlelement">&lt;indexterm&gt;</code> element was found, and will appear in the index as ***. This index term
  117. should be removed from the source.</td>
  118. </tr><tr class="strow">
  119. <td class="stentry">This will appear when one
  120. installed plug-in requires another in order to function correctly, but the required plug-in is not found. The
  121. installed plug-in will be ignored.</td>
  122. </tr><tr class="strow">
  123. <td class="stentry">This may appear if filter
  124. conditions on the root element of a topic cause the entire topic to be filtered out. To remove this message,
  125. you could place any filter conditions on the reference to this file, which will prevent the build from
  126. accessing this file.</td>
  127. </tr><tr class="strow">
  128. <td class="stentry">Either the input file or the
  129. ditaval file should change, otherwise your build is explicitly excluding all content.</td>
  130. </tr><tr class="strow">
  131. <td class="stentry">Check whether the image exists
  132. in the source location or already exists in the output directory.</td>
  133. </tr><tr class="strow">
  134. <td class="stentry">This message should only appear
  135. in the following cases:
  136. <ul class="ul">
  137. <li class="li">Errors earlier in the transform prevented this step of the transform from running; correct any errors
  138. and try the build again.</li>
  139. <li class="li">An Ant build or plug-in is directly calling the toolkit's topic merge module, and is doing so
  140. improperly; in this case the Ant build or plug-in needs to be fixed.</li>
  141. <li class="li">In the past, problems have been encountered when calling this module with an absolute path; this should
  142. no longer be an issue, but may be fixed in older releases by updating the Ant build or plug-in.</li>
  143. </ul></td>
  144. </tr><tr class="strow">
  145. <td class="stentry">This message should only appear
  146. if an Ant build or plug-in is directly calling the toolkit's topic merge module, or if earlier errors resulted
  147. in problems with some of the content. If the topic merge module is called correctly, then this indicates a
  148. program error that should be reported to the DITA-OT development team via the <a class="xref" href="https://github.com/dita-ot/dita-ot/issues" target="_blank">GitHub issues tracker</a>.
  149. </td>
  150. </tr><tr class="strow">
  151. <td class="stentry">When referencing a non-DITA
  152. file, the format attribute should indicate the type of file referenced (such as "html" for HTML topics or
  153. "pdf" for PDF files). Otherwise, the transform may attempt to parse the referenced document as a DITA
  154. topic.</td>
  155. </tr><tr class="strow">
  156. <td class="stentry">The domains attribute is used in
  157. specialized DITA documents to help determine which domain elements are legal. This message will only appear if
  158. a DITA specialization was not defined properly.</td>
  159. </tr><tr class="strow">
  160. <td class="stentry">All specialized DITA elements
  161. must define a class attribute to provide ancestry information. This message will only appear if a specialized
  162. DITA element did not define a class attribute, or if non-DITA elements are included in a DITA
  163. context.</td>
  164. </tr><tr class="strow">
  165. <td class="stentry">This informational message is
  166. intended to help you catch filter conditions that may have been specified improperly; if the value is correct,
  167. no action is needed.</td>
  168. </tr><tr class="strow">
  169. <td class="stentry"></td>
  170. </tr><tr class="strow">
  171. <td class="stentry">DITA processing is based on
  172. class attributes defined for every element. Usually these are defaulted in the DTD or Schema; if no DTD or
  173. Schema is used, the class attributes must be explicitly included in the map or topic.</td>
  174. </tr><tr class="strow">
  175. <td class="stentry">This will appear when a topic is
  176. outside the scope of the map; for example, if the main input map references
  177. <span class="ph filepath">"../other-directory/some.dita"</span>. The result would cause an output file to be created
  178. outside of the output directory. See <a class="xref" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">DITA-OT common parameters (outer.control
  179. and generate.copy.outer)</a> for details.</td>
  180. </tr><tr class="strow">
  181. <td class="stentry">This will appear when a topic is
  182. outside the scope of the map; for example, if the main input map references
  183. <span class="ph filepath">"../other-directory/some.dita"</span>. The result would cause an output file to be created
  184. outside of the output directory. If you do not want to see the warning message, please use the Ant parameter
  185. 'outer.control', and set the value to "quiet". Otherwise, move the referenced file into the input dita/map
  186. directory. See <a class="xref" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">DITA-OT common parameters (outer.control and
  187. generate.copy.outer)</a> for details.</td>
  188. </tr><tr class="strow">
  189. <td class="stentry">DITA processing is based on
  190. class attributes defined for every element. Usually these are defaulted in the DTD or Schema; if validation
  191. against the DTD or Schema is turned off, the class attributes must be explicitly included in the map or
  192. topic.</td>
  193. </tr><tr class="strow">
  194. <td class="stentry">This appears to indicate an
  195. error in creating specialized metadata elements. Please verify that the document type you are using is
  196. complete and complies with DITA Specialization rules.</td>
  197. </tr><tr class="strow">
  198. <td class="stentry">Please see the topic on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/langRef/attributes/theconactionattribute.html#theconactionattribute" target="_blank">Conref Push</a> in the DITA specification for details on expected syntax
  199. for this function.</td>
  200. </tr><tr class="strow">
  201. <td class="stentry">Please see the topic on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/langRef/attributes/theconactionattribute.html#theconactionattribute" target="_blank">Conref Push</a> in the DITA specification for details on expected syntax
  202. for this function.</td>
  203. </tr><tr class="strow">
  204. <td class="stentry">The conref attribute must be a
  205. URI reference to a DITA element. Please see the topic on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/archSpec/base/uri-based-addressing.html#uri-based-addressing" target="_blank">URI-based addressing</a> in the DITA specification for details on the
  206. expected syntax.</td>
  207. </tr><tr class="strow">
  208. <td class="stentry">The conref push function was
  209. used to replace a single element with two or more alternatives. Only one element may directly replace another
  210. using conref push. See <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/langRef/attributes/theconactionattribute.html#theconactionattribute" target="_blank">Conref Push</a> in the DITA specification for more information about the
  211. conref push "replace" function.</td>
  212. </tr><tr class="strow">
  213. <td class="stentry">The target for a conref push
  214. action does not exist; please make sure that the syntax is correct and that the target exists. See the topic
  215. on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/archSpec/base/uri-based-addressing.html#uri-based-addressing" target="_blank">URI-based addressing</a> in the DITA specification for details on the
  216. expected syntax. If the syntax is correct, it is possible that the target was filtered out of your build using
  217. a DITAVAL file.</td>
  218. </tr><tr class="strow">
  219. <td class="stentry">Please see the topic on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/langRef/attributes/theconactionattribute.html#theconactionattribute" target="_blank">Conref Push</a> in the DITA specification for details on expected syntax
  220. for this function.</td>
  221. </tr><tr class="strow">
  222. <td class="stentry">This informational message is
  223. intended to help you catch catch duplicate key definitions; if the keys are defined as expected, no action is
  224. needed.</td>
  225. </tr><tr class="strow">
  226. <td class="stentry">See <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/langRef/attributes/theconkeyrefattribute.html#theconkeyrefattribute" target="_blank">the conkeyref definition</a> for details on expected syntax and
  227. usage.</td>
  228. </tr><tr class="strow">
  229. <td class="stentry">This message is intended to help
  230. you locate incorrectly specified keys; if the key was specified correctly, this message may be
  231. ignored.</td>
  232. </tr><tr class="strow">
  233. <td class="stentry">A DITA Subject Scheme map was
  234. used to limit values that are available to the specified attribute. Please correct the attribute so that it
  235. uses one of the allowed values.</td>
  236. </tr><tr class="strow">
  237. <td class="stentry">The Eclipse index will contain a
  238. value such as "See also otherEntry", but otherEntry does not exist in this index. The index reference will be
  239. broken unless this plug-in is <em class="ph i">always</em> loaded into Eclipse with another plug-in that defines otherEntry
  240. as an index term.</td>
  241. </tr><tr class="strow">
  242. <td class="stentry">The target for a coderef
  243. element, which specifies an external text-based file, could not be located or loaded. Please verify that the
  244. reference is correct.
  245. <p class="p">Note that for security reasons, references to code samples outside of the scope of the map directory are
  246. not supported by default, as this could allow a reference to access and display any restricted or hidden
  247. file on the system. If you are certain that the path is valid and the file should be loaded, the current
  248. workaround is to set a parameter to allow these references. See <a class="xref" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">DITA-OT
  249. common parameters (outer.control and generate.copy.outer)</a> for details.</p></td>
  250. </tr><tr class="strow">
  251. <td class="stentry">The DITA-OT supports a special
  252. syntax on coderef elements to specify the character set of the target document. See <a class="xref" href="../reference/extended-functionality.html" title="DITA-OT provides additional code reference processing support beyond that which is mandated by the DITA specification. These extensions can be used to define character encodings or line ranges for use in code blocks.">Extended code reference processing</a> for details on the expected syntax.</td>
  253. </tr><tr class="strow">
  254. <td class="stentry">By default, the DITA-OT supports
  255. the extensions "dita" and "xml" for DITA topics, as mandated by the DITA Specification. Please verify that
  256. your topics use one of these extensions, or configure the toolkit to allow additional extensions.</td>
  257. </tr><tr class="strow">
  258. <td class="stentry">This message indicates that the
  259. <code class="keyword markupname xmlatt">@href</code> value specified in <var class="keyword varname">%1</var> does not use proper URI syntax. This may occur when
  260. <code class="keyword markupname xmlatt">@href</code> includes characters that should be escaped (such as the space character, which should be
  261. <code class="ph codeph">%20</code> when in a URI). In strict processing mode this will cause a build failure;
  262. in other processing modes the build will continue using the value in <var class="keyword varname">%2</var>.</td>
  263. </tr><tr class="strow">
  264. <td class="stentry">A conref "mark" action has been
  265. used to mark a target element without a corresponding content reference target. This may occur when the order
  266. of the "mark" element and the pushed element is reversed.</td>
  267. </tr><tr class="strow">
  268. <td class="stentry">
  269. <p class="p">A circular reference was found in key definitions: a series of key references where the last key references
  270. the first.</p>
  271. <p class="p">This may occur if a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> element contains both a key name in the
  272. <code class="keyword markupname xmlatt">@keys</code> attribute and a reference to the same key in the <code class="keyword markupname xmlatt">@keyref</code> attribute,
  273. or if a <code class="keyword markupname xmlatt">@keyref</code> attribute points to a key that refers back to the referencing element.</p>
  274. <p class="p">To resolve this issue, change the target of the <code class="keyword markupname xmlatt">@keyref</code> so the key is defined by pointing
  275. to a resource other than itself.</p>
  276. </td>
  277. </tr><tr class="strow">
  278. <td class="stentry">
  279. <p class="p">When a <code class="keyword markupname xmlatt">@class</code> attribute does not use the expected syntax, this usually indicates that
  280. <code class="keyword markupname xmlatt">@class</code> has been explicitly set on a DITA element. The attribute should be removed from the
  281. document so that the expected default value can be automatically used.</p>
  282. <p class="p">If this is a non-DITA element, it needs to be placed inside a <code class="keyword markupname xmlelement">&lt;foreign&gt;</code> element so
  283. that is not validated against DITA rules.</p>
  284. </td>
  285. </tr><tr class="strow">
  286. <td class="stentry">
  287. <p class="p">Ensure that the DITAVAL file exists. If more than one DITAVAL file is specified, ensure that the paths are
  288. delimited using the file path separator character appropriate for your operating system (semicolon
  289. ‘<code class="ph codeph">;</code>’ on Windows, or colon ‘<code class="ph codeph">:</code>’ on macOS or Linux).</p>
  290. </td>
  291. </tr><tr class="strow">
  292. <td class="stentry">This build uses generated text,
  293. such as the phrase "Related information" (which is generated above many link groups). The toolkit was unable
  294. to locate the string <var class="keyword varname">%1</var> for your specified language, so the string will appear in the
  295. default language. This generally indicates that the toolkit's strings need to be updated to support your
  296. language, or that your language setting is incorrect.</td>
  297. </tr><tr class="strow">
  298. <td class="stentry">The Eclipse help system requires
  299. a title in the project files generated from your map. Please add a title to your input map to get valid
  300. Eclipse help output.</td>
  301. </tr><tr class="strow">
  302. <td class="stentry">Eclipse uses anchor references
  303. to connect with other TOC files. For this to work in content generated from a DITA map, the anchorref element
  304. must reference either an existing Eclipse TOC XML file, or another DITA map (which will presumably also be
  305. converted to an Eclipse TOC).</td>
  306. </tr><tr class="strow">
  307. <td class="stentry">Eclipse builds use DITA's
  308. <code class="keyword markupname xmlelement">&lt;navref&gt;</code> element to pull in other Eclipse TOC files. The build found a
  309. <code class="keyword markupname xmlelement">&lt;navref&gt;</code> element that does not reference any other file; the element will be
  310. ignored.</td>
  311. </tr><tr class="strow">
  312. <td class="stentry">To remove this message, provide
  313. a navigation title for the referenced object in the map or topic, or ensure that you are referencing a valid
  314. local DITA target.</td>
  315. </tr><tr class="strow">
  316. <td class="stentry">Set the format attribute to
  317. identify the format of the file. If the reference is to a DITA document, ensure that the document uses a valid
  318. DITA extension (default supported extensions are "dita" and "xml").</td>
  319. </tr><tr class="strow">
  320. <td class="stentry">The HTML Help compiler will only
  321. include some types of information in the compiled CHM file; the current reference will not be
  322. included.</td>
  323. </tr><tr class="strow">
  324. <td class="stentry">Ensure that the file exists and
  325. can be read. <span class="ph">Note that the name of the file in this message may have be changed
  326. to use a standard dita topic file extension ('.dita' or '.xml'), instead of the original extension used by
  327. the file; it may also include a path to the temporary directory rather than to the original.</span></td>
  328. </tr><tr class="strow">
  329. <td class="stentry">To fix the table of contents,
  330. specify a navigation title in your map or ensure that the referenced file is local and can be accessed. <span class="ph">Note that the name of the file in this message may have be changed
  331. to use a standard dita topic file extension ('.dita' or '.xml'), instead of the original extension used by
  332. the file; it may also include a path to the temporary directory rather than to the original.</span></td>
  333. </tr><tr class="strow">
  334. <td class="stentry">No title was found in the
  335. specified topic, so the table of contents will use the indicated fallback value for this topic.</td>
  336. </tr><tr class="strow">
  337. <td class="stentry">The conref attribute must be a
  338. URI reference to an existing DITA element. Please see the topic on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/archSpec/base/uri-based-addressing.html#uri-based-addressing" target="_blank">URI-based addressing</a> in the DITA specification for details on the
  339. expected syntax. <span class="ph" id="errormessages__changeExtension">Note that the name of the file in this message may have be changed
  340. to use a standard dita topic file extension ('.dita' or '.xml'), instead of the original extension used by
  341. the file; it may also include a path to the temporary directory rather than to the original.</span>
  342. <p class="p">If the target element exists in your source file, check to make sure it is not filtered out of the build
  343. with a DITAVAL file (which will remove the target before conref processing runs).</p></td>
  344. </tr><tr class="strow">
  345. <td class="stentry">When pulling content with a
  346. conref attribute, you may only pull from a single element, but the target ID appears twice in the referenced
  347. topic. <span class="ph">Note that the name of the file in this message may have be changed
  348. to use a standard dita topic file extension ('.dita' or '.xml'), instead of the original extension used by
  349. the file; it may also include a path to the temporary directory rather than to the original.</span></td>
  350. </tr><tr class="strow">
  351. <td class="stentry">This message is deprecated and
  352. should no longer appear in any logs.</td>
  353. </tr><tr class="strow">
  354. <td class="stentry">This may appear if (for example)
  355. you have a <code class="keyword markupname xmlelement">&lt;ph&gt;</code> element that references another phrase, but that phrase itself contains
  356. a reference to the original. This will result in an infinite loop. The toolkit will stop following the conref
  357. trail when this is detected; you will need to correct the reference in your source files. <span class="ph">Note that the name of the file in this message may have be changed
  358. to use a standard dita topic file extension ('.dita' or '.xml'), instead of the original extension used by
  359. the file; it may also include a path to the temporary directory rather than to the original.</span></td>
  360. </tr><tr class="strow">
  361. <td class="stentry">The conref attribute must be a
  362. URI reference to a DITA element. Please see the topic on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/archSpec/base/uri-based-addressing.html#uri-based-addressing" target="_blank">URI-based addressing</a> in the DITA specification for details on the
  363. expected syntax.</td>
  364. </tr><tr class="strow">
  365. <td class="stentry">The conref attribute must be a
  366. URI reference to a DITA element. Please see the topic on <a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/archSpec/base/uri-based-addressing.html#uri-based-addressing" target="_blank">URI-based addressing</a> in the DITA specification for details on the
  367. expected syntax. <span class="ph">Note that the name of the file in this message may have be changed
  368. to use a standard dita topic file extension ('.dita' or '.xml'), instead of the original extension used by
  369. the file; it may also include a path to the temporary directory rather than to the original.</span></td>
  370. </tr><tr class="strow">
  371. <td class="stentry">This warning is intended to
  372. catch instances where a non-DITA format setting unexpectedly cascades to a DITA topic, which will prevent the
  373. topic from being processed. To remove this message, set the format attribute directly on the indicated
  374. reference. <span class="ph">Note that the name of the file in this message may have be changed
  375. to use a standard dita topic file extension ('.dita' or '.xml'), instead of the original extension used by
  376. the file; it may also include a path to the temporary directory rather than to the original.</span></td>
  377. </tr><tr class="strow">
  378. <td class="stentry">Found a value such as &lt;xref
  379. href=""&gt;link text&lt;/xref&gt;. The empty href attribute is not serving a purpose and has caused problems with
  380. some tools in the past; you should remove the attribute entirely or specify a value.</td>
  381. </tr><tr class="strow">
  382. <td class="stentry">The type attribute in DITA is
  383. intended to describe the type of the target; for example, a reference to a concept topic may use
  384. type="concept". Generally, this attribute is optional, and the DITA-OT build will automatically determine the
  385. value during processing. In this case, the type attribute lists a more general type than what is actually
  386. found. This is not an error but may result in unexpected sorting for links to this topic.</td>
  387. </tr><tr class="strow">
  388. <td class="stentry">The type attribute in DITA is
  389. intended to describe the type of the target; for example, a reference to a concept topic may use
  390. type="concept". Generally, this attribute is optional, and the DITA-OT build will automatically determine the
  391. value during processing. In this case, the specified type value does not match the target, which may cause
  392. your links to sort inappropriately.</td>
  393. </tr><tr class="strow">
  394. <td class="stentry">The DITA-OT is only able to
  395. dynamically retrieve titles when the target is a local (not peer or external) DITA resource.</td>
  396. </tr><tr class="strow">
  397. <td class="stentry">The DITA-OT is only able to
  398. dynamically retrieve titles when the target is a local DITA resource.</td>
  399. </tr><tr class="strow">
  400. <td class="stentry">The build was unable to get a
  401. title from the referenced topic; instead, a navigation title will be created based on the specified
  402. <code class="keyword markupname xmlelement">&lt;linktext&gt;</code> element inside of <code class="keyword markupname xmlelement">&lt;topicmeta&gt;</code>.</td>
  403. </tr><tr class="strow">
  404. <td class="stentry">If the target is a local DITA
  405. topic, ensure the reference is correct and the topic is available. Otherwise, provide a navigation title, and
  406. ensure the scope and format attributes are set appropriately.</td>
  407. </tr><tr class="strow">
  408. <td class="stentry">The DITA-OT is only able to
  409. dynamically retrieve titles and link text when the target is a local (not peer or external) DITA
  410. resource.</td>
  411. </tr><tr class="strow">
  412. <td class="stentry">The DITA-OT is only able to
  413. dynamically retrieve titles when the target is a local DITA resource.</td>
  414. </tr><tr class="strow">
  415. <td class="stentry">The referenc to this document
  416. did not specify any link text for generated map-based links; the navigation title will be used as
  417. fallback.</td>
  418. </tr><tr class="strow">
  419. <td class="stentry">The referenced file did not
  420. specify any link text for generated map-based links, and no fallback text could be located. Any links
  421. generated from this reference will have incorrect link text.</td>
  422. </tr><tr class="strow">
  423. <td class="stentry">The link or cross reference has
  424. no target specified and will not generate a link.</td>
  425. </tr><tr class="strow">
  426. <td class="stentry">The type attribute in DITA is
  427. intended to describe the type of the target; for example, a reference to a concept topic may use
  428. type="concept". Generally, this attribute is optional, and the DITA-OT build will automatically determine the
  429. value during processing. In this case, the type attribute lists a more general type than what is actually
  430. found. This is not an error but may result in unexpected sorting for links to this topic.</td>
  431. </tr><tr class="strow">
  432. <td class="stentry">The type attribute in DITA is
  433. intended to describe the type of the target; for example, a reference to a concept topic may use
  434. type="concept". Generally, this attribute is optional, and the DITA-OT build will automatically determine the
  435. value during processing. In this case, the specified type value does not match the target, which may cause
  436. your links to sort inappropriately.</td>
  437. </tr><tr class="strow">
  438. <td class="stentry">The build attempted to access
  439. the specified file in order to retrive a title or short description, but the file could not be found. If the
  440. file exists, it is possible that a DITAVAL file was used to remove the file's contents from the build. Be
  441. aware that the path information above may not match the link in your topic.</td>
  442. </tr><tr class="strow">
  443. <td class="stentry">When a link or cross reference
  444. does not have content, the build will attempt to pull the target's title for use as link text. If the target
  445. is unavailable, be sure to set the scope attribute to an appropriate value. If the target does not have a
  446. title (such as when linking to a paragraph), be sure to provide link text inside the cross
  447. reference.</td>
  448. </tr><tr class="strow">
  449. <td class="stentry">An <code class="keyword markupname xmlelement">&lt;xref&gt;</code>
  450. element specifies type="li", which indicates a link to a list item, but the item number could not be
  451. determined to use as link text. Please specify link text inside the reference, or ensure that you are
  452. referencing an available list item.</td>
  453. </tr><tr class="strow">
  454. <td class="stentry">The cross reference goes to a
  455. list item in an unordered list. The process could not automatically generate link text because the list item
  456. is not numbered. Please provide link text within the cross reference.</td>
  457. </tr><tr class="strow">
  458. <td class="stentry">An <code class="keyword markupname xmlelement">&lt;xref&gt;</code>
  459. element specifies type="fn", which indicates a link to a footnote, but the footnote number could not be
  460. determined to use as link text. Please specify link text inside the reference, or ensure that you are
  461. referencing an available footnote.</td>
  462. </tr><tr class="strow">
  463. <td class="stentry">An <code class="keyword markupname xmlelement">&lt;xref&gt;</code>
  464. element specifies type="dlentry", which indicates a link to a definition list entry, but the term could not be
  465. located to use as link text. Please specify link text inside the reference, or ensure that you are referencing
  466. an available definition list entry</td>
  467. </tr><tr class="strow">
  468. <td class="stentry">No title was found for the
  469. current document, so the HTML output file will set the <code class="keyword markupname xmlelement">&lt;title&gt;</code> to "***". This value
  470. generally appears in the title bar at the top of a browser.</td>
  471. </tr><tr class="strow">
  472. <td class="stentry">The
  473. <code class="keyword markupname xmlelement">&lt;object&gt;</code> element in HTML does not support using longdescref for accessibility. To
  474. make the object accessible, you may need to add text before or after the element. You may also be able to
  475. handle it with a <code class="keyword markupname xmlelement">&lt;param&gt;</code> element inside the object.</td>
  476. </tr><tr class="strow">
  477. <td class="stentry">This message is generated when
  478. creating draft output in order to help you locate all topics that need to be cleaned up; the cleanup items
  479. will appear in your output with styling that makes it stand out. The content will be hidden when the draft
  480. parameter is not active.</td>
  481. </tr><tr class="strow">
  482. <td class="stentry">This message is generated when
  483. creating draft output in order to help you locate all topics that have draft comments. Each comment will
  484. appear in your HTML output; the comments will be hidden when the draft parameter is not active.</td>
  485. </tr><tr class="strow">
  486. <td class="stentry">Because of the way XML and DITA
  487. are defined, it is generally not possible to prohibit adding a second title to a section during editing (or to
  488. force that title to come first). However, the DITA specification states that only one title should be used in
  489. a section. When multiple titles are found, only the first one will appear in the output.</td>
  490. </tr><tr class="strow">
  491. <td class="stentry">If it is important to flag this
  492. piece of information, try placing a flag on the block element that contains your phrase. If you just want to
  493. have an image next to the phrase, you may place an image directly into the document.</td>
  494. </tr><tr class="strow">
  495. <td class="stentry">The DITA-OT is able to remove
  496. duplicate links in most cases. However, if two links to the same resource use different attributes or link
  497. text, it is possible for them to appear together. For example, if the same link shows up with role="next" and
  498. again with no specified role, it may show up as both the "Next topic" link and as a related link. Note that
  499. links generated from a <code class="keyword markupname xmlelement">&lt;reltable&gt;</code> in a DITA Map will have the role attribute set to
  500. "friend".</td>
  501. </tr><tr class="strow">
  502. <td class="stentry">The
  503. <code class="keyword markupname xmlelement">&lt;area&gt;</code> element in an image map must provide a link target for the specified area.
  504. Please add an <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element as a child of <code class="keyword markupname xmlelement">&lt;area&gt;</code> and ensure
  505. that it specifies a link target.</td>
  506. </tr><tr class="strow">
  507. <td class="stentry">Cross reference text inside the
  508. <code class="keyword markupname xmlelement">&lt;area&gt;</code> element is used to provide accessibility for screen readers that can identify
  509. different areas of an image map. If text cannot be retrieved automatically by referencing a DITA element, it
  510. should be specified directly in the cross reference.</td>
  511. </tr><tr class="strow">
  512. <td class="stentry">The specified value was passed
  513. as-is through to the <code class="keyword markupname xmlelement">&lt;area&gt;</code> element in the HTML.</td>
  514. </tr><tr class="strow">
  515. <td class="stentry">The area element is intended to
  516. define a region in an image map; coordinates must be specified in order to define that region.</td>
  517. </tr><tr class="strow">
  518. <td class="stentry">The build will not look for peer
  519. or external topics before compiling your CHM file, so they may not be included. If you are referencing an
  520. actual HTML file that will not be available, it cannot be included in the project, and you should set the toc
  521. attribute to "no" on your topicref element. Otherwise, check to be sure your HTML file was included in the
  522. CHM; if it was not, you will need to place it in the correct location with your other output files and
  523. recompile.</td>
  524. </tr><tr class="strow">
  525. <td class="stentry">The PDF, ODT, and RTF output
  526. processes cannot automatically convert non-DITA content into DITA in order to merge it with the rest of your
  527. content. The referenced items are ignored.</td>
  528. </tr><tr class="strow">
  529. <td class="stentry">Eclipse requires that an ID be
  530. specified when creating an Eclipse Help project; the toolkit expects to locate that ID on the root element of
  531. your input map.</td>
  532. </tr><tr class="strow">
  533. <td class="stentry">The toolkit is attempting to add
  534. generated text, such as the string "Related information" that appears above links. The requested string could
  535. not be found in any language. Your output may contain a meaningful string, or it may contain a code that was
  536. intended to map to a string. This likely indicates an error in a plug-in or XSL override; either the string
  537. was requested incorrectly, or you will need to provide a mapping for the string in all of the languages you
  538. require.</td>
  539. </tr><tr class="strow">
  540. <td class="stentry">This will occur if a map
  541. references another map, and then that second map (or another further nested map) references the original map.
  542. The result is an infinite nesting of maps; please correct the chain of map references to remove circular
  543. reference.</td>
  544. </tr><tr class="strow">
  545. <td class="stentry">This will occur when a DITAVAL
  546. file contains multiple styling rules that apply to the same element.</td>
  547. </tr><tr class="strow">
  548. <td class="stentry">The "flagit" named template was
  549. deprecated in DITA-OT version 1.4, when the OASIS standard formalized the DITAVAL syntax. The template is
  550. removed in DITA-OT 1.6. Stylesheets that used this template need to be updated.</td>
  551. </tr><tr class="strow">
  552. <td class="stentry">The build attempted to access
  553. the specified file in order to retrive a title or short description, but the file could not be found. If the
  554. file exists, it is possible that a DITAVAL file was used to remove the file's contents from the build. Another
  555. possibility is that the file is located outside of the scope of the main input directory, and was not
  556. available because the <a class="xref" href="../parameters/parameters-base.html" title="Certain parameters apply to all transformations that are supported by the DITA Open Toolkit.">onlytopic.in.map</a> parameter was specified. Be aware
  557. that the path information above may not match the link in your topic.</td>
  558. </tr><tr class="strow">
  559. <td class="stentry">The link appears to use valid
  560. syntax to reference a DITA element, but that element cannot be found. Please verify that the element exists,
  561. and is not removed from the build by DITAVAL based filtering.</td>
  562. </tr><tr class="strow">
  563. <td class="stentry">Processing for terms, acronyms,
  564. or abbreviated forms will associate the key from the element's keyref attribute with a glossentry (glossary
  565. entry) topic. This message will appear if the key was defined, but was not associated with a glossentry topic.
  566. The process will try to use the best available fallback (usually the title of the referenced topic).</td>
  567. </tr><tr class="strow">
  568. <td class="stentry">Processing for abbreviated form
  569. elements will associate the key from the element's keyref attribute with a glossentry (glossary entry) topic.
  570. This message will appear if the key was defined, but was not associated with a glossentry topic. This element
  571. is only supported with keys that are associated with glossary topics; the element will not generate any
  572. output. Please correct the reference, or use a different element to reference your topic.</td>
  573. </tr><tr class="strow">
  574. <td class="stentry">According to the DITA
  575. Specification, references from maps should either go to DITA Maps, DITA Topics, or any non-DITA resource.
  576. References below the topic level should only be made from cross references (using
  577. <code class="keyword markupname xmlelement">&lt;xref&gt;</code> or similar) inside of a topic. For details, see the href attribute description
  578. in the OASIS standard's definition of the <a class="xref" href="http://docs.oasis-open.org/dita/v1.2/os/spec/langref/topicref.html" target="_blank">topicref element</a>.</td>
  579. </tr><tr class="strow">
  580. <td class="stentry">This will appear when generating
  581. PDF or ODT output that includes a link to a local topic, but the referenced topic is not part of the map
  582. itself. This will result in a broken link. You should include the topic in your map or remove the link from
  583. the build.</td>
  584. </tr><tr class="strow">
  585. <td class="stentry">The copy-to attribute is used to
  586. copy a topic over a document that already exists. Please make sure that any copy-to attributes use a unique
  587. name so that the copy will not overwrite existing content.</td>
  588. </tr><tr class="strow">
  589. <td class="stentry">Two different topics are copied
  590. to the same location using copy-to; as a result, one of these files would be over-written. Only the first
  591. instance of this copy-to value will be recognized. Please correct the use of copy-to attributes.</td>
  592. </tr><tr class="strow">
  593. <td class="stentry">This message indicates that your
  594. custom XSLT or plug-ins rely on templates that will be removed in an upcoming release. Typically this occurs
  595. when a named template has been converted to a mode template; any code that uses the deprecated template should
  596. be updated.</td>
  597. </tr><tr class="strow">
  598. <td class="stentry">This PDF build uses generated
  599. text, such as the phrase "Related information" (which is generated above many link groups). The toolkit was
  600. unable to locate the string <var class="keyword varname">%1</var> for your specified language, so the string will appear in
  601. the default language. This generally indicates that the toolkit's strings need to be updated to support your
  602. language, or that your language setting is incorrect.</td>
  603. </tr></tbody></table>
  604. <section class="section"><h2 class="title sectiontitle">Additional explanation for messages in the <span class="ph filepath">org.dita.pdf2</span> plugin</h2>
  605. <table class="simpletable"><colgroup><col style="width:100%"></colgroup><tbody><tr class="strow">
  606. <td class="stentry">The PDF index process relies
  607. on pre-defined letter headings when sorting terms. The specified term does not begin with a character that
  608. can be mapped to an existing heading. Typically this term would be placed in a "Special characters" group,
  609. but the current language did not specify such a group when setting up the index sort process.</td>
  610. </tr><tr class="strow">
  611. <td class="stentry">The PDF index process relies
  612. on pre-defined letter headings when sorting terms. The specified term does not begin with a character that
  613. can be mapped to an existing heading, so it has been placed under a heading for terms that begin with
  614. special characters such as punctuation. If this term should be sorted under a new or existing letter
  615. heading, please open an issue with DITA-OT to correct the sort.</td>
  616. </tr><tr class="strow">
  617. <td class="stentry">Found an
  618. <code class="keyword markupname xmlelement">&lt;index-see&gt;</code> element as a child of a term that also exists as a standalone index
  619. term, or as a term that also uses <code class="keyword markupname xmlelement">&lt;index-see-also&gt;</code>. When using
  620. <code class="keyword markupname xmlelement">&lt;index-see&gt;</code> with an index term, that term should not be used to create page
  621. references and should not reference additional terms. Treating the <code class="keyword markupname xmlelement">&lt;index-see&gt;</code> as
  622. <code class="keyword markupname xmlelement">&lt;index-see-also&gt;</code>.</td>
  623. </tr></tbody></table>
  624. </section>
  625. </div>
  626. </article></main></body></html>