About

A modified version of the PLOS LaTeX template, preconfigured for automated preparation of your LaTeX paper for submission in PLOS journals.

Please cite this project in your papers:

@misc{template4plos,
  title={{template4plos public code repository}},
  author={Mari{\'c}, Petar},
  year={2019},
  url={https://github.com/petarmaric/template4plos},
}

Installation

This project doesn't require system wide installation, simply create a new repository based on the template4plos repository template and then clone it to get started:

$ git clone https://github.com/your-account/your-paper.git
$ cd your-paper
$ pipenv install

Usage

Show help:

$ pipenv run make help
Usage: make [TARGET]...

Targets:
  help              Display this help message
  build             Build the paper
  export            Prepare the paper for journal submission
  clean-built       Remove the papers build directory
  clean-exported    Remove the papers export directory
  clean             Remove both the build and export directories
  view-built        View the papers built PDF file (runs 'build' if needed)
  view-exported     View the papers exported PDF file (runs 'export' if needed)
  view              View both the built and exported PDF files

Quick start:

1. write your paper, while keeping in mind you can edit any file freely:

   1. add/remove sections
   2. update Makefile to build your figures programmatically
   3. add more LaTeX packages to preamble.tex, or change their options
   4. ...

2. build (and check) your paper often as you write:

   $ pipenv run make view-built
   

3. prepare your paper for journal submission:

   $ pipenv run make view-exported
   

4. submit files from the export directory to the journal

Using Docker

If you do not wish to install a LaTeX distribution on your system you can use the dockerized version of template4plos instead:

• show help:

  $ ./dockerized.sh help
  Usage: make [TARGET]...
  
  Targets:
    help              Display this help message
    build             Build the paper
    export            Prepare the paper for journal submission
    clean-built       Remove the papers build directory
    clean-exported    Remove the papers export directory
    clean             Remove both the build and export directories
    view-built        View the papers built PDF file (runs 'build' if needed)
    view-exported     View the papers exported PDF file (runs 'export' if needed)
    view              View both the built and exported PDF files
  

• build your paper:

  $ ./dockerized.sh build
  

• prepare your paper for journal submission:

  $ ./dockerized.sh export
  

Contribute

If you find any bugs, or wish to propose new features please let us know.

If you'd like to contribute, simply fork the repository, commit your changes and send a pull request. Make sure you add yourself to CONTRIBUTORS.