Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

References



Interwiki links allow to define links to:

Referencing an article

Suppose the following article:
<article id="thisArticle" desc="my article">
   <title title="first chapter"/>
   ...
</article>
This article can be referenced through any of the following constructions:
   <ref id="thisArticle" />
   <ref id="my article" />
   <ref id="my_article" />

Referencing the index article

To specify a reference to the index article, just use the _index_ or _INDEX_ name for the reference id. For example:
  The <ref id="_index_" />

Referencing an anchor

The "id" of the anchor will be used for the anchor reference. For example, suppose the following article:
   <article desc="my article">
      <title title="first chapter"/>
      The text with an <anchor id="the Anchor" desc="anchor" />.
      ...
   </article>
The anchor can be referenced through any of the following constructions:
   <ref id="my article#the Anchor" />
   <ref id="my article#the anchor" />      
   <ref id="my_article#the_anchor" />      
   <ref id="my_article#the_Anchor" />

Referencing a chapter or title


Example

Suppose the following article:
<article id="thisArticle" desc="my article">
   <title title="first chapter"/>
   ...
</article>
This article can be referenced through any of the following constructions:
   <ref id="thisArticle" />
   <ref id="my article" />
   <ref id="my_article" />
The article chapter can be referenced through any of the following constructions:
   <ref id="thisArticle#first chapter" />
   <ref id="thisArticle#first_chapter" />
   <ref id="my article#first chapter" />
   <ref id="my_article#first_chapter" />

Unresolved references

Main Article: packages dependencies

By default unresolved references will emit an error during the generation, but it is possible to set the packages dependencies to specify that unresolved references from one package to another will not emit an error.

See also


Categories: structure

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.