如何跟踪大型文档的必要更改(“待办事项”)?

如何跟踪大型文档的必要更改(“待办事项”)?

在撰写我的博士论文时,我使用该fixme软件包向我的文档添加注释和评论pdflatex,并且我定义了几种类型的注释,以便轻松看到“实质性”变化(例如“文本可能有误”或“缺少一些信息”)和“表面”变化(例如“此表的对齐不完美”...)之间的区别。

我的文档中现在有大量的注释,我非常绝望,因为似乎不可能对要做的更改有一个概览并对它们进行排序,以确保首先做最重要的事情,并进行一些时间管理和规划,不要只为了创建一个漂亮的图表而浪费太多时间。

有没有人有好的解决方案或工作流程

  • 高效编辑论文或书籍等大型文档
  • 并跟踪笔记、想法和要做的事情?

一些想法:
如果可以在源代码(或 pdf)中创建一种“锚点”,这样我就可以直接通过待办事项注释中的超链接跳转到那里,那就太好了。

我认为我需要一个外部解决方案,允许我对这些笔记进行排序、重新排列和标记,以便确定优先级和概览——也许使用思维导图或可以过滤、排序和重新排列的表格。
另一方面,我想将它们留在乳胶文档中,这样在查看某一页时,我就可以看到相应的笔记。但在 LaTeX 编辑器中输入它们,然后在外部应用程序中重新输入它们,这没有多大意义,但这一切对我来说听起来非常复杂。:-(

答案1

我结合使用了fixmetodonotes来实现我的论文这种效果,其中第一页包含需要注意的地方的超链接。你可以查看我的论文来源这里

Fixme 软件包具有广泛的功能,可用于对更正列表进行优先排序和格式化,但我个人认为这对于像论文这样的单人项目来说太过分了。我只使用了一种 Fixme 注释。在我看来,你只是想要一种方法来跟踪你需要返回的内容,并让草稿的读者知道哪些部分需要特别注意:当你考虑这是一个“警告”还是“注释”或“致命错误”,以及它是否“固定”,以及软件包提供的所有其他选项时,你可能已经解决了这个问题。所以,我的建议是不要试图把事情搞得太复杂。在尝试撰写论文时,已经有足够的拖延可能性,所以不要给自己更多拖延的时间。

编辑:关于从待办事项注释链接回 latex 源的问题,请查看 SyncTeX,如以下问题的答案中所述这个问题。在评论中,您提到您使用 Skim,我相信可以将其配置为使用 SyncTeX。

答案2

我自己使用的一个更高级的解决方案是使用 PDF 注释pdfcomment软件包。它的优点是 PDF 阅读器本身支持它。使用 Acrobat,至少您可以编辑、回复、删除、勾选、导入/导出、搜索和排序评论。

答案3

我不熟悉这个fixme包,但我认为todonotes包可能就是您要找的东西。使用文档中描述的颜色选项,您可以为不同类型的笔记定义不同的颜色。\todototoc为您提供了待办事项列表,您甚至可以在其中显示颜色,以便快速概览并快速找到主要缺陷。使用hyperref,列表中的项目甚至可以点击,这样您就可以优雅地找到文本中的要点。

编辑:该todonotes手册fixme直接引用 1.8.5,您会发现这特别有趣。

答案4

跳出固有的思维模式思考一下,将这种事情保留在专为跟踪项目而设计的系统中是否有意义?

就我个人而言,我使用化石用于对我的所有软件和写作项目进行版本控制。我喜欢对我的文本进行修订控制,而 TeX 和 LaTeX 非常适合进行修订控制。(不同于 Word 文档,它们是脆弱的二进制文件。)我还尝试在与另一台机器上的克隆保持同步的存储库中工作。这为我的作品提供了备份,没有麻烦或头痛。

我把这种技术用在了所有事情上,从项目文档(用 Markdown 和 LaTeX 混合编写,然后使用潘多克以及由我的项目构建系统管理的 pdflatex)到一个用于按需印刷服务的个人书籍长度项目。

我之所以考虑使用 Fossil 来解决您的特定问题,是因为它包含一个集成的故障单机制。故障单可以报告、包含在时间线视图中,并可供特定签入引用。

在边注、脚注或评论中使用票证 ID 来引用存储库中的完整解释会很容易。

在我的几个项目中,我都在脚注中包含了文档修订的标识符,以便我能够始终将纸质副本与存储库关联起来。

集成的一个很酷的点是,它会生成一个脚本,提取所有引用的票证(和签到评论)并生成一个附录……

相关内容