summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/photobook/photobook.cls
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/photobook/photobook.cls')
-rw-r--r--macros/latex/contrib/photobook/photobook.cls85
1 files changed, 30 insertions, 55 deletions
diff --git a/macros/latex/contrib/photobook/photobook.cls b/macros/latex/contrib/photobook/photobook.cls
index 74f8b8f5e1..8dfe501db3 100644
--- a/macros/latex/contrib/photobook/photobook.cls
+++ b/macros/latex/contrib/photobook/photobook.cls
@@ -1,10 +1,13 @@
%----------------------------------------------------------------------
%
+% photobook.cls
+% -------------
%
% This does the following:
% - sets up the document/pdf for viewing as a book
-% - adds support for page bleeds
-% - adds basic templates for image pages
+% - sets up page bleeds
+% - defines cells as basic template building blocks
+% - adds basic templates for image pages and spreads
%
%
% This file contains both the code and the reference, but in a slightly
@@ -22,7 +25,7 @@
% Docs are built by the Makefile, so reference it for more info.
%
% To make the reference use:
-
+%
% $ make pdf
%
%
@@ -33,32 +36,18 @@
% to edit it directly, edit the source instead.
%
%
+% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
%
-% XXX ASAP \bindingoffset should also affect fill/bleed images... (DONE)
-% ...shift the macros that optionally account for \bindingoffset to
-% account for \gutteroffset (DONE)
-% ...everything should respect \bindingoffset (DONE)
-% XXX ASAP add \gutteroffset and \gutterimageoffset to offset content
-% from the gutter
-% \gutterimageoffset is an additional offset added to bleed images...
-% ...currently \bindingoffset is used for both...
-% Q: should the gutter offsets be counted from the \bindingoffset???
-%
-% +-------------------------------=--
-% | . . . =
-% | . . . =
-% | . . <-> \bindingoffset
-% | . . . =
-% | . <--> = \gutteroffset
-% | . . . =
-% | <--> . = \gutterimageoffset
-% | . . . =
-% +-------------------------------=--
-%
-% XXX DOC...
-%
-%
+% XXX ASAP should cover/jacket/endpaper/spread templates/cells account
+% for \bindingoffset (likely no) and/or \gutteroffset ???
+% ...especially relevant to endpaper/spread...
+% XXX ASAP revise how bleeds are handled by cells...
%
+% XXX captions behave in an odd way...
+% the internal (macro) minipage for some reason does not affect text
+% justification while adding a minipage in the macro argument works
+% as expected -- some odd input mode???
+% XXX Q: should \blockwidth include \bindingoffset (current) or not???
% XXX revise \clearcaption / \captionclearpage...
% XXX unify API -- see CellContent env...
% XXX make this loadable both as a class and as a package...
@@ -68,7 +57,8 @@
% - general macros -- \usecell{..}
% - templates -- \ImagePage{..}
% XXX see where we need to \ignorespaces...
-% XXX might be a good idea to add a spine calculator...
+% XXX might be a good idea to add a spine calculator (auto)...
+% ...i.e. input paper and cover board thickness and auto-calc spine...
% XXX might be fun to add a 'box' layout to build book boxes...
% XXX add a grid cell / image cell (???)
% make it trivial to define AxB cell layouts and fill them (fully/partially)
@@ -80,17 +70,6 @@
% - pre-print
% - customizing
% - extending
-% XXX add basic page templates:
-% - acknowledgements
-% Fields
-% - \Title
-% - \Authors
-% - \Thanks
-% - \ISBN
-% - \Edition / \Issue
-% - \CopyrightNotice
-% - ...
-% - info
% XXX DOC add notes about external libs section:
% - textpos
% cell/cell* depend on absolute mode being set globally
@@ -100,8 +79,8 @@
%%% NOTE: \def\<module-name>@[A-Z]+ macros will be visible to both the
%%% code and the generated docs...
-\edef\photobook@FILEVERSION{v0.1.17}
-\edef\photobook@FILEDATE{2023-04-09}
+\edef\photobook@FILEVERSION{v0.1.18}
+\edef\photobook@FILEDATE{2023-04-11}
%% \documentclass{ltxdoc}
@@ -249,7 +228,6 @@
%% \DescribeMacro{blockheight=<len>}
%% \DescribeMacro{bindingoffset=<len>}
%% \DescribeMacro{gutteroffset=<len>}
-%%% \DescribeMacro{gutterimageoffset=<len>}
%% \DescribeMacro{bleed=<len>}
%
%% This is similar to what |geometry| does, but adds bleed support.
@@ -271,7 +249,7 @@
%% . | blockheight . . = . |
%% . | . | . . <--> bindingoffset |
%% . | | . . = . |
-%% . | . . . . . . | . <--> gutteroffset v
+%% . | . . . . . . | . <--> gutteroffset v
%% . | v . . = .
%% . +-----------------------------------------+----- ^ . . ---
%% . . . . | bleed
@@ -295,7 +273,6 @@
\DeclareStringOption{blockheight}
\DeclareStringOption[0pt]{bindingoffset}[0mm]
\DeclareStringOption[0pt]{gutteroffset}[0mm]
-\DeclareStringOption[0pt]{gutterimageoffset}[0mm]
\DeclareStringOption[5mm]{bleed}[5mm]
%% \DescribeMacro{flatfold=<len>}
@@ -332,6 +309,7 @@
%% \DescribeMacro{endpaper}
%% \DescribeMacro{cover}
%% \DescribeMacro{jacket}
+%%% \DescribeMacro{web}
%
%% Sat page layout mode.
%
@@ -821,7 +799,6 @@
\setlength\bindingoffset{\photobook@bindingoffset}
%% \DescribeMacro{\gutteroffset=<len>}
-%%% \DescribeMacro{\gutterimageoffset=<len>}
%
%% Gutter offsets
%%
@@ -830,8 +807,6 @@
%%
\newlength\gutteroffset
\setlength\gutteroffset{\photobook@gutteroffset}
-\newlength\gutterimageoffset
-\setlength\gutterimageoffset{\photobook@gutterimageoffset}
%% \DescribeMacro{\defaultfoldout=<fold-spec>}
%
@@ -992,7 +967,7 @@
\setlength\clearance{0pt}
-%% \DescribeMacro{\clearfoldoutbinding=<len>}
+%% \DescribeMacro{\clearfoldoutgutter=<len>}
%% \DescribeMacro{\clearfoldoutfold=<len>}
%% \DescribeMacro{\clearfoldoutedge=<len>}
%
@@ -1000,8 +975,8 @@
%%
%% For more info see \nameref{subsec:Foldout page cells} section.
%%
-\newlength\clearfoldoutbinding
-\setlength\clearfoldoutbinding{8mm}
+\newlength\clearfoldoutgutter
+\setlength\clearfoldoutgutter{8mm}
\newlength\clearfoldoutfold
\setlength\clearfoldoutfold{5mm}
\newlength\clearfoldoutedge
@@ -3132,7 +3107,7 @@
%% automatically calculated and missing folds are the same as the previous
%% fold or the default if no folds are specified.
%%
-%% If not |<fold-spec>| is given, then the value of |\defaultfoldout| is
+%% If no |<fold-spec>| is given, then the value of |\defaultfoldout| is
%% used (default: |2|).
%%
%% \begin{minipage}{\textwidth}
@@ -3224,7 +3199,7 @@
%% \end{minipage}
%%
%
-%% \DescribeMacro{\clearfoldoutbinding=<len>}
+%% \DescribeMacro{\clearfoldoutgutter=<len>}
%% \DescribeMacro{\clearfoldoutedge=<len>}
%% \DescribeMacro{\clearfoldoutfold=<len>}
%
@@ -3235,7 +3210,7 @@
%%
%% \clearfoldoutedge <->
%% \clearfoldoutfold <->
-%% <--> \clearfoldoutbinding
+%% <--> \clearfoldoutgutter
%% (3) /\ (2)
%% +---------------------------------+ / \
%% +------------------------------- | /
@@ -3256,7 +3231,7 @@
%% \begin{verbatim}
%%
%% \clearfoldoutedge <-> /
-%% <--> \clearfoldoutbinding (3) /
+%% <--> \clearfoldoutgutter (3) /
%% \
%% +---------------------------------- \ (2)
%% +---------------------------------+ /
@@ -3420,7 +3395,7 @@
\ifnum \thephotobook@foldoutpanel = 2%
\setlength\photobook@foldout@maxpanelwidth{%
\photobook@foldout@maxpanelwidth
- - \clearfoldoutbinding}\fi%
+ - \clearfoldoutgutter}\fi%
% calculate widths...
\ifdim #1 = 0pt%
% first two panels do not need fold compensation...