Framagit est-il un outil réservé aux codeurs?

Bonjour,

J’utilise quotidiennement Framagit, que ce soit pour mes projets personnels mais également dans le cadre du collectif Emmabuntüs. Je rappelle que Framagit est une forge, c’est-à-dire une instance d’hébergement de code. Dieu sait combien j’apprécie cet outil notamment pour son interface très agréable même si je pense qu’un mode d’emploi détaillé et pédagogique pour les débutants ne serait pas du superflu.

Framagit sert donc à déposer du code. C’est d’ailleurs ce que j’ai fait avec mon premier projet personnel. Or, il se trouve que dernièrement, je me suis mis en tête de reprendre un modeste roman de science-fiction inachevé, d’une centaine de pages, que j’avais rédigé il y a quelques années. Bon, il vaut ce qu’il vaut… Des écrivains en herbe, il y en a des milliers et mon but n’est pas d’être publié chez Gallimarre ou Grassouillet. Moi ce qui m’intéresse, c’est d’explorer les possibilités d’un outil issu de la culture libre. Bref, je me suis dit :

– Mais pourquoi ne déposerais-tu pas tes chapitres dans ta forge préférée?

Aussitôt dit, aussitôt fait, j’ai créé un nouveau projet intitulé le-message, ce qui correspond au titre de l’oeuvre et j’ai déposé les deux premiers chapitres. Je dois avouer que je suis très content d’avoir eu cette idée car même s’il ne s’agit pas de code, cela me permet de structurer mon travail de manière efficace et de garder une trace de toutes les modifications. Voici donc comment je procède (Je vous invite à cliquer sur les images ci-dessous).

  • J’ouvre une issue pour chaque chapitre que je dépose.

Bildschirmfoto-6

  • Dans l’issue, je renseigne précisément chaque modification que j’effectue et je n’oublie pas de mettre un lien vers le dépôt (repository), lien qui correspond à l’endroit où se trouve le fichier modifié. Je n’inclus jamais le fichier modifié en pièce-jointe dans un commentaire. Ça deviendrait vite un capharnaüm ingérable et je n’ai pas envie de foutre le bordel!

Bildschirmfoto-7

  • Dans le repository, je dépose le fichier .odt du chapitre qui correspond à l’issue. À chaque fois que j’effectue des modifications, je dépose le nouveau fichier qui vient remplacer la version précédente.

Bildschirmfoto-8

  •  Tout est archivé dans l’historique.

Bildschirmfoto-9

Peut-on rêver meilleur outil pour s’organiser proprement et ne rien perdre de son travail? Je n’en suis pas sûr. Je me demande si un auteur a déjà utilisé ou utilise actuellement Framagit pour rédiger un roman. Suis-je le premier? Quoi qu’il en soit, j’ai bien envie de tenter l’aventure!

Ce projet est public et sous licence CC-BY-SA.

Addendum

Suite aux commentaires qui me conseillaient d’utiliser le format markdown pour faire du versioning c’est-à dire visualiser les différences entre deux versions, j’ai eu envie d’essayer et je dois reconnaître que c’est très intéressant.

J’ai commencé par installer l’éditeur de texte Atom qui supporte le markdown et j’ai remplacé le fichier .odt du 1er chapitre par un fichier markdown. La mise en forme pour justifier le texte, n’a pas été des plus aisées mais au final, on peut visualiser les différences entre deux versions comme vous pouvez le voir sur la capture d’écran ci-dessous.

Il est tout à fait possible de transférer directement les fichiers dans le dépôt sans passer par le site framagit mais en utilisant seulement la console, grâce à des commandes telles que git addgit commit et git push mais si vous le voulez bien, ça fera l’objet d’un prochain article!

Bildschirmfoto-11

L’éditeur de texte Atom (avec à droite, la prévisualisation)

Bildschirmfoto-12

Auteur : Ordinosor

Bienvenue sur Miamondo, mon blog personnel. "Mia mondo", c'est de l'espéranto et ça signifie "Mon monde" en français. Je m'appelle Benoît alias Ordinosor, Français expatrié en Allemagne. Mes centres d'intérêt sont les distributions GNU/Linux, le langage de programmation Python, la science-fiction et l'espéranto.

29 réflexions sur « Framagit est-il un outil réservé aux codeurs? »

  1. Excellente idée 🙂

    Pour pousser encore plus loin l’exploitation de Git, je te recommanderai du coup de changer le format de tes fichiers, en adoptant par exemple le format Markdown.

    C’est plus « brut » et moins joli, mais ça a un énorme avantage dans le cas d’un dépôt Git : il devient possible de faire des « diff » entre deux versions pour voir comme l’œuvre évolue.

    Et comme en plus GitLab (le logiciel utilisé pour faire Framagit) reconnait le langage Markdown, les documents pourront être consultés directement depuis l’interface Framagit, avec une mise en forme propre.

    J'aime

    1. Bonjour matt,

      Heureux de te revoir sur mon site. Ça faisait longtemps. Merci pour ton commentaire et ta suggestion qui m’intéresse. Je connais un peu le format markdown. Si il permet de visualiser les différences entre deux versions, ça peut-être utile.
      Je vais certainement essayer.

      Benoît

      J'aime

    2. Je suis tout a fait d’accord avec cette idée, il pourrait même être envisagé d’utiliser un éditeur de fichier gérant le markdown et avec une option git, qui permettrais ainsi de pousser directement les modifs dans le dépôt git sans avoir besoin de passer par l’interface même de Framagit.

      J’utilise perso cette méthode pour la rédaction d’un blog sur un dépôt git avec l’éditeur ATOM, il y en a surement d’autre mais celui-la me convient bien

      J'aime

      1. Bonjour Tarlak,

        Merci pour les liens et pour ton aide. Ça m’intéresserait d’utiliser Atom mais je cherche le moyen de l’installer en version 32 bits. Sur le site officiel, seul le 64 bits est proposé 😦

        J'aime

  2. Bonsoir
    Pour le juriste, la rédaction d’un contrat pouvant contenir des dizaines d’articles, eux mêmes pouvant contenir des sous-articles, pourrait elle s’imaginer sur framagit ?
    Comment ensuite se réaliserait « la compilation » du document pour le sortir en version « finale » ?
    la reprise des commentaires pourraient elles se faire ensuite dans les commentaires d’un traitement de texte ?
    Ca pourrait être génial pour la réalisation d’un travail collaboratif !

    J'aime

    1. Bonsoir,
      Il y a un commentaire de FDE pour vous tout en bas des commentaires. Peut-être que ça répond à vos questions?
      Personnellement, pour répondre à votre première question, il est tout à fait possible d’avoir des articles contenant des sous-articles contenant eux-mêmes des sous-sous-articles sur Framagit.
      En tout cas, pour un travail collaboratif, Framagit est parfaitement adapté. Je l’utilise tous les jours pour cela.
      Cordialement,
      Benoît.

      J'aime

  3. Bonjour,
    je suis heureux de voir que des personnes commencent à utiliser Git pour autre chose que du code. Personnellement, je gère tous mes textes par ce biais. Je travaille en natif Markdown et ça se passe parfaitement. Je procède ensuite avec pandoc via des scripts python maison pour générer mes pages Dokuwiki et les documents ePub. J’espère pouvoir générer prochainement les Pdf via LaTeX.
    J’en parle plus en détail sur le blog de mon site : https://www.hexagora.fr/fr:blog:livre_libre01
    Bon courage à vous dans votre projet d’écriture,
    Cordialement

    J'aime

    1. Bonsoir,
      Merci beaucoup. Dans le premier commentaire, Matt me conseille également d’adopter le markdown pour visualiser les diffs. Il faut que je regarde ça de plus près et il faut que j’aille faire un tour sur votre site pour avoir plus de précisions sur le sujet.
      Cordialement.
      Benoît.

      J'aime

      1. Bonsoir,
        Je pense aussi qu’il est dommage d’avoir les sources d’un roman dans un format binaire. Le Markdown est plus adapté à l’utilisation de Git car c’est du texte (comme le HTML ou le Latex), et comme dit plus haut, cela permet d’utiliser des outils de conversion automatique vers d’autres formats comme l’epub. De plus vos chapitres m’ont pas de mise en forme, et l’utilisation d’un traitement de texte n’apporte rien. Vous auriez même pu les déposer au format txt s’il n’y avait pas un hyperlien dans la chapitre un.
        Sinon c’est une bonne idée d’utiliser Git, et le début du roman me plaît bien.
        Bonne continuation.

        J'aime

      2. Bonjour Yannick,

        Merci pour votre commentaire. j’ai fait quelques essais avec markdown et ça me plaît moyennement même s’il est vrai qu’on peut visualiser les diffs très facilement. Je vais persévérer un peu mais j’ai eu quelques difficultés avec la mise en forme.
        Cordialement

        J'aime

      3. Alors pour la mise en page vous pourrez trouver ici tout les symbole utile : https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

        Mais comme je le disais dans mon commentaire, il est possible de trouver des editeur Markdown avec barre d’icone pour la mise en page, bien sur si celle-ci n’est pas trop élaborée et même avoir une prévisualisation du rendu sans le pousser sur le dépo

        Pour ma part avec l’editeur ATOM, j’ai ajouté les package : markdown-writer, tool-bar-markdown-writer, markdown-preview-plus

        Et ca peut donner quelque chose comme ceci pour la partie rédaction: http://hpics.li/bc2459f
        Et pour la partie git intégré : http://hpics.li/90362f8

        Alors oui c’est sur c’est une autre gymnastique mais une fois prise entre le gain de temps et le versionning c’est bien agréable 🙂

        J'aime

  4. @mips
    Il y a un exemple ici avec le code civil en markdown sur github (pas un contrat en fait mais assez similaire)
    https://github.com/steeve/france.code-civil
    diff « mariage pour tous » : https://github.com/steeve/france.code-civil/commit/b805ecf05a86162d149d3d182e04074ecf72c066
    Pour le reste des question ont la reprise en traitement de texte, je n’en ai pas la moindre idée.
    Par contre, convertir du markdown en pdf est possible.

    J'aime

    1. Bonsoir, personnellement, je ne conseille pas GitBook, que je trouve très peu réactif (et très imbriqué avec leur hébergement). Cela fait désormais plusieurs mois que j’utilise Atom sans m’en plaindre mais sans pour autant le trouver complètement adapté. Pour l’avenir, je continue à lorgner vers Retext : https://github.com/retext-project/retext
      Il peut déjà exporter vers odt html et pdf et il est possible de créer ses propres méthodes d’export : https://github.com/retext-project/retext/wiki/Export-Extensions
      Par ailleurs, je le trouve bien plus réactif, même sur mes très longs et gros documents (romans complets). Enfin, comme c’est du python, je ne désespère pas un jour de pouvoir en faire un outil d’écriture encore plus adapté à l’écriture de fiction, quand mes compétences se seront améliorées.

      J'aime

      1. Bonsoir,

        Je viens d’adopter Atom et markdown. J’ai converti au format markdown les chapitres odt que j’avais déposé sur framagit. Je suis plutôt satisfait du résultat. Je suis allé faire un tour sur votre blog. Très intéressant votre article mais il va falloir que je m’y replonge plusieurs fois.
        Cordialement,
        Benoît.

        J'aime

  5. Bonjour,

    C’est effectivement une idée que j’aime beaucoup. Je me suis servi de ça aussi pour un projet de JdR que je voulais communautaire ou au moins facile à reprendre et à étendre ou dupliquer.
    https://git.framasoft.org/sw-redemption/swr-dos-au-mur

    Après je trouve que mettre les fichiers odt sur le repos c’est dommage, on perd une partie de la puissance de git en utilisant un format binaire. Du LaTeX ou du Markdown est plus approprié.

    Enfin quoi qu’il en soit, l’initiative et le billet sont bienvenue !

    Fred

    J'aime

    1. Bonjour Fred,

      Merci pour votre commentaire. j’ai remplacé mes fichiers odt par des fichiers markdown que je travaille avec Atom et que je pousse directement sur le dépôt. je suis très satisfait de cette formule.
      Cordialement.

      J'aime

      1. Bonsoir,

        Désolé pour la réponse tardive. Je bloque sur l’installation de yaml.
        Voici le message d’erreur dans la console :
        File « ../dudeit.py », line 7, in
        import yaml
        ImportError: No module named ‘yaml’

        Mais je n’arrive pas à trouver et à installer le module yaml. A-t-il un autre nom?
        Cordialement.

        J'aime

      2. Si tu veux l’installer via pip, son nom est pyyaml.
        Sinon, si tu es sur une Ubuntu (et sans doute d’autres distros utilisant dpkg), tu l’as aussi dans les dépôts officiels, sous le nom python-yaml / python3-yaml.

        Perso j’ai tendance à privilégier l’installation via pip (ça permet en général d’avoir des paquets plus récents que ceux de la distro, et c’est reproductible sur d’autre systèmes, y compris non Linux).

        J'aime

  6. En fait, il est tout à fait possible de versionner de l’odt tout en pouvant visualiser des diffs :
    http://blog.riemann.cc/2013/04/23/versioning-of-openoffice-libreoffice-documents-using-git/
    https://git.wiki.kernel.org/index.php/GitTips#How_to_use_git_to_track_OpenDocument_.28OpenOffice.2C_Koffice.29_files.3F

    Par contre ça ne gérera pas le merge automatiquement, et les différences de formatage seront ignorées, donc un format texte reste ce qu’il y a de mieux.

    On peut en théorie utiliser le format fodt (flat odt) qui est un simple XML, mais bon, un diff de XML c’est pas forcément plus simple à lire.

    J'aime

  7. Salut.

    MD est vraiment pas mal pour des textes simples. txt2tags est beaucoup mieux! mais le mieux si tu veux une mise ne page avancée est de toute façon LaTeX.

    Après, pour un roman, c’est à dire pour un texte qui n’aura pas de multiple tableau et formules mathématiques, tu peux combiner les deux. C’est à dire écrire sous txt2tags (ou sous MD si tu tiens vraiment à avoir un langage sans logique) et compiler dans un fichier LaTeX, qui sera lui-même inclut dans le fichier contenant ta mise en page.

    De plus… si tu veux en écrire pas mal des romans… ou à plusieurs mains, tu peux demander à framagit de te les compiler via les CI…

    Bonne journée.

    J'aime

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s