How to participate in the documentation of SPIP

Participate in the documentation of tags, criteria, SPIP filters

Anyone can participate. The requirements are reduced to the essential:

  • to have an account on;
  • to know of a tag, a criterion, ... not documented and a use associated with it;
  • to have read this article to understand some specificities related to documentation.

The Title

  • for a filter: |nom_du_filtre
  • for a tag: #NOM_DE_LA_BALISE
  • for a criterion: {nom_du_critère}

Summarise the documented element

The Introduction serves to introduce the concept:

  • One or two short sentences of text or presentation of the element.

Describe the concept

The field text is used for exhaustive description (where possible) of the documented element:

  • capitalize first letter of sentence
  • the name of the element should be enclosed in <code> and </code> tags (example: «the tag #BALISE ...»), private area urls (example: «going to ?exec=config_fonctions ...»), sometimes the result displayed (example: «the displayed date will be 1970-01-01 00:00:00»);
  • favour tags (more readable) <code> and </code> instead of <cadre> and </cadre>;
  • prioritise its text (headings, paragraphs);
  • use the expression [{}->N] which automatically manages multilingual documentation to reference the item number N (see Multilingual internal references in the documentation).


Use keywords

  • Indicate the SPIP version that introduced the documented element. For this, use writing: (since [{}->artxxxx]) where «xxxx» is the id of the article presenting the SPIP version and where {} allow, if necessary, the automatic forwarding to the translation of the article, thereby facilitating the work of translators (see: Multilingual internal references in the documentation).
  • For the tags indicate if it is «static» (returned from the database) or «dynamic» (calculated, processed by a function).
  • Indicate if necessary (for example for a tag) the type of loop concerned.

Do your best…  :-)  

Author jack Published :

Translations : English, français