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 lualatex
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 theinputFiles
array as:"Example/Example.pillar"
, andsupport/templates/book.latex.template
in\graphicspath
as{Example/}
###Caveats
- You must neither use spaces nor underscores (
_
) in file names.
Chapter | Latest | Link reference |
---|---|---|
1 - Teapot | html pdf | Chapter *@cha:teapot* link: *Teapot>../Teapot/Teapot.pillar@cha:teapot* |
2 - Handling CSV with NeoCSV | html pdf | Chapter *@cha:neoCSV* link: *NeoCSV>../NeoCSV/NeoCSV.pier@cha:neoCSV* |
3 - JSON | html pdf | Chapter *@cha:JSON* link: *JSON>../NeoJSON/NeoJSON.pier@cha:JSON* |
4 - STON: a Smalltalk Object Notation | html pdf | Chapter *@cha:ston* link: *STON>../STON/STON.pillar@cha:ston* |
5 - Serializing Complex Objects with Fuel | html pdf | Chapter *@cha:fuel* link: *Fuel>../Fuel/Fuel.pillar@cha:fuel* |
6 - Persisting Objects with Voyage | html pdf | Chapter *@cha:voyage* link: *Voyage>../Voyage/Voyage.pier@cha:voyage* |
7 - Mustache Templates for Pharo | html pdf | Chapter *@cha:mustache* link: *Mustache>../Mustache/Mustache.pillar@cha:mustache* |
8 - Cascading Style Sheets with RenoirSt | html pdf | Chapter *@cha:renoirst* link: *RenoirST>../RenoirST/RenoirST.pier@cha:renoirst* |
9 - Documenting your Project with Pillar | html pdf | Chapter *@cha:pillar* link: *Pillar>../PillarChap/Pillar.pillar@cha:pillar* |
10 - Generate PDF documents with Artefact | html pdf | Chapter *@cha:artefact* link: *Artefact>../Artefact/Artefact.pillar@cha:artefact* |
11 - Character Encoding and Resource Meta Description | html pdf | Chapter *@cha:zincEncoding* link: *Zinc Encoding Meta>../Zinc-Encoding-Meta/Zinc-Encoding-Meta.pillar@cha:zincEncoding* |
12 - Zinc HTTP: The Client-side | html pdf | Chapter *@cha:zinc-client* link: *Zinc Client>../Zinc-HTTP-Client/Zinc-HTTP-Client.pillar@cha:zinc-client* |
13 - Zinc HTTP: The server side | html pdf | Chapter *@cha:zinc-server* link: *Zinc Server>../Zinc-HTTP-Server/Zinc-HTTP-Server.pillar@cha:zinc-server* |
14 - REST Web Services | html pdf | Chapter *@cha:zinc-rest* link: *Zinc Rest>../Zinc-REST/Zinc-REST.pillar@cha:zinc-rest* |
15 - Building and deploying your first web app with Pharo | html pdf | Chapter *@cha:webApp* link: *WebApp>../WebApp/WebApp.pier@cha:webApp* |
16 - WebSockets | html pdf | Chapter *@cha:webSockets* link: *WebSockets>../WebSockets/WebSockets.pier@cha:webSockets* |
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