mirror of
https://github.com/flynx/photobook.git
synced 2025-10-29 02:10:08 +00:00
141 lines
4.1 KiB
Markdown
141 lines
4.1 KiB
Markdown
|
|
||
|
|
`make-images.sh`
|
||
|
|
================
|
||
|
|
|
||
|
|
Generate LaTeX block of pages from a directory tree.
|
||
|
|
|
||
|
|
This is initially intended as a means to convert the exported directory
|
||
|
|
tree from an image viewer where image/text sequencing was done, but it
|
||
|
|
can also be used standalone.
|
||
|
|
|
||
|
|
A typical project tree:
|
||
|
|
```
|
||
|
|
book/
|
||
|
|
├── templates/ . . . . . . . . . . . . Global templates.
|
||
|
|
│ ├── imagepage.tex . . . . . . . . . Single page image template.
|
||
|
|
│ ├── textpage.tex . . . . . . . . . Single page text template.
|
||
|
|
│ │ These are used to build spreads
|
||
|
|
│ │ when no explicit template matches.
|
||
|
|
│ ├── blank-image.tex
|
||
|
|
│ ├── image-blank.tex
|
||
|
|
│ ├── image-image.tex
|
||
|
|
│ ├── fullbleed.tex
|
||
|
|
│ └── ...
|
||
|
|
├── pages/ . . . . . . . . . . . . . . Main block layout.
|
||
|
|
│ ├── 00/ . . . . . . . . . . . . . . A basic spread.
|
||
|
|
│ │ ├── tweaks.tex The spread template is built
|
||
|
|
│ │ └── 0-DSC02432.jpg automaticall ywith tweaks.tex
|
||
|
|
│ │ prepended.
|
||
|
|
│ ├── 01/
|
||
|
|
│ │ ├── 0-DSC02439.jpg
|
||
|
|
│ │ └── 1-intro.txt
|
||
|
|
│ ├── 02/
|
||
|
|
│ │ ├── fullbleed.tpl . . . . . . . Explicitly use a global template.
|
||
|
|
│ │ └── 1-DSC02511.jpg
|
||
|
|
│ ├── 03/
|
||
|
|
│ │ ├── 0-DSC02509-0.jpg
|
||
|
|
│ │ └── 1-DSC02506-0.jpg
|
||
|
|
│ └── ...
|
||
|
|
├── captions/ . . . . . . . . . . . . . Image captions.
|
||
|
|
│ ├── DSC02432.txt
|
||
|
|
│ ├── DSC02439.txt
|
||
|
|
│ ├── DSC02511.txt
|
||
|
|
│ └── ...
|
||
|
|
├── setup.tex . . . . . . . . . . . . . Book block setup.
|
||
|
|
│ This is included by all top level
|
||
|
|
│ .tex files like block.tex,
|
||
|
|
│ cover.tex, ...etc.
|
||
|
|
├── block.tex . . . . . . . . . . . . . Block skeletal layout.
|
||
|
|
│ This usually includes the titles,
|
||
|
|
│ technical pages and sources the
|
||
|
|
│ ./block-pages.tex.
|
||
|
|
├── block-pages.tex . . . . . . . . . . The generated block content.
|
||
|
|
├── cover.tex . . . . . . . . . . . . . Cover layout.
|
||
|
|
├── jacket.tex . . . . . . . . . . . . Dust jacket layout.
|
||
|
|
└── ...
|
||
|
|
```
|
||
|
|
|
||
|
|
Generate the block:
|
||
|
|
```shell
|
||
|
|
$ make-images.sh ./pages > block-pages.tex
|
||
|
|
```
|
||
|
|
|
||
|
|
Note that `make-images.sh` does not force a specific layout outside of the `pages`
|
||
|
|
directory, all paths are configurable. The way the root files are structured is
|
||
|
|
just one way to organize a book's srouce code with minimal code duplication.
|
||
|
|
|
||
|
|
|
||
|
|
The process
|
||
|
|
-----------
|
||
|
|
|
||
|
|
|
||
|
|
Layout
|
||
|
|
------
|
||
|
|
|
||
|
|
```
|
||
|
|
pages/
|
||
|
|
├── <spread>/
|
||
|
|
│ ├── tweaks.tex
|
||
|
|
│ ├── layout.tex
|
||
|
|
│ ├── <template-name>.tpl
|
||
|
|
│ ├── 00-<image-name>.<ext>
|
||
|
|
│ ├── 01-<text>.txt
|
||
|
|
│ └── ...
|
||
|
|
└── ...
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
Image captions
|
||
|
|
--------------
|
||
|
|
|
||
|
|
In general image captions are decoupled from the main layout to enable
|
||
|
|
writers and editors to work on them externally.
|
||
|
|
```
|
||
|
|
captions/
|
||
|
|
├── <image-name>.txt
|
||
|
|
└── ...
|
||
|
|
```
|
||
|
|
|
||
|
|
The captions folder name/location is controlled by the `$CAPTION_DIR`
|
||
|
|
environment variable.
|
||
|
|
|
||
|
|
|
||
|
|
Inline captions are also supported:
|
||
|
|
```
|
||
|
|
pages/
|
||
|
|
├── <spread>/
|
||
|
|
│ ├── ...
|
||
|
|
│ ├── 00-<image-name>.<ext>
|
||
|
|
│ ├── 00-<image-name>.txt . . . . . . Local image caption
|
||
|
|
│ └── ...
|
||
|
|
└── ...
|
||
|
|
```
|
||
|
|
An inline caption must have the same filename as the corresponding image
|
||
|
|
but with a .txt extension.
|
||
|
|
|
||
|
|
|
||
|
|
Templates
|
||
|
|
---------
|
||
|
|
|
||
|
|
```
|
||
|
|
templates/
|
||
|
|
├── <template-name>.tex
|
||
|
|
└── ...
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
Environment variables
|
||
|
|
---------------------
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
`cls2tex.sh`
|
||
|
|
============
|
||
|
|
|
||
|
|
Extract the documentation from photobook.cls which is used to build the
|
||
|
|
photobook.pdf reference manual.
|
||
|
|
|
||
|
|
|
||
|
|
|