Copier un article pour le partager sur un wiki

Je reviens à la charge encore une fois sur le sujet de la contribution pour le logiciel libre. Il y a moins d'un an, j'avais déjà écrit sur le sujet: Contribuer à un Wiki . Je pense que la documentation est une partie importante et indispensable pour que le logiciel libre soit accessible au plus grand nombre (débutants et experts) et surtout continuer de découvrir des choses. On va voir ce qu'il est possible de faire et comment.

Aussi bien pour de la documentation, un tuto ou un article, on tombe régulièrement sur du contenu intéressant et utile à partager. En règle générale, il n'est disponible que sur le site où l'auteur l'a posté. On en retrouve sur les forums, réseaux sociaux, blogs, wikis, ... Pour aider la communauté et ajouter sa pierre à l'édifice, je vous propose de repartager toutes ces connaissances et les intégrer dans un wiki. Pas un simple copier/coller mais une méthode rapide pour garder l'ensemble de la mise en forme (titres, gras, italique, balise de code, ...). Par exemple, pour copier l'article Commandes en vrac et l'intégrer au wiki Debian-Facile. Cela nous permettra de centraliser la connaissance autour de Debian.

Vous l'aurez compris, je vous ai préparé un tuto pour faire des tutos ou comment repartager un article sur un wiki.

Cette méthode permet de gagner du temps et surtout ne pas s’embêter avec les différents formats et syntaxes qui peuvent exister. Le wiki Debian-Facile utilise la syntaxe dokuwiki et je n'ai toujours pas l'habitude de l'utiliser, donc ça m'arrange.

C'est valable pour tous les formats qui seront convertibles avec pandoc et vous pouvez contribuer pour n'importe quel wiki ou site. Vous pouvez également vous créer votre propre wiki et garder sous la main tous les trucs qui vous sont utiles. L'objectif est d'enrichir mutuellement ces documentations pour les compléter et les actualiser le plus facilement possible.

Aujourd'hui, on aura simplement besoin de Firefox et pandoc.

Debian 9.2 (stretch)
Firefox 52.4
pandoc 1.17.2

Récupérer l'article orignal

Une fois que vous avez repéré un article intéressant à partager, il faut le récupérer. On va donc extraire le texte qui nous intéresse au format HTML (on ne prendra que ce qui nous intéresse, pas la totalité de la page).

Pour ça, on va utiliser l'Inspecteur de Firefox. Il permet de repérer facilement les blocs qui contiennent le texte qui nous est utile pour le copier.
Pour lancer l'inspecteur: Ctrl+Maj+C ou clic-droit puis Examiner l'élément en se positionnant sur le début du texte à copier.

Dans l'inspecteur on identifie le bloc à récupérer, il apparaît en surbrillance sur la page. On fait un clic-droit puis Copier > L'extérieur du HTML.
On enregistre le tout dans un fichier texte, par exemple: commandes-en-vrac.html

Pour ceux qui ne connaissent pas HTML, il faut tâtonner en survolant les éléments qui seront identifiés en surbrillance.
Il est aussi possible d'afficher directement le code source de la page, avec un clic-droit: Code source de la page ou Ctrl+U.

Convertir l'article

On va utiliser l'utilitaire pandoc pour transformer l'article enregistré au format HTML vers le format dokuwiki utilisé par le wiki Debian-Facile.

On commence par installer le paquet:


#root
apt install pandoc

Ensuite on lance la commande qui va bien en prenant soin de modifier les chemins des fichiers et autres paramètres si besoin:


$user
pandoc -s -r html /tmp/commandes-en-vrac.html -w dokuwiki -o /tmp/commandes-en-vrac.dokuwiki
  • -r html : le format du fichier d'entrée
  • /tmp/commandes-en-vrac.html : le chemin du fichier d'entrée
  • -w dokuwiki: le format du fichier de sortie
  • -o /tmp/commandes-en-vrac.dokuwiki : le chemin du fichier de sortie

Pour consulter la documentation sur pandoc et les formats supportés:


$user
pandoc --help
man pandoc

Copier l'article dans le wiki

On a donc notre article au format dokuwiki dans le fichier commandes-en-vrac.dokuwiki . Il nous reste la partie facile et rapide à faire. On copie le contenu du fichier commandes-en-vrac.dokuwiki puis on le colle dans la page du wiki qui correspond.

On prend quand même le temps de vérifier que la mise en forme est correcte. Il faut vérifier les liens qui peuvent ne plus pointer au bon endroit. S'il y a des images ou des vidéos, il faudra peut-être penser à les ajouter au wiki (au cas la source disparaisse ou soit déplacée). Si on a un peu de temps et pour faire les choses bien, on peut vérifier et compléter certains points.

Quelques conseils pour la rédaction

En règle générale, copier un article ne suffit pas, il faut parfois effectuer quelques modifications. Quelques éléments à vérifier:

  • Indiquer la date de rédaction,
  • Indiquer la version des logiciels utilisés,
  • Indiquer les fichiers importants: les fichiers de configuration et les données pour les sauvegardes,
  • Citer les sources et autres liens utiles,
  • Respecter le respect des licences,
  • Vérifier l'orthographe: j'utilise LibreOffice Writer avec Grammalecte,
  • ...

Pourquoi ?

C'est vrai que c'est un peu idiot de se poser la question à la fin sur l'utilité de dupliquer du contenu. Voici quelques raisons:

  • Repartager les contenus intéressants: certains articles sont oubliés parce que le site n'est pas connu.
  • Améliorer la visibilité du libre: plus il y aura d'articles plus ils seront faciles à trouver sur internet.
  • Le contenu peut disparaître: de nombreux sites disparaissent tous les jours embarquant en même temps des connaissances importantes.
  • Adapter un contenu: en modifiant seulement les commandes qui peuvent différer d'une distribution à l'autre.
  • Compléter une documentation existante.
  • ...

Par ailleurs, c'est dans l'esprit du logiciel libre de partager et de réutiliser. Pourquoi devrait-on s’embêter à refaire de la documentation quand certains ont déjà fait un superbe travail ? Je peux vous assurer qu'écrire un article de qualité c'est pas évident et surtout c'est chronophage. Autant se concentrer sur l'écriture du contenu nouveau ou adapter l'existant plutôt que de repartir de zéro.

C'est une des nombreuses manières de contribuer pour le développement et la promotion du logiciel libre. Vous pouvez également:

  • Repartager des articles via les réseaux sociaux, le Journal du Hacker ou votre Shaarli,
  • Participer au développement d'un logiciel,
  • Remonter les bugs,
  • Rédiger de la documentation et des tutos pour la communauté,
  • Faire de l'entraide sur les forums et chats,
  • Organiser et participer à des évènements du libre,
  • Financer des auteurs et des projets,
  • ...

Pas d'excuses, nous avons tous la possibilité de contribuer, même si cela peut sembler modeste. Tout ce que vous pourrez faire sera utile.

Ressources

Fil RSS des commentaires de cet article

Écrire un commentaire