Deelnemen aan het documenteren van bakens, criteria en filters van SPIP

Iedereen kan deelnemen. De vereisten zijn tot een minimum beperkt:

• je moet een account hebben op spip.net;
• je moet een baken, voorwaarde,... kennen die niet gedocumenteerd is en een toepassing ervan kennen;
• je moet dit artikel lezen om te begrijpen welke eisen aan de documentatie gesteld worden.

De titel van het artikel

• een filter: |naam_van_het_filter
• een baken: #NAAM_VAN_HET_BAKEN
• een voorwaarde: {naam_van_de_voorwaarde}

Samenvatting van het gedocumenteerde element

De koptekst dient om het concept te introduceren:

• een of twee samenvattende zinnen as presentatie van het element. De tekst wordt gebruikt door de modellen <critereXX>,<baliseXX> (een voorbeeld van dit gebruik De lus ARTICLES (artikelen)).

Het concept beschrijven

In het veld Tekst staat de uitgebreide beschrijving (zo uitgebreid mogelijk) van het gedocumenteerde element:

• een hoofdletter aan het begin van een zin
• de naam van het element tussen de opmaakcodes <code> en </code>, lbijvoorbeeld: «het baken #BAKEN ...»), de URL’s van het privé gedeelte (bijvoorbeeld: «ga naar ?exec=config_fonctions ...»), het weergegeven resultaat (bijvoorbeeld: «de weergegeven datum is van het type 1970-01-01 00:00:00»)
• geef de voorkeur aan (beter leesbare) opmaakcodes <code> en </code> boven <cadre> en </cadre>
• bouw een structuur in de tekst (tussentitels, paragrafen).

-  Algemeen

• beperk je tot het element zelf (probeer niet alles uit te leggen, vermijd uitweiding, tips en trucs, ...)
• verifieer minimaal (door de code te lezen) de verstrekte gegevens

Gebruik van trefwoorden

Trefwoorden hebben in de documentatie van SPIP alleen bij de Franstalige artikelen een speciale functie. Ze kunnen uitsluitend door de beheerders van de site worden aangemaakt.

• Geef aan vanaf welke versie van SPIP het gedocumenteerde van toepassing is. Hiervoor kan een schrijfwijze: (vanaf [{}->artxxxx]) waarbij «xxxx» de ID is van het artikel dat de SPIP-versie beschrijft en waarbij de {} het mogelijk maakt naar de juiste taalversie van het artikel te gan, wat ook het werk van vertales vergemakkelijkt (zie: Automatische meertalige referenties in de documentatie).
• Voor bakens:
  • Geef aan of het «statisch» baken is (afgeleid van de database) of een «dynamisch» baken (berekend, verwerkt door een functie)
• geef indien van toepassing (bijvoorbeeld bij een baken) het type lus aan
• doe je best  :-)  

... wordt vervolgd