[WIKI] Ménage de printemps

croque-Odillecroque-Odille Member
juin 2012 modifié dans Discussions générales
Bonjour,


Comme vous l'avez peut-être remarqué, le Wiki a connu une réorganisation ces dernières semaines. J'en suis à l'origine (en concertation avec Stéphane) et je continue ma tâche. Et à ce sujet, j'ai quelques petites choses à exprimer :


- dans l'ensemble, la structure du Wiki devrait rester celle que vous pouvez consulter actuellement. A priori elle nous semble, à Stéphane et à moi, plus claire. Vos retours sont bien sûr la bienvenue. Ceci dit, pour garder un Wiki clair et lisible, il serait bon qu'elle ne soit pas retouchée par tout un chacun.


- toutes les contributions d'utilisateurs concernant l'usage de PluXml ont été regroupées dans la page des Tips (http://wiki.pluxml.org/index.php?page=Tips). Certains trucs et astuces, ne sont plus vraiment à jour. Donc avant de tailler à la hache, si vous êtes l'auteur de certains de ces trucs et astuces, pensez à les mettre à jour ou à indiquer qu'ils sont vraiment obsolètes, ainsi je pourrai faire le ménage. De même pour la page des Plugins non officiels (http://wiki.pluxml.org/index.php?page=Plugins+non+officiels)


- en bas de la page d'accueil du Wiki, dans la section 'Autres', j'ai regroupé un peu ce qui tourne autour de PluXml. Vous trouverez de quoi inscrire votre site réalisé avec PluXml, ou votre site consacré à PluXml. Il s'y trouve aussi une FAQ (en cours de rédaction) et une partie dédiée à comment vous pouvez contribuer au projet PluXml. Tout à ça pour dire que si vous recherchez des informations manquantes ou que vous avez du mal à trouver certaines informations, faites-le moi savoir


- la doc pour les développeurs va aussi connaître un ravalement de façade (sisi, sans dec' :-D) Mais j'aurai certainement l'occasion d'en reparler (ou Stéphane le fera)


- le Wiki demeure participatif. Je le reprends en main ces dernières semaines afin de le re-dynamiser et de l'entretenir, c'est pourquoi je suis un peu directif, mais cela ne doit pas vous empêcher d'y participer.


Tout ça pour dire que le Wiki se met à jour, donc si vous avez des questions, des remarques, des envies et des besoins, c'est le moment quoi :-)


Merci,
croque-Odille

Réponses

  • bankaibankai Member
    Jolie travail Croque-Odille (sacré jeu de mot), il est vraiment bien réorganisé.
    c'est un travail énorme pour tout remettre en place et surtout d'optimiser le contenu.
  • amowebamoweb Member
    Je pense que c'est quelque chose qui devenait de plus en plus nécessaire.
    Merci, on s'y retrouve déjà 1000x mieux :-)

    Amaury
  • AirWAirW Member
    Bravo pour cette initiative et merci pour le travail déjà accompli !
  • Beau travail.

    Super la page des plugins non officiels. A chacun d'apporter sa pierre à l'édifice.
    Il faudrait peut-être créer une fiche type : nom, version, date, auteur, historique, site de contact... afin d'avoir quelque chose d'uniforme quel que soit le plugin.
  • Oui, ça devenait nécessaire de dépoussiérer le wiki. A force de râler de voir le wiki dans l'état qu'il était, j'ai fini par me retrousser les manches ;-)


    @ Jerry Wham,


    C'était aussi dans mes idées de normaliser un peu la présentation des plugins. Je vais faire une ébauche de template dans le semaine histoire qu'on voit un peu plus clair. Je note les éléments que tu as écrit.


    Doc pour les développeurs


    Comme vous pourrez le remarquer, la documentation pour les développeurs a aussi connu une mise à jour. Principalement dans son contenu. Pour l'heure, seulement la classe plxShow a été détaillée. D'autres choses vont venir par la suite.


    J'aurai besoin d'un retour des développeurs sur la documentation actuelle de cette classe plxShow. Parcourez-la un peu, toutes les fonctions n'étant pas détaillées autant les unes que les autres, mais elles reposent toutes sur une même norme de présentation. Vous manque-t-il certaines informations non détaillées ? Y a-t-il des choses que vous aimeriez y trouvez ? Des choses qui vous simplifierez le développement avec PluXml ?


    Pour le reste de la documentation pour les développeurs, on aura le temps d'en reparler. Là y a du lourd, ça va être un sacré chantier :-D


    Note : le wiki pour les développeurs n'est pas participatif. Ceci afin d'avoir toujours une information la plus fiable possible.


    Merci


    Roadmap


    - terminer le travail sur le wiki général
    - terminer le travail sur les fonctions de la classe plxShow
    - rédiger une documentation pour les développeurs
  • FrancisFrancis Member
    juin 2012 modifié
    Merci bien, Croque-Odille, pour ce travail bien utile.


    Pour la classe plxShow, il y a quelque chose qui me gêne : dans la fonction artCatId, on parle de "la" catégorie de l'article, alors qu'un article peut appartenir à plusieurs catégories.
    Même chose pour catId et catDescription, si ces fonctions sont utilisées dans une page d'article.


    (une parenthèse : on aurait parfois besoin de la liste des id de toutes les catégories d'un article, mais je crois que ça n'existe pas ; on peut avoir les titres - qui peuvent être modifiés par les utilisateurs, donc moins sûrs à utiliser dans un programme)


    + un petit détail : dans le wiki en général, si on pouvait enlever le décalage vers le bas qui se produit en même temps que l'apparition du lien "Editer", l'affichage serait plus stable.


    En tout cas, c'est un gros boulot que tu fais, mais il sera super utile pour tous, et ce genre de doc donne de la valeur à un CMS.
  • willywilly Member
    Je joins mes remerciements pour ce travail à tous ceux déjà exprimés ici.

    J'aurai une toute petite observation concernant la présentation. Dans les pages du wiki, les éléments des listes sont un peu trop espacées à mon goût.
  • croque-Odillecroque-Odille Member
    juin 2012 modifié
    Hello,


    J'ai fait un template de présentation pour les plugins non officiels, vous pouvez le consulter ici : http://wiki.pluxml.org/index.php?page=plugin+template


    Il n'est pas simple de faire quelque chose de plus évolué car on touche vite aux limites du wiki. Si ça vous convient, on garde ce modèle, sinon, on en reparle pour le modifier.


    @ Francis,


    Pour artCatId(), effectivement ça ne retourne qu'une seule catégorie même quand l'article en a plusieurs [1]


    Pour catId(), idem sauf qu'en plus j'ai un bug puisque cette fonction ne me retourne pas un chiffre mais le string "home" quand un article a plusieurs catégorie. Peut-être que ça vient du fait que cette fonction ne devrait pas être autorisée sur les pages de type "article" (c'est probablement plus une fonction pour le template categorie.php, mais Stéphane doit confirmer) [1]


    Et pour catDescription(), quand il y a plusieurs catégorie, rien ne s'affiche. [1]


    [1] Là faut voir avec le patron, ça sent le bug.


    Pour récupérer la liste des id de toutes les catégories d'un article, a priori, c'est artCatId() qu'il faut utiliser, mais ça semble buguer comme dit plus haut.


    Pour le CSS, c'est corrigé.


    @ willy,


    Pour les éléments de listes trop espacés, il faudrait que je revoie tout le CSS du wiki. A la base je n'étais pas parti pour ça donc j'ai juste modifié un peu. Le problème c'est que si je réduis cet espace, il devient trop petit sur les autres pages du wiki (sur la page d'accueil c'est un poil trop espacé, mais sur la page des prérequis c'est plutôt correct).
  • bankaibankai Member
    sympa le boulot réalisé, tu travail Bien.
    La mise en page pour les plugins non officiel est bien pour ma part.
  • Merci Croque-Odille pour ces précisions : comme quoi, rédiger la doc, ça amène à trouver des bugs et à améliorer notre PluXml !

    Merci aussi pour la rectification du CSS, l'affichage est plus stable, c'est beaucoup plus agréable comme ça.
  • Pour le template ça me va bien. Il me semble que tout y est. Bien joué
Connectez-vous ou Inscrivez-vous pour répondre.