| 1 |
.\" generated with Ronn/v0.7.3 |
| 2 |
.\" http://github.com/rtomayko/ronn/tree/0.7.3 |
| 3 |
. |
| 4 |
.TH "PAGELAYOUTAPI" "1" "December 2023" "" "" |
| 5 |
. |
| 6 |
.SH "NAME" |
| 7 |
\fBpagelayoutapi\fR \- API for the pagelayout LaTeX class |
| 8 |
. |
| 9 |
.SH "SYNOPSIS" |
| 10 |
\fBpagelayoutapi getwidth\fR % FILE |
| 11 |
. |
| 12 |
.P |
| 13 |
\fBpagelayoutapi getheight\fR % FILE |
| 14 |
. |
| 15 |
.P |
| 16 |
\fBpagelayoutapi optimize\fR % FILE % FILENAME % EXTENSION % ORIGINALWIDTH % ORIGINALHEIGHT % CROPLEFT % CROPRIGHT % CROPTOP % CROPBOTTOM % DENSITY % WIDTH % HEIGHT % DOWNSAMPLETHRESHOLD % UNSHARP % QUALITY |
| 17 |
. |
| 18 |
.P |
| 19 |
\fBpagelayoutapi makeshadow\fR % FILENAME % STANDARDDEVIATION % OPACITY % COLOR % WIDTH % HEIGHT % FRAMEWIDTH % FRAMEHEIGHT % MARGIN % BORDERRADIUS |
| 20 |
. |
| 21 |
.P |
| 22 |
\fBpagelayoutapi start\fR [% import % [GRAPHICSPATH]] [% turbo % JOBNAME] |
| 23 |
. |
| 24 |
.P |
| 25 |
\fBpagelayoutapi batchoptimize\fR % BATCHLIST |
| 26 |
. |
| 27 |
.SH "DESCRIPTION" |
| 28 |
This script provides an API for the pagelayout LaTeX class\. |
| 29 |
. |
| 30 |
.TP |
| 31 |
\fBpagelayoutapi getwidth\fR |
| 32 |
Returns the width in pixels for the given image file\. |
| 33 |
. |
| 34 |
.TP |
| 35 |
\fBpagelayoutapi getheight\fR |
| 36 |
Returns the height in pixels for the given image file\. |
| 37 |
. |
| 38 |
.TP |
| 39 |
\fBpagelayoutapi optimize\fR |
| 40 |
Creates a cropped, rezised, sharpend and compressed image and stores it in the cache directory\. |
| 41 |
. |
| 42 |
.TP |
| 43 |
\fBpagelayoutapi makeshadow\fR |
| 44 |
Creates a shadow image and stores it in the cache directory\. |
| 45 |
. |
| 46 |
.TP |
| 47 |
\fBpagelayoutapi start\fR |
| 48 |
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 \fBpagelayoutapi batchoptimize\fR\. |
| 49 |
. |
| 50 |
.TP |
| 51 |
\fBpagelayoutapi batchoptimize\fR |
| 52 |
Optimizes multiple images in parallel\. |
| 53 |
. |
| 54 |
.SH "OPTIONS" |
| 55 |
. |
| 56 |
.TP |
| 57 |
\fB\-\-help\fR |
| 58 |
Prints a help message\. |
| 59 |
. |
| 60 |
.TP |
| 61 |
\fB\-\-version\fR |
| 62 |
Prints version information\. |
| 63 |
. |
| 64 |
.SH "PARAMETERS" |
| 65 |
. |
| 66 |
.TP |
| 67 |
FILE |
| 68 |
filename with extension (eg\. IMG1234\.JPEG) |
| 69 |
. |
| 70 |
.TP |
| 71 |
FILENAME |
| 72 |
filename without extension (eg\. IMG1234) |
| 73 |
. |
| 74 |
.TP |
| 75 |
EXTENSION |
| 76 |
optimized file extension (\.jpg|\.png) |
| 77 |
. |
| 78 |
.TP |
| 79 |
DENSITY |
| 80 |
density in ppi (eg\. 72) |
| 81 |
. |
| 82 |
.TP |
| 83 |
DOWNSAMPLETHRESHOLD |
| 84 |
downsample threshold (integer >= 100) |
| 85 |
. |
| 86 |
.TP |
| 87 |
UNSHARP |
| 88 |
unsharp filter (eg\. 2x1) |
| 89 |
. |
| 90 |
.TP |
| 91 |
QUALITY |
| 92 |
quality (integer > 0, <= 100) |
| 93 |
. |
| 94 |
.TP |
| 95 |
STANDARDDEVIATION |
| 96 |
standard deviation (decimal > 0\.0) |
| 97 |
. |
| 98 |
.TP |
| 99 |
OPACITY |
| 100 |
opacity (decimal >= 0\.0, <= 1\.0) |
| 101 |
. |
| 102 |
.TP |
| 103 |
COLOR |
| 104 |
color string (eg\. pink) |
| 105 |
. |
| 106 |
.TP |
| 107 |
GRAPHICSPATH |
| 108 |
list of directories (eg\. {images/}{tmp/}) |
| 109 |
. |
| 110 |
.TP |
| 111 |
JOBNAME |
| 112 |
LaTeX filename without extension (eg\. my\-document) |
| 113 |
. |
| 114 |
.TP |
| 115 |
BATCHLIST |
| 116 |
a flat list of batch items where each batch item is a flat list of the 15 parameters required by the command `pagelayoutapi optimize` |
| 117 |
. |
| 118 |
.P |
| 119 |
All other parameters are length dimensions\. The command \fBpagelayoutapi optimize\fR expects integer values in the LaTeX unit sp (eg\. 65536)\. The command \fBpagelayoutapi makeshadow\fR expects decimal values in a SVG compatible unit (eg\. 420\.0pt)\. |
| 120 |
. |
| 121 |
.SH "ENVIRONMENT" |
| 122 |
\fBpagelayoutapi\fR requires ImageMagick 7\.0 or later and Inkscape 1\.0 or later\. |
| 123 |
. |
| 124 |
.TP |
| 125 |
\fBPAGELAYOUT_IMPORT_DIRECTORY\fR |
| 126 |
Defines a system wide import directory\. |
| 127 |
. |
| 128 |
.SH "AUTHOR" |
| 129 |
\fBpagelayoutapi\fR was written by Friedemann Bartels\. \fIhttps://github\.com/friedemannbartels\fR |
| 130 |
. |
| 131 |
.SH "LICENSE" |
| 132 |
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\. |