Enterprise Pharo (english version)

How to write a book

This book is written in Pillar markup. If you are not familiar with it please read the Pillar chapter.

Prerequisites

Install LaTeX

The book requires TeX Live 2015 to generate the PDFs. Linux distributions often require to install several packages, please refer to the SBAbook description.

Mac OS X users: download and install MacTeX (the 2.4Gb MacTeX.pkg file), and add its binaries to your system path (don't forget to start a new terminal session, for the path changes to take effect):

echo /usr/texbin > TeX
sudo mv TeX /etc/paths.d

Download Pillar

Run ./download.sh to obtain the required Pillar executable. This will also download the required Pharo image and VM and install it locally in the book's directory.

Generating the book

To generate the individual book chapters, execute ./compile.sh. This will place the rendered chapters in book-result/.

To compose the chapters into the full book, after running ./compile.sh, execute ./compileBook.sh.

To generate a single chapter (for example, the Teapot chapter):

./pillar export Teapot/Teapot.pillar
bash pillarPostExport.sh

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"
• support/latex/book.tex in \graphicspath as {Example/}
• EnterprisePharo.pillar as ${inputFile:Example/Example.pillar}$

Caveats

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

Chapters

Tools

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

• Emacs: pillar-mode
• Vim: vim-pillar
• TextMate: Pillar.tmbundle
• ATOM: language-pillar