LATEX-GIT-LOG(1) Robin Schneider LATEX-GIT-LOG(1)

latex-git-log - ایجاد تاریخچه نگارش‌های یک پروژه گیت در قالب کد منبع LaTeX

latex-git-log [گزینه‌ها] [فایل] ...

گزینه‌ها:

--author          درج نام نویسنده در خروجی
--width           تعیین عرض فیلد پیام کامیت بر حسب سانتی‌متر در جدول LaTeX
--git-c-add       تعیین نشانی اینترنتی پایه (Base URL) برای پیوند به کامیت
--user            تعیین نام کاربری گیت‌هاب جهت استخراج URL پایه
--repo            تعیین مخزن گیت‌هاب جهت استخراج URL پایه
--lang            زبان راهنمای علائم و تمام رشته‌ها در خروجی
--version, -v     نمایش نسخه این اسکریپت
--help            نمایش پیام راهنمای خلاصه
--man             نمایش مستندات کامل
--range           تعیین محدوده بازبینی‌های گیت

تعیین عرض فیلد پیام کامیت بر حسب سانتی‌متر در جدول LaTeX. اگر این پارامتر تعیین نشود، جدول از نظر عمودی محدود نخواهد شد؛ به این معنی که اگر پیام کامیت بسیار طولانی باشد، احتمالاً جدول در صفحه جا نخواهد شد و خطای «Overfull» از سمت TeX دریافت خواهید کرد.

در این حالت باید عرض ستون شامل پیام‌های کامیت را مشخص کنید. معمولاً برای کاغذ DIN A4 در حالت افقی (landscape) مقداری مانند --width=14 استفاده می‌شود.

تعیین نشانی اینترنتی پایه (Base URL) برای پیوند دادن به یک کامیت. این اسکریپت به صورت خودکار تلاش می‌کند تا از URL پایه گیت‌هاب استفاده کند.
تعیین زبان راهنمای علائم و تمامی رشته‌ها در خروجی. به طور پیش‌فرض از زبان سیستم استفاده می‌شود، اما می‌توانید آن را با این پارامتر بازنویسی کنید.

در حال حاضر این اسکریپت فقط از زبان‌های انگلیسی و آلمانی پشتیبانی می‌کند. اگر به ترجمه به زبان دیگری نیاز دارید، می‌توانید یک فایل ‎.po ایجاد کنید یا این پروژه در یکی از وب‌سایت‌های ترجمه آنلاین ثبت شود.

می‌توانید به این صورت از آن استفاده کنید:

latex-git-log --width=6 --lang=en > example-output.tex

این اسکریپت به ماژول‌های پرل (Perl) زیر نیاز دارد:

IPC::System::Simple
Locale::Maketext::Simple

سایر موارد باید از قبل نصب شده باشند.

جدول از بسته longtable استفاده می‌کند و پیوندها به منابع وب برای هر کامیت از ماکروی \href از بسته hyperref استفاده می‌کنند. بنابراین این دو بسته باید بارگذاری شوند.

علاوه بر این، باید ماکروی \longtableendfoot را تعریف کنید که در پایین هر صفحه (در صورتی که جدول در صفحه بعد ادامه داشته باشد) نمایش داده خواهد شد. می‌توانید آن را به عنوان یک پیام بومی‌سازی‌شده تعریف کنید تا به خواننده اطلاع دهد این جدول کامل نبوده و در صفحه بعد ادامه خواهد یافت.

در صورتی که این برنامه درون یک مخزن گیت اجرا شود، کل تاریخچه نگارش‌ها را در قالب جدولی نوشته‌شده در LaTeX خروجی می‌دهد. هنگامی که آرگومان(های) فایل داده شوند، تنها تاریخچه‌ای که آن فایل(ها) را تغییر داده است خروجی داده خواهد شد.

هدف این است که خروجی استاندارد این اسکریپت را به یک فایل هدایت کنید تا سپس بتوانید آن را درون سند اصلی LaTeX خود فراخوانی کنید.

از آنجا که این جدول می‌تواند بسیار بزرگ باشد، ممکن است بخواهید آن را در صفحه‌ای با جهت افقی (landscape) قرار دهید.

1.1.0

Robin Schneider <ypid@riseup.net>

مخزن CTAN: https://ctan.org/pkg/latex-git-log

مخزن کد منبع: https://github.com/ypid/typesetting/tree/master/scripts/latex-git-log

لطفاً گزارش باگ‌ها و درخواست‌های قابلیت‌های جدید را در نشانی زیر ارسال فرمایید: https://github.com/ypid/typesetting/issues

•
به نظر می‌رسد قابلیت ترجمه به درستی کار نمی‌کند؛ بنابراین این اسکریپت قادر به تولید خروجی به زبان آلمانی نیست. زبان انگلیسی کار می‌کند.

حق نشر (C) 2012-2013,2017,2019-2020,2024 Robin Schneider <ypid@riseup.net>

این برنامه یک نرم‌افزار آزاد است؛ می‌توانید آن را تحت شرایط مجوز عمومی همگانی گنو (GNU GPL) منتشر شده توسط بنیاد نرم‌افزارهای آزاد، چه نسخه ۳ مجوز یا (به انتخاب خودتان) هر نسخه بعدی دیگر، بازتوزیع کرده و/یا تغییر دهید.

این برنامه با این امید توزیع شده است که مفید واقع شود، اما بدون هیچ‌گونه ضمانتی؛ حتی بدون ضمانت ضمنی قابل فروش بودن یا مناسب بودن برای یک هدف خاص. برای جزئیات بیشتر به مجوز عمومی همگانی گنو مراجعه کنید.

شما باید به همراه این برنامه نسخه‌ای از مجوز عمومی همگانی گنو را دریافت کرده باشید؛ در غیر این صورت، نشانی http://www.gnu.org/licenses را مشاهده کنید.

2024-05-31 latex-git-log