quelques lacunes dans la doc

Après avoir passé quelque temps à implémenter de nouvelles fonctions sur
un site SPIP, j'ai pris note de quelques lacunes dans la documentation
du site spip.net qui me paraissent assez importantes pour les mentionner
ici.

1) L'article "La boucle ARTICLES"

http://www.spip.net/fr_article902.html

L'article ommet de préciser ce signifient les chiffres exprimés sous la
forme {0,1}

Ce filtre est fondamental, et il figure dans de nombreux squelettes,
comme ceci:
<BOUCLEn(ARTICLES){id_rubrique}{par date}{inverse}{0,1}

On comprend rapidement que cette boucle affiche l'article le plus
récent, toutefois le rapport entre les deux chiffres n'est pas forcément
évident, cela mériterait donc d'être explicité clairement dans cet
article de référence.

*****************

2) L'article consacré au filtre "| ?{sioui, sinon}"

http://www.spip.net/fr_article4186.html

En parcourant les forums à la recherche d'opérations conditionnelles
complexes, on tombe régulièrement sur des exemples construits de cette
manière:

  [(#OBJET|?{' ',''}) code exécuté si l'objet existe ]
  [(#OBJET|?{'',' '}) code exécuté si l'objet n'existe pas ]
  
Cette méthode est incontestablement fort utile pour vérifier l'existence
d'un #LOGO d'article, ou de toutes sortes d'autres éléments.

Or la logique de ce |?{' ',''} est loin d'être intuitive, ce serait donc
un bon enrichissement pour l'article cité que d'en expliquer le
fonctionnement et de donner un exemple d'utilisation.

***************

3) L'article "La syntaxe des boucles"

http://www.spip.net/fr_article898.html

C'est un article fondamental pour les débutants SPIP, il est donc
indispensable qu'il fournisse une information claire et complète.

Dans le paragraphe qui commence par "Le code alternatif (terminé par
<//Bn>) est affiché à la place de la boucle", il serait bon de préciser
qu'une boucle placée dans cette endroit ne sera pas exéctuée. Dans
l'état actuel de l'article, on ne peut que le supposer.

**************

4. Exemples de boucles conditionnelles

D'autre part je trouve que les exemples concernant l'usage de boucles
conditionnelles sont trop limités, se contentant toujours d'une seule
condition "if/else".

Dans le cas d'applications réelles, on sera souvent confronté à des
situations où il faut *trois* options, comme ceci par exemple:

* Si l'article a une image-logo, afficher cette image.
* Sinon, vérifier si l'article a des images attachées, et en afficher une.
* Sinon, afficher une image aléatoire tirée d'une rubrique prédéfinie.

Il m'a été extrêment difficile de trouver dans la documentation de
spip.net ne serait-ce qu'une piste de solution. En cherchant à travers
les forums et archives mailing-listes, j'ai bien sûr fini par trouver
une méthode (faisant usage du |?{sioui,sinon} décrit ci-dessus) mais je
n'ai aucun moyen de savoir s'il s'agit de la méthode la plus élégante et
stable, ou si j'ai conçu un bricolage aberrant qui risque d'être
invalidé par la prochaine mise à jour... Ce n'est pas que je demande des
solutions toutes faites pour chaque cas de figure, mais me sentirais
plus à l'aise en sachant que j'emploie une technique certifiée conforme
par les experts SPIPiens :wink:

J'espère que ces remarques parviendront aux architectes de spip.net.
S'il y a un meilleur endroit pour les poster que cette liste, faites-moi
signe...
--
Manuel
SPIP Community Geneva

tar.gz a écrit :

Après avoir passé quelque temps à implémenter de nouvelles fonctions sur
un site SPIP, j'ai pris note de quelques lacunes dans la documentation
du site spip.net qui me paraissent assez importantes pour les mentionner
ici.

1) L'article "La boucle ARTICLES"

La boucle ARTICLES - SPIP

L'article ommet de préciser ce signifient les chiffres exprimés sous la
forme {0,1}

Ce filtre est fondamental, et il figure dans de nombreux squelettes,
comme ceci:
<BOUCLEn(ARTICLES){id_rubrique}{par date}{inverse}{0,1}

On comprend rapidement que cette boucle affiche l'article le plus
récent, toutefois le rapport entre les deux chiffres n'est pas forcément
évident, cela mériterait donc d'être explicité clairement dans cet
article de référence.

- {a,b} où a et b sont des chiffres. Ce critère permet de limiter le nombre de résultats. a indique le résultat à partir duquel on commence l’affichage (attention, le premier résultat est numéroté 0 - zéro) ; b indique le nombre de résultats affichés.

Par exemple {0,10} affiche les dix premiers résultats ; {4,2} affiche les deux résultats à partir du cinquième (inclus).

Chag

--
"Ca ne marche pas" ne veut rien dire. Alors ne dites rien (ou développez !)
"it doesn't work" means nothing. So, say nothing (or say more !)

tar.gz a écrit :

  [(#OBJET|?{' ',''}) code exécuté si l'objet existe ]
  [(#OBJET|?{'',' '}) code exécuté si l'objet n'existe pas ]

juste : il vaut surement mieux utiliser les filtres |oui et |non...

JLuc

Bonjour Manuel

Merci pour ces retours constructifs. En effet cette liste est le bon
point de départ pour remonter les remarques.

Comme certaines des remarques ne peuvent être traitées simplement du
fait de l'organisation de la documentation, peux tu publier tes
remarques dans les forums privé des articles concernés ?

En publiant dans les forums des articles cela évite de noyer une
information précise au mileu des autres sujets. Cela permet aussi de
remonter aux contributeurs de la documentation inscrit sur la liste
dédiée spip-trad.

Pour s'inscrire sur spip.net : http://www.spip.net/spip.php?page=login

Les articles concernés :
http://www.spip.net/ecrire/?exec=articles&id_article=902
http://www.spip.net/ecrire/?exec=articles&id_article=4186
http://www.spip.net/ecrire/?exec=articles&id_article=898

Km

Merci pour les retours!

@ Km - je vais suivre ton conseil et remonter les remarques dans les
forums des articles.

@ JLuc - merci pour le tuyau concernant les filtres |oui |non !! c'est
exactement ce type de renvoi qui me manquait dans la doc officielle. Je
vois ces filtres mentionnés dans
http://programmer.spip.org/Les-filtres-de-tests alors qu'ils ne sont pas
(encore) listés dans le Glossaire de spip.net -- donc pour quelqu'un qui
progresse pas à pas en analysant les squelettes-dist et se réfère aux
articles d'introduction, ce n'est pas évident de tomber là-dessus.

@ Chag - voilà en effet qui comble ma lacune #1, visiblement j'étais
passé à côté de cet article.

--
Manuel

cam.lafit@azerttyu.net said the following on 17/09/09 11:20:

Bonjour Manuel

Merci pour ces retours constructifs. En effet cette liste est le bon
point de départ pour remonter les remarques.

Comme certaines des remarques ne peuvent être traitées simplement du
fait de l'organisation de la documentation, peux tu publier tes
remarques dans les forums privé des articles concernés ?

En publiant dans les forums des articles cela évite de noyer une
information précise au mileu des autres sujets. Cela permet aussi de
remonter aux contributeurs de la documentation inscrit sur la liste
dédiée spip-trad.

Pour s'inscrire sur spip.net : SPIP

Les articles concernés :
SPIP
SPIP
SPIP

Km