unify YAML variables used accross template by documenting them.
Open
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 1.5k
- Forks
- 517
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 5
Description
Currently, I don't think all the templates use the same Pandoc variable name for a same purposed variable.
Example:
- acs template
title:
- short: short title
- formatted: full title
whereas common pandoc is to use
title: full title
shorttitle: short title
This thread is to compile the used one and decide which to keep
List of common variables that can be uses in a template
title: Title of the articleshorttitle: A short title for the articleruntitle: used in some format as title in\runtitlebut this is quite the same
author: Field for author informations (see also #324 for author specific uniformisation)keywords: Keywordshortauthors
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the ACS template and the other templates to inventory the YAML and Pandoc variable names currently in use, including title, shorttitle, runtitle, author, keywords, and shortauthors. The work is done when the project has agreed on canonical names and the templates' variables are documented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100