是否有在线评论系统、惯例或程序?

是否有在线评论系统、惯例或程序?

在撰写此类论文时https://github.com/geneura-papers/2015-Evostar/blob/b9474f66cd45aee316136831c4a9b4acaef4e89f/GPbot/GPbot-evostar2015.tex我们使用 LaTeX 评论来评论论文本身并提出建议。有几个问题

  • 当问题解决后,我们会手动删除评论。除非我们不这样做,这种情况经常发生。
  • 当我们提交论文时,我们还必须手动删除所有评论。有时我们会将资料提交到允许下载的地方,其中包含我们的所有评论,包括内部笑话。
  • 我们无法知道尚未解决的问题,在某些情况下,也无法知道是谁造成的。我们通常会签署文件,但有时我们会忘记。

我们需要一个工具,也许在编译后使用它,将允许

  1. 使用一些简单的标记来表示问题,例如笔记 重要的或者解决了(在这种情况下,它可能会被删除)
  2. 删除生产中的所有问题(我确信可能已经有一些这样做的事情了),除了一些标记为注释的问题应该留在源中(元数据,如文件名或其他内容)
  3. 如果能和git、GitHub绑定就完美了
  4. 列出未解决的问题

如果没有这样的工具,那会很奇怪,但我一直找不到它。另一方面,如果我们开始编写它,其他人会有兴趣使用它吗?有人发现过类似的问题吗?你是如何解决的?

答案1

这可能是显而易见的,但您可以定义一个不执行任何操作的命令并将其用作输入文件中的标记。

此命令忽略它收到的所有输入。它的唯一功能是作为输入文件中的注释。第一个参数是可选的,因此您可以键入\FIX[note]{comment}或仅键入\FIX{comment}

\documentclass{article}

\newcommand{\FIX}[2][\relax]{\relax}
\newcommand{\SOLVED}{\FIX}

\begin{document}

The sentunz may not be spelld korrectly.
%%
\FIX[important]{Fire the employee who wrote this.}
\SOLVED[2014-11-26]{Employee fired}
%%

\end{document}

您稍后可以重新定义这些命令来执行其他操作,例如打印带有边缘注释的版本:

\renewcommand{\FIX}[2][\relax]{\marginpar{{\footnotesize \textbf{#1}\par #2}}}

在此处输入图片描述

您还可以为 FIX 命令创建一个计数器,\newcounter{fix}并在每次调用该命令时增加它\stepcounter{fix}。在文档末尾,您可以调用命令来打印\thefix带注释的版本。

答案2

FiXme 包:CTAN链接 文档 FiXme 是一款用于 LATEX 文档的协作注释工具。似乎是一个全面的解决方案。

相关内容