Skip to content

Commit c0cb8b4

Browse files
committed
Fix English wording and typos in template document
Correct grammar/typos (accompanied by, possible, set up) and an invalid YAML example (missing colon after author), and reword an awkward sentence in the advanced formatting section.
1 parent e3bca19 commit c0cb8b4

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Jane Doe, John Doe
66
journal
77
extension](https://github.com/computorg/computo-quarto-extension), the
88
knitr kernel (R user) and
9-
[renv](https://rstudio.github.io/renv/articles/renv.html) to set-up the
9+
[renv](https://rstudio.github.io/renv/articles/renv.html) to set up the
1010
dependencies.
1111
For a detailed, step-by-step guide on preparing your article, setting up
1212
the continuous integration and submitting it to Computo, please consult

‎_quarto.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ author:
2727
date: last-modified
2828
date-modified: last-modified
2929
description: |
30-
Template for preparing a submission to Computo, using the [quarto journal extension](https://github.com/computorg/computo-quarto-extension), the knitr kernel (R user) and [renv](https://rstudio.github.io/renv/articles/renv.html) to set-up the dependencies.
30+
Template for preparing a submission to Computo, using the [quarto journal extension](https://github.com/computorg/computo-quarto-extension), the knitr kernel (R user) and [renv](https://rstudio.github.io/renv/articles/renv.html) to set up the dependencies.
3131
3232
For a detailed, step-by-step guide on preparing your article, setting up the continuous integration and submitting it to Computo, please consult the [guidelines for authors](https://computo-journal.org/site/guidelines-authors.html).
3333
abstract: >+
@@ -36,9 +36,9 @@ keywords: [key1, key2, key3]
3636
bibliography: references.bib
3737
github-user: computorg
3838
repo: "template-computo-r"
39-
draft: true # set to false once the build is running
39+
status: "draft"
4040
published: false # will be set to true once accepted
4141
license: CC-BY-4.0
4242
format:
4343
computo-html: default
44-
computo-pdf: default
44+
computo-pdf: default

‎template-computo-R.qmd‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## About this document
44

5-
This document, accompanied with the [tuned git repos](https://github.com/computorg/template-computo-R/), provides a template for writing contributions to **Computo** [@computo].
5+
This document, accompanied by the [tuned git repos](https://github.com/computorg/template-computo-R/), provides a template for writing contributions to **Computo** [@computo].
66

77
::: {.callout-tip}
88
## Note
9-
The content of this document only provides key formatting principles. For a detailed, step-by-step guide on preparing your article and submitting it to Computo, please consult the [guidelines for authors](https://computo-journal.org/site/guidelines-authors.html).
9+
This document provides only the key formatting principles. For a detailed, step-by-step guide on preparing your article and submitting it to Computo, please consult the [guidelines for authors](https://computo-journal.org/site/guidelines-authors.html).
1010
:::
1111

1212
## Quarto
@@ -15,7 +15,7 @@ The content of this document only provides key formatting principles. For a deta
1515

1616
## Requirements
1717

18-
You need [quarto](https://quarto.org/) installed on your system and the [Computo extension](https://github.com/computorg/computo-quarto-extension) to prepare your document. For the latter, once quarto is installed, run the following to install the extension in the current directory (it creates a `_extension` directory which is ignored by git thanks to `.gitignore` by default):
18+
You need [quarto](https://quarto.org/) installed on your system and the [Computo extension](https://github.com/computorg/computo-quarto-extension) to prepare your document. For the latter, once quarto is installed, run the following to install the extension in the current directory (it creates a `_extension` directory which is ignored by git thanks to `.gitignore` by default):
1919

2020
```.bash
2121
quarto add computorg/computo-quarto-extension
@@ -30,7 +30,7 @@ This section covers basic formatting guidelines for quarto documents.
3030
To render a document, run `quarto render`. By default, both PDF and HTML documents are generated:
3131

3232
```.bash
33-
quarto render template-computo-R.qmd # will render both to html and PDF
33+
quarto render # will render both to html and PDF
3434
```
3535

3636
::: {.callout-tip}
@@ -66,7 +66,7 @@ f(x_1, \dots, x_n; \mu, \sigma^2) =
6666
\frac{1}{\sigma \sqrt{2\pi}} \exp{\left(- \frac{1}{2\sigma^2}\sum_{i=1}^n(x_i - \mu)^2\right)}
6767
$$
6868

69-
It is also posible to cross-reference an equation, see @eq-mylabel:
69+
It is also possible to cross-reference an equation, see @eq-mylabel:
7070

7171
$$
7272
\begin{aligned}
@@ -101,7 +101,7 @@ Quarto uses either Jupyter or knitr to render code chunks. This can be triggered
101101
``` yaml
102102
---
103103
title: "My Document"
104-
author "Jane Doe"
104+
author: "Jane Doe"
105105
---
106106
```
107107

@@ -171,7 +171,7 @@ page](https://quarto.org/docs/authoring/cross-references.html).
171171

172172
## Advanced formatting
173173

174-
Advanced formatting features are possible and documented (including interactive plots, pseudo-code, (Tikz) diagrams, Lua filters, mixing R + Python in the same document), but are beyond the scope of this simple introduction. We point several entries in this direction.
174+
Advanced formatting features are possible and documented (including interactive plots, pseudo-code, (Tikz) diagrams, Lua filters, mixing R + Python in the same document), but are beyond the scope of this simple introduction. We list a few useful resources below.
175175

176176
::: {.callout-warning}
177177
## More information

0 commit comments

Comments
 (0)