Skip to content

Commit

Permalink
Cleanup and revert
Browse files Browse the repository at this point in the history
  • Loading branch information
cthoyt committed Sep 4, 2024
1 parent 095c718 commit 4eee7bb
Showing 1 changed file with 33 additions and 39 deletions.
72 changes: 33 additions & 39 deletions example/paper.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,20 @@
---
title: >-
Article Writing with Markdown and the Open Journals publishing pipeline
Article Writing with Markdown and the Open Journals publishing pipeline
authors:
- name: Albert Krewinkel
email: [email protected]
affiliation: [ 1, 2, 4 ]
affiliation: [1, 2, 4]
orcid: 0000-0002-9455-0796
corresponding: true
roles:
- type: methodology
- type: software
degree: equal
- name: Juanjo Bazán
orcid: 0000-0001-7699-3983
affiliation: [ 1 ]
affiliation: [1]
equal-contrib: true
roles:
- type: software
- name: Arfon M. Smith
orcid: 0000-0002-3957-2474
affiliation: [ 1, 3 ]
affiliation: [1, 3]
equal-contrib: true
roles:
- type: methodology
- type: software
degree: equal
- type: supervision
degree: lead
affiliations:
- index: 1
name: Open Journals
Expand Down Expand Up @@ -65,6 +53,7 @@ paper by @upper1974.

[YAML]: https://yaml.org


# Statement of Need

The journal publisher, in most cases where you'd be reading this, Open
Expand Down Expand Up @@ -95,21 +84,21 @@ The markup in Markdown should be semantic, not presentations. The table
below gives a small example.

+---------------------+-------------------------+-----------------------+
| Markup | Markdown example | Rendered output |
| Markup | Markdown example | Rendered output |
+:====================+:=======================:+:=====================:+
| emphasis | `*this*` | *this* |
| emphasis | `*this*` | *this* |
+---------------------+-------------------------+-----------------------+
| strong emphasis | `**that**` | **that** |
| strong emphasis | `**that**` | **that** |
+---------------------+-------------------------+-----------------------+
| strikeout | `~~not this~~` | ~~not this~~ |
| strikeout | `~~not this~~` | ~~not this~~ |
+---------------------+-------------------------+-----------------------+
| subscript | `H~2~O` | H~2~O |
| subscript | `H~2~O` | H~2~O |
+---------------------+-------------------------+-----------------------+
| superscript | `Ca^2+^` | Ca^2+^ |
| superscript | `Ca^2+^` | Ca^2+^ |
+---------------------+-------------------------+-----------------------+
| underline | `[underline]{.ul}` | [underline]{.ul} |
| underline | `[underline]{.ul}` | [underline]{.ul} |
+---------------------+-------------------------+-----------------------+
| inline code | `` `return 23` `` | `return 23` |
| inline code | `` `return 23` `` | `return 23` |
+---------------------+-------------------------+-----------------------+

: Basic inline markup and examples.
Expand Down Expand Up @@ -149,7 +138,8 @@ can sometimes be useful to give images an explicit height and/or width,
e.g. when adding an image as part of a paragraph. The Markdown `![Nyan
cat](nyan-cat.png){height="9pt"}` includes the image "nyan-cat.png"
![Nyan cat](images/nyan-cat.png){height="9pt"} while scaling it to a height of
9 pt.
9 pt.


![The "Mandrill" standard test image, sometimes erroneously called
"Baboon", is a popular sample photo and used in image processing
Expand Down Expand Up @@ -209,7 +199,7 @@ can be any sequence of characters, like `[^marker]`, but may not contain
whitespace characters.

[^markers]: Although it should be noted that some publishers prefer
symbols or letters as footnote markers.
symbols or letters as footnote markers.

The above example results in the following output:

Expand All @@ -218,6 +208,7 @@ The above example results in the following output:
>
> [^1]: An open license that allows reuse.

## Blocks

The larger components of a document are called "blocks".
Expand Down Expand Up @@ -250,6 +241,7 @@ discouraged.
Usually [lists], as described in the next section, should be preferred
over forth- and fifth-level headings.


### Lists

Bullet lists and numbered lists, a.k.a. enumerations, offer an
Expand All @@ -264,8 +256,8 @@ additional method to present sequential and hierarchical information.

- apples
- citrus fruits
- lemons
- oranges
- lemons
- oranges

Enumerations start with the number of the first item. Using the the
first two [laws of
Expand All @@ -290,6 +282,7 @@ Rendered:
gained as heat, $Q$, less the thermodynamic work, $W$, done by the
system on its surroundings. $$\Delta U = Q - W$$


# Article metadata

## Names
Expand Down Expand Up @@ -437,17 +430,18 @@ authors:
roles:
- 'funding-acquisition'
- 'supervision'
```

## Affiliations

Each affiliation requires an `index` and `name`.
Each affiliation requires an `index` and `name`.

Optionally, the Research Organization Registry (ROR) identifier for the top-level
organization can be annotated with the `ror` key. Note that ROR does not include
departments in its [scope](https://ror.org/registry/#scope-and-criteria-for-inclusion),
so ROR annotations are typically made to the top-level organization.
Optionally, the Research Organization Registry (ROR) identifier for the top-level
organization can be annotated with the `ror` key. Note that ROR does not include
departments in its [scope](https://ror.org/registry/#scope-and-criteria-for-inclusion),
so ROR annotations are typically made to the top-level organization.

```yaml
```yaml
authors:
- name: Albert Krewinkel
affiliation: [ 1, 2, 3 ]
Expand Down Expand Up @@ -494,13 +488,13 @@ number of the referenced float. E.g., in this document
`\ref{proglangs}` gives "\ref{proglangs}".

: Comparison of programming languages used in the publishing tool.
[]{label="proglangs"}
[]{label="proglangs"}

| Language | Typing | Garbage Collected | Evaluation | Created |
| Language | Typing | Garbage Collected | Evaluation | Created |
|----------|:---------------:|:-----------------:|------------|---------|
| Haskell | static, strong | yes | non-strict | 1990 |
| Lua | dynamic, strong | yes | strict | 1993 |
| C | static, weak | no | strict | 1972 |
| Haskell | static, strong | yes | non-strict | 1990 |
| Lua | dynamic, strong | yes | strict | 1993 |
| C | static, weak | no | strict | 1972 |

## Equations

Expand Down

0 comments on commit 4eee7bb

Please sign in to comment.