I am trying to figure out in RMarkdown how to underline some words. If I am knitting to HTML I can do this:
<u>These words are underlined</u>
Which works fine in that case. But the underlining is not persisted when I knit to Microsoft Word. I don't believe any changes have been made to RMarkdown to natively do it such as the commands for bold and italics. Any suggestions?
Thanks
Simply you can use the underline class [Your text]{.underline}, which pandoc innately supports, as like the small caps class [Your text]{.smallcaps}. This method also works for the production of other formats, such as HTML and PDF.
---
title: "Untitled"
output: word_document
---
[Underlined text]{.underline}
[Small Capital text]{.smallcaps}
For what it's worth ... (; As far as I get it, this is not possible by using HTML tags. The reason why HTML tags work when rendering to HTML is that the HTML code is not touched upon by rmarkdown, knitr or pandoc and simply passed through to the final HTML document as text. In case of HTML the browser knows what to do with this "text". But in Word or Latex it's simply text which will be displayed as is.
However, for Word output you could have a look at the officedown package which adds some addtional Word functionalities to rmarkdown via the officer officer package , e.g. the following example RMD shows how to get underlined text in Word:
---
title: "officedown template"
output: officedown::rdocx_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, fig.cap = TRUE)
library(officedown)
library(officer)
ft <- fp_text(underlined = TRUE)
```
This document presents most of the features of the package `r ftext("officedown", ft)`.
Just tried everything that came to my mind - seems to be not possible
(would be great to hear about actually working solutions)
I tried the following:
<u> text </u>
<ins> text </ins>
<span style="text-decoration:underline"> text </span>
$\text{\underline{LaTeX makes it possible}}$
$\underline{LaTeX makes it possible}$
While a most of these worked for html_document - none really worked for Rmarkdown to Word.
<u> - the obvious solution - didn't work.
<ins> which is also often suggested - didn't work.
html5 markup - didn't work
LaTeX - did not work
Might well be, that this just is not possible.
The problem has two parts:
1.) Getting Rmarkdown/pandoc to render the html when knitting to a word file. How to achieve this has been explained here: HTML tags in Rmarkdown to word document by user #tarleb (please consider upvoting that answer as it is the basis for mine).
2.) <u> for underlining has been more or less deprecated. However, the <u> tags simply have to be wrapped inside a <p> to work.
So this should achieve what you want:
---
output:
word_document:
md_extensions: +raw_html-markdown_in_html_blocks
pandoc_args: ['--lua-filter', 'read_html.lua']
---
<p><u>This text will be underlined.</u> This not anymore</p>
<u>But this will not.</u>
<p style="text-decoration: underline;">Neither will this.</p>
with a file read_html.lua in the same directory with this content:
function RawBlock (raw)
if raw.format:match 'html' and not FORMAT:match 'html' then
return pandoc.read(raw.text, raw.format).blocks
end
end
A workaround
RMarkdown is based on Pandoc, and Pandoc's Markdown does not natively support underline. Underline in Pandoc's Markdown is implemented by HTML tag <u>...</u>. However, <u>...</u> cannot be not converted into underline text in docx or pdf(tested with pandoc 2.10.1). A workaround is modifying the text style in MS Word.
Choose a substitute for <u>...</u>, such as ***...***.
---
output:
word_document: default
---
This is a regular paragraph.
***This paragraph is bold italic at first. It will be underlined later.***
Knit Rmarkdown document into docx
Replace bold italic text with underline text in Word.
Press Ctrl + H.
Set the text format in Format > Font.
Find Bold Italic text.
Replace with Regular Underline text.
Press Replace All
If you have used <u>...</u>, replace them with ***...***.
Press Ctrl + F.
check the regex option.
replace <u>(.+)<\/u> with ***$1*** .
Press All next to Replace.
Return to step 1 and step 2.
Advice
I recommend sticking to the native syntax of Rmarkdown and Pandoc's Markdown. Thought the syntax is limited, it works well with different output formats. Limited syntax is the power of Markdown! It is so simple that it can be converted into many different output formats. I also recommend following the concept of separation of content and style. It saves me from formatting contents repeatedly.
Related
I'm trying to reduce the size of a section of text within a qmd document that needs rendering in docx.
I tried using a styled div:
---
title: "Test"
format: docx
---
The main text will be normal-sized.
::: {style="font-size: 10pt;"}
This block of text should be sized 10pt.
:::
Observed output:
Intended outptut:
Of note, my code works well in html.
Is there another way of doing this with a docx output?
The styling process for docx is a little different: one needs to create a "reference doc", set the styles in that doc and apply it with
---
format:
docx:
reference-doc: my-styled-reference.docx
---
See How to specify the font used for word doc exported using pandoc? and How do I add custom formatting to docx files generated in Pandoc? for more details on this process.
I am trying to change the code chunk formatting options in a rmarkdown document that is generated as a pdf. I want the formatting for these code chunks to be different. I want similar to
class.source="bg-info", class.output="bg-warning"
for HTML documents.
Not sure if I understood your question correctly. Please always include an minimum working example (MWE) with your question for greater clarity. Since it is not outline exactly what is required, a general outline is provided.
To change the code chunk formatting options in a Rmarkdown document (PDF or HTML) you can use the built-in Pandoc Syntax Highlighting styles. You can change both the background of code chunks, and the font color. All you have to do is to add the highlight in YAML.
highlight specifies the syntax highlighting style. Some alternatives are default, tango, pygments, kate, monochrome, espresso, zenburn, haddock, breezedark, and textmate. You can also use null to prevent any highlighting. For example:
title: "A nice document"
output:
html_document:
highlight: haddock
You can change the the appearance of your code and output with some predefined CSS classes for backgrounds in HTML: "bg-primary", "bg-success", "bg-info", "bg-warning", and "bg-danger". Arbitrary class names and user-define custom CSS rules are also allowed. A detailed discussion can be found in Yihui Xie's R Markdown Cookbook.
My R markdown PDF file does not show inline code as it should. This only works correct when choosing HTML as output file.
Generally inline code should look like this. So when highlighting some words within my text, I want it to look like this.
E.g. I want to have this sentence in my PDF output:
A good way to pronounce %>%when reading code is then.
Instead I get what you see here:
The image shows how the inline code is displayed in my output. Only changed font and style, instead of grey background.
I use exactly the same code as I am using here at stack overflow: `` these signs before and after the text I want to highlight.
Any tip how to fix this? I need PDF output, and not HTML.
Thanks a lot!
Text like `this` is translated into the LaTeX command \texttt{this}. LaTeX commands can be changed, so we can modify the \texttt command to create a color box:
```{=latex}
\definecolor{codegray}{HTML}{cccccc}
\let\textttOrig\texttt
\renewcommand{\texttt}[1]{\textttOrig{\colorbox{codegray}{#1}}}
```
Add the above at the beginning of your Rmd document (right after the YAML header) to get a gray background for you inline code snippets.
I've got an .Rmd I need to output using the word_document2 format with R bookdown. It has a .docx template which works fine for heading styles etc.
However, it appears that the figure/table captions are output using the "normal" style, so I can't control the font, size etc. on them as a group and am having to go through after the fact and change them all by hand. Is there a way to get bookdown to designate them to use Word's "caption" style, or alternatively to specify a custom style for them?
In your YAML header for your .Rmd, you can specify a Word doc to use as the basis for all formatting. Your rendered word doc will pick up all the styles from this reference_docx and apply them to your output:
---
title: "Example .Rmd"
output:
word_document:
toc: yes
reference_docx: word-styles-reference-01.docx
theme: hpstr
fontsize: 11pt
---
The Word file that I am using for styles is here: https://drive.google.com/open?id=1gSyE22hJbGdsTj6C-RWBTnyBVnG0XwB3
In trying to make a reproducible example, I found the problem (apologies for not including an example in the first place).
The issue wasn't with the .Rmd, but the reference .docx itself. It had a "Caption" style, but for some reason it didn't have "Image Caption" or "Table Caption" styles, which is what markdown was looking for. I copied those styles over from another Word document according to these instructions, and now it works fine.
I'm afraid the response will be: "Markdown is meant to be simple and it doesn't do that", but it (almost) never hurts to ask.
When writing an R Markdown document I can view the HTML file in a browser and it looks great. When I try to print it, either on paper or as PDF, the color in the figures is printed but not the syntax highlighting. Is there a way to maintain syntax highlighting when printing?
Example:
Minimal Example
=====
This text looks great in the file and the plot prints in color, but see commented code below.
```{r}
# this commented line will be green in the HTML file, but will be black when I print it
z <- cor(mtcars)
require(lattice) # 'require' will be blue in the HTML file, but will be black when I print it
levelplot(z)
```
I push the "Knit HTML" button in RStudio and open the HTML in Chrome or Safari and there are no problems. If I print from the HTML from the browser all the syntax highlighting is lost.
After doing your 'Knit' to your original example.Rmd you will have an example.md in your working path, then use pandoc...
# for pdf (you need to have latex installed)
system( "pandoc example.md -o example.pdf")
# for syntax-highlight persistant html
system("pandoc example.md -o example.html -s -S")
One solution that I also found is to knit to HTML, preview the html file in the browser, and then highlight everything and paste it into a MS Word document. From there you can export to PDF or print. It unfortunately does not copy all of the images to the Word document. But if all you need is the syntax highlighting, and not too worried about images or plots, then this solution is fairly straight forward. It actually copies the boxes of code a little better than the pandoc solution, but with the drawback of no images.