DITA-messages-details.html 52 KB

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