Aide en ligne : proposition alternative pour une aide embarquée - commentairesAide en ligne : proposition alternative pour une aide embarquée2012-10-22T13:22:09Zhttps://blog.smellup.net/spip.php?article63#comment1862012-10-22T13:22:09Z<p>En optant pour l'option d'un squelette, rien n'empêche d'écrire purement et simplement du HTML, sans balise SPIP ni chaine de langue. Ce sera interprété correctement par SPIP. (ATTENTION : reste la question de l'encodage, il faut que le squelette soit en UTF-8).</p>
<p>Donc on pourrait très bien commencer à rédiger une aide totalement en français avant de procéder à un découpage en chaines de langue et/ou d'ajouter des balises si des tests sont requis.</p>
<p>Par contre, pour la question de la traduction de cette aide, afin de pouvoir utiliser <a href="http://trad.spip.net" class="spip_url spip_out" rel='nofollow external'>http://trad.spip.net</a>, il faudra, à un moment du développement, découper ce texte en chaînes de langue. Sinon, cela signifierait qu'il faudrait réinventer un système de traduction. Ma première réaction est de se baser sur les outils existants, d'où des chaines de langue si on veut fournir une aide multilingue.</p>Aide en ligne : proposition alternative pour une aide embarquée2012-10-22T13:01:58Zhttps://blog.smellup.net/spip.php?article63#comment1852012-10-22T13:01:58Z<p>Ma réaction spontanée c'est « rester simple » pour ne pas complexifier et freiner voire dissuader la création d'aide.<br class="autobr">
L'usage de balises est un obstacle, mais celles-ci peuvent facilement s'ajouter après coup.<br class="autobr">
Par contre, l'usage des chaines de langues complique beaucoup le processus dés le début, du moins en ce qui concerne la version originale puisque trad.spip.net a l'air facile à utiliser.</p>
<p>CEPENDANT, aucune de ces complications et fonctionnalités possibles ne semble (et ne doit être) obligatoire dans la solution proposée.<br class="autobr">
Le fichier peut être 100% en bon français pur HTML sans balise ni chaines de langues.<br class="autobr">
Ouf.</p>Aide en ligne : proposition alternative pour une aide embarquée2012-10-22T10:47:28Zhttps://blog.smellup.net/spip.php?article63#comment1842012-10-22T10:47:28Z<p>Pour ce qui est du markdown dans spip j'ai déjà dans ma toolbox (plugin persso avec mes bouts de truc), intégré phpMarkDown extra qui est une classe convertissant le .md en html <i>valid et prope (sans ajout de class)</i>.</p>
<p><a href="http://michelf.ca/projets/php-markdown/extra/" class="spip_url spip_out auto" rel="nofollow external">http://michelf.ca/projets/php-markdown/extra/</a></p>
<p><a href="http://michelf.ca/projets/php-markdown/syntaxe/" class="spip_out" rel='nofollow external'>Syntaxe</a></p>
<p>Pourquoi j'utilise : Je m'en sert pour afficher mes notes de developpement dans des articles avec un modèle, ou dans un skel via le filtre |markdown.</p>
<p>Le gros avantage de ce format, je le répète est d'être lisible contrairement aux autres langages comme celui de spip, tiddly, mediaWiki qui dégrade le texte et la lisibilité avant le traitement.</p>
<p>En partant du principe que : si je rédige, je ne sait pas forcément quel va être le format et le mode de diffusion, on part donc du principe que l'on va rédiger, puis après relecture, discussions, débat, passer à la mise en forme pour le mode de diffusion choisi :
<br><span class="spip-puce ltr"><b>–</b></span> spip
<br><span class="spip-puce ltr"><b>–</b></span> texte
<br><span class="spip-puce ltr"><b>–</b></span> html
<br><span class="spip-puce ltr"><b>–</b></span> pdf</p>
<p>on garde donc jusqu'à la mise en production/finalisation du contenu un texte lisible et utilisable sans conversion, un peut comme les pages man sous UNIX : y'a pas de html dedans<small class="fine d-inline"> </small>;-) et pourtant l'aide en ligne est la en xhtml.</p>Aide en ligne : proposition alternative pour une aide embarquée2012-10-22T09:21:27Zhttps://blog.smellup.net/spip.php?article63#comment1832012-10-22T09:21:27Z<p>En réponse à <a href="http://www.mail-archive.com/spip-zone@rezo.net/msg29488.html" class="spip_url spip_out" rel='nofollow external'>http://www.mail-archive.com/spip-zo...</a>.</p>
<blockquote class="spip">
<p>-* utilisation du langage spip : markdown reste lisible même en fichier texte simple et donc manipulable par n'importe qui et pour n'importe quoi, de plus c'est devenu un standard quasi pour toutes les doc et Readme sur beaucoup de projets (hors php c'est vrai)</p>
<ul class="spip"><li> l'écriture dans les fichiers lang en array, ne facilite pas les modifs et mise a jour du texte : j'aurais plutot fait des fichier .aide ou aide1_fr.md qui sont chargés en fonction du besoin.
</li></ul></blockquote>
<p>Le choix présenté ici repose sur l'utilisation de chaines de langue afin de pouvoir utiliser <a href="http://trad.spip.net" class="spip_url spip_out" rel='nofollow external'>http://trad.spip.net</a> qui centralise toutes les traductions et permet de gérer l'état d'avancement des traductions mais également le fait qu'une chaine de langue dans la langue mère a été modifiée.</p>
<p>Il est vrai que d'autres choix techniques peuvent être faits, et que les entrées d'aide pourraient être rédigées directement via un fichier markdown ou un fichier HTML avec le texte (sans chaine de langue).</p>
<p>Concernant le format markdown, cela impliquerait l'introduction pour les rédacteurs/développeurs d'un nouveau langage à connaître (bien que ce n'est pas rédhibitoire), d'implémenter un parseur markdown dans SPIP. Bien etendu, l'utilisation de balises SPIP ne seraient pas possibles (il faut dès lors permettre d'utiliser au choix markdown ou HTML pour les cas plus complexes). Si cela permet de rédiger plus facilement la documentation dans la langue mère, cela repose tout le problème de la traduction. La traduction devrait-elle être gérée directement via SVN<small class="fine d-inline"> </small>? Ou bien faudrait-il développer un trad.spip.net parallèle spécifiquement pour les fichiers d'aide<small class="fine d-inline"> </small>? et demander aux traducteurs d'apprendre à utiliser deux outils différents<small class="fine d-inline"> </small>?</p>
<p>Une autre approche pourrait être de maintenir un format squelette SPIP avec des chaînes de langue mais de faciliter la rédaction/modification du texte. On pourrait envisager un système permettant, à la visualisation d'un squelette SPIP, d'ajouter des crayons sur les chaines de langue afin de pouvoir les éditer/modifier facilement (la modification étant reportée directement dans le fichier de langue). Un tel outil sera profitable pas seulement pour la rédaction de l'aide embarquée mais plus généralement pour tout développement (squelette, plugin...). Un <code class="spip_code spip_code_inline" dir="ltr">var_mode=lang</code> aurait toute sa place dans LangOne.</p>