Rst

From Electrolab
Revision as of 18:23, 21 July 2012 by Pierreg (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Je suis un grand utilisateur, et un peu prosélyte, de rst, ou RestructuredText. Le nom est barbare, le concept simple. voir http://docutils.sourceforge.net/rst.html. En 2 mots, c'est un langage de markup léger, analogue à celui utilisé par ce wiki. Mais bien sur ce n'est pas le même langage, c'est pas compatible, où serait le plaisir? Il est notablement plus puissant que mediawiki (celui utilisé par ce wiki), et notamment:

  • plus orienté scientifique (et notamment documentation logicielle).
  • Utilisable dans d'autres contextes qu'un wiki.
  • équipé de traducteurs de et vers: html, pdf, odt, latex, pour ne citer que les principaux.

urls:

C'est né dans la communeauté python, c'est le coeur de sphinx, la platforme de documentation utilisée pour la documentation python. J'aimerai non pas vous convertir à rst, adopter un nouveau langage aussi simple fût-il, ne se fait pas facilement. Mais que ce wiki permette l'utilisation de rst.

C'est possible, grace à une extension, décrite ici: http://www.mediawiki.org/wiki/Extension:RstToHtml Il y a un module php à installer, et 2-3 coups de tournevis à donner.

J'en parle à mon aise, je ne connais pas php, je ne saurais pas (en l'état) faire la manip. Mais je peux assister si besoin.

Hormis le fait qu'il faut mettre les mains dans le cambouis, vous allez me dire: Si on permet 2 langages, on va avoir un site hétérogène! Les uns écrivent en mediawiki (la majorité), les autres en rst. Plus question de modifier les pages les uns des autres. Plusieurs réponses à cet argument:

  • Uno, la plupart des pages sont écrites par une personne, rarement modifiées par une autre, voire rarement modifiées tout court!
  • Deux, les modifs faites à une page sont souvent des corrections à la marge: on corrige une faute de typo, on ajoute un url. Ça reste possible, dans un langage qu'on ne connait pas (et qui reste simple, au demeurant.

Bon, c'est vrai, certaines pages sont écrites et ré-écrites, comme celles pour le repas mardi. Pour celles-ci il est logique de rester en mediawiki.

L'autre intérêt de ma proposition, c'est de potentiellement se doter, au lab, d'un langage permettant la rédaction de doc technique 100 fois moins lourde que du Office, gérable en conf (je veux dire git ou autre), facile à apprendre. La façon dont on travaille au lab, si elle permet l'éclosion de nombreux projets, ne suscite pas un grand niveau de normalisation. J'ai vu les discussions autour des langages de description 3d, ou de design de CI, les choix ne sont pas faciles, et souvent des solutions non libres sont, malgré qu'on en aie, les seules viables. Ici, le langage de wiki n'a pas été choisi, il venait avec l'outil, je ne pense pas ce ça ait été débattu.

Pourquoi je pousse ça maintenant? C'est bassement intéressé! Je veux pousser dans la même direction à mon boulot, ou il y a aussi un wiki, et je veux rôder mon argumentaire, et savoir-faire!

Bien sur, si ça se fait, je deviens Mr rst du lab, support des questions, interrogations, conversions, des uns et des zots. J'ai pas eu un rôle très actif jusqu'à ce jour, c'est le moment.

Page installée sur le wiki, je lance le débat sur la ml, répondez sur la ml, ou ici! Page Discussion, c'est le moment ou jamais d'essayer!

Bon, ça fait longtemps je j'avais rien rédigé d'aussi long hors rst, ça m'a donné soif, à bientôt!