Modularisation de la documentation : #BALISE, {critères}, |filtre

Bonjour à tous

Pour resituer, il y a quelque temps (troglos mai 2008) on avait émis
l'idée de restructurer la documentation concernant les balises, les
critères et filtres pour gagner en souplesse.

Remarques :
-* je parle {{d'élément}} pour parler indifféremment de balises/critères/filtre
-* j'utilise le terme {{d'objet/objet SPIP}}, pour définir la notion
générique ARTICLES/RUBRIQUES/....

{{{Problématique}}}

Dans les constats on pouvait lister :

-* La difficulté à préparer une documentation en amont de la
publication d'une nouvelle version stable
-** Exemples :
-*** l'arrivée des filtres |et, |ou, ..;
--*** #CONNECT
En l'état on était obligé :
- soit d'attendre que la nouvelle version officielle soit sortie pour
lancer les projets de documentation
- soit de publier une information non valide au vu de la version stable
Du coup on se retrouve dans tous les cas avec un documentation non
pertinente vis à vis de la version stable du moment.

-* Duplication d'une meme information dans plusieurs articles pour le
même élément.
-** Exemples :
-*** les filtres images (http://www.spip.net/fr_article3327.html,
http://www.spip.net/fr_article901.html)
-*** des balises perdues dans les annonces des sorties
(http://www.spip.net/fr_article3368.html#CHEMIN)
Ce qui amène le risque d'avoir des informations différentes sur le même élément

-* Difficulté à rédiger un article transversal
-** Exemples :
-*** images_* sans recréer toute une partie de la documentation
-*** Générer le glossaire depuis la liste des articles référencés (à terme)
On retrouve les problèmes liés de la duplication de l'information, le
risque d'oublier de document un élément dans tous les articles y
faisant référence.

Bon à cette étape j'espère vous avoir convaincu que pour le moment la
solution que nous avons n'est pas optimale.
Si c'est le cas, on peut essayer pour voir une autre solution :slight_smile: Sinon
tant pis pour moi mais au moins j'aurais essayé :stuck_out_tongue:

{{{Une proposition d'amélioration}}}

La solution proposée :
-* maintient l'existant, si les traductions ne suivent et ben on ne perd rien
-* prend en compte la problématique du multilinguisme
-* permet d'afficher une explication dans la langue de référence si la
traduction n'est pas encore publiée
-* modularise les divers éléments SPIP pour pouvoir les traiter indépendamment
-* pouvoir rédiger plusieurs articles distincts sur un même élément si
la fonctionnalité est différente selon le contexte (grâce à
l'utilisation des mots clefs)

Evolutions imaginées :
-* affecter un mot clef pour la version SPIP pour chaque éléments et
permettre de n'afficher les elements valable que pour une version
donnée
-*

Bien sur on peut lister au moins comme défauts :
-* beaucoup de petits articles
-* la nécessité de mettre en place le concept "d'objet SPIP" comme
pour #TEXTE qui est signifie la même chose pour les différents objets
(ARTICLES, RUBRIQUES, ...)
-* le fait que les articles de références sont obligatoirement le
français (en tout cas avec le modèle existant)

On le constate avec http://www.spip.net/fr_article3856.html qui est
tout petit et qui n'est pas assez générique (on parle de ARTICLES et
non des objets en général).

{{{Le fonctionnement}}}

-* Pour les articles de références
-** Faire un article par balise/filtre/critères (se reporter à
http://www.spip.net/ecrire/?exec=naviguer&id_rubrique=543)
-** Le titre doit être le nom de l'élément explicité (dans l'idée de
les exploiter dans le glossaire)
-** Affecter les mots clefs qui vont bien (la boucle concernées pour
les balises et critère, les balises concernées pour les filtres)
-** Dans les articles de fond utiliser les modèles <criteresXX>,
<baliseXX> où XX est un id des mots clefs.
(http://www.spip.net/ecrire/?exec=articles&id_article=902)

-* Pour les traductions
-** Créer les rubriques obligatoirement nommée <code>balises</code> et
<code>critères</code>,
-** Rédiger les traductions dedans (pour prendre en compte le contexte
de langue)

-* Affichage des données
-** Le modèle parcours les articles correspondant au mot clef dans la
langue de référence (français)
-** Pour chaque article de référence, le modèle recherche la version traduite :
-*** si celle ci existe, on l'affiche
-*** sinon on affiche dans la langue de référence.

Les modèles ont été mis sur la zone
(http://zone.spip.org/trac/spip-zone/changeset/25536/). Ils sont à
améliorer.

{{{Démonstration}}}

J'ai fait le travail pour la boucles ARTICLE dans la version française
et anglaise pour les critères et les balises statiques.
Les balises et critères :
http://www.spip.net/ecrire/?exec=naviguer&id_rubrique=143
http://www.spip.net/ecrire/?exec=naviguer&id_rubrique=199

La boucle ARTICLES :
(fr) http://www.spip.net/ecrire/?exec=articles&id_article=902
(en) http://www.spip.net/ecrire/?exec=articles&id_article=2083
Comme vous pouvez le voir (avec les publications) le travail se fait
assez rapidement.

{{{Questions ??? }}}

Qu'en pensez vous ? Est ce que vous êtes d'accord pour tester ? Que
faudrait il faire pour améliorer cette suggestion ?

Km

PS : j'avais réouvert cette discussion dans un ancien fil, mais noyé
dans l'ensemble des publications il semble que ce soit plus perdu
qu'autre chose.

Bon, J'ai fais la meme chose avec l'article "la boucle articles" et les balises et criteres en arabe et ca a l'air pas mal surtout en ce qui concerne les mises a jour futures de ces concepts.

Mais je n'ai pas compris quel etait le probleme concernant les balises calculee par SPIP dans l'article.

Autre chose et concernant l'amelioration on ne pourrait pas rattacher les mots cle aux articles et a leurs traductions en meme temps et d'un coup? j'avoue que ajouter les mots cle a l'article de reference (ici la boucle articles) est assez fastidieux.

Troisieme chose, est ce qu'il y a deja une idee sur comment intergrer le multilinguisme dans la page de glossaire: Glossaire - SPIP?

George

cam.lafit@azerttyu.net wrote:

Bonjour à tous

{{{Démonstration}}}

J'ai fait le travail pour la boucles ARTICLE dans la version française
et anglaise pour les critères et les balises statiques.
Les balises et critères :
SPIP
SPIP

La boucle ARTICLES :
(fr) SPIP
(en) SPIP
Comme vous pouvez le voir (avec les publications) le travail se fait
assez rapidement.

{{{Questions ??? }}}

Qu'en pensez vous ? Est ce que vous êtes d'accord pour tester ? Que
faudrait il faire pour améliorer cette suggestion ?

Km

Bonjour

Bon, J'ai fais la meme chose avec l'article "la boucle articles" et les
balises et criteres en arabe et ca a l'air pas mal surtout en ce qui
concerne les mises a jour futures de ces concepts.

bonne nouvelle :slight_smile: J'avais un doute sur le fait que les traducteurs
suivent cette proposition. Mine de rien de découper comme ça ça
demande du travail.
J'ai vu aussi que la version catalane était en cours.

Mais je n'ai pas compris quel était le problème concernant les balises
calculee par SPIP dans l'article.

Lorsque j'ai fait les modèles, je n'ai pas fait attention aux divers
concepts pour les balises :
-* les statiques (issu de la base de données)
-* et les calculées (avec un traitement supplémentaire).
Ce qui me fait penser à un autre concept, pour les balises comme
#AUTORISER, #GET, #ARRAY, .... , je ne sais pas comment catégoriser ce
groupe.

Donc pour le moment on se retrouve avec la possibilité de lier un
unique lot de balises, sans possibilité de distinguer ces 3 cas.
Pour le moment je vois 2 solutions :
-* rajouter des mots clefs pour gérer les type de balises
-* faire des sous rubriques

De plus on rencontre un autre problème comme me la fait remarquer Fil
avec #AUTORISER, on se retrouve avec un article de fond trop complet
pour être intégrer dans un article comme on le fait avec la boucle
ARTICLES
Pour ça je vois encore 2 solutions :
-* Profiter des champs #DESCRIPTIF pour la version courte et #TEXTE
pour une version longue. Si on n'a pas de version longue comme pour
{id_article} on utilise le contenu de #TEXTE pour l'explication longue
et courte.
-* Utiliser des mots clef et faire de nouveaux articles pour les
versions longues.

Pour ma part je pense plus pertinent la première solution, mais je
n'ai pas regardé comme était géré les différents champs au niveau du
squelette du site.

Comme j'étais pas sur du mouvement que vous suivrez, j'ai préféré
attendre vos retours avant de continuer à faire évoluer les modèles.

Autre chose et concernant l'amelioration on ne pourrait pas rattacher les
mots cle aux articles et a leurs traductions en meme temps et d'un coup?
j'avoue que ajouter les mots cle a l'article de reference (ici la boucle
articles) est assez fastidieux.

Ah oui le fait de créer un traduction, ça ne duplique pas les
affectations de mots clefs.
C'est sur que ça pourrait être pratique à moins qu'il y est une astuce.
Pour les modèles <balisesXX>, <criteresYY>, ce n'est pas trop gênant
vu qu'on s'appuie d'abord sur les articles de référence avant de
chercher les traductions disponibles.

Troisieme chose, est ce qu'il y a deja une idee sur comment intergrer le
multilinguisme dans la page de glossaire: Glossaire - SPIP?

^^
En fait pas encore, pour ma part ça cogite encore un peu mais avec
cette modularisation on devrait plus facilement s'en sortir.

Pour la suite du chantier, je voulais d'abord avoir votre avis avant
de continuer à tout casser.

Km

J'ai pense a une chose (la nuit porte conseil): actuellement il y a autant de micro articles et de mots cle qu'il y a des balises (statiques?) et de criteres. On ne pourrai pas simplement dans les modeles balsies et criteres remplacer les boucles ARTICLES par de boucles MOTS et se debarasser des petits articles?

la description de la balise ou du critere pourrai se trouver en <multi> (pour les trad) dans le descriptif ou le texte du mot cle.

George

cam.lafit@azerttyu.net wrote:

Bonjour

Bon, J'ai fais la meme chose avec l'article "la boucle articles" et les
balises et criteres en arabe et ca a l'air pas mal surtout en ce qui
concerne les mises a jour futures de ces concepts.
    
bonne nouvelle :slight_smile: J'avais un doute sur le fait que les traducteurs
suivent cette proposition. Mine de rien de découper comme ça ça
demande du travail.
J'ai vu aussi que la version catalane était en cours.

Mais je n'ai pas compris quel était le problème concernant les balises
calculee par SPIP dans l'article.
    
Lorsque j'ai fait les modèles, je n'ai pas fait attention aux divers
concepts pour les balises :
-* les statiques (issu de la base de données)
-* et les calculées (avec un traitement supplémentaire).
Ce qui me fait penser à un autre concept, pour les balises comme
#AUTORISER, #GET, #ARRAY, .... , je ne sais pas comment catégoriser ce
groupe.

Donc pour le moment on se retrouve avec la possibilité de lier un
unique lot de balises, sans possibilité de distinguer ces 3 cas.
Pour le moment je vois 2 solutions :
-* rajouter des mots clefs pour gérer les type de balises
-* faire des sous rubriques
  

S'lt

J'étais en fait de le refléchir à l'envers :slight_smile:
C'est à dire faire les micro articles et comme les mots clefs
deviennent redondant de les supprimer à terme.

Je crains que de faire les mots en mutli soit compliqué à gérer, car
il ne sera plus possible de savoir :
- quels élément ont été traduits dans une langue donnée (ce qu'on
retrouve avec les liens de traductions dans les articles)
- si les traductions sont triés dans le meme ordre d'un mot clef à un autre.

C'est ces 2 points qui m'ont fait partir plutot sur les articles que
sur les mots clefs.

Si vous pensez que les multi et mot clefs sont mieux, c'est le bon
moment pour changer :slight_smile:

(reflexion derniere minute) De plus le fait de passer en mot clef, je
ne vois pas comment on gére les cas comme autorisation avec un
descriptif court et un long

Km

Le 31 déc. 08 à 09:59, cam.lafit@azerttyu.net a écrit :

Je crains que de faire les mots en mutli soit compliqué à gérer, car
il ne sera plus possible de savoir :
- quels élément ont été traduits dans une langue donnée (ce qu'on
retrouve avec les liens de traductions dans les articles)
- si les traductions sont triés dans le meme ordre d'un mot clef à un autre.

Un élément à verser au dossier: mon chantier en cours est la nouvelle syntaxe des squelettes,
que je compte bien rendre multi-lingue. Partant, il faudra envisager d'ajouter à la table des mots-clés un champ id_trad si on veut gérér ça proprement dans la doc. Ca ferait un argument de plus.

Committo,Ergo:Sum

C'est interessant ca: Ca veut dire qu'il y aurait un mot cle par traduction comme pour les articles?

George

Emmanuel Saint-James wrote:

Le 31 déc. 08 à 09:59, cam.lafit@azerttyu.net a écrit :

Je crains que de faire les mots en mutli soit compliqué à gérer, car
il ne sera plus possible de savoir :
- quels élément ont été traduits dans une langue donnée (ce qu'on
retrouve avec les liens de traductions dans les articles)
- si les traductions sont triés dans le meme ordre d'un mot clef à un autre.

Un élément à verser au dossier: mon chantier en cours est la nouvelle syntaxe des squelettes,
que je compte bien rendre multi-lingue. Partant, il faudra envisager d'ajouter à la table des mots-clés un champ id_trad si on veut gérér ça proprement dans la doc. Ca ferait un argument de plus.

Committo,Ergo:Sum

S'lt

Pour faire le distingo entre balises calculée et balises statique,
j'ai mis à jour le modele balises.html

Il faut maintenant faire <balisesXX|statique> ou <balisesXX|calculee>
"statique" et "calculee" sont 2 mots clefs definis dans le groupe "Balises"

La prochaine évolution sera d'utiliser le champ #DESCRIPTIF et #TEXTE
si on souhaite faire un article plus complet sur une balise comme on
peut le souhaiter avec #AUTORISER, #SESSION, ...

Hi

J'ai pense a une chose concernant les petits articles des balises: il y a des balises qui sont communes (dans leur nom du moins) a plusieurs entites, par exemple #TITRE, #TEXTE, #DESCRIPTIF.

Je ne crois pas qu'ill faille creer un article #TITRE pour l'article de reference "la boucle ARTICLES" et un autre article #TITRE pour l'article de reference "la boucle RUBRIQUES" etc.

On peut avoir un texte generique dans le micro article #TITRE qui marche pour tous les article de reference qui utilise la balise #TITRE, ou meme mieux completer le modele balisesxx par une autre variable. exemple:

le texte du micro article #TITRE sera: "le titre de "
puis dans l'article "la boucle ARTICLES" on mettrai <balisesXX|element=l'article> ce qui donnera "#TITRE: le titre de l'article"
puis dans l'article "la boucle RUBRIQUES" on mettrai <balisesXX|element=la rubrique> ce qui donnera "#TITRE: le titre de la rubrique".

Est ce que ca va comme idee ou non?

George

Quoting "cam.lafit@azerttyu.net" <cam.lafit@azerttyu.net>:

S'lt

Pour faire le distingo entre balises calculée et balises statique,
j'ai mis à jour le modele balises.html

Il faut maintenant faire <balisesXX|statique> ou <balisesXX|calculee>
"statique" et "calculee" sont 2 mots clefs definis dans le groupe "Balises"

La prochaine évolution sera d'utiliser le champ #DESCRIPTIF et #TEXTE
si on souhaite faire un article plus complet sur une balise comme on
peut le souhaiter avec #AUTORISER, #SESSION, ...

S'lt

Je ne crois pas qu'ill faille creer un article #TITRE pour l'article [...]
"la boucle ARTICLES" et un autre [...] pour l'article [...]
"la boucle RUBRIQUES" etc.
On peut avoir un texte generique dans le micro article #TITRE qui marche
pour tous les article de reference qui utilise la balise #TITRE,

C'est ce que je voulais dire avec ceci :

-* la nécessité de mettre en place le concept "d'objet SPIP" comme
pour #TEXTE qui est signifie la même chose pour les différents objets
(ARTICLES, RUBRIQUES, ...)

ou meme
mieux completer le modele balisesxx par une autre variable. exemple:

le texte du micro article #TITRE sera: "le titre de "
puis dans l'article "la boucle ARTICLES" on mettrai
<balisesXX|element=l'article> ce qui donnera "#TITRE: le titre de l'article"
puis dans l'article "la boucle RUBRIQUES" on mettrai <balisesXX|element=la
rubrique> ce qui donnera "#TITRE: le titre de la rubrique".

J'aime bien l'idée pour ma part.

Mais comme cela va se comporter avec les traductions ?
Cela obligerait de faire ?
[fr] <balisesXX|element=larubrique>
[en] <balisesXX|element=thesections>

il faudrait essayer de trouver un moyen pour que l'appel au modele
soit générique toute langue confondue. Là j'ai pas d'idée.

km

Quoting "cam.lafit@azerttyu.net" <cam.lafit@azerttyu.net>:

le texte du micro article #TITRE sera: "le titre de "
puis dans l'article "la boucle ARTICLES" on mettrai
<balisesXX|element=l'article> ce qui donnera "#TITRE: le titre de l'article"
puis dans l'article "la boucle RUBRIQUES" on mettrai <balisesXX|element=la
rubrique> ce qui donnera "#TITRE: le titre de la rubrique".

J'aime bien l'idée pour ma part.

Mais comme cela va se comporter avec les traductions ?
Cela obligerait de faire ?
[fr] <balisesXX|element=larubrique>
[en] <balisesXX|element=thesections>

il faudrait essayer de trouver un moyen pour que l'appel au modele
soit générique toute langue confondue. Là j'ai pas d'idée.

Non, il suffit que dans chaque article reference on mette la valeur de l'argument dans la langue de l'article:

Dans "la boucle RUBRIQUES" francais on met <balisesXX|element=la rubrique> et dans "the RUBRIQUES loop" anglais on met <balisesXX|element=the section>

et ainsi de suite

George

S'lt

Je viens de rajouter un comportement aux modeles.
Premier cas d'utilisation avec
http://www.spip.net/ecrire/?exec=articles&id_article=3981

Vu que nous avons certains critres, filtres dont l'explication est
trop conséquente, on peut ajoindre un resumé dans le chapo.

Lorsqu'on fait appel au modeles, on vérifie la présence d'un #CHAPO si
celui est présent on l'affiche sinon on se replie sur le #TEXTE.

Dans la liste des chose à faire :
* Si on a la chapo, rajouter un lien vers l'article complet : Plus
d'information sur le critère/la balise XXX
     mais il y a surement une histoire de chaine de langue à mettre en place.
* Rajouter l'argument element de George.
* ...

Km

Hi

Je n'ai pas bien compris ce que tu veux dire par consequente.
D'apres ton dernier commit, si on prend l'article #SESSION par exemple qui a un chapo et un texte, on ne verra que le chapo dans l'article de reference et non le texte, ou ai-je compris de travers?

George

cam.lafit@azerttyu.net wrote:

S'lt

Je viens de rajouter un comportement aux modeles.
Premier cas d'utilisation avec
SPIP

Vu que nous avons certains critres, filtres dont l'explication est
trop conséquente, on peut ajoindre un resumé dans le chapo.

Lorsqu'on fait appel au modeles, on vérifie la présence d'un #CHAPO si
celui est présent on l'affiche sinon on se replie sur le #TEXTE.

Dans la liste des chose à faire :
* Si on a la chapo, rajouter un lien vers l'article complet : Plus
d'information sur le critère/la balise XXX
     mais il y a surement une histoire de chaine de langue à mettre en place.
* Rajouter l'argument element de George.
* ...

Km

S'lt

Je n'ai pas bien compris ce que tu veux dire par consequente.

Par "conséquent" je pensais à "long", "fortement descriptif" comme
pour #AUTORISATION ou bien {like}. Dans la cas où l'explication mérite
plus qu'un simple ligne contextuelle tel qu'on l'a pour #ID_AUTEUR

D'apres ton dernier commit, si on prend l'article #SESSION par exemple qui a
un chapo et un texte, on ne verra que le chapo dans l'article de reference
et non le texte, ou ai-je compris de travers?

C'est ça l'idée.
Quand on n'a rien à dire sur un critere/balise, on ne remplit que le texte
Quand on souhaite aller plus loin, on donne une explication succinte
dans chapo et on détaille dans le texte

Ainsi :
si on tombe sur l'article complet de la balise/critere, on aura le
chapeau pour situer, et le texte pour aller plus loin
si on lit un article de réference, on a uniquement le chapo pour
l'information minimun requise

En espérant avoir éclairci mon commit
Km