1*405e795fSMasatake YAMATO.. _ctags_lang-rmarkdown(7): 2*405e795fSMasatake YAMATO 3*405e795fSMasatake YAMATO====================================================================== 4*405e795fSMasatake YAMATOctags-lang-rmarkdown 5*405e795fSMasatake YAMATO====================================================================== 6*405e795fSMasatake YAMATO----------------------------------------------------------------------- 7*405e795fSMasatake YAMATORandom notes about tagging R Markdown source code with Universal Ctags 8*405e795fSMasatake YAMATO----------------------------------------------------------------------- 9*405e795fSMasatake YAMATO:Version: @VERSION@ 10*405e795fSMasatake YAMATO:Manual group: Universal Ctags 11*405e795fSMasatake YAMATO:Manual section: 7 12*405e795fSMasatake YAMATO 13*405e795fSMasatake YAMATOSYNOPSIS 14*405e795fSMasatake YAMATO-------- 15*405e795fSMasatake YAMATO| **@CTAGS_NAME_EXECUTABLE@** ...--extras=+{subparser}{guest} --languages=+RMarkdown ... 16*405e795fSMasatake YAMATO| **@CTAGS_NAME_EXECUTABLE@** ...--extras=+{subparser}{guest} --language-force=RMarkdown ... 17*405e795fSMasatake YAMATO| **@CTAGS_NAME_EXECUTABLE@** ...--extras=+{subparser}{guest} --map-RMarkdown=+.rmd ... 18*405e795fSMasatake YAMATO 19*405e795fSMasatake YAMATODESCRIPTION 20*405e795fSMasatake YAMATO----------- 21*405e795fSMasatake YAMATORMarkdown parser is an exclusive subparser stacked on top of the Markdown parser. 22*405e795fSMasatake YAMATOIt works when: 23*405e795fSMasatake YAMATO 24*405e795fSMasatake YAMATO* the Markdown parser is enabled, 25*405e795fSMasatake YAMATO* the ``subparser`` extra is enabled, and 26*405e795fSMasatake YAMATO* the RMarkdown parser itself is enabled. 27*405e795fSMasatake YAMATO 28*405e795fSMasatake YAMATOThe RMarkdown parser extends the way of detecting **codeblocks** from the 29*405e795fSMasatake YAMATOMarkdown parser for running guest parsers on **code chunks**. 30*405e795fSMasatake YAMATO 31*405e795fSMasatake YAMATOThe Markdown parser expects the following syntax for codeblocks 32*405e795fSMasatake YAMATO 33*405e795fSMasatake YAMATO.. code-block:: 34*405e795fSMasatake YAMATO 35*405e795fSMasatake YAMATO ```language-name 36*405e795fSMasatake YAMATO ... 37*405e795fSMasatake YAMATO ``` 38*405e795fSMasatake YAMATO 39*405e795fSMasatake YAMATOFor an example 40*405e795fSMasatake YAMATO 41*405e795fSMasatake YAMATO.. code-block:: 42*405e795fSMasatake YAMATO 43*405e795fSMasatake YAMATO ```r 44*405e795fSMasatake YAMATO ... 45*405e795fSMasatake YAMATO ``` 46*405e795fSMasatake YAMATO 47*405e795fSMasatake YAMATOThe RMarkdown parser accepts the following syntax for code chunks 48*405e795fSMasatake YAMATOas the markdown parser accepts codeblocks 49*405e795fSMasatake YAMATO 50*405e795fSMasatake YAMATO.. code-block:: 51*405e795fSMasatake YAMATO 52*405e795fSMasatake YAMATO ```{language-name chunk-label, ...} 53*405e795fSMasatake YAMATO ... 54*405e795fSMasatake YAMATO ``` 55*405e795fSMasatake YAMATO 56*405e795fSMasatake YAMATOFor an example 57*405e795fSMasatake YAMATO 58*405e795fSMasatake YAMATO.. code-block:: 59*405e795fSMasatake YAMATO 60*405e795fSMasatake YAMATO ```{r precalc fig.height=4} 61*405e795fSMasatake YAMATO ... 62*405e795fSMasatake YAMATO ``` 63*405e795fSMasatake YAMATO 64*405e795fSMasatake YAMATOGive `--extras=+{guest}` for enabling ``guest`` to command line if you 65*405e795fSMasatake YAMATOwant to run proper parsers on inside code chunks. 66*405e795fSMasatake YAMATO 67*405e795fSMasatake YAMATOThe parser extrats chunk labels coming after `language-name` as 68*405e795fSMasatake YAMATO`chunklabel` kind objcts. The kind is enabled by default. 69*405e795fSMasatake YAMATO 70*405e795fSMasatake YAMATOEXAMPLES 71*405e795fSMasatake YAMATO-------- 72*405e795fSMasatake YAMATO"input.rmd" 73*405e795fSMasatake YAMATO 74*405e795fSMasatake YAMATO.. code-block:: RMarkdown 75*405e795fSMasatake YAMATO 76*405e795fSMasatake YAMATO # Section 1 77*405e795fSMasatake YAMATO 78*405e795fSMasatake YAMATO ```{r myblock} 79*405e795fSMasatake YAMATO zero_fun <- function () { 80*405e795fSMasatake YAMATO return 0 81*405e795fSMasatake YAMATO } 82*405e795fSMasatake YAMATO ``` 83*405e795fSMasatake YAMATO 84*405e795fSMasatake YAMATO # Section 2 85*405e795fSMasatake YAMATO 86*405e795fSMasatake YAMATO"output.tags" 87*405e795fSMasatake YAMATOwith "--options=NONE --extras=+{guest} --fields=+KZln -o - input.rmd" 88*405e795fSMasatake YAMATO 89*405e795fSMasatake YAMATO.. code-block:: tags 90*405e795fSMasatake YAMATO 91*405e795fSMasatake YAMATO Section 1 input.rmd /^# Section 1$/;" chapter line:1 language:Markdown 92*405e795fSMasatake YAMATO Section 2 input.rmd /^# Section 2$/;" chapter line:9 language:Markdown 93*405e795fSMasatake YAMATO myblock input.rmd /^```{r myblock}$/;" chunklabel line:3 language:RMarkdown 94*405e795fSMasatake YAMATO zero_fun input.rmd /^ zero_fun <- function () {$/;" function line:4 language:R 95*405e795fSMasatake YAMATO 96*405e795fSMasatake YAMATOSEE ALSO 97*405e795fSMasatake YAMATO-------- 98*405e795fSMasatake YAMATOctags(1), ctags-client-tools(7), `R Markdown: The Definitive Guide <https://bookdown.org/yihui/rmarkdown/>`_ 99