1PAGELAYOUTAPI(1)                                              PAGELAYOUTAPI(1)
2
3
4

NAME

6       pagelayoutapi - API for the pagelayout LaTeX class
7

SYNOPSIS

9       pagelayoutapi getwidth % FILE
10
11       pagelayoutapi  optimize % FILE % FILENAME % EXTENSION % ORIGINALWIDTH %
12       ORIGINALHEIGHT % CROPLEFT % CROPRIGHT % CROPTOP % CROPBOTTOM %  DENSITY
13       % WIDTH % HEIGHT % DOWNSAMPLETHRESHOLD % UNSHARP % QUALITY
14
15       pagelayoutapi  makeshadow  %  FILENAME  % STANDARDDEVIATION % OPACITY %
16       COLOR % WIDTH % HEIGHT % FRAMEWIDTH % FRAMEHEIGHT % MARGIN %  BORDERRA‐
17       DIUS
18
19       pagelayoutapi start [% import % [GRAPHICSPATH]] [% turbo % JOBNAME]
20
21       pagelayoutapi batchoptimize % BATCHLIST
22

DESCRIPTION

24       This script provides an API for the pagelayout LaTeX class.
25
26       pagelayoutapi getwidth
27              Returns the width in pixels for the given image file.
28
29       pagelayoutapi optimize
30              Creates  a  cropped,  rezised, sharpend and compressed image and
31              stores it in the cache directory.
32
33       pagelayoutapi makeshadow
34              Creates a shadow image and stores it in the cache directory.
35
36       pagelayoutapi start
37              The import parameter triggers the  image  import  (see  pagelay‐
38              out-manual.pdf  chapter  "Image Optimization"). Running the com‐
39              mand with the parameter turbo, where the jobname is the filename
40              of the document, processes the document in a special batch mode,
41              that creates a batch list and calls  the  command  pagelayoutapi
42              batchoptimize.
43
44       pagelayoutapi batchoptimize
45              Optimizes multiple images in parallel.
46

OPTIONS

48       --help Prints a help message.
49
50       --version
51              Prints version information.
52

PARAMETERS

54       FILE   filename with extension (eg. IMG1234.JPEG)
55
56       FILENAME
57              filename without extension (eg. IMG1234)
58
59       EXTENSION
60              optimized file extension (.jpg|.png)
61
62       DENSITY
63              density in ppi (eg. 72)
64
65       DOWNSAMPLETHRESHOLD
66              downsample threshold (integer >= 100)
67
68       UNSHARP
69              unsharp filter (eg. 2x1)
70
71       QUALITY
72              quality (integer > 0, <= 100)
73
74       STANDARDDEVIATION
75              standard deviation (decimal > 0.0)
76
77       OPACITY
78              opacity (decimal >= 0.0, <= 1.0)
79
80       COLOR  color string (eg. pink)
81
82       GRAPHICSPATH
83              list of directories (eg. {images/}{tmp/})
84
85       JOBNAME
86              LaTeX filename without extension (eg. my-document)
87
88       BATCHLIST
89              a  flat list of batch items where each batch item is a flat list
90              of the 15 parameters required by the command `pagelayoutapi  op‐
91              timize`
92
93       All  other  parameters are length dimensions. The command pagelayoutapi
94       optimize expects integer values in the LaTeX unit sp (eg.  65536).  The
95       command  pagelayoutapi  makeshadow expects decimal values in a SVG com‐
96       patible unit (eg. 420.0pt).
97

ENVIRONMENT

99       pagelayoutapi requires ImageMagick 7.0 or later  and  Inkscape  1.0  or
100       later.
101
102       PAGELAYOUT_IMPORT_DIRECTORY
103              Defines a system wide import directory.
104

AUTHOR

106       pagelayoutapi      was      written      by     Friedemann     Bartels.
107       https://github.com/friedemannbartels
108

LICENSE

110       Copyright (c) 2022-2023 Friedemann Bartels. Free use of  this  software
111       is  granted under the terms of the LaTeX Project Public License version
112       1.3c or later.
113
114
115
116                                 January 2023                 PAGELAYOUTAPI(1)