نام (NAME)

pagelayoutapi - رابط برنامه‌نویسی (API) برای کلاس pagelayout در LaTeX

خلاصه دستور (SYNOPSIS)

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

توضیحات (DESCRIPTION)

این اسکریپت یک رابط برنامه‌نویسی (API) برای کلاس pagelayout در LaTeX فراهم می‌کند.

pagelayoutapi getwidth: عرض فایل تصویری داده‌شده را بر حسب پیکسل برمی‌گرداند.
pagelayoutapi getheight: ارتفاع فایل تصویری داده‌شده را بر حسب پیکسل برمی‌گرداند.
pagelayoutapi optimize: یک تصویر برش‌خورده، تغییراندازه‌یافته، واضح‌شده (sharpened) و فشرده‌شده ایجاد کرده و آن را در دایرکتوری حافظه موقت (cache) ذخیره می‌کند.
pagelayoutapi makeshadow: یک تصویر سایه‌دار ایجاد کرده و آن را در دایرکتوری حافظه موقت (cache) ذخیره می‌کند.
pagelayoutapi start: پارامتر import روند وارد کردن تصویر را آغاز می‌کند (فصل «Image Optimization» در pagelayout-manual.pdf را ببینید). اجرای دستور با پارامتر turbo، در شرایطی که jobname نام فایل سند باشد، سند را در یک حالت دسته‌ای (batch) ویژه پردازش می‌کند که یک فهرست دسته‌ای ساخته و دستور pagelayoutapi batchoptimize را فراخوانی می‌نماید.
pagelayoutapi batchoptimize: چندین تصویر را به‌صورت موازی بهینه‌سازی می‌کند.

گزینه‌ها (OPTIONS)

--help: یک پیام راهنما را چاپ می‌کند.
--version: اطلاعات نسخه را چاپ می‌کند.

پارامترها (PARAMETERS)

FILE: نام فایل همراه با پسوند (به عنوان مثال IMG1234.JPEG)
FILENAME: نام فایل بدون پسوند (به عنوان مثال IMG1234)
EXTENSION: پسوند فایل بهینه‌شده (.jpg|.png)
DENSITY: تراکم بر حسب ppi (به عنوان مثال 72)
DOWNSAMPLETHRESHOLD: آستانه کاهش نمونه‌برداری (downsample) (عدد صحیح >= 100)
UNSHARP: فیلتر وضوح‌بخشی unsharp (به عنوان مثال 2x1)
QUALITY: کیفیت (عدد صحیح > 0، <= 100)
STANDARDDEVIATION: انحراف معیار (عدد اعشاری > 0.0)
OPACITY: میزان کدری (عدد اعشاری >= 0.0، <= 1.0)
COLOR: رشته رنگ (به عنوان مثال pink)
GRAPHICSPATH: فهرستی از دایرکتوری‌ها (به عنوان مثال {images/}{tmp/})
JOBNAME: نام فایل LaTeX بدون پسوند (به عنوان مثال my-document)
BATCHLIST: یک فهرست ساده از موارد دسته‌ای که در آن هر مورد، فهرستی ساده از ۱۵ پارامتر مورد نیاز دستور `pagelayoutapi optimize` است

تمامی پارامترهای دیگر ابعاد طولی هستند. دستور pagelayoutapi optimize مقادیر عدد صحیح را در واحد LaTeX به نام sp (به عنوان مثال 65536) انتظار دارد. دستور pagelayoutapi makeshadow مقادیر اعشاری را در یک واحد سازگار با SVG (به عنوان مثال 420.0pt) انتظار دارد.

محیط (ENVIRONMENT)

ابزار pagelayoutapi نیازمند ImageMagick نسخه 7.0 یا بالاتر و Inkscape نسخه 1.0 یا بالاتر است.

PAGELAYOUT_IMPORT_DIRECTORY: یک دایرکتوری سراسری برای وارد کردن فایل‌ها در سطح سیستم تعریف می‌کند.

نویسندگان (AUTHORS)

ابزار pagelayoutapi توسط Friedemann Bartels نوشته شده است. https://github.com/friedemannbartels

کپی‌رایت و تکثیر (COPYRIGHT)