Metadata-Version: 2.1
Name: scoop-template-engine
Version: 0.0.12
Summary: Scoop Template Engine
Author-email: Roland Herzog <roland.herzog@iwr.uni-heidelberg.de>
Project-URL: homepage, https://gitlab.com/scoopgroup-public/scoop-template-engine
Project-URL: repository, https://gitlab.com/scoopgroup-public/scoop-template-engine
Project-URL: Bug Tracker, https://gitlab.com/scoopgroup-public/scoop-template-engine/issues
Keywords: template engine,LaTeX,scientific publishing,journals
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Topic :: Text Processing :: Markup :: LaTeX
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

The purpose of the scoop template engine (`ste`) is to facilitate the preparation of manuscripts in [LaTeX](https://www.latex-project.org/) for publication in scientific journals.
It allows the separation of layout from content.
The layout, which depends on the journal, will be automatically generated.
An effort is made to achieve compatibility of a range of standard LaTeX packages with each supported journal.
In addition, a consistent set of theorem-like environments is provided across journals. 


## Installation
```python
pip3 install scoop-template-engine
ste --init
```

## Quick Start
Describe the meta data of your manuscript in a `.yaml` file, such as
```yaml
# LaTeX related settings
latex:
  bibfiles: my.bib
  abstract: abstract.tex
  body: content.tex
  preamble: |-
    \usepackage{amsmath}
    \usepackage{cleveref}

# Information on your manuscript
manuscript:
  authors:
    - LMS
    - JIF
  title: Carrying the One Effectively

# Author data
authors:
  - 
    familyname: Simpson
    givenname: Lisa M.
    institutions: Harvard College
    tag: LMS

  - 
    familyname: Frink
    givenname: Jonathan I. Q.
    institutions: Springfield Heights
    tag: JIF

# Institution data
institutions:
  Harvard College: >-
    Harvard College, Cambridge, MA 02138, USA

  Springfield Heights: >-
    Springfield Heights Institute of Technology, Springfield, OR 97475, USA
```
