Conseils pour l'édition en collaboration un document LaTeX

Question

Ma configuration par défaut est de mettre la source tex dans un dépôt subversion et insérer des notes les uns aux autres sous forme de commentaires dans la source lors de la modification du contenu des autres. Tout se sent assez sous-optimale, surtout quand il y a des conflits de subversion où tout ce qu'il vous dit est « ces deux versions de ce grand paragraphe sont en conflit ».

Je suis venu avec quelques tours mais je suis sûr qu'il ya beaucoup de meilleures idées (ou meilleures versions de mes idées) là-bas.

Pour la collaboration sur le code, voir cette question:

Comment collaborez-vous avec d'autres codeurs en temps réel?

(Certaines de ces réponses s'appliqueront à la collaboration sur des documents LaTeX ainsi.)

Answer 1

Toujours fin de chaque phrase avec un saut de ligne. Jamais reformater paragraphes. Ces règles réduisent non seulement les conflits parasites mais aussi faire votre papier édité en collaboration plus facile à réviser.

Pour le commentaire de l'auteur utiliser les commentaires marginaux:

\long\def\authornote#1{%
        \leavevmode\unskip\raisebox{-3.5pt}{\rlap{$\scriptstyle\diamond$}}%
        \marginpar{\raggedright\hbadness=10000
        \def\baselinestretch{0.8}\tiny
        \it #1\par}}
\newcommand{\simon}[1]{\authornote{SLPJ: #1}}
\newcommand{\norman}[1]{\authornote{NR: #1}}
\newcommand{\john}[1]{\authornote{JD: #1}}

Nous avons mis ces derniers dans la marge, car souvent nous préparons un document à des limites strictes de longueur, et nous voulons que les notes marginales de ne pas modifier la longueur du papier. Les notes marginales sont alors désactivées par

\long\def\authornote#1{\relax}

J'inventèrent également nbibtex outil (maintenant dans Debian!) De sorte que vous pouvez utiliser différents fichiers .bib de vos co-auteurs, sans avoir à se mettre d'accord sur les touches de BibTeX arbitraires. nbibtex fonctionne comme BibTeX sauf qu'il utilise des mots clés de l'auteur, le titre et d'autres domaines. Le fichier BibTeX de chaque auteur peut être différent, mais si le papier est là, nbibtex trouvera.

Answer 2

Pour atténuer le problème des conflits de subversion inutiles, vous pouvez adopter la convention de nouvelles lignes à la fin des phrases. (Cela rend également plus facile de réarranger ou en commentaire ou un commentaire sur , des phrases.)

Quant aux commentaires les uns aux autres dans la source de texte, je trouve qu'il est préférable de faire ceux qui apparaissent dans le document pdf, mais ont la possibilité de les désactiver pour la version finale. J'utilise une macro « kibitz » pour cela. Pour l'utiliser, placez le suivant en haut du document:

\newcount\Comments  % 0 suppresses notes to selves in text
\Comments=1   % TODO: set to 0 for final version

\documentclass{article}   % or whatever your documentclass

% for comments
\usepackage{color}
\definecolor{darkgreen}{rgb}{0,0.5,0}
\definecolor{purple}{rgb}{1,0,1}
% \kibitz{color}{comment} inserts a colored comment in the text
\newcommand{\kibitz}[2]{\ifnum\Comments=1\textcolor{#1}{#2}\fi}
% add yourself here:
\newcommand{\alice}[1]{\kibitz{red}      {[ALC: #1]}}
\newcommand{\bob}[1]  {\kibitz{purple}   {[BOB: #1]}}
\newcommand{\carol}[1]{\kibitz{cyan}     {[CAR: #1]}}
\newcommand{\deb}[1]  {\kibitz{darkgreen}{[DEB: #1]}}
\newcommand{\evan}[1] {\kibitz{blue}     {[EVN: #1]}}

Alors Alice, par exemple, peut juste coller quelque chose comme \alice{Bob must've added the previous sentence which is obviously false.} et il sera affiché en rouge dans le pdf tant Comments est réglé sur 1.