Have the main information about how to use the tool
CSS TeX Shell HTML Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Book
book-result
pharo-vm
support
LICENSE
Pharo.changes
Pharo.image
README - copie.md
README.md
clean.sh
compile.sh
download.sh
pharo
pharo-ui
pillar
pillar.conf
updateBookSkeleton.sh

README.md

How to write a book

This book is written in Pillar markup. If you are not familiar with it please check the pillar-documentation.

###Generating the book

First of all you have to run ./download.sh to obtain the Pillar executable that does all the job.

To generate your book execute ./compile.sh. If you want to generate only one chapter, pass the file's path to the script: ./compile.sh Example/Example.pillar. If you have pdflatex installed and available in your system's PATH, the script will also generate pdf files.

###Adding a chapter

To add a chapter create a directory for it (named, e.g., Example) and put there a .pillar file (named, e.g., Example.pillar) which will contain the chapter itself. Put images in the figures subdirectory of the new chapter directory.

Add your chapter to:

  • pillar.conf in the inputFiles array as: "Example/Example.pillar", and
  • _support/templates/book.latex.template in \graphicspath as {Example/}

###Caveats

  • You must neither use spaces nor underscores (_) in file names.

Tools

There are mods/bundles/packages for text editors, that provide improvements for pillar files editing: