文本注释的数据格式

Fab*_*olm 6 format text comments

差异格式是或多或少用于表示文本之间的差异和由程序员被广泛用于分发源代码更改的事实标准。大多数版本控制系统可以输出差异,差异用于讨论对文本(例如源代码)的提议更改,因为它们在说明更改方面非常强大。

然而,我经常想简单地评论一个文本而不改变它,并且想要一种数据格式,它可以以一种与 diff 用于更改的方式一样强大的方式来表示对文本的注释。一个典型的用例是代码审查,我想对代码发表评论,但(还)不提出任何更改。另一个用例是用我自己的想法和提醒来注释一篇文章。在 Word 中,我可以通过标记文本并在文本旁边创建注释气球来注释文本。但是 Word 在其他方面很麻烦——我希望将注释放在一个单独的文件中,并保持原样。

存在哪些数据格式可以以与 diff 表示更改的方式一样精确的方式表示对文本的注释?

我不是在寻找像“XML”这样的一般答案。我正在寻找明确表示文本注释的格式。(也许除了 Word 等某些程序的特定于应用程序的格式之外,不存在这种格式。)

Jen*_*och 5

很好的问题。

大多数人都会将 XML 或 HTML 之类的子集放入讨论中。标记语言使用存储在原始文本中的(数据)属性。但这不是您要寻找的。我排除了 XML/HTML 和 RDF 及微格式。

一般来说

您需要保留原始文本,克隆它,然后通过自定义标记语言添加注释。这允许原始文本与注释文本之间存在文本差异。重要的是原始文本和文本注释的修订是分开存储的。

这允许多个差异:

  • “原始文本”和“带注释的文本修订版 1..n”之间的差异
  • “注释文本 rev n”和“注释文本 rev n+1”之间的差异。

这是相当强大的。

存在哪些数据格式?

在对峙表示中,文档的文本与注释分开,注释通过字符偏移连接到特定的文本范围。注释通过文件命名约定与其文本关联,即它们的基本名称(不带后缀的文件名)相同:例如,文件 PMID-1000.a1 包含文件 PMID-1000.txt 的注释。

正如您所看到的,它是“基于文件名的注释关联”。学术研究和改进的空间很大,)

  • 这个答案比我最初想象的要好。我一直在寻找一种注释格式,主要用于代码和文档审阅,我希望将它们存储为纯文本(或 Markdown 或简单的东西),例如可以从 PDF 导出(或作为 PDF 导入)的 FDF 文件注释,但对于文本文件而不是 PDF,我的结论是没有通用格式(例如,受多个 IDE 支持),但 diff 可能是最好的解决方案。事实上,我可以只注释代码,将其提交到 Git 或 Subversion,然后进行比较,也可以查看所有历史记录(不需要额外的 IDE)。 (2认同)