.\" -*- coding: us-ascii -*- .if \n(.g .ds T< \\FC .if \n(.g .ds T> \\F[\n[.fam]] .de URL \\$2 \(la\\$1\(ra\\$3 .. .if \n(.g .mso www.tmac .TH docbook2texi 1 "3 March 2007" "docbook2X 0.8.8" docbook2X .SH "نام (NAME)" docbook2texi \- تبدیل سندهای DocBook به Texinfo .SH "خلاصه دستور (SYNOPSIS)" 'nh .fi .ad l \fBdocbook2texi\fR \kx .if (\nx>(\n(.l/2)) .nr x (\n(.l/5) 'in \n(.iu+\nxu [\fIگزینه‌ها\fR] \fIxml-document\fR 'in \n(.iu-\nxu .ad b 'hy .SH "توضیحات (DESCRIPTION)" دستور \fBdocbook2texi\fR سند DocBook XML داده‌شده را به یک یا چند سند Texinfo تبدیل می‌کند. به‌طور پیش‌فرض، این سندهای Texinfo در دایرکتوری جاری خروجی داده می‌شوند. .PP دستور \fBdocbook2texi\fR یک اسکریپت پوششی برای یک فرآیند تبدیل دو مرحله‌ای است. برای جزئیات بیشتر به بخش \(lqفرآیند تبدیل\(rq در ادامه مراجعه کنید. .SH "گزینه‌ها (OPTIONS)" گزینه‌های در دسترس اساساً اجتماع گزینه‌های دستورات \fBdb2x_xsltproc\fR(1) و \fBdb2x_texixml\fR(1) هستند. .PP برخی از گزینه‌های پرکاربرد در زیر آمده است: .TP \*(T<\fB\-\-encoding=\fR\*(T>\fIکدگذاری\fR کدگذاری نویسه‌های خروجی را تنظیم می‌کند. .TP \*(T<\fB\-\-string\-param \fR\*(T>\fIپارامتر\fR\*(T<\fB=\fR\*(T>\fIمقدار\fR یک پارامتر برگه استایل را تنظیم می‌کند (گزینه‌هایی که بر نحوه نمایش خروجی اثر می‌گذارند). برای پارامترهایی که می‌توانند تنظیم شوند، به بخش \(lqپارامترهای برگه استایل\(rq در ادامه مراجعه کنید. .TP \*(T<\fB\-\-sgml\fR\*(T> به‌جای XML، یک سند منبع SGML را به عنوان ورودی می‌پذیرد. .SS "پارامترهای برگه استایل (STYLESHEET PARAMETERS)" .TP \*(T \fBخلاصه\fR. آیا از نشانه‌گذاری عنوان برای عنوان‌های فرعی (captions) استفاده شود؟ \fBتنظیم پیش‌فرض\fR. \*(T<0\*(T> (بولی نادرست / false) اگر درست (true) باشد، محتوای \*(T در برخی اشیاء (رسمی) با دستورات \*(T<@\fIheading\fR\*(T> در Texinfo رندر می‌شود. اگر نادرست (false) باشد، عنوان‌ها به صورت یک پاراگراف تأکیدشده رندر می‌شوند. .TP \*(T \fBخلاصه\fR. ترجمه \*(T با استفاده از \*(T<@pxref\*(T> \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> (بولی درست / true) اگر درست باشد، \*(T با ابرمتن و به دنبال آن ارجاع متقابل در پرانتز ترجمه می‌شود. در غیر این صورت، محتوای ابرمتن به عنوان نام ارجاع متقابل که با \*(T<@ref\*(T> نشانه‌گذاری شده عمل می‌کند. معمولاً info این ساختار را به شکل نامناسبی نمایش می‌دهد. .TP \*(T \fBخلاصه\fR. تأکید بر نام‌های گره Texinfo ساخته‌شده به صورت دستی \fBتنظیم پیش‌فرض\fR. \*(T<0\*(T> (بولی نادرست / false) عناصر موجود در سند منبع می‌توانند با مشخص کردن یک \*(T، یا برای عناصر بخش‌بندی، یک \*(T با \*(T در نگهدارنده \*(T<\fI*\fRinfo\*(T>، بر تولید نام گره Texinfo اثر بگذارند. با این حال، برای اکثر سندهای منبع، نام‌های صریح گره Texinfo در دسترس نیستند و برگه استایل سعی می‌کند نامی معقول تولید کند، مثلاً از عنوان معمولی یک عنصر. نام تولیدشده ممکن است بهینه نباشد. اگر این گزینه تنظیم شده باشد و برگه استایل نیاز به تولید نام داشته باشد، یک هشدار صادر می‌شود و همیشه از \*(T<\fBgenerate\-id\fR\*(T> برای نام استفاده می‌گردد. هنگامی که افزونه جدول هش در دسترس نباشد، برگه استایل نمی‌تواند تداخل نام گره‌ها را بررسی کند، و در این حالت، تنظیم این گزینه و استفاده از نام‌های صریح گره توصیه می‌شود. این گزینه به‌طور پیش‌فرض تنظیم نشده است (یعنی نادرست / false است). .RS \fBنکته\fR راه‌حل جایگزین نهایی برای تولید نام گره‌ها استفاده از تابع XSLT به نام \*(T<\fBgenerate\-id\fR\*(T> است، و برگه استایل در این حالت صرف‌نظر از تنظیم بودن یا نبودن \*(T همیشه یک هشدار صادر می‌کند. .RE .TP \*(T \fBخلاصه\fR. آیا عناصر \*(T نمایش داده شوند؟ \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> (بولی درست / true) اگر درست باشد، کامنت‌ها نمایش داده خواهند شد، در غیر این صورت پنهان می‌شوند. کامنت‌ها در اینجا به عنصر \*(T اشاره دارد که در DocBook V4.0 به \*(T تغییر نام داده است، نه کامنت‌های XML (<-- مانند این -->) که در دسترس نیستند. .TP \*(T \fBخلاصه\fR. آیا عناصر یک FuncSynopsis تزیین شوند؟ \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> (بولی درست / true) اگر درست باشد، عناصر FuncSynopsis تزیین خواهند شد (مثلاً پررنگ یا مورب). تزیین توسط توابعی کنترل می‌شود که می‌توانند در یک لایه سفارشی‌سازی بازتعریف شوند. .TP \*(T \fBخلاصه\fR. تولید پرانتز بعد از یک تابع؟ \fBتنظیم پیش‌فرض\fR. \*(T<0\*(T> (بولی نادرست / false) اگر درست باشد، قالب‌بندی عنصر \*(T<\*(T> شامل پرانتزهای تولیدشده خواهد بود. .TP \*(T \fBخلاصه\fR. آیا سربرگ NAME قبل از 'RefName'ها خروجی داده شود؟ \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> (بولی درست / true) اگر درست باشد، یک عنوان بخش "NAME" قبل از فهرست 'RefName'ها خروجی داده می‌شود. .TP \*(T \fBخلاصه\fR. آیا \*(T به عنوان بخشی از ارجاع متقابل \*(T خروجی داده شود؟ \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> (بولی درست / true) اگر درست باشد، هنگام ارجاع متقابل به \*(Tها، چه با \*(T و چه با \*(T، از \*(T استفاده می‌شود. .TP \*(T \fBخلاصه\fR. آیا \*(T به \*(T ترجیح داده شود؟ \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> (بولی درست / true) اگر درست باشد، \*(T در یک \*(T به هر \*(T ترجیح داده می‌شود. (البته برای قالب‌های خروجی غیر از Texinfo، معمولاً ترجیح می‌دهید از \*(T استفاده کنید، اما Info یک قالب فقط‌متنی است.) علاوه بر مقادیر true و false، این پارامتر می‌تواند روی \*(T<2\*(T> نیز تنظیم شود تا مشخص کند که هم متن و هم تصاویر باید خروجی داده شوند. ممکن است بخواهید این کار را انجام دهید زیرا برخی از نمایش‌دهنده‌های Texinfo می‌توانند تصاویر را بخوانند. توجه داشته باشید که دستور \*(T<@image\*(T> در Texinfo سازوکار مخصوص به خود را برای جابه‌جایی بین خروجی متن و تصویر دارد \(em اما ما در اینجا از آن استفاده نمی‌کنیم. پیش‌فرض true (درست) است. .TP \*(T \fBخلاصه\fR. آیا از نشانه‌گذاری درون‌خطی معنایی Texinfo استفاده شود؟ \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> (بولی درست / true) اگر درست باشد، نشانه‌گذاری درون‌خطی معنایی DocBook به (نزدیک‌ترین) معادل Texinfo ترجمه می‌شود. این حالت پیش‌فرض است. با این حال، از آنجا که قالب Info محدود به متن ساده است، نشانه‌گذاری درون‌خطی معنایی اغلب با استفاده از نقل‌قول‌های صریح متمایز می‌شود که ممکن است ظاهر خوبی نداشته باشد. می‌توانید این گزینه را روی false تنظیم کنید تا از این موارد جلوگیری شود. (برای کنترل دقیق‌تر بر قالب‌بندی درون‌خطی، می‌توانید از برگه استایل اختصاصی خود استفاده کنید.) .TP \*(T \fBخلاصه\fR. شناسه URI سند XML حاوی داده‌های بومی‌سازی سفارشی \fBتنظیم پیش‌فرض\fR. (خالی) این پارامتر URI یک سند XML را مشخص می‌کند که ترجمه‌های متنی (و سایر اطلاعات وابسته به محلی‌سازی) مورد نیاز برگه استایل برای پردازش سند DocBook را توصیف می‌کند. ترجمه‌های متنی که توسط این پارامتر مشخص می‌شوند همیشه بر ترجمه‌های متنی پیش‌فرض (از پارامتر داخلی \*(T) اولویت دارند. اگر ترجمه خاصی در اینجا وجود نداشته باشد، از ترجمه پیش‌فرض متناظر به عنوان جایگزین استفاده می‌شود. این پارامتر عمدتاً برای تغییر نویسه‌های نگارشی خاصی است که در قالب‌بندی سند منبع استفاده می‌شوند. تنظیمات نویسه‌های نگارشی اغلب مختص سند منبع هستند، اما می‌توانند به محلی‌سازی (locale) نیز وابسته باشند. برای عدم استفاده از ترجمه‌های متنی سفارشی، این پارامتر را به عنوان رشته خالی رها کنید. .TP \*(T \fBخلاصه\fR. سند XML حاوی داده‌های بومی‌سازی سفارشی \fBتنظیم پیش‌فرض\fR. \*(T این پارامتر سند XML را مشخص می‌کند که ترجمه‌های متنی (و سایر اطلاعات وابسته به محلی‌سازی) مورد نیاز برگه استایل برای پردازش سند DocBook را توصیف می‌کند. این پارامتر برای برگه استایل داخلی است. برای اشاره به یک سند XML خارجی با یک URI یا نام فایل، باید به‌جای آن از پارامتر \*(T استفاده کنید. با این حال، درون یک برگه استایل سفارشی (\fIنه در خط فرمان\fR) این پارامتر می‌تواند روی عبارت XPath به صورت \*(T تنظیم شود، که باعث می‌شود ترجمه‌های سفارشی که مستقیماً درون برگه استایل سفارشی تعبیه شده‌اند خوانده شوند. .TP \*(T \fBخلاصه\fR. آیا \*(T در \*(T نام میانی است؟ \fBتنظیم پیش‌فرض\fR. \*(T<1\*(T> اگر درست باشد، \*(T یک \*(T بین \*(T و \*(T ظاهر می‌شود. در غیر این صورت، \*(T نادیده گرفته می‌شود. .TP \*(T \fBخلاصه\fR. نام فایل Info \fBتنظیم پیش‌فرض\fR. (خالی) این پارامتر نام فایل نهایی Info را مشخص می‌کند و تنظیمات موجود در خود سند و انتخاب خودکار در برگه استایل را بازنویسی می‌کند. اگر سند یک \*(T باشد، این پارامتر تأثیری ندارد. .RS \fBمهم\fR پسوند \*(T<.info\*(T> را در نام \fIوارد نکنید\fR. .RE (توجه داشته باشید که این پارامتر هیچ ارتباطی با نام \fIخروجی Texi-XML\fR توسط پردازنده XSLT که این برگه استایل را از آن اجرا می‌کنید ندارد.) .TP \*(T \fBخلاصه\fR. دسته‌بندی سند در دایرکتوری Info \fBتنظیم پیش‌فرض\fR. (خالی) این پارامتر روی دسته‌ای تنظیم می‌شود که سند باید در دایرکتوری Info فایل‌های نصب‌شده ذیل آن قرار گیرد. برای مثال، \*(T. .RS \fBنکته\fR دسته‌ها ممکن است مستقیماً در سند منبع نیز تنظیم شوند. اما اگر این پارامتر خالی نباشد، همیشه تنظیمات موجود در سند منبع را بازنویسی می‌کند. .RE .TP \*(T \fBخلاصه\fR. توضیحات سند در دایرکتوری Info \fBتنظیم پیش‌فرض\fR. (خالی) این یک توضیح کوتاه از سند است که در دایرکتوری Info فایل‌های نصب‌شده نمایش داده می‌شود. برای مثال، \*(T. .RS \fBنکته\fR توضیحات منو ممکن است مستقیماً در سند منبع نیز تنظیم شوند. اما اگر این پارامتر خالی نباشد، همیشه تنظیمات موجود در سند منبع را بازنویسی می‌کند. .RE .TP \*(T \fBخلاصه\fR. نمایه Texinfo مورد استفاده \fBتنظیم پیش‌فرض\fR. \*(T نمایه Texinfo برای \*(T و \*(T با استفاده از ویژگی \*(T مشخص می‌شود. اگر عناصر فوق ویژگی \*(T نداشته باشند، از مقدار پیش‌فرض مشخص‌شده توسط این پارامتر استفاده می‌شود. نمایه‌های از پیش تعریف‌شده عبارتند از: .RS .TP \*(T, \*(T نمایه مفاهیم (Concept index) .TP \*(T, \*(T نمایه توابع (Function index) .TP \*(T, \*(T نمایه متغیرها (Variable index) .TP \*(T, \*(T نمایه کلیدها (Keystroke index) .TP \*(T, \*(T نمایه برنامه‌ها (Program index) .TP \*(T, \*(T نمایه انواع داده (Data type index) .RE نمایه‌های تعریف‌شده توسط کاربر هنوز پشتیبانی نمی‌شوند. .TP \*(T \fBخلاصه\fR. برچسب پیش‌فرض defaultlabel را روی QandASet تنظیم می‌کند. \fBتنظیم پیش‌فرض\fR. \*(T<\*(T> اگر هیچ ویژگی defaultlabel روی یک QandASet مشخص نشده باشد، از این مقدار استفاده می‌شود. این مقدار باید یکی از مقادیر مجاز برای ویژگی defaultlabel باشد. .TP \*(T \fBخلاصه\fR. آیا جدول محتوا (فهرست) برای QandASetها ایجاد شود؟ \fBتنظیم پیش‌فرض\fR. \*(T<\*(T> اگر درست باشد، یک فهرست مطالب برای QandASetها ساخته می‌شود. .SH "مثال‌ها (EXAMPLES)" .nf \*(T<\fB$ \fRdocbook2texi tdg.xml \fB$ \fRdocbook2texi \-\-encoding=utf\-8//TRANSLIT tdg.xml \fB$ \fRdocbook2texi \-\-string\-param semantic\-decorations=0 tdg.xml \*(T>.fi .SH "فرآیند تبدیل (CONVERSION PROCESS)" .SS "تبدیل به Texinfo" سندهای DocBook در دو مرحله به Texinfo تبدیل می‌شوند: .TP 0.4i 1. منبع DocBook توسط یک برگه استایل XSLT به یک قالب XML میانی به نام Texi-XML تبدیل می‌شود. فرمت Texi-XML ساده‌تر از DocBook و نزدیک‌تر به قالب Texinfo است؛ هدف آن آسان‌تر کردن کار برگه‌های استایل است. برگه استایل برای این منظور در مسیر \*(T<\fIxslt/texi/docbook.xsl\fR\*(T> قرار دارد. برای سازگاری و انتقال‌پذیری، همیشه باید با URI زیر به آن ارجاع داده شود: .nf http://docbook2x.sourceforge.net/latest/xslt/texi/docbook.xsl .fi این برگه استایل را با \fBdb2x_xsltproc\fR(1) اجرا کنید. \fBسفارشی‌سازی\fR. همچنین می‌توانید با ایجاد برگه استایل XSLT اختصاصی خود \(em تغییر پارامترها یا افزودن الگوهای جدید \(em و وارد کردن مسیر \*(T<\fIxslt/texi/docbook.xsl\fR\*(T>، خروجی را سفارشی‌سازی کنید. .TP 0.4i 2. فرمت Texi-XML توسط دستور \fBdb2x_texixml\fR(1) به فایل‌های واقعی Texinfo تبدیل می‌شود. .PP دستور \fBdocbook2texi\fR هر دو مرحله را به‌طور خودکار انجام می‌دهد، اما در صورت بروز هرگونه مشکل، می‌توانید با انجام جداگانه هر مرحله، خطاها را با وضوح بیشتری مشاهده کنید: .nf \*(T<\fB$ \fRdb2x_xsltproc \-s texi \fImydoc\fR.xml \-o \fImydoc\fR.txml \fB$ \fRdb2x_texixml \fImydoc\fR.txml \*(T>.fi .PP گزینه‌های مربوط به برگه استایل تبدیل در مستندات مرجع برگه‌های استایل Texinfo شرح داده شده است. .SS "تبدیل مجموعه نویسه‌ها (Character set conversion)" هنگام ترجمه XML به قالب‌های قدیمی مبتنی بر ASCII با پشتیبانی ضعیف از یونیکد، مانند صفحات راهنما (man) و Texinfo، همیشه این مشکل وجود دارد که نویسه‌های یونیکد در سند منبع نیز باید به نحوی ترجمه شوند. .PP یک تبدیل مستقیم مجموعه نویسه‌ها از یونیکد کافی نیست، زیرا مجموعه نویسه مقصد، که معمولاً US-ASCII یا ISO Latin-1 است، شامل نویسه‌های متداول مانند خط تیره و علامت‌های نقل‌قول جهت‌دار که به طور گسترده در اسناد XML استفاده می‌شوند، نیست. اما قالب‌بندهای اسناد (man و Texinfo) اجازه می‌دهند چنین نویسه‌هایی با یک عبارت گریز نشانه‌گذاری وارد شوند: برای مثال، \*(T<\e(lq\*(T> برای علامت نقل‌قول جهت‌دار چپ \*(T<\(lq\*(T>. و اگر یک گریز در سطح نشانه‌گذاری در دسترس نباشد، ممکن است از یک نویسه‌گردانی به ASCII استفاده شود: برای مثال، استفاده از علامت کوچک‌تر در ASCII یعنی \*(T<<\*(T> برای علامت نقل‌قول زاویه‌دار \*(T<\(la\*(T>. .PP بنابراین مشکل نویسه‌های یونیکد را می‌توان در دو مرحله حل کرد: .TP 0.4i 1. برنامه \fButf8trans\fR(1)، برنامه‌ای موجود در بسته docbook2X، نویسه‌های یونیکد را به نویسه‌گردانی‌ها یا عبارات گریز در سطح نشانه‌گذاری نگاشت می‌کند. از آنجا که لزوماً یک نگاشت ثابت و رسمی برای نویسه‌های یونیکد وجود ندارد، \fButf8trans\fR می‌تواند نگاشت‌های نویسه قابل‌تغییر توسط کاربر را که در فایل‌های متنی بیان شده‌اند بخواند و اعمال کند. (برخلاف اکثر تبدیل‌کننده‌های مجموعه نویسه.) در مسیرهای \*(T<\fIcharmaps/man/roff.charmap\fR\*(T> و \*(T<\fIcharmaps/man/texi.charmap\fR\*(T> نگاشت‌های نویسه‌ای وجود دارند که می‌توانند برای تبدیل صفحات راهنما و Texinfo استفاده شوند. برنامه‌های \fBdb2x_manxml\fR(1) و \fBdb2x_texixml\fR(1) این نگاشت‌های نویسه، یا نگاشت نویسه دیگری که توسط کاربر مشخص شده را به‌طور خودکار اعمال می‌کنند. .TP 0.4i 2. بقیه متن یونیکد به یک مجموعه نویسه دیگر (کدگذاری) تبدیل می‌شود. برای مثال، یک سند فرانسوی با نویسه‌های دارای اعراب (مانند \*(T<\('e\*(T>) ممکن است به ISO Latin 1 تبدیل شود. این مرحله پس از نگاشت نویسه توسط \fButf8trans\fR، با استفاده از ابزار تبدیل کدگذاری \fBiconv\fR(1) اعمال می‌شود. هر دو دستور \fBdb2x_manxml\fR(1) و \fBdb2x_texixml\fR(1) می‌توانند هنگام تولید خروجی خود، \fBiconv\fR(1) را به‌طور خودکار فراخوانی کنند. .SH "فایل‌ها (FILES)" \*(T<\fI/usr/local/share/docbook2X/xslt/texi/docbook.xsl\fR\*(T> .br \*(T<\fI/usr/local/share/docbook2X/xslt/backend/db2x_texixml.xsl\fR\*(T> .br \*(T<\fI/usr/local/share/docbook2X/xslt/catalog.xml\fR\*(T> .br \*(T<\fI/usr/local/share/docbook2X/charmaps/texi.charmap.xml\fR\*(T> .br \*(T<\fI/usr/local/share/docbook2X/charmaps/texi.charmap.xml\fR\*(T> .PP فایل‌های فوق توسط بسته docbook2X توزیع و نصب می‌شوند. .SH "نکات (NOTES)" دستورات \fBdocbook2man\fR یا \fBdocbook2texi\fR شرح داده شده در این صفحه راهنما، از بسته docbook2X ارائه شده‌اند. نباید آن را با دستوری به همین نام از بسته منسوخ‌شده docbook-utils اشتباه گرفت. .SH "محدودیت‌ها (LIMITATIONS)" .TP 0.2i \(bu درون برنامه، یک خط لوله طولانی از برنامه‌ها وجود دارد که سند شما از آن عبور می‌کند. اگر هر بخش از این خط لوله با شکست مواجه شود (حتی به دلایل جزئی، مانند اشتباه تایپی در گزینه‌های برنامه)، خطاهای حاصل ممکن است به سختی قابل رمزگشایی باشند \(em در این حالت، سعی کنید اجزای docbook2X را به صورت جداگانه اجرا کنید. .SH "نویسنده (AUTHOR)" Steve Cheng <\*(T>. .SH "همچنین ببینید (SEE ALSO)" \fBdb2x_xsltproc\fR(1), \fBdb2x_texixml\fR(1), \fButf8trans\fR(1) .PP راهنمای docbook2X (در قالب Texinfo یا HTML) به طور کامل نحوه تبدیل DocBook به صفحات راهنما و Texinfo را شرح می‌دهد. .PP اطلاعات به‌روز درباره این برنامه را می‌توان در .URL http://docbook2x.sourceforge.net "وب‌سایت docbook2X" یافت.