在结账簿结尾处创建定义/定理索引

时间:2016-11-22 07:08:20

标签: r markdown knitr bookdown

为了方便读者,我想在我的书籍结尾处列出以书签形式写的缩写,一本简单的清单或书中正文的定义索引。即使用自定义块创建的,如下所示:

```{definition, bar, echo=T}
A bar is defined here as a foo-like thing.
```

(我需要定义,但其他人可能会喜欢定理列表等。不知道图表和表格的列表是否可以用同样的方式涵盖?)

感谢@yihui,我知道knitr::all_labels(engine == 'definition')是我的朋友。

所以我可以在本书的最后任何地方做到这一点,通常是在最后:

```{r comment="",results="asis",echo=FALSE}
knitr::all_labels(engine == 'definition') %>% unlist %>% paste0("\n\n","\\@ref(def:",.,"): ",.,"\n\n",collapse="\n\n") %>% cat

```

打印出来:

1: bar

2: foobar

可点击的数字。哪个可以。但是,如果在每个标签之后,实际定义也可以打印出来,那不是很好吗? (块中的内容在knitr :: all_labels(engine =='definition')中不可用)

2 个答案:

答案 0 :(得分:8)

以下是使用输出格式bookdown::html_document2的示例,它也适用于任何其他图书输出格式:

---
title: "Test Definitions"
output: bookdown::html_document2
---

```{r setup, include=FALSE}
def_list = list()
knitr::knit_hooks$set(engine = function(before, options) {
  if (before && options$engine == 'definition') {
    # collect definition terms from options$name
    def_list[[options$label]] <<- options$name
  }
  NULL
})
```

```{definition, d1, name='Foo'}
Foo is defined as ...
```

```{definition, d2, name='Bar'}
Bar is defined as ...
```

All definitions in this document:

```{r echo=FALSE, results='asis'}
def_list = unlist(def_list)
cat(sprintf('- \\@ref(def:%s) %s', names(def_list), def_list), sep = '\n')
```

输出:

definition list

基本思想是使用chunk hook来收集定义标签和名称,并在最后打印它们。您不必使用块选项name。它可以是任意选项,例如term。选项name是特殊的,因为定义的名称将在输出中打印。如果您不喜欢,可以使用term

```{definition, d2, term='Bar'}
Bar is defined as ...
```

答案 1 :(得分:2)

完美,所以加上Yihui的建议,这也打印出了定义,没有必要打扰名字,只需标签就可以了:

```{definition, 'Bar',echo=T,cache=F}
Bar is defined as something
```

```{definition, 'Bar2',echo=T,cache=F}
Bar2 is defined as something else.
```

Here are all the definitions in this book.

```{r comment="",results="asis",echo=FALSE,cache=F}


for(x in knitr::all_labels(engine == 'definition')){
   paste0("\n\n","\\@ref(def:",x,"): ",x,"\n\n>",knitr:::knit_code$get(x),collapse="\n\n") %>% cat
} 

```

...产生这个:

以下是本书中的所有定义。

1:Bar

  

Bar被定义为

2:Bar2

  

Bar2被定义为其他东西。