From c464f20ec657beaf900c5806e4af2173198a071e Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Thu, 9 Mar 2023 15:24:05 +0300 Subject: [PATCH] started docs for the included scripts... Signed-off-by: Alex A. Naanou --- scripts/README.md | 140 ++++++++++++++++++ .../README.md | 4 +- 2 files changed, 142 insertions(+), 2 deletions(-) create mode 100644 scripts/README.md diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..6ac7bd3 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,140 @@ + +`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/ +├── / +│   ├── tweaks.tex +│   ├── layout.tex +│   ├── .tpl +│   ├── 00-. +│   ├── 01-.txt +│   └── ... +└── ... +``` + + +Image captions +-------------- + +In general image captions are decoupled from the main layout to enable +writers and editors to work on them externally. +``` +captions/ +├── .txt +└── ... +``` + +The captions folder name/location is controlled by the `$CAPTION_DIR` +environment variable. + + +Inline captions are also supported: +``` +pages/ +├── / +│   ├── ... +│   ├── 00-. +│   ├── 00-.txt . . . . . . Local image caption +│   └── ... +└── ... +``` +An inline caption must have the same filename as the corresponding image +but with a .txt extension. + + +Templates +--------- + +``` +templates/ +├── .tex +└── ... +``` + + +Environment variables +--------------------- + + + + +`cls2tex.sh` +============ + +Extract the documentation from photobook.cls which is used to build the +photobook.pdf reference manual. + + + diff --git a/talks/20230225 - Presentation at Orlov's/README.md b/talks/20230225 - Presentation at Orlov's/README.md index 040206b..bec833d 100644 --- a/talks/20230225 - Presentation at Orlov's/README.md +++ b/talks/20230225 - Presentation at Orlov's/README.md @@ -15,11 +15,11 @@ $ make all sweep ``` Generated pdf's: -- `photobook-slides.pdf` +- `photobook-slides-en.pdf` / `photobook-slides-ru.pdf` The actual slides used for the talk. These require a pdf viewer that supports "book mode" and the "two-page view", and preferably good enough maners not to ignore the settings set in the file. -- `photobook-slides-web.pdf` +- `photobook-web-en.pdf` / `photobook-web-ru.pdf` Compatibility version that sets one spread per page. This should work on any pdf viewer.