photobook

LaTeX document class for making photo books.

Available on:

CTAN: https://ctan.org/pkg/photobook
GitHub: https://github.com/flynx/photobook

Install / Build

The simplest way to install is to use either TeX Live's or MiKTeX's standard way to install modules.

Installing from source:

# get the source...
$ git clone https://github.com/flynx/photobook.git

# if desired, install in the user context...
$ cd ./photobook
$ make install

The photobook document class requires a set of modules to be installed for it to function, the full list is included in the docs and can be generated and printed by calling:

$ make depends

For more info on make targets see the: ./Makefile

Documentation

Pre-built documentation can be found in the Github releases or on CTAN.

A full book (dummy) example is included in ./examples/book/ and can be used as a reference / starting point.

Building documentation

Building the reference from source is done by:

$ make pdf

Build requirements for docs:

LaTeX tool chain (including: lualatex, latexmk, ..)
The simplest way to get started is TeX Live, either a full install or for specific modules see the Packages section in photobook.cls,
Un*x-like environment (bash, GNU Make, coreutils, ...),
on Windows systems, either Cygwin or WSL/WSL2 should work fine.

Notes

The main reference is maintained inline with the source photobook.cls thus it is both human-readable next to the code it documents and is used to build the photobook.pdf. Extracting the documentation source (photobook*.tex) is done by make via cls2tex.sh when building the docs, see them for more info.
There is a bug in default captions not being typeset correctly if too long, a workaround is to place them in a minipage like this:
```
\imagecell{%
  \begin{minipage}{\cellwidth}%
      long caption text...
  \end{minipage}%
}{some-image}
```
(still working on a solution for this).
photobook is mostly used with lualatex, other engines are mostly supported but some features may misbehave.

Authors

Alex A. Naanou

License

BSD 3-Clause License

flynx / photobook

readme