.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "LATEX-GIT-LOG 1" .TH LATEX-GIT-LOG 1 2024-05-31 latex-git-log "Robin Schneider" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "نام (NAME)" latex-git-log \- ایجاد تاریخچه نگارش‌های یک پروژه گیت در قالب کد منبع LaTeX .SH "خلاصه دستور (SYNOPSIS)" .IX Header "Synopsis" .B latex\-git\-log [\fIگزینه‌ها\fR] [\fIفایل\fR] ... .PP گزینه‌ها: .PP .Vb 10 \& \-\-author درج نام نویسنده در خروجی \& \-\-width تعیین عرض فیلد پیام کامیت بر حسب سانتی‌متر در جدول LaTeX \& \-\-git\-c\-add تعیین نشانی اینترنتی پایه (Base URL) برای پیوند به کامیت \& \-\-user تعیین نام کاربری گیت‌هاب جهت استخراج URL پایه \& \-\-repo تعیین مخزن گیت‌هاب جهت استخراج URL پایه \& \-\-lang زبان راهنمای علائم و تمام رشته‌ها در خروجی \& \-\-version, \-v نمایش نسخه این اسکریپت \& \-\-help نمایش پیام راهنمای خلاصه \& \-\-man نمایش مستندات کامل \& \-\-range تعیین محدوده بازبینی‌های گیت .Ve .SH "گزینه‌ها (OPTIONS)" .IX Header "Options" .IP \fB\-\-width\fR 8 .IX Item "--width" تعیین عرض فیلد پیام کامیت بر حسب سانتی‌متر در جدول LaTeX. اگر این پارامتر تعیین نشود، جدول از نظر عمودی محدود نخواهد شد؛ به این معنی که اگر پیام کامیت بسیار طولانی باشد، احتمالاً جدول در صفحه جا نخواهد شد و خطای «Overfull» از سمت TeX دریافت خواهید کرد. .Sp در این حالت باید عرض ستون شامل پیام‌های کامیت را مشخص کنید. معمولاً برای کاغذ DIN A4 در حالت افقی (landscape) مقداری مانند \-\-width=14 استفاده می‌شود. .IP \fB\-\-git\-c\-add\fR 8 .IX Item "--git-c-add" تعیین نشانی اینترنتی پایه (Base URL) برای پیوند دادن به یک کامیت. این اسکریپت به صورت خودکار تلاش می‌کند تا از URL پایه گیت‌هاب استفاده کند. .IP \fB\-\-lang\fR 8 .IX Item "--lang" تعیین زبان راهنمای علائم و تمامی رشته‌ها در خروجی. به طور پیش‌فرض از زبان سیستم استفاده می‌شود، اما می‌توانید آن را با این پارامتر بازنویسی کنید. .Sp در حال حاضر این اسکریپت فقط از زبان‌های انگلیسی و آلمانی پشتیبانی می‌کند. اگر به ترجمه به زبان دیگری نیاز دارید، می‌توانید یک فایل ‎.po ایجاد کنید یا این پروژه در یکی از وب‌سایت‌های ترجمه آنلاین ثبت شود. .SH "مثال‌ها (EXAMPLES)" .IX Header "Example" می‌توانید به این صورت از آن استفاده کنید: .PP .Vb 1 \& latex\-git\-log \-\-width=6 \-\-lang=en > example\-output.tex .Ve .SH "وابستگی‌ها (DEPENDENCIES)" .IX Header "Dependencies" .SS "وابستگی‌های این اسکریپت (Of this script)" .IX Subsection "Of this script" این اسکریپت به ماژول‌های پرل (Perl) زیر نیاز دارد: .PP .Vb 2 \& IPC::System::Simple \& Locale::Maketext::Simple .Ve .PP سایر موارد باید از قبل نصب شده باشند. .SS "برای کامپایل خروجی (To compile the output)" .IX Subsection "To compile the output" جدول از بسته \fBlongtable\fR استفاده می‌کند و پیوندها به منابع وب برای هر کامیت از ماکروی \ehref از بسته \fBhyperref\fR استفاده می‌کنند. بنابراین این دو بسته باید بارگذاری شوند. .PP علاوه بر این، باید ماکروی \fB\elongtableendfoot\fR را تعریف کنید که در پایین هر صفحه (در صورتی که جدول در صفحه بعد ادامه داشته باشد) نمایش داده خواهد شد. می‌توانید آن را به عنوان یک پیام بومی‌سازی‌شده تعریف کنید تا به خواننده اطلاع دهد این جدول کامل نبوده و در صفحه بعد ادامه خواهد یافت. .SH "توضیحات (DESCRIPTION)" .IX Header "Description" در صورتی که \fBاین برنامه\fR درون یک مخزن گیت اجرا شود، کل تاریخچه نگارش‌ها را در قالب جدولی نوشته‌شده در LaTeX خروجی می‌دهد. هنگامی که آرگومان(های) \fIفایل\fR داده شوند، تنها تاریخچه‌ای که آن فایل(ها) را تغییر داده است خروجی داده خواهد شد. .PP هدف این است که خروجی استاندارد این اسکریپت را به یک فایل هدایت کنید تا سپس بتوانید آن را درون سند اصلی LaTeX خود فراخوانی کنید. .PP از آنجا که این جدول می‌تواند بسیار بزرگ باشد، ممکن است بخواهید آن را در صفحه‌ای با جهت افقی (landscape) قرار دهید. .SH "نسخه (VERSION)" .IX Header "Version" 1.1.0 .SH "نویسنده (AUTHOR)" .IX Header "Author" Robin Schneider .SH "توسعه (DEVELOPMENT)" .IX Header "Development" مخزن CTAN: https://ctan.org/pkg/latex\-git\-log .PP مخزن کد منبع: https://github.com/ypid/typesetting/tree/master/scripts/latex\-git\-log .PP لطفاً گزارش باگ‌ها و درخواست‌های قابلیت‌های جدید را در نشانی زیر ارسال فرمایید: https://github.com/ypid/typesetting/issues .SH "باگ‌ها و محدودیت‌ها (BUGS AND LIMITATIONS)" .IX Header "Bugs and limitations" .IP \(bu 4 به نظر می‌رسد قابلیت ترجمه به درستی کار نمی‌کند؛ بنابراین این اسکریپت قادر به تولید خروجی به زبان آلمانی نیست. زبان انگلیسی کار می‌کند. .SH "مجوز و حق نشر (LICENSE AND COPYRIGHT)" .IX Header "License and Copyright" حق نشر (C) 2012\-2013,2017,2019\-2020,2024 Robin Schneider .PP این برنامه یک نرم‌افزار آزاد است؛ می‌توانید آن را تحت شرایط مجوز عمومی همگانی گنو (GNU GPL) منتشر شده توسط بنیاد نرم‌افزارهای آزاد، چه نسخه ۳ مجوز یا (به انتخاب خودتان) هر نسخه بعدی دیگر، بازتوزیع کرده و/یا تغییر دهید. .PP این برنامه با این امید توزیع شده است که مفید واقع شود، اما بدون هیچ‌گونه ضمانتی؛ حتی بدون ضمانت ضمنی قابل فروش بودن یا مناسب بودن برای یک هدف خاص. برای جزئیات بیشتر به مجوز عمومی همگانی گنو مراجعه کنید. .PP شما باید به همراه این برنامه نسخه‌ای از مجوز عمومی همگانی گنو را دریافت کرده باشید؛ در غیر این صورت، نشانی را مشاهده کنید.