SCDOC(5)                      File Formats Manual                     SCDOC(5)

نام (NAME)
       scdoc - قالب سند برای نگارش صفحات راهنما

سینتکس (SYNTAX)
       پرونده‌های ورودی باید از کدگذاری UTF-8 استفاده کنند.

   مقدمه (Preamble)
       هر پرونده scdoc باید با مقدمه زیر آغاز شود:

           NAME(section) ["left_footer" ["center_header"]]

       NAME نام صفحه راهنمایی است که می‌نویسید، و section بخشی است که برای آن
       می‌نویسید (برای اطلاعات بیشتر درباره بخش‌های راهنما، man(1) را ببینید).

       left_footer و center_header آرگومان‌های اختیاری هستند که متن قرارگرفته
       در آن مکان‌ها را در صفحه راهنمای تولیدشده تنظیم می‌کنند و باید با علامت
       نقل‌قول دوتایی محصور شوند.

   عناوین بخش‌ها (Section headers)
       هر بخش از صفحه راهنمای شما باید با چیزی شبیه به موارد زیر آغاز شود:

           # HEADER NAME

       عناوین زیربخش‌ها نیز شناخته می‌شوند - از دو علامت هش استفاده کنید. هر
       عنوان باید در هر دو طرف خود یک خط خالی داشته باشد.

   پاراگراف‌ها (Paragraphs)
       یک پاراگراف جدید را با یک خط خالی آغاز کنید.

   شکست خط (Line breaks)
       با پایان دادن یک خط با ++ یک شکست خط درج کنید.

       نتیجه شبیه به
       این خواهد بود.

   قالب‌بندی (Formatting)
       متن را می‌توان با ستاره و زیرخط توپر یا زیرخط‌دار کرد: *bold* یا
       _underlined_. زیرخط‌ها در میان_کلمات نادیده گرفته می‌شوند.

   تورفتگی (Indentation)
       می‌توانید خطوط را با نویسه تب (\t) دندانه‌دار کنید تا به اندازه ۴ فاصله
       در خروجی تورفته شوند. خطوط تورفته نمی‌توانند حاوی عناوین بخش‌ها باشند.

           نتیجه شبیه به چیزی مانند این خواهد بود.

           می‌توانید از چندین خط و بیشتر انواع قالب‌بندی استفاده کنید.

       تورفتگی را کم کنید تا به حالت عادی برگردید، یا دوباره تورفتگی ایجاد
       کنید تا عمق تورفتگی افزایش یابد.

   فهرست‌ها (Lists)
       می‌توانید فهرست‌های نشانه‌دار را با خط تیره (-) شروع کنید، مانند زیر:

           - Item 1
           - Item 2
                - Subitem 1
                - Subitem 2
           - Item 3

       نتیجه شبیه به این خواهد بود:

       •   Item 1
       •   Item 2
           •   Subitem 1
           •   Subitem 2
       •   Item 3

       همچنین می‌توانید ورودی‌های طولانی را با دادن همان سطح تورفتگی، به اضافه
       دو فاصله، در خط دیگری ادامه دهید. آن‌ها به عنوان یک ورودی فهرست واحد
       رندر می‌شوند.

           - Item 1 is pretty long so let's
             break it up onto two lines
           - Item 2 is shorter
                - But its children can go on
                  for a while

       •   Item 1 is pretty long so let's break it up onto two lines
       •   Item 2 is shorter
           •   But its children can go on for a while

   فهرست‌های شماره‌دار (Numbered lists)
       فهرست‌های شماره‌دار شبیه فهرست‌های معمولی هستند، اما به‌جای خط تیره (-) با
       نقطه (.) شروع می‌شوند، مانند زیر:

           . Item 1
           . Item 2
           . Item 3,
             with multiple lines

       1.  Item 1
       2.  Item 2
       3.  Item 3, with multiple lines

   جدول‌ها (Tables)
       برای شروع یک جدول، یک خط خالی و سپس هر تعداد سطر اضافه کنید.

       هر سطر از جدول باید با | یا : برای شروع یک سطر یا ستون جدید به ترتیب
       آغاز شود (یا فاصله برای ادامه خانه قبلی در چندین خط)، و به دنبال آن [
       یا - یا ] برای تراز کردن محتوا به چپ، وسط یا راست، و سپس یک فاصله و
       محتوای آن خانه بیاید. می‌توانید به‌جای مشخص‌کننده تراز از فاصله استفاده
       کنید تا تراز همان ستون در سطر قبلی به ارث برسد. هر سطر باید تعداد
       ستون‌های یکسانی داشته باشد؛ ستون‌های خالی مجاز هستند.

       نخستین نویسه از اولین سطر محدود به | نیست و معنای خاصی دارد. علامت [
       جدولی با حاشیه در اطراف هر خانه ایجاد می‌کند. علامت | جدولی بدون حاشیه
       ایجاد می‌کند. علامت ] جدولی با یک حاشیه در اطراف کل جدول ایجاد می‌کند.

       برای پایان دادن به جدول خود، یک خط خالی بعد از آخرین سطر اضافه کنید.

           [[ *Foo*
           :- _Bar_
           :-
           |  *Row 1*
           :  Hello
           :] world!
           |  *Row 2*
           :  こんにちは
           :  世界
              !

       ┌──────┬────────────┬────────┐
       │Foo   │    Bar     │        │
       ├──────┼────────────┼────────┤
       │Row 1 │   Hello    │ world! │
       ├──────┼────────────┼────────┤
       │Row 2 │ こんにちは │ 世界 ! │
       └──────┴────────────┴────────┘
       همچنین می‌توانید ستون‌ها را طوری تنظیم کنید که فضای موجود را با < (تراز
       چپ)، = (تراز وسط) و > (تراز راست) پر کنند، مانند زیر:

           [[ *Normal column*
           :< Expanded column
           |  *Foo*
           :  Bar

       ┌──────────────┬───────────────────────────────────────────────────────┐
       │Normal column │ Expanded column                                       │
       ├──────────────┼───────────────────────────────────────────────────────┤
       │Foo           │ Bar                                                   │
       └──────────────┴───────────────────────────────────────────────────────┘

   متن تحت‌اللفظی (Literal text)
       می‌توانید قالب‌بندی scdoc را خاموش کرده و متن را به‌صورت تحت‌اللفظی با
       کدهای گریز و بلوک‌های تحت‌اللفظی خروجی دهید. درج یک \ در متن منبع شما
       باعث می‌شود نماد پس از آن به عنوان تحت‌اللفظی تلقی شده و مستقیماً در خروجی
       کپی شود. همچنین می‌توانید بلوک‌هایی از نحو تحت‌اللفظی مانند زیر ایجاد
       کنید:

           ```
           _This formatting_ will *not* be interpreted by scdoc.
           ```

       این بلوک‌ها یک سطح تورفته خواهند شد. توجه داشته باشید که متن تحت‌اللفظی
       در نمایش‌دهنده man به‌صورت کلمه‌به‌کلمه نشان داده می‌شود - یعنی ابزاری برای
       درج ماکروهای roff سفارشی شما در خروجی نیست. توجه داشته باشید که \
       همچنان در داخل بلوک‌های تحت‌اللفظی تفسیر می‌شود، که به عنوان مثال می‌تواند
       برای خروجی دادن ``` در داخل یک بلوک تحت‌اللفظی مفید باشد.

   توضیحات (Comments)
       خطوطی که با ; و یک فاصله شروع می‌شوند نادیده گرفته می‌شوند.

           ; This is a comment

قراردادها (CONVENTIONS)
       طبق قرارداد، تمام اسناد scdoc باید به طور دقیق روی ۸۰ ستون شکسته شوند.

همچنین ببینید (SEE ALSO)
       scdoc(1)

نویسندگان (AUTHORS)
       نگهداری توسط Drew DeVault <sir@cmpwn.com>. سورس‌های به‌روز را می‌توان در
       <https://git.sr.ht/~sircmpwn/scdoc> یافت و باگ‌ها یا وصله‌ها را می‌توان از
       طریق ایمیل به ~sircmpwn/public-inbox@lists.sr.ht ارسال کرد.

                                  2026-07-07                          SCDOC(5)