Adicionando MS-Word-like comentários em LaTeX
Pergunta
Eu preciso de uma maneira de adicionar comentários de texto em "estilo Palavra" para um documento Latex. Eu não quero comentar o código-fonte do documento. O que eu quero é uma maneira de adicionar correções, sugestões, etc., para o documento, para que não interrompa o fluxo de texto, mas que ainda iria tornar mais fácil para que todos saibam, que parte da frase que estão relacionados com a . Eles também devem "desaparecer" quando compilar o documento para impressão.
No início, eu pensei em escrever um novo comando, que seria apenas para a frente a entrada para \marginpar{}
, e quando compilar para impressão faria apenas a definição esvaziar. O problema é que você não tem nenhuma garantia que os comentários aparecerão e você não será capaz de distingui-los do outro marginpars
.
Qualquer idéia?
Solução
todonotes
é um outro pacote que faz agradáveis ??procurando textos explicativos. Você pode ver uma série de exemplos no documentação .
Outras dicas
Desde LaTeX é um formato de texto, se você quer mostrar que alguém as diferenças de uma maneira que eles podem usá-los (e cereja escolher a partir deles) usar a ferramenta diff
padrão (por exemplo, diff -u orig.tex new.tex > docdiffs
). Esta é a melhor maneira de anotar algo como documentos LaTeX, e pode ser facilmente utilizado por qualquer pessoa envolvida na produção de um documento a partir de fontes de látex. então você pode usar comentários LaTeX padrão em seu patch para explicar as mudanças, e eles podem ser facilmente integrados. Se a vida de documentos em um sistema de algum tipo de controle de versão, basta usar o VCS para gerar um arquivo de patch que pode ser revisto.
Eu tenho usado changes.sty
, o que dá mudança básica colorir:
\added{new text} \deleted{old text} \replaced{new text}{old text}
Todos estes demorar um parâmetro opcional com as iniciais do autor que fez esta mudança. Isso resulta em diferentes cores utilizadas, e estas iniciais são exibidos sobrescrito após o texto alterado.
\replaced[MI]{new text}{old text}
Você pode ocultar as marcas de mudança, dando o final
opção para o pacote changes
.
Isso é muito básico, e os comentários não são suportados, mas pode ajudar.
minha casa laminados "FIXME" usos de ferramentas pequenas \marginpar
sempre que possível e vai em linha em locais (como legendas), onde que é difícil de arranjar. Isto trabalha para fora porque eu não costumam usar parágrafos margem para outras coisas. Este faz significa que você não pode finalizar o layout até que tudo é fixo, mas eu não sinto muita dor daquele ...
Outros, que eu concordo sinceramente com Michael sobre o uso de ferramentas padrão e controle de versão.
Veja também:
- para editar colaborativamente um documento LaTeX (que endereços que você pergunta principal ...)
- https://stackoverflow.com/questions/193298/best-practices-in-latex
e um auto-plug:
Você pode usar o changebar pacote para áreas de destaque de texto que foram afetados.
Se você não quer fazer a marcação manualmente (que pode ser tedioso e interromper o fluxo de editar) o puro latexdiff utilitário irá demorar um diff do seu documento e produzir uma versão dele com marcação adicionado a apresentar visualmente as mudanças entre as duas versões na saída typeset.
Esta seria a minha solução preferida, embora eu não tenha testado-lo em documentos grandes, multi-arquivo.
Você também pode tentar o pacote trackchanges
.
O pacote todonotes parece ótimo, mas se isso for demasiado pesado para uso, uma solução simples é apenas para notas de rodapé de uso (por exemplo em vermelho para separá-los de notas regulares).
trackchanges.sty funciona exatamente da maneira changes.sty . Veja @ resposta de Svante. Tem fácil de lembrar comandos e você pode mudar a forma como as edições irá aparecer depois de compilar o documento. Você também pode ocultar as edições para impressão.
O melhor pacote que sei é Fácil revisão que fornece a funcionalidade comentando em ambiente de LaTeX. Por exemplo, você pode usar os seguintes comandos simples, como \add{NEW TEXT}
, \remove{OLD TEXT}
, \replace{OLD TEXT}{NEW TEXT}
, \comment{TEXT}{COMMENT}
, \highlight{TEXT}
e \alert{TEXT}
.
Alguns exemplos podem ser encontrados aqui .