Skip to content

Commit cb9810a

Browse files
author
Joris Hijmans
authored
Initial commit
0 parents  commit cb9810a

26 files changed

+2820
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.DS_Store

.quartoignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Add files / folder that are useful to your repo
2+
# but should not be in the downloaded bundle after `quarto use template`
3+
style-guide

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 quarto-journals
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Article Format Template (AFT)
2+
3+
<!-- REMOVE THIS IN YOUR FORMAT TEMPLATE -->
4+
> Template for creating a new journal article format for Quarto.
5+
>
6+
> This repository is a [Github Repository Template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) that you should use as a starter to create a new extension format. Click on the "Use this template" button at the top !
7+
>
8+
> See information about how-to use this repo template inside the template file or its rendered version at <https://quarto-journals.github.io/article-format-template/>
9+
10+
<!-- ALL THE BELOW SHOULD BE IN YOUR README -->
11+
12+
This is a Quarto template that assists you in creating a manuscript for Article Format Template journals. You can learn more about ...
13+
14+
## Creating a New Article
15+
16+
You can use this as a template to create an article for an AFT journal. To do this, use the following command:
17+
18+
```bash
19+
quarto use template quarto-journals/article-format-template
20+
```
21+
22+
This will install the extension and create an example qmd file and bibiography that you can use as a starting place for your article.
23+
24+
## Installation For Existing Document
25+
26+
You may also use this format with an existing Quarto project or document. From the quarto project or document directory, run the following command to install this format:
27+
28+
```bash
29+
quarto add quarto-journals/article-format-template
30+
```
31+
32+
## Usage
33+
34+
To use the format, you can use the format names `aft-pdf` and `aft-html`. For example:
35+
36+
```bash
37+
quarto render article.qmd --to aft-pdf
38+
```
39+
40+
or in your document yaml
41+
42+
```yaml
43+
format:
44+
pdf: default
45+
aft-pdf:
46+
keep-tex: true
47+
```
48+
49+
You can view a preview of the rendered template at <https://quarto-journals.github.io/article-format-template/>.
50+
51+
## Format Options
52+
53+
This format does not have specific format option. Include documentation of such option otherwise. See <https://github.com/quarto-journals/elsevier#format-options> for an example.

_extensions/aft/_extension.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
title: Article Format Template
2+
author: Christophe Dervieux
3+
version: 0.1.0
4+
contributes:
5+
formats:
6+
common:
7+
# define below YAML configuration common to all formats
8+
filters:
9+
# You can include here Lua filters from your extension format
10+
- color-text.lua
11+
shortcodes:
12+
# You can include here Lua filters defining shortcodes from your extension
13+
- shortcodes.lua
14+
knitr:
15+
opts_chunk:
16+
echo: false
17+
pdf:
18+
# define default configuration for the pdf version of your format
19+
documentclass: aft
20+
colorlinks: true
21+
urlcolor: red
22+
fig-width: 6.5
23+
fig-height: 4.5
24+
# This format use a bst file with natbib
25+
biblio-style: te
26+
cite-method: natbib
27+
# Set this below (`biblio-config: false`) if your cls already load a bst file
28+
# biblio-config: false
29+
# Content to add in header that your format is using
30+
header-includes: |
31+
\usepackage{orcidlink}
32+
\definecolor{mypink}{RGB}{219, 48, 122}
33+
template-partials:
34+
# Add here the partials your format is using
35+
- "partials/title.tex"
36+
- "partials/_authors.tex"
37+
format-resources:
38+
# Add here the resources required for the PDF rendering
39+
- aft.cls
40+
- te.bst
41+
html:
42+
# define default configuration for the html version of your format
43+
number-sections: true
44+
toc: true
45+
theme: custom.scss
46+
# Use a CSL file to style (https://www.zotero.org/styles/)
47+
csl: https://www.zotero.org/styles/journal-of-institutional-and-theoretical-economics

0 commit comments

Comments
 (0)