Multimarkdown and LaTeX framework for academic papers.
Framework for easily using MultiMarkdown and LaTeX based system to write academic papers, especially those with shared templates for organization. This system is designed with several important design guidelines and observations:
In light of these observations, this framework aims to provide:
These instructions provide a method to configure Scriptorium to work on Windows with a minimum of fuss. There are many other ways to configure this system, and cleaner instructions would be appreciated in a pull request
Scriptorium can be invoked directly from the command line using the name scriptorium.
Check that all external dependencies are installed and detected correctly, by veryifying the following command returns nothing:
You can check where templates will be installed:
scriptorium config TEMPLATE_DIR
or change the directory:
scriptorium config TEMPLATE_DIR ~/.scriptorium/templates
Install some example templates:
scriptorium template -i https://github.com/jasedit/simple_templates.git
To list which templates are currently available in scriptorium:
scriptorium template -l
To create a new paper in the directory example_report using the report template previously installed:
scriptorium new example_report -t report -c author "John Doe" -c title "My Example Report"
Adding example content using the command:
echo " # Introduction This is an introductory section." >> example_report/paper.mmd
The PDF of the report can be built using:
scriptorium build example_report
or, if inside example_report:
Since papers in development are generally not open-source, this framework pushes papers into standalone folders. Storing these folders in version control is STRONGLY encouraged, though not strictly required by the system. Generally, version control repositories don’t handle binary files (e.g. images) particularly well, so it is recommended to break up papers into more repositories to require less overhead storing history, as well as providing finer granularity in sharing papers.
In order to integrate the template system, the MultiMarkdown metadata header requires a few important statements. Consider an example header, as shown below.
Base Header Level: 3 latex author: Author Title: Paper Title myemail: email@example.com latex input: template/setup.tex latex footer: template/footer.ex
The Base Header Level is important for configuring MultiMarkdown to avoid section levels which may not be supported by the template being used. Level 1 is the \chapter command in LaTeX, which is often unused in conference papers. The latex author key bypasses input sanitization, allowing LaTeX specific commands in the authors title. myemail is the author’s e-mail address. The input and footer are used to read the template preamble and footer. Some templates will also read a metadata.tex file, which provides a direct LaTeX file for specifying metadata when LaTeX specific commands are necessary.
A template defines the latex setup defining how a paper is going to be laid out, which packages it will use, etc. For reference, consider templates in the simple templates repository. A template is made in a few steps:
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|scriptorium-2.7.1-py2.py3-none-any.whl (19.5 kB) Copy SHA256 Checksum SHA256||py2.py3||Wheel||Jul 25, 2017|
|scriptorium-2.7.1.tar.gz (16.9 kB) Copy SHA256 Checksum SHA256||–||Source||Jul 25, 2017|