This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Next revision Both sides next revision | ||
projects:workgroups:notes_on_writing_text_for_the_book [2019/03/13 10:19] schuemie [Generic Markdown syntax] |
projects:workgroups:notes_on_writing_text_for_the_book [2019/03/13 10:20] schuemie |
||
---|---|---|---|
Line 24: | Line 24: | ||
* Tables and lists only render correctly if they have an empty line in front of them. | * Tables and lists only render correctly if they have an empty line in front of them. | ||
- | * Extra rows in the boob.bib file (not used in the text) are not a problem. | + | * Extra rows in the book.bib file (not used in the text) are not a problem. |
===== Editing the Book ===== | ===== Editing the Book ===== | ||
Line 71: | Line 71: | ||
term | term | ||
: definition | : definition | ||
- | |||
- | |||
- | |||
===== Adding figures ===== | ===== Adding figures ===== | ||
- | Please add figure files to a subfolder of the [[https://github.com/OHDSI/TheBookOfOhdsi/tree/master/images|images folder]]. The subfolder should have the same name as the chapter Rmd file. | + | Please add figure files to a subfolder of the [[https://github.com/OHDSI/TheBookOfOhdsi/tree/master/images|images folder]]. The subfolder should have the same name as the chapter Rmd file. Keep filename extensions in lower case, so 'figure.png', not 'figure.PNG'. |
In the chapter, you can include a figure using the following piece of text: | In the chapter, you can include a figure using the following piece of text: | ||
Line 85: | Line 82: | ||
``` | ``` | ||
- | Here, ''figure1'' is the label that can be used to reference the figure. You furthermore must specify a caption and the path to the figure file. | + | Here, ''figure1'' is the label that can be used to reference the figure. Only use alphanumeric characters in labels. So not '```{r figure_1}' but '```{r figure1}'. You furthermore must specify a caption and the path to the figure file. |
You can reference the figure in your text for example using ''Figure \@ref(fig:figure1) shows ...''. | You can reference the figure in your text for example using ''Figure \@ref(fig:figure1) shows ...''. |