Aujourd'hui, on vous pré­sente une méthode pour créer vos docu­ments col­la­bo­ra­tifs en ligne, en uti­li­sant LaTeX, ain­si que quelques astuces qui pour­ront peut-être vous sim­pli­fier la vie !

Un petit peu de contexte

Ima­gi­nons : vous êtes un jeune cher­cheur dyna­mique, et vous vou­lez rédi­ger un papier avec vos col­la­bo­ra­teurs. Ou bien vous êtes un étu­diant, et vous devez rendre un rap­port quel­conque à par­tir d'un tra­vail fait en groupe.

Vous pour­riez ain­si tra­vailler de manière soli­taire, et vou­loir créer vos docu­ments direc­te­ment dans le cloud, pour pou­voir les ouvrir de n'importe quelle sta­tion de tra­vail. De mul­tiples solu­tions à ces situa­tions existent : Google Docs, Fra­ma­Pad, la conjonc­tion d'un logi­ciel de trai­te­ment de texte et d'un ser­vice de sto­ckage dans le cloud… Mais le résul­tat peut ne pas vous satis­faire. On pour­ra citer par exemple la dif­fi­cul­té de rédi­ger des for­mules mathé­ma­tiques, ou encore les pro­blèmes de ver­sions de logi­ciel et de com­pa­ti­bi­li­té si ceux-ci ne sont pas inté­grés au cloud. Ce qu'il vous fau­drait, c'est un édi­teur de texte sup­por­tant le lan­gage LaTeX, et qui serait col­la­bo­ra­tif ! Ça tombe bien, on va vous en pré­sen­ter.

La minute LaTeX

LaTeX, c'est un lan­gage et sys­tème de com­po­si­tion per­met­tant de réa­li­ser des docu­ments pro­fes­sion­nels. Si vous ne connais­sez pas encore cet outil, je vous conseille d'aller faire un tour du côté d'un autre de nos articles qui vous appren­dra à créer votre pre­mier docu­ment en LaTeX.

Main­te­nant que vous êtes un peu à l'aise avec LaTeX et que vous connais­sez par cœur tous les articles du blog avec ce mot-clef, ajou­tons la dimen­sion col­la­bo­ra­tive !

Les différents supports

Dans ce mar­ché flo­ris­sant de l'édition de docu­ments LaTeX en ligne, deux ser­vices se démarquent un peu.

ShareLaTeX

Sha­re­La­TeX est un ser­vice au modèle Free­mium : il a une ver­sion gra­tuite et une ver­sion payante com­por­tant plus de fonc­tion­na­li­tés.

Dans sa ver­sion gra­tuite, il n'est pas pos­sible de col­la­bo­rer avec d'autres per­sonnes, ce qui limite un peu notre inté­rêt. Ses deux ver­sions payantes ("Col­la­bo­ra­tor" et "Pro­fes­sio­nal" à 14 € et 28 € par mois) per­mettent d'incorporer plus de col­la­bo­ra­teurs, de syn­chro­ni­ser direc­te­ment avec Drop­box et Github. Cepen­dant, il est à noter que la par­ti­ci­pa­tion à cer­taines confé­rences peut don­ner un accès libre et gra­tuit à vie (comme Data Inte­gra­tion in Life Science par exemple), et qu'il existe des réduc­tions pour les aca­dé­miques et pour les labo­ra­toires (il se peut que ce der­nier ait même déjà une licence sans que vous le sachiez, n'hésitez pas à deman­der).

Overleaf

Over­leaf est une autre solu­tion du même type. La ver­sion gra­tuite donne accès à 1Go de sto­ckage, un sys­tème de ver­sion­nage, plein de thèmes dis­po­nibles, de l'auto-complétion, et accès à un dépôt Git géné­ré auto­ma­ti­que­ment. De plus, et c'est ce qui nous inté­resse, le par­tage peut se faire avec autant de per­sonnes que vous le sou­hai­tez.

Pour la suite de l'article, on va donc pré­fé­rer ce ser­vice à Sha­re­La­TeX.

Début classique avec Overleaf

Après les néces­saires étapes d'inscription et de connexion, nous allons com­men­cer par créer un nou­veau docu­ment (notez que vous pou­vez aus­si impor­ter une archive zip), en cli­quant sur "New Pro­ject". S'offrent alors à nous une myriade de thèmes, prêts à l'emploi, vous n'avez qu'à sélec­tion­ner celui qui vous convient et le docu­ment sera pré-rem­pli par le code géné­rant le thème choi­si.

Vous pou­vez ensuite com­men­cer à rédi­ger votre docu­ment dans la par­tie gauche de la page nou­vel­le­ment affi­chée. Pour les gens moins à l'aise avec LaTeX (vous-même ou l'un de vos col­la­bo­ra­teurs) il est éga­le­ment pos­sible d'utiliser un édi­teur WYSIWYG, en cli­quant sur le bou­ton "Rich Text".

Enfin, pour par­ta­ger le docu­ment, cli­quez sur "Share", ou bien sim­ple­ment copiez-col­lez le lien de votre navi­ga­teur, et envoyez-le à vos col­la­bo­ra­teurs.

 

Et pour ceux qui aiment un peu plus de défi

Mais pour les plus déve­lop­peurs dans l'âme qui se voient confron­tés à ce pro­blème (à savoir : fichiers LaTeX à modi­fier, tra­vail col­la­bo­ra­tif, acces­si­bi­li­té sur plu­sieurs ordi­na­teurs), une autre solu­tion vien­dra à l'esprit : Git !

En effet, Git per­met de gérer et édi­ter faci­le­ment des fichiers à plu­sieurs, de syn­chro­ni­ser le conte­nu d'un dépôt entre plu­sieurs ordi­na­teurs, etc. Si vous n'êtes pas encore fami­lier avec cet outil, n'hésitez pas consul­ter cet article d'introduction à Git sur notre blog.

LaTeX et Git : premiers pas

Pour com­men­cer, créez votre docu­ment LaTeX, dans un dos­sier créé au préa­lable.

Ensuite, pour ini­tia­li­ser un dépôt Git dans ce réper­toire, il suf­fit de taper :

Et voi­là, il ne reste plus qu'à par­ta­ger ce dépôt, à grands coups de

  !

LaTeX, Git et Github

Pour faci­li­ter le par­tage du dépôt, il est pos­sible d'utiliser GitHub, le fameux ser­vice de sto­ckage de dépôts Git. Pour cela, quatre étapes simples tirées de l'aide de GitHub :

1. Créez un nou­veau dépôt sur GitHub.

2. Dans votre ligne de com­mande, créez un clone

  du dépôt local. Dans mon cas :

3. Faites un

  à par­tir du dépôt nou­vel­le­ment clo­né, avec l'option

  (qui fait en sorte que toutes les réfé­rences comme les branches, les tags, etc, sont incluses dans l'opération). Indi­quez l'adresse du dépôt git sur Github.

4. Sup­pri­mez ce dont vous n'avez plus besoin, et clo­nez à nou­veau à par­tir de GitHub.

Main­te­nant que votre dépôt est sur GitHub, vous pou­vez faci­le­ment le par­ta­ger et tra­vailler en col­la­bo­ra­tion, aus­si bien en ligne qu'hors ligne. Vous pou­vez aus­si uti­li­ser tous les outils de GitHub et les adap­ter à l'écriture de docu­ments. Voi­ci quelques exemples (tirés de ce billet) :

• Uti­li­sez les mes­sages de
  com­mit
  

    comme d'un jour­nal, pour vous rap­pe­ler votre rai­son­ne­ment (et évi­ter les ques­tions du type : "Mais pour­quoi est-ce que j'ai fait ça ?")

  
  
• Uti­li­sez le wiki pour struc­tu­rer vos idées dans un pre­mier temps
• Uti­li­sez le sys­tème d'issues pour gérer les ques­tions qui peuvent arri­ver en cours de route, votre todo-list, vos idées… Les éti­quettes se doivent d'être expli­cites (ex : "ques­tion", "idée"…)

 

LaTeX, Git, Github et Overleaf

Vous croyiez avoir atteint le sum­mum de l'élégance ? Atten­dez, il reste encore une étape ! Il est en effet pos­sible de syn­chro­ni­ser votre tra­vail sur Over­leaf et sur GitHub !

"Pour­quoi faire ?" me direz-vous, eh bien pour plu­sieurs rai­sons. Quelques exemples : vous aimez GitHub et ses dif­fé­rents outils, mais un col­la­bo­ra­teur ne sait uti­li­ser que le texte enri­chi, en WYSIWYG. Ou bien vous vou­lez gar­der une trace de vos docu­ments dans votre compte GitHub, qui gère tout de même bien mieux les ver­sions.

La marche à suivre est assez simple, puisque chaque docu­ment sur Over­leaf est asso­cié à un dépôt Git. Il suf­fit donc d'avoir un dépôt local avec deux ori­gines. Voi­ci la marche à suivre, for­te­ment ins­pi­rée de cet article

1. Clo­nez votre docu­ment Over­leaf loca­le­ment. Si votre docu­ment sur celui-ci a pour adresse https://​www​.over​leaf​.com/​2​0​2​9​5​5​9​g​k​ypz, alors le dépôt Git asso­cié est https://git.over​leaf​.com/​2​0​2​9​5​5​9​g​k​ypz.

2. L'origine de ce dépôt est donc le dépôt dis­tant sur Over­leaf. Renom­mons cette ori­gine pour plus de clar­té.

Doré­na­vant, pour impor­ter les chan­ge­ments effec­tués sur Over­leaf, il vous suf­fi­ra de lan­cer :

3. Créez un dépôt sur GitHub, et ajou­tez GitHub comme réper­toire dis­tant.

4. Faites un push vers GitHub pour syn­chro­ni­ser.

Tous vos dépôts (en local, sur Over­leaf et sur GitHub) sont main­te­nant à jour !

Conclusion

Nous avons donc vu deux façons de rédi­ger des docu­ments LaTeX de manière col­la­bo­ra­tive. La pre­mière est basée sur un ser­vice en ligne, Over­leaf, qui per­met de le faire très faci­le­ment, même dans sa ver­sion gra­tuite. Le second est un peu plus tech­nique et fait appel à Git en plus, et dans notre cas GitHub (qui peut être sub­sti­tué par tout autre sto­ckage de dépôts Git).

Vous n'avez donc plus d'excuse pour rédi­ger des rap­ports bien propres !

Mer­ci aux relec­teurs Bun­ny, Aki­ra, et Kum­qua­tum pour leur par­ti­ci­pa­tion.