francofusco
commented
3 months ago Small update regarding my last question: I found a way to create templates that contain parameters that can be declared as key-value pairs. The values can be specified when "using" the templates later on.
Here is an example of usage:
% Declare a template that has the two parameters "hratio" and "vratio", whose
% default value is 0.5 (for both).
\makeatletter
\NewParametricTemplate{FlexibleWindows}{hratio=0.5, vratio=0.5}{
\placeholder{0 0 {\FlexibleWindows@vratio} {\FlexibleWindows@hratio}}
\placeholder{0 {\FlexibleWindows@hratio} {\FlexibleWindows@vratio} 1}
\placeholder{{\FlexibleWindows@vratio} 0 1 {\FlexibleWindows@hratio}}
\placeholder{{\FlexibleWindows@vratio} {\FlexibleWindows@hratio} 1 1}
}
\makeatother
\begin{document}
% Use the template by changing the parameters.
\ParametricTemplate[hratio=0.6, vratio=0.4]{FlexibleWindows}{
\graphic{img1}
\graphic{img2}
\graphic{img3}
\graphic{img4}
}
% Use the template by changing the parameters. We can also change margins & co.
\ParametricTemplate[hratio=0.4, vratio=0.4][margin=5mm, gutter=1mm]{FlexibleWindows}{
\graphic{img1}
\graphic{img2}
\graphic{img3}
\graphic{img4}
}
\end{document}which produces the following pages:
For those interested, this is the code for the \NewParametricTemplate and \ParametricTemplate commands:
\usepackage{kvoptions}
\usepackage{xparse}
\makeatletter%
% Initialize the given key with the given value. To be used with \kv@parse to
% declare a list of key-value pairs.
% Usage:
% \ProcessorParseAndDeclare{key}{value}
\newcommand{\ProcessorParseAndDeclare}[2]{\DeclareStringOption[#2]{#1}}
% Create a new template that accepts parameters in the form of key-value pairs.
% The command declares the key-value pairs (using the template name as family)
% and then calls the \template command from the pagelayout class.
% Usage:
% \NewParametricTemplate[pagelayout-kvoptions]{name}{kvparameters}{body}
%
% Args:
% - pagelayout-kvoptions: Key-value options to be forwarded to the \template
% command as its optional arguments (example: "margin=3mm, gutter=5pt").
% - name: Name of the template. This must not contain spaces because this name
% is used to prefix the parameters using the kvoptions package.
% - kvparameters: Key-value parameters that can be used in the template body.
% The values passed in the list are used as the defaults for the keys.
% - body: Code to be passed as the last parameter to the \template command.
% Parameters are accessible in the body as "\name@param".
%
% Example:
% \makeatletter
% \NewParametricTemplate{SimpleParametric}{ratio=0.5}{
% \placeholder{0 0 1 {\SimpleParametric@ratio}}
% \placeholder{0 {\SimpleParametric@ratio} 1 1}
% }
% \makeatother
%
% Note: as shown in the example, it is very important to wrap the declaration
% within the "\makeatletter" and "\makeatother" commands. Otherwise, the full
% parameter names (that is, \SimpleParametric@ratio in the example) are not
% expanded as intended.
\NewDocumentCommand{\NewParametricTemplate}{O{} m m m}{%
\SetupKeyvalOptions{family=#2, prefix=#2@}%
\kv@parse{#3}{\ProcessorParseAndDeclare}%
\ProcessKeyvalOptions{#2}%
\newtemplate[#1]{#2}{#4}%
}
% Use a template declared with \NewParametricTemplate.
% Usage:
% \ParametricTemplate[kvparameters][pagelayout-kvoptions]{name}{content}
%
% Args:
% - kvparameters: Key-value pairs to set one or more parameters of the
% template. Every parameter that is not set explicitly here will use the
% default value specified during declaration in \NewParametricTemplate.
% - pagelayout-kvoptions: Key-value options to be forwarded to the \template
% command as its optional arguments (example: "margin=3mm, gutter=5pt").
% - name: Name of the template to be used - must match the name of one of the
% templates created with \NewParametricTemplate.
% - content: Mix of graphics and text to fill the template. This is equivalent
% to what would be passed as last argument to \template.
%
% Examples:
% \ParametricTemplate{SimpleParametric}{\graphic{img1}\graphic{img2}}
% \ParametricTemplate[ratio=0.35]{SimpleParametric}{\graphic{img1}\graphic{img2}}
% \ParametricTemplate[][margin=2cm]{SimpleParametric}{\graphic{img1}\graphic{img2}}
% \ParametricTemplate[ratio=0.55][gutter=5mm]{SimpleParametric}{\graphic{img1}\graphic{img2}}
\NewDocumentCommand{\ParametricTemplate}{O{} O{} m m}{%
\kvsetkeys{#3}{#1}%
\template[#2]{#3}{#4}%
}
\makeatother
friedemannbartels
Hello! Thanks for the class, it's very nice and intuitive to use!
I am experimenting with it to see if I can create some travel pohotobooks where the layouts are a bit more "playful" than what appears in professional photobooks. As an example, my current "challenge" is to create a layout that contains 5 cells as follows (for a "lay-flat" kind of book):
The "specs" on the sizes are as follows:
What I've achieved so far is ok visually, but a bit hacky in the way it is coded. If possible, I need a bit of guidance to clarify some doubts and to improve the solution I came up with.
This is what I got. First of all, I created a "backup" of the lengths
\bleed,\marginand\gutter, saving them in the lengths\documentbleed,\documentmarginand\documentgutter. I then created a template with\newtemplate[double, margin=-\documentbleed, gutter=0pt]{complex}{...}. The reason formargin=-\documentbleedis that the "drawing area" should span the whole page, bleed area included. The reason forgutter=0pt... is actually not entirely clear to me, I'll get back to it later in the description. With the page setup, I then usedpgfmathto calculate manually all dimensions and positions needed, then I used\placeholder{y1 x1 y2 x2}to allocate the elements. Here is the code for the template:The code above works, but it has a limitation: to change the margin and distance between pictures, it is necessary to do manually change the "back-up lengths" as in:
which is breaking the (clear and simple) API used in
\template[]{}- where you would simply set the values using the keyword arguments.I've tried a different approach that does not need to use
documentmargin& friends, but it appears to be broken. More precisely, I create a page without changing the margin, and then position everything relative to the drawing area - which is the page, minus the bleed and the margin. The corner images are placed with ease, but when I try to position the center image something goes wrong. The code I need to execute is:The code above produces the following spread:
A simplified version of the failing code (which places only the center image using a hard-coded width) is the following:
Note that if I set
\rowendmanually to 1, then the image is placed as expected (despite the negative initial row):Any idea how to fix this?
I also have a couple of random doubts:
\placeholder? Because when prototyping the template I tried keeping the gutter as it was, and simply use\gutterfor spacing images. However, the result was that images were twice as far as I would expect. My conclusion was that the gutter is "applied" around each image and thus I "deactivated" it usinggutter=0ptin the template declaration, and resorted to the use of\documentgutterfor all calculations.Thanks in advance for any help that can be given!