.de d \" begin display
.sp
.in +4
.nf
..
.de e \" end display
.in -4
.fi
.sp
..
.TH "HXREF" "1" "10 Jul 2011" "7.x" "HTML-XML-utils"
.SH "نام (NAME)"
hxref \- تولید ارجاعات متقابل درون و بین فایل‌های HTML
.SH "خلاصه دستور (SYNOPSIS)"
.B hxref
.RB "[\| " \-x " \|]"
.RB "[\| " \-l " \|]"
.RB "[\| " \-b
.IR base " \|]"
.RB "[\| " \-i
.IR index " \|]"
.RI "[\| -- \|] [\| " input " [\| " output " \|] \|]"
.SH "توضیحات (DESCRIPTION)"
.LP
دستور
.B hxref
عناصر درون‌خطی (inline) را به عناصر DFN با محتوای یکسان پیوند می‌دهد.
این دستور در صورت نیاز، ویژگی‌های ID را اضافه می‌کند. چنانچه محتوای یک DFN یا
عنصر دیگر مناسب نباشد، می‌توان از ویژگی TITLE برای
ارائه اصطلاح مورد استفاده در مقایسه‌ها بهره برد.
.LP
در اینجا یک مثال آورده شده است:
.d
<p>A <dfn>b-box</dfn> is defined to be...
<p>For every b there is a <em>b-box</em>...
.e
خروجی
.B hxref
مشابه زیر خواهد بود:
.d
<p>A <dfn id="b-box">b-box</dfn> is defined to be...
<p>For every b there is a <a href="#b-box"><em>b-box</em></a>...
.e
.SH "گزینه‌ها (OPTIONS)"
گزینه‌های زیر پشتیبانی می‌شوند:
.TP 10
.B \-x
استفاده از قواعد XML: عناصر خالی با یک اسلش در انتها نوشته می‌شوند: <IMG\ />
.TP
.BI \-b " base"
پیشوند URLهای تولیدشده را تعیین می‌کند. به‌طور پیش‌فرض
.I base
خالی است که منجر به تولید URLهایی مانند "#b-box" در بالا می‌شود. اگر
.I base
برای مثال روی "http://xyz" تنظیم شود، URLها شبیه به "http://xyz/#b-box" خواهند بود.
.TP
.BI \-i " index"
به
.B hxref
دستور می‌دهد پیش از جستجوی اصطلاحات در سند، آن‌ها را از یک فایل پایگاه‌داده بخواند و پس از آن
اصطلاحات یافت‌شده را در همان فایل ذخیره کند. عناصر DFN در سند بر اصطلاحات یافت‌شده در
.IR index
اولویت دارند. این قابلیت به
.B hxref
اجازه می‌دهد تا چندین بار روی فایل‌های مختلف اجرا شود تا فایل‌ها به یکدیگر ارجاع دهند.
ممکن است برای برطرف کردن تمام ارجاعات متقابل، اجرای دوباره دستورها لازم باشد.
.TP
.B \-l
تلاش برای استفاده از اطلاعات وابسته به زبان برای تطبیق نمونه‌ها با تعاریف آن‌ها. در حال حاضر تنها از زبان انگلیسی پشتیبانی می‌شود و تنها قواعد اعمال‌شده عبارتند از جستجو بدون "s" پایانی (تطبیق "trees" با "tree")، بدون "es" پایانی (تطبیق "bosses" با "boss") و جایگزینی "ies" پایانی با "y" (تطبیق "bounties" با "bounty").
.B hxref
زبان را از ویژگی‌های "lang" و "xml:lang" درون سند تشخیص می‌دهد.
.SH "عملوندها (OPERANDS)"
عملوندهای زیر پشتیبانی می‌شوند:
.TP 10
.I input
نام یک فایل HTML. در صورت عدم ارائه، ورودی استاندارد خوانده می‌شود.
نام ویژه "-" نیز نشان‌دهنده ورودی استاندارد است.
.I input
می‌تواند یک URL باشد.
.TP
.I output
فایلی که خروجی در آن نوشته می‌شود. در صورت عدم ارائه، از خروجی استاندارد استفاده می‌شود. این عملوند
.I نباید
یک URL باشد.
.SH "عیب‌یابی (DIAGNOSTICS)"
مقدارهای خروج زیر بازگردانده می‌شوند:
.TP 10
.B 0
اتمام موفقیت‌آمیز.
.TP
.B > 0
خطایی در تجزیه فایل HTML رخ داده است.
.B hxref
تلاش خواهد کرد تا خطا را تصحیح کرده و در هر صورت خروجی را تولید کند.
.SH "همچنین ببینید (SEE ALSO)"
.BR asc2xml (1),
.BR hxindex (1),
.BR hxnormalize (1),
.BR hxnum (1),
.BR hxtoc (1),
.BR xml2asc (1)
.SH "اشکالات (BUGS)"
.LP
بازیابی خطا برای HTML نامعتبر بسیار ابتدایی است.
.LP
برنامه ویژگی‌های ID را تولید می‌کند، اما تگ‌های <a name=...> را تولید نمی‌کند؛ بنابراین پیوندها تنها در مرورگرهایی کار می‌کنند که ویژگی‌های ID را به رسمیت می‌شناسند.
.LP
قواعد تطبیق جمع در انگلیسی ابتدایی هستند. هیچ واژه‌نامه‌ای استفاده نمی‌شود؛ مثلاً "bees" به عنوان حالت جمع "be" در نظر گرفته خواهد شد.
.LP
در حال حاضر راهی برای تعیین زبان پیش‌فرض سند در مواردی که عنصر ریشه ویژگی "lang" یا "xml:lang" ندارد وجود ندارد.
.LP
.B hxref
ابتدا تلاش می‌کند تا با تشکیل ID از حروف و ارقام یافت‌شده در محتوای عنصر، ویژگی‌های ID «خوانا» تولید کند و در صورتی که تعداد کافی پیدا نکند، به تولید IDهای تصادفی متوسل می‌شود. با این حال، الگوریتم این نسخه ابتدایی بوده و تنها برای حروف و ارقام ASCII نتایج معقولی ارائه می‌دهد.