通过 Rmarkdown 添加 MS Word 评论答案

【问题标题】：Add a MS Word Comment via Rmarkdown通过 Rmarkdown 添加 MS Word 评论
【发布时间】：2019-09-11 15:29:54
【问题描述】：

有没有办法通过 R 降价文件添加 MS Word “评论”？我正在使用reference_docx，并且熟悉添加自定义样式...但还没有弄清楚如何让评论显示在这样的一侧：

澄清一下：我想在我的纯文本 Rmd 文件中添加一个标签（或什么？），这样当我“编织”生成的 MS Word 文档时，就会有一个呈现的注释。

【问题讨论】：

【解决方案1】：

其实这是可以的。是的，Markdown（和 RMarkdown）用于纯文本写作，但它们是使用 pandoc 翻译的。于是我google了一下，发现如下代码，效果很好：

---
title: "test"
output:
  word_document: default
---

This text contains a [This is the comment]{.comment-start id="0" author="Johannes G." date="2020-01-13T10:12:00Z"}comment.[]{.comment-end id="0"}.

这会在编织成其他格式时造成一些混乱，因此您可能需要考虑使用 R 函数来代替：

```{r echo=FALSE}
word_comment <- function(comment, highlight = "") {
  if (isTRUE(knitr:::pandoc_to() == "docx")) {
    paste0('[', comment, ']{.comment-start id="0" author="Johannes G."',
           'date="2020-01-13T10:12:00Z"}', highlight, '[]{.comment-end id="0"}')
  }
}
```

This text contains a `r word_comment("This is the comment", "comment.")`.

代码可能可以改进，但我找不到创建评论的块的文档，所以目前它工作得很好。

【讨论】：

【解决方案2】：

我想扩展@JBGruber 的好答案：

此代码适用于 html 和 word 作为输出：

```{css, echo=FALSE}
span.comment-start{
    background: #e0f3db;
}
span.comment-end{
    background: #e0f3db;
}
span.comment-start::after{
    content: " (" attr(author) ", " attr(date) ") [";
}
span.comment-end::before{
    content: "]"
}
span.comment-text{
    background: #fdbb84;
}

```

```{r, echo=FALSE}
commentN <- 0
cmt <- function(txt, cm, author, date = "2021-01-01", comN = commentN){
  cmt_str <- paste0('<span class="comment-text">[',cm,']{.comment-start id="', comN, '" author="', author, '" date="', date, '"}', txt, '[]{.comment-end id="',commentN,'"}</span>')
  assign("commentN", commentN + 1, envir = .GlobalEnv)
  return(cmt_str)
}
```

您可以通过调用在文本中添加 cmets

`r cmt("Text to be commented", "The comment itself", "myName", "Date")`

【讨论】：

【解决方案3】：

Markdown（和 RMarkdown）用于纯文本写作。因此，您不能像在 word 中那样添加评论（并且可以在屏幕的某个位置弹出）。

不过，您可以在 RMarkdown 中添加纯文本 cmets，在渲染到 Docx 后，您可以在 word 中看到普通的单词注释（它也适用于 Word 到 RMarkdown）。

详情见redoc library

【讨论】：

“尽管如此”这句话是我要问的。我一直在玩 redoc，但还没有弄清楚如何发表评论（跟踪更改很棒）......不过，我会继续研究 redoc，我可能只是错过了一些东西。
试试{>> <<}看看https://github.com/CriticMarkup/CriticMarkup-toolkit/
"Markdown（和 RMarkdown）用于纯文本写作。" - 我强烈反对。 RMarkdown 用于准备纯文本的文档，也可以使用表格、图形等，以及其他方式呈现 R 生成的结果。因此，它非常灵活。指定注释不起作用没有根本原因。除了到目前为止没有人实现它。
我很确定可以有一个实现，用户可以添加 popuup cmets 和许多其他功能。然而，这不是降价的目的。是的，markdowns 是为了详细说明（甚至是非常复杂的）文档而创建的，而 Rmarkdown 可以做到这一点，包括可重现的代码。而且，这个想法是让基本文本的界面更加简洁，而不是丰富的文档。因此，我认为弹出式 cmets 不适合。