Skip to content

Commit 08cd00c

Browse files
committed
More details on building articles for publication
1 parent c13fbb2 commit 08cd00c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

vignettes/issue_build_guide.Rmd

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ For each article in the issue:
6666
```
6767

6868
This needs an OpenAI API key stored in `.Renviron` as `OPENAI_API_KEY`. Check the copyediting carefully, as the AI can make mistakes. It is usually pretty good on the main article, but often messes up the bib file.
69-
* For articles with an Rmd file, make sure it renders to both pdf and html. output should be set to
69+
* For articles with an Rmd file, make sure it renders to both pdf and html. output should be set to:
7070

7171
```yaml
7272
output:
@@ -75,14 +75,16 @@ For each article in the issue:
7575
self_contained: yes
7676
```
7777

78-
* For articles containing a tex file, but no Rmd file, use texor to create the Rmd
78+
Many authors include LaTeX-specific or html-specific elements that cause problems. These need to be converted to work in both outputs.
79+
80+
* For articles containing a tex file, but no Rmd file, use texor to create the Rmd file:
7981

8082
```r
8183
texor::latex_to_web("<path to article folder>")
8284
```
8385

8486
- The conversion to Rmd can be fragile, especially if authors have defined their own LaTeX macros, or use additional packages. Also tables, equations and equation cross-referencing can need fixing.
85-
- This should only produce an html output. The original tex file is used to produce the pdf output.
87+
- The Rmd file created only generates an html output. The original tex file is used to produce the pdf output.
8688

8789
* If you encounter problems that you can't solve yourself, ask the Technical Editor for assistance.
8890

0 commit comments

Comments
 (0)