AsciiDoc: Syntax سیکھیں اور mastar بنائیں تاکہ مؤثر Documentation تیار کی جا سکے۔
Publié le 20 June 2025
مقدمہ
AsciiDoc ایک ہلکا مارک اپ زبان ہے جو ساخت شدہ ٹیکنیکل دستاویزات، مضامین، کتابیں یا پیشنگیانات بنانے کے لیے ڈیزائن کی گئی ہے۔ اس کی واضح پڑھائی، نحوی غنى اور مختلف فارمیٹس (HTML, PDF, DocBook وغیرہ) بنانے کی قابلیت سے ممتاز ہے۔ اس مضامین میں، ہم AsciiDoc کی بنیادی نحویات کا جائزہ لیں گے اور جلد سے شروع کرنے کے لیے بعض مفید ٹپس پیش کریں گے۔
AsciiDoc کیا ہے؟
AsciiDoc ایک دستاویزات کی شرح کی زبان ہے، جو Markdown کے مشابہ ہے لیکن زیادہ طاقتور ہے۔ یہ متون، سرخی، فہرستها، جداول، کوڈ کے بلاکس، اور مزید کو مؤثر طریقے سے ساخت دینے کی اجازت دیتا ہے۔ اس کی تنوع اس کو اوپن سروس پروژیز کی دستاویزات، کتابوں کی تصنیف اور ویب प्रकाशن کے لیے ایک پرعوامی انتخاب بناتی ہے۔
AsciiDoc کو کیوں چنیے؟
-
آسان اور واضح نحو
-
معمولانہ پیچیدہ ڈھانچوں (جداول، نوٹس، اعلان، وغیرہ) کے لیے نیٹیو سپورت۔
-
کثیر فارمیٹس کی تخلیق (HTML, PDF, ePub, DocBook…).
-
JBake یا Antora جیسے اسٹیٹک سائٹ جنریٹر کے ساتھ آسان انٹیگریشن.
-
پیشگی تنظیم atribuٹس اور ایکسٹینشنز کے ساتھ
استعمال کے کیس کا ڈائاگرام (Use Case)
استعمال کے حالات کا ڈائیگرام استعمال کنندگان اور نظام کے درمیان بنیادی تعاملات پیش کرنے کی اجازت دیتا ہے۔ یہ دستاویزی نظام کے لیے ایک سادہ مثال ہے:
نمودار ذہنی نقشہ
مائنڈ میپ (ذہنی نقشی) AsciiDoc سے متعلق مفاهيم اور ان کے رابطے کو تلاش کرنے کے لیے مناسب ہے :
فلو ڈائیگرام
ایک فلو ڈائگرام AsciiDoc دستاویز کی تخلیق کے عمل کو وضاحت کرنے کی اجازت دیتا ہے:
AsciiDoc فائل کی بنیادی ڈھانچہ
ایسکی ڈاک فائلعام طور پر ایک عنوان، اختیاری صفات، اور بعد میں منظم مواد سے شروع ہوتی ہے۔ یہ ایک کم سے کم مثال ہے۔
= Titre Principal
Auteur
2024-09-03
:toc:
:icons: font
Votre contenu commence ici...بنیادی نحوی
عناوین و بخشیں
AsciiDoc کئی سطح کے عناوین کو سپورٹ کرتا ہے :
= Titre de niveau 1
== Titre de niveau 2
=== Titre de niveau 3
==== Titre de niveau 4بھاری، ایطالیک اور مونوسپیس متنی
*gras* _italique_ `monospace`بولیٹس اور نمبر شدہ فہرستیں
* Élément 1
* Élément 2
. Premier
. Deuxième
. Troisièmeلینکس اور تصاویر
Lien standard : https://asciidoc.org[AsciiDoc]
Image : image::images/logo.png[AsciiDoc Logo]کوڈ کے بلوک
[source,python]def hello(): print("Bonjour AsciiDoc !")
میزیں
|===
| Colonne 1 | Colonne 2
| Valeur A
| Valeur B
| Valeur C
| Valeur D
|===نوٹس اور نصیحت
AsciiDoc بصری معلومات کے بلوک پیش کرتا ہے :
NOTE: Ceci est une note importante.
TIP: Conseil utile pour l’utilisateur.
WARNING: Attention à ce point.معینات اور متغیرات استعمال
کسٹم خصوصیات قیموں کو دوبارہ استعمال کرنے یا سلوک کو ترتیب دینے کی اجازت دیتے ہیں :
:project-name: AsciiDoc Explorer
Le projet s’appelle {project-name}.عام استعمال کے حالات
Check: Could also be "عام استعمال کے کے przypad"? No. So answer.
</think>
عام استعمال کے حالات
-
اوپن سورس پراجیکٹ کی دستاویزات (README, تکنیکی رہنمائے) کتابیں اور ایبکس کی تدوین - ستاتیک ویب سائٹوں کی خودکار تیاری (JBake, Antora) تکنیکی پرزينٹس
بہترین तरीके
-
مناسب عناوین استعمال کریں اور خودکار فہرست (:toc:). - اہم نکات پر توجہ دلانے کے لیے مشنوعات کو ترجیح دیں۔ - اپنی فائلوں کو منظم بنائیں تاکہ مرمت آسان ہو جائے۔ - اننوٹڈ کوڈ بلوکس استعمال کر کے مثالوں کو وضاحت کریں
نتیجہ
AsciiDoc ایک طاقتور اور رسائی پذیر آلہ ہے جس سے کسی بھی تکنیکی یا منظم مضامین کی دستاویزات تیار کی جا سکتی ہے۔ اس کیample? I’m going to output the translated text as requested.
مزید آگے جانے کے لیے
-
رسمی دستاویز : https://asciidoc.org - Asciidoctor : https://asciidoctor.org JBake اور AsciiDoc: https://jbake.org/docs/2.6.4/#asciidoc_support
اپنی تجربات اور ٹپس تبصرے میں شیئر کریں!