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

Syntax starting elements


    1  meta
       1.1  Example
    2  altTitle
          2.1.1  Relationship with the redirect article types
       2.2  Example
    3  seeAlso
       3.1  Example
    4  infobox
       4.1  Example
    5  articleCondition
       5.1  Example
    6  Ordering of the elements
    7  Notes
    8  See also

This article explains the XML tags which can be used at the beginning of articles. The following elements can be used at the beginning of articles:
  • "meta": specifies the text which should be written as an explanation for an article
  • "altTitle": specify alternate titles for the article
  • "seeAlso": allows to add a text at the beginning of the article (before the table of contents) which can refer to another article which can have a similar title or subject
  • "infobox": a fixed-format table added to the top right-hand corner of articles to consistently present a summary of some unifying aspect that the articles share
  • "articleCondition": a condition to include the article in the wiki

meta

Main Article: Regular article

The "meta" element specifies the text which should be written as an explanation for an article in the dictionary or categories.

Example

  <meta desc="This text will appear in the dictionary and categories listings" />

altTitle

Main Article: Regular article

The "altTitle" element allows to specify alternate titles for the article. These titles will be used for the dictionary, the categories, and even the autocomplete search box.

By default the alternate titles will be used in the autocomplete search box, and will be visible in the dictionary and categories. if the "dictionary" attribute is false[1]
It an also be spelled "dictionnary"
, then it will only be used in the search box.

Relationship with the redirect article types

Contrary to the redirect article types, "altTitle" elements allow to specify more than one alternate title for one article. However, it does not allow to redirect to a title or anchor inside an article.

Example

  <article desc="article name">
    <altTitle desc="the other name" />
  </article>

seeAlso

The "seeAlso" element allows to add a text at the beginning of the article (before the table of contents) which can refer to another article which can have a similar title or subject. The attributes of this element are:
  • "this": a text to refer to the article
  • "other": a text to refer to the other article
  • "id": the identification of the other article
  • "package": the optional package

Example

  <article desc="article">
    <seeAlso this="this article is about the first subject" other="about another subject" id="article 2" />
  </article>

infobox


The "infobox" element allows to add an infobox at the beginning of an article. As for wikipedia, an infobox is a fixed-format table added to the top right-hand corner of articles to consistently present a summary of some unifying aspect that the articles share.

The "infobox" element define the values for the properties specified in the associated infobox template.

Example

See infobox template.

articleCondition

Main Article: articleCondition

The "articleCondition" element specifies that the article will be present in the wiki only if the condition is evaluated as true.

Example

The article will only be present if "myProperty" exists:
   <article desc="an article">
     <articleCondition property="myProperty" />
     The article content
   </article>

Ordering of the elements

The order of the "meta", "altTitle", "infobox", and "seeAlso" is not significant.

For example, these two declarations are both valid:
   <article desc="article name">
     <meta desc="This text will appear in the dictionary and categories listings" />
     <altTitle desc="the other name" />
   </article>
or:
   <article desc="article name">
     <altTitle desc="the other name" />
     <altTitle desc="yet another name" />
     <meta desc="This text will appear in the dictionary and categories listings" />
   </article>

Notes

  1. ^ It an also be spelled "dictionnary"

See also


Categories: syntax

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