Skip to content

flh/patoline

 
 

Repository files navigation

Patoline - A modern digital typesetting system

This repository contains the source code of Patoline, which homepage is hosted at https://patoline.github.io.

Dependencies

Dependencies include:

  • OCaml (version 4.03.0 or higher)
  • OCamlFind
  • Earley (available on opam)
  • Earley-OCaml (available on opam)
  • Camlzip (available on opam)
  • Imagelib (available on opam)
  • other libraries (listed in "configure" step)
  • GNU make (version 4.0 or higher)

To setup a suitable OCaml environment, the simplest possible solution is to use the Opam package manager. It can be installed by following instructions at http://opam.ocaml.org/doc/Install.html. You can then install an OCaml compiler and the required libraries as follows.

opam switch 4.05.0
eval `opam config env`
opam install ocamlfind ocamlbuild
opam install earley earley-ocaml
opam install camlzip imagelib sqlite3

You can optionally install more Opam packages (OCaml libraries) depending on the Patoline drivers that you want to use. For instance, you will need to install lablgl for our OpenGL driver, or cairo for our Cairo driver.

Compilation from source

Patoline can be compiled from source as follows:

wget https://github.com/patoline/patoline/archive/master.zip
unzip master.zip
cd patoline-master
make configure
./configure
make
make packages
make install

First Patoline document

Here is a hello world patoline document.

======================
Hello, World!
----------------------
Patoline newbies
======================

-> Section with text

This is my //first// document! That's so **cool**!

-<

-> Section with maths

Did you known that $(a + b)² = a² + 2ab + b²$?

-<

If you copy-paste it in a file hello_world.txp, then you can compile it with the command patoline hello_world.txp. This will produce a PDF file called hello_world.pdf. Note that you can compile to other format drivers such as a webpage using SVG format or an OpenGL window. To do that, select a driver with the command patoline --driver DRIVER hello_world.txp. You can obtain the list of available drivers for your installation with the command patoline drivers.

List of developpers and contributors

Main developpers and contributors:

  • Pierre-Étienne Meunier
  • Christophe Raffalli
  • Rodolphe Lepigre
  • Tom Hirschowitz
  • Florian Hatat
  • Pierre Hyvernat
  • Guillaume Theyssier
  • Vincent Laporte
  • Alan Schmitt

About

Patoline typesetting system

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • OCaml 83.9%
  • TeX 9.5%
  • Makefile 3.6%
  • C 1.4%
  • Emacs Lisp 1.3%
  • Vim Script 0.2%
  • Other 0.1%