Indoctrinatr

About

Indoctrinatr Tools is a set of commandline tools to kick-start and develop Indoctrinatr Template Packs. Indoctrinatr in itself is an Open Source Software project by dkd Internet Service GmbH, Frankfurt (Germany), which renders eRuby (more specifically: Erubis) enriched XeTeX templates to PDF documents.

Installation

Gem Version

  1. Install XeTeX:

    Mac OS X: MacTeX (e.g. brew install mactex)

    Debian/Ubuntu:

    apt-get install texlive texlive-xetex texlive-latex-extra texlive-generic-extra

  2. We distribute Indoctrinatr Tools as a Rubygem. Please run:

    gem install indoctrinatr-tools

    After installation verify if you have a working indoctrinatr shell command.

LaTeX Requirements

  • latexmk
  • for the template documentation
    • Tested against TeX Live 2022
    • dirtree
    • datetime2

Usage

Replace project_name with the name of your Template Pack:

Command Description
indoctrinatr new project_name Creates a scaffold for a new Template Pack
indoctrinatr parse project_name Parses a XeTex file with ERB and default values
indoctrinatr pdf project_name Compiles PDF with default values
indoctrinatr pdf_with_field_names project_name Generates PDF with the field names as values
indoctrinatr doc project_name Creates a technical documentation of your template pack
indoctrinatr check project_name Analyzes your Template Pack for errors
indoctrinatr pack project_name Creates a Template Pack from a given project folder
indoctrinatr demo Creates, parses, and compiles a demo project
indoctrinatr workflow Displays a suggested workflow

The commands pdf, pdf_with_field_names and doc have a keep-aux-files option. This is helpful if you run in into LaTeX errors, want to inspect the .log file and run LaTeX for yourself again.

The command doc does not overwrite existing examples. This means that you can customize the examples that are appended in the documentation.

Build

If you want to build the Rubygem yourself, run rake build to build and rake install to build and install the Indoctrinatr Tools gem.

Feedback

What you think of Indoctrinatr and Indoctrinatr Tools? Drop us a line ([email protected]) and tell us how you use Indoctrinatr. You can also open a GitHub Issue if you experience any problems.

Contributing

We are also looking forward to your GitHub Pull Requests.

Manual testing: After cloning the repo, run bundle exec bin/indoctrinatr inside the directory for testing your own development changes. Automatic testing: run rspec

License

Indoctrinatr and Indoctrinatr Tools are licensed under the terms and conditions of the MIT License.

Credits

dkd

  • Luka Lüdicke (development)
  • Eike Henrich (development)
  • Nicolai Reuschling (development)
  • Søren Schaffstein (idea, product management)