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

Naming constraints



When referencing the names of articles and titles, the case for the name is not important.

For example for the article "my article", all the following references will correctly link to this article:
  • "my article"
  • "my_article"
  • "My Article"
  • "MY ARTICLE"

Naming algorithm

The algorithm which is used to give the id of an article or chapter / title is the following:
  • The name is trimmed[1]
    For example " name " is replaced by "name"
  • All consecutive spaces are replaced by one space[2]
    For example "the name" is replaced by "the name"
  • Spaces are replaced by an underscore character[3]
    For example "the name" is replaced by "the_name"
  • Accented characters are replaced by their unaccented equivalent character
  • Upper-case letters are replaced by their associated lower-case letter
  • Digits an lower-case letters are kept
  • The following characters are kept: "#.()+-_"
  • Other characters are removed from the result

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 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" />

Notes

  1. ^ For example " name " is replaced by "name"
  2. ^ For example "the name" is replaced by "the name"
  3. ^ For example "the name" is replaced by "the_name"

See also


Categories: structure

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