flynx/photobook
1
0
Fork 0
mirror of https://github.com/flynx/photobook.git synced 2025-11-02 20:30:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
photobook/photobook.cls
Alex A. Naanou c6a2697061 lots of tweaks... 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
2021-08-06 03:47:58 +03:00

1680 lines
42 KiB
TeX
Raw Blame History

%----------------------------------------------------------------------
%
%
% 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 (XXX)
%
%
% XXX BUG: fix \OFFSETFIX
% XXX BUG: fix \CAPTIONWIDTHFIX
% XXX BUG: there seems to be a slight offset bias...
%
% XXX might be a good idea to add a spine calculator...
%
%
%----------------------------------------------------------------------
\NeedsTeXFormat{LaTeX2e}
% XXX set release date...
\ProvidesClass{photobook}[2021/07/28 Photo book Latex class]
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% Class/package options...
\RequirePackage{kvoptions}
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% Helpers...
\newcommand\@DeclareLiteralOptionTo[2]{%
\DeclareVoidOption{#2}{%
\expandafter\edef\csname photobook@#1\endcsname{#2}}}
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% layout mode...
%
% - block (default):
%
% blockwidth
% <--------------->
%
% +---------------+
% | |
% | |
% | |
% | |
% | |
% +---------------+
%
%
% - endpaper:
%
% blockwidth 2x
% <------------------------------->
%
% +---------------+---------------+
% | . |
% | . |
% | . |
% | . |
% | . |
% +---------------+---------------+
%
%
% - cover:
%
% blockwidth blockwidth
% <---------------> <--------------->
% <-> coverboardgrow <-> coverboardgrow
% <-> coverflap . <-> coverflap
% . . . . . .
% +-------------------++---++-------------------+ ---
% | + - - - - - - - - ++ - ++ - - - - - - - - + | --^ coverflap
% | . + - - - - - - - ++ - ++ - - - - - - - + . | --^ coverboardgrow
% | . . .. .. . . | ^
% | . . .. .. . . | | blockheight
% | . . Back .. .. Front . . | |
% | . . .. .. . . | |
% | . . .. .. . . | v
% | . + - - - - - - - ++ - ++ - - - - - - - + . | --v coverboardgrow
% | + - - - - - - - - ++ - ++ - - - - - - - - + | --v coverflap
% +-------------------++---++-------------------+ ---
% . .
% ^. .^ spinefold
% . .
% <---> spinewidth
%
%
% - jacket: (XXX)
%
% <---> jaketflap/jacketflapback <---> jaketflap/jacketflapfront
% . . . .
% . . blockwidth blockwidth . .
% . . <---------------> <---------------> . .
% . .<-> coverboardgrow <-> coverboardgrow
% . . . . . .
% +---++-----------------++---++-----------------++---+ ---
% | .. + - - - - - - - ++ - ++ - - - - - - - + .. | --^ coverboardgrow
% | .. . .. .. . .. | ^
% | .. . .. .. . .. | | blockheight
% | .. . Back .. .. Front . .. | |
% | .. . .. .. . .. | |
% | .. . .. .. . .. | v
% | .. + - - - - - - - ++ - ++ - - - - - - - + .. | --v coverboardgrow
% +---++-----------------++---++-----------------++---+ ---
% .. . . ..
% ^ jacketwrap . . ^ jacketwrap
% ^. .^ spinefold
% . .
% <---> spinewidth
%
%
% XXX in cover layout setup pdf boxes in a way to use \bleed as foldover...
% ...see hyperref docs to set pdf view/print area (???)
% .....should also set \bleed default to something like 17mm
% XXX also need a way to:
% - setup front-cover
% - setup pine
% - setup back-cover
% ...envs??
% XXX do we need to implement cover fold over???
% XXX not yet sure how to go about this -- should we update \blockwidth
% or should we define a new length and let some templates
% use one and some use the other???
% ...I'm leaning towards the later...
% XXX fold/cut marks???
% XXX write all the dimensions to pdf comment...
% XXX EXPERIMENTAL...
\DeclareStringOption[block]{layoutmode}[block]
\@DeclareLiteralOptionTo{layoutmode}{block}
%\@DeclareLiteralOptionTo{layoutmode}{web}
\@DeclareLiteralOptionTo{layoutmode}{endpaper}
% XXX add overhang...
% XXX minght be a good idea to add cover types as separate values and
% preset defeaults per type, e.g:
% layoutmode= hardcover softcover
% should also set:
% spinefold= 5mm 5mm
% coverflap= 17mm 0mm
% bleed= 0mm 5mm
\@DeclareLiteralOptionTo{layoutmode}{cover}
%\@DeclareLiteralOptionTo{layoutmode}{hardcover}
%\@DeclareLiteralOptionTo{layoutmode}{softcover}
% XXX add flap sizes...
% XXX not implemented...
\@DeclareLiteralOptionTo{layoutmode}{jacket}
% spine width and spine fold...
%
% NOTE: this is only used when layoutmode=cover
\DeclareStringOption[0pt]{spinewidth}[0pt]
\DeclareStringOption[0pt]{spinefold}[7mm]
\DeclareStringOption[0pt]{coverboardgrow}[3mm]
% XXX defaults should depend on cover type...
\DeclareStringOption[0pt]{coverflap}[17mm]
\DeclareStringOption[0pt]{jacketwrap}[2mm]
\DeclareStringOption[0pt]{jacketflap}[50mm]
\DeclareStringOption[0pt]{jacketflapfront}[50mm]
\DeclareStringOption[0pt]{jacketflapback}[50mm]
% pdf layout...
%
% defaults:
% - TwoColumnLeft (for layoutmode=block)
% - SinglePage
%
% see: hyperref's pdfpagelayout for more options...
\DeclareStringOption{pdfpagelayout}
\@DeclareLiteralOptionTo{pdfpagelayout}{SinglePage}
\@DeclareLiteralOptionTo{pdfpagelayout}{OneColumn}
\@DeclareLiteralOptionTo{pdfpagelayout}{TwoColumnRight}
\@DeclareLiteralOptionTo{pdfpagelayout}{TwoColumnLeft}
\@DeclareLiteralOptionTo{pdfpagelayout}{TwoPageRight}
\@DeclareLiteralOptionTo{pdfpagelayout}{TwoPageLeft}
% page geometry...
%
% <---> bleed <---> bleed
%
% + - - - - - - - - - - - - - - - - - - - - - + - + ^
% . . . | bleed
% . +---------------------------------------+ . v . . ---
% . | ^ . = .
% . | . . . . . . | . . = . ^
% . |<-- blockwidth ----------------------->= . |
% . | . | . . = . |
% . | | . = . textheight
% . | . | . . = . |
% . | blockheight . = . |
% . | . | . . = . |
% . | | <---> bindingoffset |
% . | . . . . . . | . . = . v
% . | v . = .
% . +---------------------------------------+ . ^ . . ---
% . . . . | bleed
% + - - - - - - - - - - - - - - - - - - - - - + - + v
% . .
% | <-- textwidth --------------> . |
% ^ binding line
%
% NOTE: if blockwidth/blockheight are set they will force recalculations
% and overriding of the paperwidth/paperheight if they were changed
% by the user code anywhere between \documentclass[..]{photobook}
% and \begin{document}...
\DeclareStringOption{blockwidth}
\DeclareStringOption{blockheight}
\DeclareStringOption[0]{bindingoffset}[10mm]
\DeclareStringOption[5mm]{bleed}[5mm]
% Distance from image to paper border (clearence) for full-page images.
%
% this can be:
% - negative value set image bleed,
% - positive value set distance frome paper edge to image.
%
\DeclareStringOption{clearimage}[-5mm]
% Image block size relative to text block...
%
% XXX better name...
\DeclareStringOption[0.85]{imageblockwidth}[1]
\DeclareStringOption[0.85]{imageblockheight}[1]
\DeclareStringOption[-0.05]{imageblockoffsettop}[0]
% let the user set geometry defaults.
%
% NOTE: if this is not set any options set by the uset intersecting with
% options set in the class will get overriden by class options...
% NOTE: this does not affect the following:
% paperwidth=\bleedblockwidth
% paperheight=\bleedblockheight
% bindingoffset=\bindingoffset
%
% XXX better name...
\DeclareBoolOption{geometrynodefaults}
\DeclareDefaultOption{\PassOptionsToClass{\CurrentOption}{book}}
\ProcessKeyvalOptions*
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% Parent class...
%
\LoadClass[9pt, final, openany]{book}
%----------------------------------------------------------------------
% Packages...
%
% NOTE: imports are after \LoadClass{ .. } to avoid figting over macro
% names...
\RequirePackage{calc}
\RequirePackage{xargs}
\RequirePackage{ifthen}
\RequirePackage{iftex}
\RequirePackage{etoolbox}
\RequirePackage{atbegshi}
\RequirePackage[unicode]{hyperref}
\RequirePackage{eso-pic}
\RequirePackage{graphicx}
\RequirePackage[
overlay,absolute,
%showboxes,
]{textpos}
\RequirePackage[linewidth=1pt]{mdframed}
\RequirePackage{rotating}
%----------------------------------------------------------------------
% Globals...
\edef\layoutmode{\photobook@layoutmode}
\edef\pdfpagelayout{\photobook@pdfpagelayout}
% layout modes...
%
\newif\ifcoverlayout
\newif\ifhardcoverlayout
\newif\ifsoftcoverlayout
\newif\ifendpaperlayout
\newif\ifjacketlayout
% agrigates...
\newif\ifcoverlikelayout
\newif\ifblocklayout
\newlength\spinewidth
\setlength\spinewidth{\photobook@spinewidth}
\newlength\spinefold
\setlength\spinefold{\photobook@spinefold}
\newlength\coverboardgrow
\setlength\coverboardgrow{\photobook@coverboardgrow}
\newlength\coverflap
\newlength\jacketwrap
\newlength\jacketflap
\newlength\jacketflapfront
\newlength\jacketflapback
% NOTE: page and bleed block sizes are set via \RecalculatePageLengths
\newlength\blockwidth
\newlength\blockheight
% NOTE: these are equivalent to \paperwidth and \paperheight but are
% independent of them...
\newlength\bleedblockwidth
\newlength\bleedblockheight
% original page block size...
%
% for the block layout these are the same as \blockwidth and \blockheight
% for other layouts these are the original page layout size while the
% \blockwidth are set tho the current layout visible size...
\newlength\pageblockwidth
\newlength\pageblockheight
\newlength\bleed
\setlength\bleed{\photobook@bleed}
\newlength\bindingoffset
\setlength\bindingoffset{\photobook@bindingoffset}
% NOTE: since this can be any number but we need to detect if it was set
% manually we'll set it to \maxdimen and hope noe will print
% something big enough and dare to use it as image clearence...
\newlength{\clearimage}
\setlength\clearimage{\maxdimen}
\edef\imageblockwidth{\photobook@imageblockwidth}
\edef\imageblockheight{\photobook@imageblockheight}
\edef\imageblockoffsettop{\photobook@imageblockoffsettop}
%----------------------------------------------------------------------
% Commands...
\newcommand\RecalculatePageLengths{
% layout bools...
\coverlayoutfalse
\hardcoverlayoutfalse
\softcoverlayoutfalse
\endpaperlayoutfalse
\jacketlayoutfalse
\coverlikelayoutfalse
\blocklayoutfalse
\ifdefstring{\layoutmode}{block}{
\blocklayouttrue }{}
\ifdefstring{\layoutmode}{cover}{
\coverlayouttrue
\coverlikelayouttrue }{}
\ifdefstring{\layoutmode}{hardcover}{
\hardcoverlayouttrue
\coverlikelayouttrue }{}
\ifdefstring{\layoutmode}{softcover}{
\softcoverlayouttrue
\coverlikelayouttrue }{}
\ifdefstring{\layoutmode}{jacket}{%
\jacketlayouttrue
\coverlikelayouttrue }{}
\ifdefstring{\layoutmode}{endpaper}{
\endpaperlayouttrue }{}
% pdf layout...
\ifx\photobook@pdfpagelayout\empty
\ifblocklayout
\def\pdfpagelayout{TwoPageRight}
\else
\def\pdfpagelayout{SinglePage}
\fi
\else
\def\pdfpagelayout{\photobook@pdfpagelayout}
\fi
% items to ignore in different layouts...
% XXX is this the correct way to go???
\ifcoverlayout
\setlength\coverflap{\photobook@coverflap}
\else
\setlength\coverflap{0pt}
\fi
\ifjacketlayout
\setlength\jacketwrap{\photobook@jacketwrap}
\setlength\jacketflap{\photobook@jacketflap}
\else
\setlength\jacketwrap{0pt}
\setlength\jacketflap{0pt}
\fi
% flaps...
\ifdim\jacketflapfront=0pt
\setlength\jacketflapfront{\jacketflap}
\fi
\ifdim\jacketflapback=0pt
\setlength\jacketflapback{\jacketflap}
\fi
% block size...
\ifdim\blockwidth=0pt
% layout: block...
\setlength\blockwidth{
\ifx\photobook@blockwidth\empty
\dimexpr
\paperwidth
- 2\bleed
\relax
\else
\photobook@blockwidth
\fi}
\setlength\pageblockwidth{\blockwidth}
% layout: cover...
\ifcoverlayout
\setlength\blockwidth{
\dimexpr
2\blockwidth
+ \spinewidth
+ 2\spinefold
+ 2\coverboardgrow
+ 2\coverflap
\relax } \fi
% layout: jacket...
% XXX this seems to be about 6mm off -- what are we missing here???
\ifjacketlayout
\setlength\blockwidth{
\dimexpr
2\blockwidth
+ \spinewidth
+ 2\spinefold
+ 2\jacketwrap
+ \jacketflapfront
+ \jacketflapback
\relax } \fi
% layout: endpaper...
\ifendpaperlayout
\setlength\blockwidth{ 2\blockwidth } \fi
\fi
\ifdim\blockheight=0pt
% layout: block / endpaper...
\setlength\blockheight{
\ifx\photobook@blockheight\empty
\dimexpr \paperheight - 2\bleed \relax
\else
\photobook@blockheight
\fi}
\setlength\pageblockheight{\blockheight}
% layout: cover...
\ifcoverlayout
\setlength\blockheight{
\dimexpr
\blockheight
+ 2\coverboardgrow
+ 2\coverflap
\relax } \fi
% layout: jacket...
\ifjacketlayout
\setlength\blockheight{
\dimexpr
\blockheight
+ 2\coverboardgrow
\relax } \fi
\fi
% default image clearence...
\ifdim\clearimage=\maxdimen
\ifx\photobook@clearimage\empty
\setlength\clearimage{-\bleed}
\else
\setlength\clearimage{\photobook@clearimage}
\fi
\fi
% page with bleeds...
% NOTE: this is essentially \paperwidth and \paperheight but we do
% not rely on them being defined -- photobook settings take
% priority over \paperwidth and \paperwidth...
\setlength\bleedblockwidth{\dimexpr
2\bleed + \blockwidth
\relax}
\setlength\bleedblockheight{\dimexpr
2\bleed + \blockheight
\relax} }
\newcommand\ResetPageLengths{
\setlength\blockwidth{0mm}
\setlength\blockheight{0mm}
\edef\pdfpagelayout{}
%
\RecalculatePageLengths }
%----------------------------------------------------------------------
% Setup (early)...
% init/update lengths...
\RecalculatePageLengths
% minimal geometry setup...
\RequirePackage[
% paper size (incl. bleeds)...
paperwidth=\bleedblockwidth, paperheight=\bleedblockheight,
]{geometry}
%----------------------------------------------------------------------
% Setup (late)...
\AtEndPreamble{
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% Metadata...
\hypersetup{
pdfinfo={
Title={\@title},
Subject={\@subject},
Author={\@author},
Keywords={\@keywords},
},
pdfpagelayout=\pdfpagelayout,
}
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% Geometry...
\RecalculatePageLengths
% no-defaults -- the user is expected to set things up...
\ifphotobook@geometrynodefaults
\geometry{
% paper size (incl. bleeds)...
paperwidth=\bleedblockwidth, paperheight=\bleedblockheight,
bindingoffset=\bindingoffset}
% normal mode...
\else
\geometry{
% paper size (incl. bleeds)...
paperwidth=\bleedblockwidth, paperheight=\bleedblockheight,
bindingoffset=\bindingoffset,
% include header/footer/margin notes in printed area
twoside, includeall, nomarginpar,
ignorehead=false, ignorefoot=false, ignoremp=false,
% center printed area on page
vcentering, hcentering}
\fi
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% pdf boxes...
% calculate pdf box dimensions in pt...
\edef\@pdfWidthPt{\strip@pt\dimexpr
0.996264009963\bleedblockwidth \relax}
\edef\@pdfHeightPt{\strip@pt\dimexpr
0.996264009963\bleedblockheight \relax}
\edef\@pdfBleedPt{\strip@pt\dimexpr
0.996264009963\bleed \relax}
\edef\@pdfTopPt{\strip@pt\dimexpr
0.996264009963\dimexpr
\bleedblockheight - \bleed \relax \relax}
\edef\@pdfRightPt{\strip@pt\dimexpr
0.996264009963\dimexpr
\bleedblockwidth - \bleed \relax \relax}
% set the boxes...
\ifxetex
% XXX not tested...
\AtBeginShipout{\AtBeginShipoutAddToBox{
\special{pdf:put @thispage <<
/MediaBox [0 0 \@pdfWidthPt\space \@pdfHeightPt]
/BleedBox [0 0 \@pdfWidthPt\space \@pdfHeightPt]
/ArtBox [\@pdfBleedPt\space \@pdfBleedPt\space \@pdfRightPt\space \@pdfTopPt]
/TrimBox [\@pdfBleedPt\space \@pdfBleedPt\space \@pdfRightPt\space \@pdfTopPt]
/CropBox [\@pdfBleedPt\space \@pdfBleedPt\space \@pdfRightPt\space \@pdfTopPt]
>>} }}
\else
\edef\pdfboxes{
/MediaBox [0 0 \@pdfWidthPt\space \@pdfHeightPt]
/BleedBox [0 0 \@pdfWidthPt\space \@pdfHeightPt]
/ArtBox [\@pdfBleedPt\space \@pdfBleedPt\space \@pdfRightPt\space \@pdfTopPt]
/TrimBox [\@pdfBleedPt\space \@pdfBleedPt\space \@pdfRightPt\space \@pdfTopPt]
/CropBox [\@pdfBleedPt\space \@pdfBleedPt\space \@pdfRightPt\space \@pdfTopPt]
}
\expandafter\pdfpageattr\expandafter{\pdfboxes}
\fi
} % \AtEndPreamble{..}
%----------------------------------------------------------------------
% Generic Commands....
\def\@keywords{}
\newcommand\keywords[1]{%
\def\@keywords{#1}}
\def\@subject{}
\newcommand\subject[1]{%
\def\@subject{#1}}
\newcommand*{\cleartoleftpage}{%
\clearpage
\if@twoside
\ifodd\c@page
\hbox{}\newpage
\if@twocolumn
\hbox{}\newpage
\fi
\fi
\fi }
% XXX workaround a problem with xelatex vs. lualatex...
\ifxetex
\newcommand\ShipoutPicture[1]{
\AddToShipoutPicture*{#1}}
\else
% XXX for some reason in pdflatex and lualatex \pagecolor{..} and
% \AddToShipoutPicture*{..} start fighting over space...
% XXX this draws over page numbers...
\newcommand\ShipoutPicture[1]{
\AddToShipoutPictureFG*{#1}}
\fi
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% XXX HACKS...
% XXX for some reason we are pushed away from the left edge...
\newlength{\OFFSETFIX}
\setlength{\OFFSETFIX}{-4mm}
% This compensates for caption width being miscalcualted for right
% alingned captions...
\newlength{\CAPTIONWIDTHFIX}
\setlength{\CAPTIONWIDTHFIX}{-5mm}
%----------------------------------------------------------------------
% Captions...
% XXX need to be able to configure/pass/override:
% - size / \captionsize...
% - color...
% XXX captions seem not to account for \imageblockoffsettop...
%\newcommand\captionsize{\scriptsize}
\newcommand\captionsize{\fontsize{6.5pt}{8pt}\selectfont}
% \imagecaption{caption}{location-date}
%
\newcommand\imagecaption[2]{
{\captionsize%
#1 %
\par\vspace{-\parskip}%
#2}}
% \overlaycaption{caption}{location-date}
%
\newcommand\overlaycaption[2]{
\begin{flushright}
\captionsize%
\color{black}{%
\colorbox{white}{ #1 }%
\par\vspace{-\parskip}%
\colorbox{white}{ #2 }}
\end{flushright}}
% \captionsidebox[offset]{imagebox}{text}
%
\newcommand\captionsidebox[3][0mm]{
\begin{minipage}{\dimexpr
% caption-image distance...
-1em
-\clearimage
+\blockwidth
-(\wd#2 - #1)
+(\nudgeimageby)
-(0.5\blockwidth - 0.5\textwidth) \relax}%
{ \captionsize #3 }
\end{minipage}}
% \captionboxleft[offset]{imagebox}{text}
% \captionboxright[offset]{imagebox}{text}
%
\newcommand\captionboxleft[3][0mm]{
\null
\vfill
\begin{flushleft}
\captionsidebox[#1]{#2}{%
\begin{flushright}
#3
\end{flushright}}
\end{flushleft}}
\newcommand\captionboxright[3][0mm]{
\null
\vfill
\begin{flushright}
\captionsidebox[#1]{#2}{%
\begin{flushleft}
#3
\end{flushleft}}
\end{flushright}}
% XXX \CAPTIONWIDTHFIX
% \captionbottombox[offset]{imagebox}{text}
%
% XXX for some reason the width is wrong here...
\newcommand\captionbottombox[3][0mm]{
\hspace{ #1 }{
% XXX the \CAPTIONWIDTHFIX factor is compensating for an odd alignment error...
\begin{minipage}{\dimexpr \CAPTIONWIDTHFIX + \wd#2 \relax}
{ \captionsize #3 }
\end{minipage}}}
% \graycaptionpage{text}
%
% XXX should this be \captionsize or \scriptsize
\newcommand\graycaptionpage[1]{
\pagestyle{empty}
\pagecolor{normgray}
\color{white}
\null
\vfill
\hspace{0.66\textwidth}{%
\begin{minipage}{0.33\textwidth}
\setlength{\parskip}{0.5em}%
\captionsize\it%
#1
\end{minipage} }
\newpage
\nopagecolor
\color{black} }
%----------------------------------------------------------------------
% Cover/endpaper Templates...
%
% XXX need a way to place images / templates into these...
% XXX should these only be visible in respective modes or for non-zero widths???
% XXX this may span more than one page if there is enoug stuff packed
% into it...
\newenvironment{page}{}{%
\null
\clearpage }
%%% \photobook@newtemplatecell{name}{x}{y}{width}{heigth}
%%%
%%% XXX need to quote arguments to make them eval on env expansion and not
%%% on command expansion....
%%\newcommand\photobook@newtemplatecell[5]{
%% \newenvironment{#1}{%
%% \setlength\cellwidth{#4}
%% \setlength\cellheight{#5}
%% %
%% \begin{textblock*}{\pageblockwidth}(#2, #3)%
%% \begin{minipage}[t][\cellheight][t]{\cellwidth}%
%% }{%
%% \end{minipage}%
%% \end{textblock*} } }
\newlength\cellwidth
\newlength\cellheight
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% endpaper...
%
% XXX for some reason naming this anything starting with endpaper will
% make LaTeX complain that that is already defined...
\newenvironment{leftside}{%
\setlength\cellwidth{\pageblockwidth}
\setlength\cellheight{\pageblockheight}
%
\begin{textblock*}{\pageblockwidth}(\bleed, \bleed)%
\begin{minipage}[t][\cellheight][t]{\cellwidth}%
}{%
\end{minipage}%
\end{textblock*} }
\newenvironment{rightside}{%
\setlength\cellwidth{\pageblockwidth}
\setlength\cellheight{\pageblockheight}
%
\begin{textblock*}{\pageblockwidth}(
\bleed
+ \pageblockwidth,
\bleed )%
\begin{minipage}[t][\cellheight][t]{\cellwidth}%
}{%
\end{minipage}%
\end{textblock*} }
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% cover-like layout components...
% front cover...
%
\newenvironment{frontcover}{%
\setlength\cellwidth{\dimexpr
\pageblockwidth
+ \coverboardgrow \relax }
\setlength\cellheight{\dimexpr
\pageblockheight
+ 2\coverboardgrow \relax }
%
\begin{textblock*}{\pageblockwidth + \coverboardgrow}(
\bleed
+ \jacketflapback
+ \coverflap
+ \jacketwrap
+ \coverboardgrow
+ \pageblockwidth
+ 2\spinefold
+ \spinewidth,
\bleed
+ \coverflap )%
\begin{minipage}[t][\cellheight][t]{\cellwidth}%
}{%
\end{minipage}%
\end{textblock*} }
% back cover...
%
\newenvironment{backcover}{%
\setlength\cellwidth{\dimexpr
\pageblockwidth
+ \coverboardgrow \relax }
\setlength\cellheight{\dimexpr
\pageblockheight
+ 2\coverboardgrow \relax }
%
\begin{textblock*}{\pageblockwidth + \coverboardgrow}(
\bleed
+ \jacketflapback
+ \coverflap
+ \jacketwrap,
\bleed
+ \coverflap )%
\begin{minipage}[t][\cellheight][t]{\cellwidth}%
}{%
\end{minipage}%
\end{textblock*} }
% spine...
%
\newenvironment{spine}{%
\setlength\cellwidth{\dimexpr
\spinewidth \relax }
\setlength\cellheight{\dimexpr
\pageblockheight
+ 2\coverboardgrow \relax }
%
\begin{textblock*}{\spinewidth}(
\bleed
+ \jacketflapback
+ \coverflap
+ \jacketwrap
+ \coverboardgrow
+ \pageblockwidth
+ \spinefold,
\bleed
+ \coverflap )%
\begin{minipage}[t][\cellheight][t]{\cellwidth}%
}{%
\end{minipage}%
\end{textblock*} }
% vertical spine...
%
% XXX make args be up or down...
\newenvironment{vspine}[1][270]{%
\setlength\cellwidth{\dimexpr
\spinewidth \relax }
\setlength\cellheight{\dimexpr
\pageblockheight
+ 2\coverboardgrow \relax }
%
\begin{textblock*}{\spinewidth}(
\bleed
+ \jacketflapback
+ \coverflap
+ \jacketwrap
+ \coverboardgrow
+ \pageblockwidth
+ \spinefold,
\bleed
+ \coverflap )%
% XXX this does not work for some reason...
%\begin{turn}{\ifdefstring{#1}{up}{270}{90}}
\begin{turn}{#1}
\begin{minipage}[t][\cellwidth][t]{\cellheight}%
}{%
\end{minipage}%
\end{turn}
\end{textblock*} }
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% jacket components...
% front flap...
%
\newenvironment{frontflap}{%
\setlength\cellwidth{\jacketflapfront }
\setlength\cellheight{\dimexpr
\pageblockheight
+ 2\coverboardgrow \relax }
%
\begin{textblock*}{\jacketflapfront}(
\bleed
+ \jacketflapback
+ 2\jacketwrap
+ 2\coverboardgrow
+ 2\pageblockwidth
+ 2\spinefold
+ \spinewidth,
\bleed
+ \coverflap )%
\begin{minipage}[t][\cellheight][t]{\cellwidth}%
}{%
\end{minipage}%
\end{textblock*} }
% back flap...
%
\newenvironment{backflap}{%
\setlength\cellwidth{\jacketflapback}
\setlength\cellheight{\dimexpr
\pageblockheight
+ 2\coverboardgrow \relax }
%
\begin{textblock*}{\jacketflapback}(
\bleed,
\bleed
+ \coverflap )%
\begin{minipage}[t][\cellheight][t]{\cellwidth}%
}{%
\end{minipage}%
\end{textblock*} }
\newcommand\photobook@TemplateCell[1]{
% XXX this seems to be bigger than the size given...
%\fbox{\parbox[t][\cellheight][t]{\cellwidth}{%
\begin{center}
\vfill
#1 \\
(\the\cellwidth \space x \the\cellheight)
\vfill
\end{center} }
%\end{center} }} }
\newcommand\GenerateTemplate{
% XXX undo this after...
\TPoptions{showboxes=true}
\begin{page}
\setlength{\parindent}{0em}
\ifendpaperlayout
\begin{leftside}
\photobook@TemplateCell{ENDPAPER LEFT}
\end{leftside}
\begin{rightside}
\photobook@TemplateCell{ENDPAPER RIGHT}
\end{rightside}
\fi
\ifcoverlikelayout
\begin{frontcover}
\photobook@TemplateCell{FRONT COVER}
\end{frontcover}
%\begin{vspine}[90]
\begin{vspine}%[down]
\photobook@TemplateCell{SPINE}
\end{vspine}
\begin{backcover}
\photobook@TemplateCell{BACK COVER}
\end{backcover}
\fi
\ifjacketlayout
\begin{frontflap}
\photobook@TemplateCell{FRONT FLAP}
\end{frontflap}
\begin{backflap}
\photobook@TemplateCell{BACK FLAP}
\end{backflap}
\fi
\end{page} }
%----------------------------------------------------------------------
% Page Templates...
\newsavebox\photobook@imagebox
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% \imagepagefitWH{width}{height}{caption}{image}
%
% NOTE: width and hight are ratios of \textwidth and \textheight
% respectively.
% i.e. \imagepagefitWH{0.5}{0.5}{...} will set image size to half
% the size of the text block....
%
% XXX this generates lots of warnings...
% XXX broblems with captions:
% - vertical offset is floating depending on image proportions...
% - width is a bit off...
% XXX BUG: vertical alignment falls apart if page head is changed...
% XXX replace \ifthenelse\isodd .. with etoolbox equivalent.... (???)
\newcommand\imagepagefitWH[4]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio=true,
width=#1\textwidth,
height=#2\textheight]{#4} }
\null
\vfill
% image...
\vspace{ \imageblockoffsettop\textheight }
\begin{center}
\usebox\photobook@imagebox
\end{center}
\vfill
% caption...
\ShipoutPicture{
\vfill
\vspace{ \dimexpr
% XXX this is not accurate for some reason...
( 1em
+ (\dimexpr \imageblockoffsettop\textheight / 2 \relax)
+ \paperheight
+ \ht\photobook@imagebox )
/ 2 \relax }
\begin{minipage}{\paperwidth}
\begin{center}
\ifthenelse{\isodd{\thepage}}%
% odd pages...
{ \captionbottombox[ \bindingoffset ]{\photobook@imagebox}{%
\begin{flushright}
#3
\end{flushright} } }%
% even pages...
{ \captionbottombox[ -\bindingoffset ]{\photobook@imagebox}{%
\begin{flushright}
#3
\end{flushright} } }%
\end{center}
\end{minipage} }
\newpage }
% \imagepagefitH[height]{caption}{image}
% \imagepagefitW[width]{caption}{image}
%
\newcommand\imagepagefitH[3][\imageblockheight]{
\imagepagefitWH{\imageblockwidth}{#1}{#2}{#3} }
\newcommand\imagepagefitW[3][\imageblockwidth]{
\imagepagefitWH{#1}{\imageblockheight}{#2}{#3} }
% \imagepage{caption}{path}
%
% +---------------+
% | |
% | +-----------+ |
% | |. .| |
% | | . . | |
% | | image | |
% | | . . | |
% | |. .| |
% | +-----------+ |
% | c |
% | |
% +---------------+
%
\newcommand\imagepage[2]{
\imagepagefitWH{\imageblockwidth}{\imageblockheight}{#1}{#2} }
% XXX
% XXX captions wrong...
% \imagepagefit[clearence]{caption}{image}
%
% +---------------+
% | |. .| |
% | | . . | |
% | | . . | |
% | | . . | |
% | | image | |
% | | . . | |
% | | . . | |
% | | . . | |
% | |. .| |
% +---------------+
%
% NOTE: this is like \imagepage but will fit an image into page...
\newcommand\imagepagefit[3][\clearimage]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
width=\dimexpr \blockwidth - ((#1) * 2) \relax,
height=\dimexpr \blockheight - ((#1) * 2) \relax]{#3} }
%\clearpage
\null
% XXX misaligned...
\captionboxright{\photobook@imagebox}{#2}%
\ShipoutPicture{%
%\AtPageCenter{%
% XXX this for some reason not at -\bleed horizontally...
\AtPageLowerLeft{%
\hspace*{\dimexpr
% XXX when \AtPageCenter{ .. }for some reason -\bleed puts
% the image in the center but adding -0.5\ht\photobook@imagebox
% to it offsets the image to the left -- scaling????!!
%-\bleed
+0.5\OFFSETFIX
+0.5\blockwidth
-0.5\wd\photobook@imagebox
+\bleed
\relax}{
\raisebox{\dimexpr
+0.5\blockheight
-0.5\ht\photobook@imagebox
+\bleed
\relax}{
\usebox\photobook@imagebox } } } }
\newpage }
% XXX does not work...
% XXX \OFFSETFIX
% \imagepagefill[clearence]{caption}{image}
%
% +---------------+
% |---------------|
% | |
% |. .|
% | . . |
% | image |
% | . . |
% |. .|
% | |
% |-------------c-|
% +---------------+
%
% NOTE: this is like \imagepage but will fit an image into page...
% XXX add option to align to top/bottom...
% XXX captions untested...
\newcommand\imagepagefill[3][\clearimage]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
width=\dimexpr \blockwidth - ((#1) * 2) \relax,
% XXX make this use the minumum dimention and not width...
%height=\dimexpr \blockheight - ((#1) * 2) \relax
]{#3} }
\clearpage
\captionboxright[-#1]{\photobook@imagebox}{#2}
\ShipoutPicture{
\AtPageLowerLeft{
\hspace*{\dimexpr
+0.5\blockwidth
-0.5\wd\photobook@imagebox
-\bleed
-0.5\OFFSETFIX
\relax}{
\raisebox{\dimexpr
(#1)
+\clearimage
+\bleed \relax}{
\usebox\photobook@imagebox } } } }
\newpage }
% XXX
% XXX \OFFSETFIX
% portraitimagepageleft[clearence]{caption}{image}
%
% +---------------+
% |. .| |
% | . . | |
% | . . | |
% | . . | |
% | image | |
% | . . | |
% | . . | |
% | . . | |
% |. .| c |
% +---------------+
%
\newcommand\portraitimagepageleft[3][\clearimage]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
height=\dimexpr \blockheight - ((#1) * 2) \relax]{#3} }
\clearpage
\captionboxright[-#1]{\photobook@imagebox}{#2}
\ShipoutPicture{
\AtPageLowerLeft{
\hspace*{\dimexpr \OFFSETFIX + #1 \relax}{
\raisebox{\dimexpr #1 + \bleed \relax}{
\usebox\photobook@imagebox } } } }
\newpage }
% XXX
% portraitimagepageright{caption}{image}
%
% +---------------+
% | |. .|
% | | . . |
% | | . . |
% | | . . |
% | | image |
% | | . . |
% | | . . |
% | | . . |
% | c |. .|
% +---------------+
%
%
\newcommand\portraitimagepageright[3][\clearimage]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
height=\dimexpr \blockheight - ((#1) * 2) \relax]{#3} }
\clearpage
\captionboxleft[-#1]{\photobook@imagebox}{#2}
\ShipoutPicture{
\AtPageLowerLeft{
\hspace*{\dimexpr
-#1
+\blockwidth
-\wd\photobook@imagebox \relax}{
\raisebox{\dimexpr #1 + \bleed \relax}{
\usebox\photobook@imagebox } } } }
\newpage }
%----------------------------------------------------------------------
% Spread Templates...
\newlength{\photobook@tmpnudgeimageby}
\newlength{\photobook@tmpvnudgeimageby}
\newlength{\photobook@tmpvgrowimageby}
\newlength{\nudgeimageby}
\setlength{\nudgeimageby}{0mm}
\newlength{\vnudgeimageby}
\setlength{\vnudgeimageby}{0mm}
\newlength{\vgrowimageby}
\setlength{\vgrowimageby}{0mm}
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% nudgeimage{amount}
%
% NOTE: in addition to spread commands below this is also used by
% \captionsidebox
\newcommand\nudgeimage[1]{%
\setlength{\nudgeimageby}{#1}}
% vnudgeimage{amount}
%
% offset image vertically within bleeds.
%
% NOTE: this should not be used in conjunction with \vgrowimage{..} and
% should not exceed 1/2 of the amount given to \vgrowimage{..}
\newcommand\vnudgeimage[1]{%
\setlength{\vnudgeimageby}{#1}}
% vgrowimage{amount}
%
% This will effectively add to 1/2 amount to top bleed and the same to
% bottom bleed.
\newcommand\vgrowimage[1]{%
\setlength{\vgrowimageby}{#1}}
% resetnudgeimage
%
% NOTE: when working with shipout place this after \newpage as when
% placed before this will reset the \nudgeimageby BEFORE the image
% placing commands have a chance to execute.
% XXX rename
\newcommand\resetnudgeimage{%
\setlength{\vgrowimageby}{0mm}%
\setlength{\vnudgeimageby}{0mm}%
\setlength{\nudgeimageby}{0mm}}
% - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
% XXX
% portraitspreadbleedleft[clearence]{caption}{image}
%
% +---------------+---------------+
% | |. .| |
% | | . . | |
% | | . . | |
% | | . . | |
% | | image | |
% | | . . | |
% | | . . | |
% | | . . | |
% | |. .| c |
% +---------------+---------------+
%
\newcommand\portraitspreadbleedleft[3][\clearimage]{
\cleartoleftpage
% style the caption...
\null
\vfill
\begin{flushright}
#2%
\end{flushright}
\newpage
% XXX add \bleed
\portraitimagepageleft[#1]{}{#3} }
% XXX
% portraitspreadbleedright[clearence]{caption}{image}
%
% +---------------+---------------+
% | |. .| |
% | | . . | |
% | | . . | |
% | | . . | |
% | | image | |
% | | . . | |
% | | . . | |
% | | . . | |
% | c |. .| |
% +---------------+---------------+
%
\newcommand\portraitspreadbleedright[3][\clearimage]{
\cleartoleftpage
% style the caption...
% XXX add \bleed
\portraitimagepageright[#1]{}{#3}
\null
\vfill
\begin{flushleft}
#2%
\end{flushleft}
\newpage }
% XXX
% XXX \OFFSETFIX
% imagespreadleft[clearence]{caption}{image}
%
% Image spread aligned left (with bleed)...
%
% +---------------+---------------+
% | . . . | |
% | . . . | |
% | . . . | |
% | . .. | |
% | image | |
% | . .. | |
% | . . . | |
% | . . . | |
% | . . . | c |
% +---------------+---------------+
%
%
% XXX might be a good idea to do a version of this with min/max width of
% the caption block...
\newcommand\imagespreadleft[3][\clearimage]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
height=\dimexpr \blockheight - ((#1) * 2) + \vgrowimageby \relax]{#3} }
% left page...
% XXX BUG: this in some cases creates an extra empty spread before this...
% ...appears to be a problem where we have a tweak.tex
%\cleartoleftpage
\null
\ShipoutPicture{
\AtPageLowerLeft{
\hspace*{\dimexpr
\OFFSETFIX
-(\nudgeimageby)
+#1
+\bleed
\relax}{
\raisebox{\dimexpr
#1
+ \bleed
- 0.5\vgrowimageby
- \vnudgeimageby
\relax}{
\usebox\photobook@imagebox } } } }
\newpage
% right page...
\captionboxright[\blockwidth]{\photobook@imagebox}{#2}
\ShipoutPicture{
\AtPageLowerLeft{
\hspace*{\dimexpr
\OFFSETFIX
-(\nudgeimageby)
+#1
-\blockwidth
+\bleed
\relax}{
\raisebox{\dimexpr
#1
+ \bleed
- 0.5\vgrowimageby
- \vnudgeimageby
\relax}{
\usebox\photobook@imagebox } } } }
\newpage
\resetnudgeimage }
% XXX
% imagespreadright[clearence]{caption}{image}
%
% Image spread aligned right (with bleed)...
%
% +---------------+---------------+
% | | . . . |
% | | . . . |
% | | . . . |
% | | .. . |
% | | image |
% | | .. . |
% | | . . . |
% | | . . . |
% | c | . . . |
% +---------------+---------------+
%
\newcommand\imagespreadright[3][\clearimage]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
height=\dimexpr \blockheight - ((#1) * 2) + \vgrowimageby \relax]{#3} }
% left page...
%\cleartoleftpage
\null
\captionboxleft[\blockwidth]{\photobook@imagebox}{#2}
\ShipoutPicture{
\AtPageLowerLeft{
\hspace*{\dimexpr
-#1
+0.5\OFFSETFIX
+(\nudgeimageby)
+2\blockwidth
+\bleed
-\wd\photobook@imagebox \relax}{
\raisebox{\dimexpr
#1 + \bleed
- 0.5\vgrowimageby - \vnudgeimageby \relax}{
\usebox\photobook@imagebox } } } }
\newpage
% right page...
\null
\ShipoutPicture{
\AtPageLowerLeft{
\hspace*{\dimexpr
-#1
+0.5\OFFSETFIX
+(\nudgeimageby)
+\blockwidth
+\bleed
-\wd\photobook@imagebox \relax}{
\raisebox{\dimexpr
#1 + \bleed
- 0.5\vgrowimageby - \vnudgeimageby \relax}{
\usebox\photobook@imagebox } } } }
\newpage
\resetnudgeimage }
% XXX
% XXX \OFFSETFIX
% imageleftspreadfullbleed[vertical-offset]{caption}{image}
%
% Image spread with full bleed...
%
% +---------------+
% | . .
% | . .
% | . .
% | . .
% | ima
% | . .
% | . .
% | . .
% | . c .
% +---------------+
%
\newcommand\imageleftspreadfullbleed[3][0mm]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
width=\dimexpr
2\blockwidth - 2\clearimage + \vgrowimageby \relax]{#3} }
\clearpage
\null
\vfill
\begin{flushright}
#2
\end{flushright}
\ShipoutPicture{
\AtPageCenter{
\hspace{\dimexpr
\OFFSETFIX
-(\nudgeimageby)
+\clearimage
-0.5\blockwidth \relax}{
\raisebox{\dimexpr
(#1)
+\clearimage
-(0.5\blockheight
+(0.5\ht\photobook@imagebox - 0.5\blockheight))
- 0.5\vgrowimageby - \vnudgeimageby \relax}{
\usebox\photobook@imagebox } } } }
\newpage
\resetnudgeimage }
% XXX
% XXX \OFFSETFIX
% imagerightspreadfullbleed[vertical-offset]{caption}{image}
%
% Image spread with full bleed...
%
% +---------------+
% . . |
% . . |
% . . |
% . . |
% age |
% . . |
% . . |
% . . |
% . . c |
% +---------------+
%
\newcommand\imagerightspreadfullbleed[3][0mm]{
\sbox{\photobook@imagebox}{
\includegraphics[
keepaspectratio,
width=\dimexpr
2\blockwidth - 2\clearimage + \vgrowimageby \relax]{#3} }
\clearpage
\null
\vfill
% XXX for some reason the last line here is a bit off...
% XXX do we need to restrict caption width here??? ...0.5\textwidth??
% XXX make caption sizing a bit more flexible...
\begin{flushright}
\captionsize #2
\end{flushright}
\ShipoutPicture{
\AtPageCenter{
\hspace{\dimexpr
\OFFSETFIX
-(\nudgeimageby)
+\clearimage
-1.5\blockwidth \relax}{
\raisebox{\dimexpr
(#1)
+\clearimage
-(0.5\blockheight
+(0.5\ht\photobook@imagebox - 0.5\blockheight))
- 0.5\vgrowimageby - \vnudgeimageby \relax}{
\usebox\photobook@imagebox } } } }
\newpage
\resetnudgeimage }
% XXX BUG?: this is not centered vertically...
% XXX
% imagespreadfullbleed[vertical-offset]{caption}{image}
%
% Image spread with full bleed...
%
% +---------------+---------------+
% | . . . |
% | . . . |
% | . . . |
% | . . . |
% | image |
% | . . . |
% | . . . |
% | . . . |
% | . . . c |
% +---------------+---------------+
%
% XXX do we need the same thing but with a left caption???
\newcommand\imagespreadfullbleed[3][0mm]{
\setlength{\photobook@tmpnudgeimageby}{\nudgeimageby}
\setlength{\photobook@tmpvnudgeimageby}{\vnudgeimageby}
\setlength{\photobook@tmpvgrowimageby}{\vgrowimageby}
\cleartoleftpage
\imageleftspreadfullbleed[#1]{}{#3}
\nudgeimage{\photobook@tmpnudgeimageby}
\vnudgeimage{\photobook@tmpvnudgeimageby}
\vgrowimage{\photobook@tmpvgrowimageby}
\imagerightspreadfullbleed[#1]{#2}{#3} }
%----------------------------------------------------------------------
%%% XXX DEBUG...
%%\AtBeginDocument{
%%}
%----------------------------------------------------------------------
% vim:set ts=4 sw=4 :
Reference in New Issue View Git Blame Copy Permalink