Добавление комментариев в стиле MS-Word в LaTeX

Question

Мне нужен способ добавить текстовые комментарии в стиле Word в латексный документ. Я не хочу комментировать исходный код документа. Мне нужен способ добавить исправления, предложения и т. Д. В документ, чтобы они не прерывали поток текста, но при этом всем было бы легко узнать, к какой части предложения они относятся , Они также должны «исчезнуть» при компиляции документа для печати. ​​

Сначала я подумал о написании новой команды, которая просто перенаправит ввод на \marginpar{}, а при компиляции для печати определение просто станет пустым. Проблема в том, что у вас нет гарантии, где появятся комментарии, и вы не сможете отличить их от других marginpars.

Есть идеи?

Answer 1

todonotes - это еще один пакет, который делает приятные на вид выноски. Вы можете увидеть ряд примеров в документации .

Answer 2

Поскольку LaTeX является текстовым форматом, если вы хотите показать кому-то различия в том, как они могут их использовать (и выбрать из них вишню), используйте стандартный инструмент diff (например, diff -u orig.tex new.tex > docdiffs). Это лучший способ аннотировать что-то вроде документов LaTeX, и его может легко использовать любой, кто участвует в создании документа из источников LaTeX. Затем вы можете использовать стандартные комментарии LaTeX в своем патче, чтобы объяснить изменения, и они могут быть очень легко интегрированы. Если документ находится в какой-либо системе контроля версий, просто используйте VCS для создания файла исправления, который можно просмотреть.

Answer 3

Я использовал changes.sty, что дает базовое изменение цвета:

\added{new text}
\deleted{old text}
\replaced{new text}{old text}

Все они принимают необязательный параметр с инициалами автора, который сделал это изменение. Это приводит к использованию разных цветов, и эти инициалы отображаются с надписью после измененного текста.

\replaced[MI]{new text}{old text}

Вы можете скрыть отметки об изменениях, задав опцию final пакету changes.

Это очень просто, комментарии не поддерживаются, но это может помочь.

Answer 4

Мой маленький домашний инструмент "fixme" использует \marginpar, где это возможно, и встроен в местах (например, в заголовках), где это трудно организовать. Это работает, потому что я не часто использую абзацы для других целей. Это означает означает, что вы не можете завершить макет, пока все не исправлено, но я не чувствую большой боли от этого ...

Кроме того, я искренне согласен с Майклом об использовании стандартных инструментов и управлении версиями.

Смотри также:

• Советы по совместному редактированию документа LaTeX (который касается основного вопроса ...)
• https://stackoverflow.com/questions/193298/best-practices-in-latex

и вилка:

• Как мне заставить Emacs заполнять предложения, но не абзацы?

Answer 5

Вы также можете попробовать пакет trackchanges.

Answer 6

Вы можете использовать пакет изменений , чтобы выделить области текста, которые были затронуты.

Если вы не хотите делать разметку вручную (что может быть утомительным и прерывать процесс редактирования), аккуратная утилита latexdiff возьмет diff вашего документа и выдаст его версию с добавлена ​​разметка для визуального отображения изменений между двумя версиями в выводе набора.

Это было бы моим предпочтительным решением, хотя я не проверял его на больших многофайловых документах.

Answer 7

Лучший пакет, который я знаю, это Easy Review , который обеспечивает возможность комментирования в среде LaTeX. Например, вы можете использовать следующие простые команды, например \add{NEW TEXT}, \remove{OLD TEXT}, \replace{OLD TEXT}{NEW TEXT}, \comment{TEXT}{COMMENT}, \highlight{TEXT} и \alert{TEXT}.

Некоторые примеры можно найти здесь .

Answer 8

Пакет trackchanges.sty работает точно так же, как changes.sty Смотрите ответ @ Сванте. Он имеет легко запоминающиеся команды, и вы можете изменить способ редактирования после компиляции документа. Вы также можете скрыть изменения для печати. ​​

Answer 9

Пакет todonotes выглядит великолепно, но если он окажется слишком громоздким для использования, простое решение - просто использовать сноски (например, красным, чтобы отделить их от обычных сносок).