PAGELAYOUTAPI(1) PAGELAYOUTAPI(1)

pagelayoutapi - API for the pagelayout LaTeX class

pagelayoutapi getwidth % FILE

pagelayoutapi getheight % FILE

pagelayoutapi optimize % FILE % FILENAME % EXTENSION % ORIGINALWIDTH % ORIGINALHEIGHT % CROPLEFT % CROPRIGHT % CROPTOP % CROPBOTTOM % DENSITY % WIDTH % HEIGHT % DOWNSAMPLETHRESHOLD % UNSHARP % QUALITY

pagelayoutapi makeshadow % FILENAME % STANDARDDEVIATION % OPACITY % COLOR % WIDTH % HEIGHT % FRAMEWIDTH % FRAMEHEIGHT % MARGIN % BORDERRADIUS

pagelayoutapi start [% import % [GRAPHICSPATH]] [% turbo % JOBNAME]

pagelayoutapi batchoptimize % BATCHLIST

This script provides an API for the pagelayout LaTeX class.

Returns the width in pixels for the given image file.
Returns the height in pixels for the given image file.
Creates a cropped, rezised, sharpend and compressed image and stores it in the cache directory.
Creates a shadow image and stores it in the cache directory.
The import parameter triggers the image import (see pagelayout-manual.pdf chapter "Image Optimization"). Running the command with the parameter turbo, where the jobname is the filename of the document, processes the document in a special batch mode, that creates a batch list and calls the command pagelayoutapi batchoptimize.
Optimizes multiple images in parallel.

Prints a help message.
Prints version information.

filename with extension (eg. IMG1234.JPEG)
filename without extension (eg. IMG1234)
optimized file extension (.jpg|.png)
density in ppi (eg. 72)
downsample threshold (integer >= 100)
unsharp filter (eg. 2x1)
quality (integer > 0, <= 100)
standard deviation (decimal > 0.0)
opacity (decimal >= 0.0, <= 1.0)
color string (eg. pink)
list of directories (eg. {images/}{tmp/})
LaTeX filename without extension (eg. my-document)
a flat list of batch items where each batch item is a flat list of the 15 parameters required by the command `pagelayoutapi optimize`

All other parameters are length dimensions. The command pagelayoutapi optimize expects integer values in the LaTeX unit sp (eg. 65536). The command pagelayoutapi makeshadow expects decimal values in a SVG compatible unit (eg. 420.0pt).

pagelayoutapi requires ImageMagick 7.0 or later and Inkscape 1.0 or later.

Defines a system wide import directory.

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

Copyright (c) 2022-2023 Friedemann Bartels. Free use of this software is granted under the terms of the LaTeX Project Public License version 1.3c or later.

December 2023