【问题标题】:Data format for text annotations文本注释的数据格式
【发布时间】:2012-12-02 17:57:57
【问题描述】:

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

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

存在哪些数据格式可以像 diff 一样精确地表示文本注释?

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

【问题讨论】:

    标签: text comments format


    【解决方案1】:

    很好的问题。

    大多数人会在讨论中抛出 XML 或 HTML 之类的子集。 标记语言使用存储在原始文本中的(数据)属性。但这不是你要找的。我不包括 XML/HTML 和 RDF 和微格式。

    一般情况

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

    这允许多个差异:

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

    这个功能很强大。

    存在哪些数据格式?

    在对峙表示中,文档的文本被保留 与注解分开,注解连接到特定的跨度 通过字符偏移的文本。注释与 它们的文本按文件命名约定表示它们的基本名称(文件 没有后缀的名称)相同:例如,文件 PMID-1000.a1 包含文件 PMID-1000.txt 的注释。

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

    【讨论】:

    • 优秀的答案!这些格式只需要一些概括。嗯...诱人... ;)
    • 这个答案比我最初想的要好。我一直在寻找一种注释格式,主要用于代码和文档审查,我希望它们以纯文本(或降价或简单的东西)的形式存储,比如可以从 PDF 导出(或导入为)PDF 的 FDF 文件cmets,但是对于文本文件而不是 PDF,我的结论是没有通用格式(例如,多个 IDE 都支持),但是 diff 可能是最好的解决方案。事实上,我可以只注释代码,将其提交到 Git 或 Subversion,然后在其中进行比较,也可以查看所有历史记录(无需额外的 IDE)。
    猜你喜欢
    • 2020-12-11
    • 2014-10-28
    • 1970-01-01
    • 2011-07-12
    • 2017-10-29
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-07-27
    相关资源
    最近更新 更多