Suggerimenti per la modifica collaborativa di un documento LaTeX

Question

La mia configurazione predefinita è quella di inserire il sorgente tex in un repository subversion e inserire note reciproche come commenti nel sorgente quando si apportano modifiche al contenuto di altre persone.Sembra tutto piuttosto subottimale, soprattutto quando ci sono conflitti di sovversione in cui tutto ciò che ti dice è "queste due versioni di questo enorme paragrafo sono in conflitto".

Ho escogitato alcuni trucchi, ma sono sicuro che ci siano idee molto migliori (o versioni migliori delle mie idee) là fuori.

Per collaborare al codice, vedere questa domanda:

Come collabori con altri programmatori in tempo reale?

(Alcune di queste risposte si applicheranno anche alla collaborazione su documenti LaTeX.)

Answer 1

Sempre terminare ogni frase con una nuova riga. Mai riformattare i paragrafi.Queste regole non solo riducono al minimo i conflitti spuri, ma rendono anche più semplice la revisione del documento modificato in modo collaborativo.

Per il commento dell'autore utilizzo i commenti marginali:

\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}}

Li inseriamo a margine perché spesso stiamo preparando un documento con limiti di lunghezza rigidi e vogliamo che le note marginali non modifichino la lunghezza del documento.Le note marginali vengono quindi disattivate da

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

Ho inventato anche il nbibtex (ora in Debian!) in modo da poter utilizzare file .bib diversi dai tuoi coautori senza dover concordare chiavi BibTeX arbitrarie. nbibtex funziona come BibTeX tranne per il fatto che utilizza parole chiave dell'autore, del titolo e di altri campi.Il file BibTeX di ogni autore può essere diverso, ma se l'articolo è lì, nbibtex lo troverà.

Answer 2

Per mitigare il problema dei conflitti sovversione inutili, si può adottare la convenzione di nuove righe alla fine delle frasi. (Questo rende anche più facile per riorganizzare o commentare, o commento su , frasi.)

Per quanto riguarda i commenti a vicenda la fonte del testo, trovo che sia meglio fare coloro che appaiono nel documento PDF, ma hanno la possibilità di disattivarli per la versione finale. Io uso una macro "kibitz" per questo. Per utilizzarlo, inserire il seguente nella parte superiore del documento:

\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]}}

Poi Alice, per esempio, può solo attaccare qualcosa come \alice{Bob must've added the previous sentence which is obviously false.} e mostrerà in rosso nel pdf a patto Comments è impostato su 1.