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

Categories description



It is possible to add descriptions to categories. This can be specified in XML files with the "categories" root. Each "category" element allows to specify its description, which will be presented in the categories list.

Rules for categories

  • You can have as many files for categories description as you want
  • You don't need to specify categories descriptions file. If there is no description for a category[1]
    Because the category only appears in articles
    , the description of the category in the html page for the category will be empty
  • If there is a description for a category but no article belongs to this category, the category will not be present[2]
    There willl be no categories without any article associated with it

Setting detailed descriptions

It is possible to have more than just a sentence for the description of a category. For example:
   <categories>
      <category id="syntax" desc="Articles about syntax">
   This category deals about the articles syntax.
      </category>
      <category id="structure" desc="Articles about structure"/>
   </categories>
Note that the description attribute is however always required and will be used when presenting the link to the category in the list of categories page.

Example

The following file specifies two categories with descriptions:
   <categories>
      <category id="syntax" desc="Articles about syntax"/>
      <category id="structure" desc="Articles about structure"/>
   </categories>

Notes

  1. ^ Because the category only appears in articles
  2. ^ There willl be no categories without any article associated with it

See also


Categories: structure

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