Participate in the documentation of tags, criteria, SPIP filters
Anyone can participate. The requirements are reduced to the essential:
- to have an account on spip.net: https://www.spip.net/spip.php?page=identifiants;
- 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 backticks (example: «the tag
#BALISE...»), private area urls (example: «going to?exec=config_fonctions...»), sometimes the result displayed (example: «the displayed date will be1970-01-01 00:00:00»); - 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).
Generally
- stick to document the only item in question (do not try to say everything, avoid digressions, tips and tricks, too specific examples...),
- check «a minima» (reading the code: http://core.spip.org/projects/spip/repository/show/branches/spip-3.2) the information provided.
Use keywords
- Indicate the SPIP version that introduced the documented element. o do this, use one of the keywords available in the "SPIP version (since)" group.
- 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.