mirror of https://github.com/flynx/photobook.git synced 2025-10-28 18:00:10 +00:00

Alex A. Naanou 0d14bb32e3 added notes about generated doc source...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>

2023-04-26 21:00:31 +03:00

photobook

LaTeX document class for making photo books.

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.

The package is available on:

To install from source:

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

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

If only building the docs is required without installing:

$ make pdf

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

The main refetence is 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.