|
1 |
| -# Generated citation / reference files |
| 1 | +# Output directory containing the formatted manuscript |
2 | 2 |
|
3 |
| -The [`references`](https://github.com/greenelab/deep-review/tree/references) branch contains files automatically generated by the manuscript build process. |
4 |
| -It consists of the contents of the [`references/generated`](https://github.com/greenelab/deep-review/tree/master/references/generated) directory of the `master` branch. |
5 |
| -These files are not tracked in `master`, but instead written to the `references` branch by continuous Travis CI builds. |
| 3 | +The `output` branch contains files automatically generated by the manuscript build process. |
| 4 | +It consists of the contents of the `output` directory of the `master` branch. |
| 5 | +These files are not tracked in `master`, but instead written to the `output` branch by continuous Travis CI builds. |
6 | 6 |
|
7 | 7 | ## Files
|
8 | 8 |
|
9 | 9 | This directory contains the following files:
|
10 | 10 |
|
11 |
| -+ [`processed-citations.tsv`](processed-citations.tsv) is a table of references extracted from the manuscript sections and their mapping to standardized citation_ids. |
12 |
| -+ [`all-sections.md`](all-sections.md) is a markdown document of all manuscript sections, with references replaced by citation_ids. |
13 |
| -+ [`citations.json`](citations.json) is a cache of citation metadata that can include both bibtex and CSL citation records. |
14 |
| -+ [`bibliography.bib`](bibliography.bib) is a bibtex bibliography file of a subset of citations. |
15 |
| -+ [`bibliography.json`](bibliography.json) is CSL-JSON file of bibliographic item metadata ([see specification](https://github.com/citation-style-language/schema/blob/master/csl-data.json)) for all references. |
| 11 | ++ [`citations.tsv`](citations.tsv) is a table of citations extracted from the manuscript and the corresponding standard citations and citation IDs. |
| 12 | ++ [`manuscript.md`](manuscript.md) is a markdown document of all manuscript sections, with citation strings replaced by citation IDs. |
| 13 | ++ [`references.json`](references.json) is CSL-JSON file of bibliographic item metadata ([see specification](https://github.com/citation-style-language/schema/blob/master/csl-data.json)) for all references. |
| 14 | ++ [`variables.json`](variables.json) contains variables that were passed to the jinja2 templater. These variables contain those automatically generated by the manubot as well as those provided by the user via the `--template-variables-path` option. |
16 | 15 |
|
17 |
| -Pandoc consumes `all-sections.md` and `bibliography.json` to create the formatted manuscript. |
| 16 | +Pandoc consumes `manuscript.md` and `references.json` to create the formatted manuscript, which is exported to `manuscript.html`, `manuscript.pdf`, and optionally `manuscript.docx`. |
0 commit comments