Doxygen என்பது குறிப்புரை செய்யப்பட்ட C++ எனும் மூலகுறிமுறைவரிகளிலிருந்து ஆவணங்களை உருவாக்குவதற்கான நடைமுறையில் செந்தரமான கருவி ஆகும், ஆனால் இது C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, , UNO/OpenOffice flavors போன்ற பிற பிரபலமான நிரலாக்க மொழிகளையும் ஆதரிக்கிறது. ), Fortran, ஓரளவு Dஇன் விரிவாக்க வன்பொருள் விளக்க மொழி VHDLஆகியவற்றினை ஆதரிக்கிறது.
இது நமக்கு மூன்று வழிகளில் உதவுகின்றது:
1. இது ஒரு இணையத்தின் ஆவண உலாவியையும் (HTML இல்) /அல்லது ஒரு இணைய இணைப்பில்லாது குறிப்புரை கையேட்டையும் (in ) ஆவணப்படுத்தப் பட்ட மூலக் கோப்புகளின் தொகுப்பிலிருந்து உருவாக்க முடியும். RTF (MS-Word), PostScript,, மீயிணைப்பு செய்யப்பட்ட PDF, சுருக்கப்பட்ட HTML , Unix கையேடு பக்கங்களில் வெளியீட்டை உருவாக்குவதற்கான ஆதரவினையும்கொண்டுள்ளது. ஆதாரங்களில் இருந்து ஆவணங்கள் நேரடியாகப் பிரித்தெடுக்கப்படுகின்றன, இது ஆவணங்களை மூலக் குறிமுறைவரிகளுடன் இணக்கமாக வைத்திருப்பதை மிகவும் எளிதாக்குகிறது.
2. ஆவணமற்ற மூலக் கோப்புகளிலிருந்து குறிமுறைைவரிகளின் கட்டமைப்பைப் பிரித்தெடுக்க இதனை கட்டமைக்கலாம். பெரிய மூலங்களின் விநியோகங்களில் வழிமுறையை விரைவாகக் கண்டறிய இது மிகவும் பயனுள்ளதாக இருக்கும். சார்பு வரைபடங்கள், பரம்பரை வரைபடங்கள் , ஒத்துழைப்பு வரைபடங்கள் ஆகியவற்றின் மூலம் பல்வேறு உறுப்புகளுக்கு இடையிலான உறவுகளை காட்சிப்படுத்த முடியும், இவை அனைத்தும் தானாகவே உருவாக்கப்படுகின்றன.
3. சாதாரண ஆவணங்களை உருவாக்குவதற்கும் doxygen ஐப் பயன்படுத்தலாம் (doxygen ஐ பயனபாட்டிற்கான பயனர் கையேடு , இணைய தளகையேடு போன்று).
இது Mac OS X ,Linuxஆகியவற்றின் கீழ் உருவாக்கப்பட்டது, ஆனால்இது மிகவும் கையடக்கமாக அமைக்கப்பட்டுள்ளது நம்முடைய விரலியில்கூட கொண்டுசென்று பயன்படுத்தலாம். இதன் விளைவாக, இது மற்ற யூனிக்ஸ்வெளியீடுகளிலும் இயங்குகிறது. மேலும், விண்டோவிற்கான செயற்படுத்துதல்கள் கிடைக்கின்றன.
இதனுடைய செயற்படுத்தக்கூடிய டாக்சிஜன் என்பது மூலங்களைப் பாகுபடுத்தி ஆவணங்களை உருவாக்குகின்ற முக்கிய நிரலாக்கமாகும்.
நாம் விரும்பியவாறு, செயற்படுத்தக்கூடிய doxywizard ஐப் பயன்படுத்தலாம், இது doxygen ஆல் பயன்படுத்தப்படும் கட்டமைப்பு கோப்பைத் திருத்துவதற்கும், வரைகலை சூழலில் doxygen ஐ இயக்குவதற்கும் ஒரு வரைகலை முன் முனைமமாகும்..
பின்வரும் படமானது கருவிகளுக்கும் அவற்றுக்கிடையேயான தகவல் ஓட்டத்திற்கும் இடையிலான தொடர்பைக் காட்டுகிறது:
படிமுறை 0: நிரலாக்க/வன்பொருள் விளக்க மொழியை டாக்சிஜன் ஆதரிக்கிறதா எனச் சரிபார்த்திடுக முதலில், நிரலாக்க/வன்பொருள் விளக்க மொழி டாக்சிஜனால் அங்கீகரிக்கப்படுவதற்கான நியாயமான வாய்ப்பு உள்ளது என்பதை உறுதிப்படுத்திகொள்க. இதில் முன்னிருப்பாக C, C++, Lex, C#, Objective-C, IDL, Java, PHP, Python, Fortran , D. ஆகிய நிரலாக்க மொழிகள் ஆதரிக்கப்படுகின்றன:
Doxygen ஆனது வன்பொருள் விளக்க மொழியான VHDL ஐ முன்னிருப்பாக ஆதரிக்கிறது. குறிப்பிட்ட பாகுபடுத்திகளைப் பயன்படுத்த, குறிப்பிட்ட கோப்பு வகை நீட்டிப்புகளை தகவமைவுசெய்திடலாம்: மேலும், முன்பக்கசெயலி நிரல்களைப் பயன்படுத்தி முற்றிலும் வேறுபட்ட மொழிகளை ஆதரித்திடுமாறு செய்யலாம்:
படிமுறை 1: ஒரு தகவமைவுடனான கோப்பை உருவாக்குதல் Doxygen அதன் அனைத்து அமைப்புகளையும் தீர்மானிக்க தகவமைவு கோப்பைப் பயன்படுத்தி கொள்கிறது. ஒவ்வொரு செயல்திட்டமும் அதன் சொந்த தகவமைவு கோப்பைப் பெற வேண்டும். ஒரு செயல்திட்டமானது ஒற்றை மூலக் கோப்பைக் கொண்டிருக்கும், ஆனால் மீண்டும் மீண்டும் வருடுதல் செய்யப்படும் முழு மூல மரமாகவும் இருக்கலாம். தகவமைவு கோப்பின் உருவாக்கத்தை எளிமையாக்க, இதில் நமக்காக ஒரு மாதிரிபலக தகவமைவு கோப்பை உருவாக்க முடியும். இதைச் செய்ய, கட்டளை வரியிலிருந்து -g எனும்வாய்ப்புடன் doxygen ஐ அழைத்திடுக:
TAGNAME = VALUE or
TAGNAME = VALUE1 VALUE2 …
உருவாக்கப்பட்ட மாதிரிபலக தகவமைவு கோப்பில் உள்ள பெரும்பாலான குறிச்சொற்களின் மதிப்புகளை அவற்றின் இயல்புநிலை மதிப்பிற்கே விட்டுவிடலாம்.
உரைபதிப்பாளரைக் கொண்டு தகவமைவுக் கோப்பைத் திருத்த நாம் விரும்பவில்லை எனில், doxywizard ஐப் பயன்படுத்திகொள்ளவேண்டும், இது டாக்ஸிஜன் தகவமைவு கோப்புகளை உருவாக்க, படிக்க , எழுதக்கூடிய வரைகலை பயனாளர்இடைமுகப்பின்(GUI )முன்பக்கமாகும், மேலும் அவற்றை உள்ளிடுவதன் மூலம் தகவமைவு வாய்ப்புகளை கட்டமைக்க அனுமதிக்கிறது. உரையாடல்கள்.
சில C /அல்லது C++ மூலத்தினை , தலைப்புக் கோப்புகளைக் கொண்ட ஒரு சிறிய செயல்திட்டத்திற்கு, INPUT குறிச்சொல்லை காலியாக விடலாம் . தற்போதைய கோப்பகத்தில் ஆதாரங்களை doxygen ஆனது தேடிடுகின்றது.
மூல அடைவு அல்லது மரத்தை உள்ளடக்கிய ஒரு பெரிய செயல்திட்டப்பணி நம்மிடம் இருந்தால், நாம் INPUT குறிச்சொல்லுக்கு மூலகோப்பகம் அல்லது கோப்பகங்களை ஒதுக்க வேண்டும், மேலும் ஒன்று அல்லது ஒன்றிற்கு மேற்பட்ட கோப்பு வடிவமைப்புகளை FILE_PATTERNS குறிச்சொல்லில் சேர்த்திடுக (எடுத்துகாட்டாக *.cpp *.h). தோரணிகளில் ஒன்றோடு பொருந்தக்கூடிய கோப்புகள் மட்டுமே பாகுபடுத்தப்படும். ஒரு மூல மரத்தின் சுழல்நிலை பாகுபடுத்தலுக்கு, RECURSIVE குறிச்சொல்லை YES என அமைக்க வேண்டும். பாகுபடுத்தப்பட்ட கோப்புகளின் பட்டியலை மேலும் நன்றாக மாற்ற, EXCLUDE, EXCLUDE_PATTERNS ஆகிய குறிச்சொற்களைப் பயன்படுத்தலாம். எடுத்துக்காட்டாக ஒரு மூல மரத்திலிருந்து அனைத்து பரிசோதனை கோப்பகங்களையும் தவிர்க்க, அதனை ஒருவர் பயன்படுத்தலாம்:
EXCLUDE_PATTERNS = /test/
|
நீட்டிப்புகள் |
கணினிமொழி |
நீட்டிப்புகள் |
கணினிமொழி |
நீட்டிப்புகள் |
கணினிமொழி |
|
.dox |
C / C++ |
.hpp |
C / C++ |
.py |
Python |
|
.doc |
C / C++ |
.h++ |
C / C++ |
.pyw |
Python |
|
.c |
C / C++ |
.mm |
C / C++ |
.f |
Fortran |
|
.cc |
C / C++ |
.txt |
C / C++ |
.for |
Fortran |
|
.cxx |
C / C++ |
.idl |
IDL |
.f90 |
Fortran |
|
.cpp |
C / C++ |
.ddl |
IDL |
.f95 |
Fortran |
|
.c++ |
C / C++ |
.odl |
IDL |
.f03 |
Fortran |
|
.ii |
C / C++ |
.java |
Java |
.f08 |
Fortran |
|
.ixx |
C / C++ |
.cs |
C# |
.f18 |
Fortran |
|
.ipp |
C / C++ |
.d |
D |
.vhd |
VHDL |
|
.i++ |
C / C++ |
.php |
PHP |
.vhdl |
VHDL |
|
.inl |
C / C++ |
.php4 |
PHP |
.ucf |
VHDL |
|
.h |
C / C++ |
.php5 |
PHP |
.qsf |
VHDL |
|
.H |
C / C++ |
.inc |
PHP |
.l |
Lex |
|
.hh |
C / C++ |
.phtml |
PHP |
.md |
Markdown |
|
.HH |
C / C++ |
.m |
Objective-C |
.markdown |
Markdown |
|
.hxx |
C / C++ |
.M |
Objective-C |
.ice |
Slice |
மேலே உள்ள பட்டியலில் FILE_PATTERNS இல் இயல்பாக அமைக்கப்பட்டதை விட அதிகமான உருப்படிகள் இருக்கலாம் என்பதை நினைவில் கொள்க.
பாகுபடுத்தப்படாத எந்த நீட்டிப்பையும் FILE_PATTERNS இல் சேர்ப்பதன் மூலம் அமைக்கலாம்,மேலும் பொருத்தமான EXTENSION_MAPPING அமைக்கப்படும்.
ஏற்கனவே உள்ள செயல்திட்டத்திற்கு Doxygenஐ பயன்படுத்தத் தொடங்கினால் (இதனால் டாக்சிஜனுக்குத் தெரிந்த எந்த ஆவணமும் இல்லாமல்), அதன் அமைப்பு என்ன மற்றும் ஆவணப்படுத்தப்பட்ட முடிவு எவ்வாறு இருக்கும் என்பது பற்றிய கருத்தினைப் பெறலாம். அவ்வாறு செய்ய, தகவமைவு கோப்பில் உள்ள EXTRACT_ALL எனும் குறிச்சொல்லை YES என அமைக்க வேண்டும். பின்னர், ஆதாரங்களில் உள்ள அனைத்தும் ஆவணப்படுத்தப்பட்டதாக Doxygen பாசாங்கு (pretend) செய்யும். இதன் விளைவாக, EXTRACT_ALLஎன்பதில் YES என அமைக்கப்படும் வரை, ஆவணமற்ற உறுப்பினர்களைப் பற்றிய எச்சரிக்கைகள் உருவாக்கப்படாது என்பதை நினைவில் கொள்க.
ஏற்கனவே உள்ள மென்பொருளை பகுப்பாய்வு செய்ய, மூலக் கோப்புகளில் அதன் வரையறையுடன் (ஆவணப்படுத்தப்பட்ட) உட்பொருளை குறுக்கு-குறிப்பு செய்வது பயனுள்ளது. நாம் SOURCE_BROWSER குறிச்சொல்லை YES என அமைத்தால், டாக்ஸிஜன் அத்தகைய குறுக்கு குறிப்புகளை உருவாக்கும். INLINE_SOURCES ஐ YES என அமைப்பதன் மூலம் ஆவணங்களில் நேரடியாக ஆதாரங்களைச் சேர்க்கலாம் (எடுத்துக்காட்டாக குறிமுறைவரிகளின் மதிப்பாய்வுகளுக்கு இது எளிதாக இருக்கும்).
படிமுறை2Doxygenஐ இயக்குதல்
ஆவணங்களை உருவாக்க, இப்போது பின்வருமாறு உள்ளிடலாம்:
doxygen <config-file>
அமைப்புகளைப் பொறுத்து, வெளியீட்டு கோப்பகத்தில் html, rtf, latex, xml, man ஆகியவையும்/அல்லது docbook கோப்பகங்களையும் doxygen ஆனதுஉருவாக்கும். பெயர்கள் குறிப்பிடுவது போன்று, இந்த கோப்பகங்கள் HTML, RTF, , XML, Unix-Man , DocBook வடிவமைப்பு ஆகியவற்றில் உருவாக்கப்பட்ட ஆவணங்களைக் கொண்டிருக்கின்றன.
இயல்புநிலை வெளியீட்டு அடைவு என்பதுdoxygen தொடங்கப்பட்ட கோப்பகமாகும். வெளியீடு எழுதப்பட்ட மூல கோப்பகத்தை OUTPUT_DIRECTORY ஐப் பயன்படுத்தி மாற்றலாம். HTML_OUTPUT, RTF_OUTPUT, LATEX_OUTPUT, XML_OUTPUT, MAN_OUTPUT , DOCBOOK_OUTPUT ஆகியவற்றைப் பயன்படுத்தி வெளியீட்டு கோப்பகத்தில் உள்ள வடிவமைப்பு குறிப்பிட்ட கோப்பகத்தைத் தேர்ந்தெடுக்கலாம். கட்டமைப்பு கோப்பின் குறிச்சொற்கள். வெளியீட்டு அடைவு இல்லை என்றால், doxygen ஆனது அதைநமக்காக உருவாக்க முயற்சிக்கும் (ஆனால் mkdir -p போன்று முழுப் பாதையையும் மீண்டும் மீண்டும் உருவாக்க முயற்சிக்காது).
HTML வெளியீடு
உருவாக்கப்பட்ட HTML ஆவணங்களை html கோப்பகத்தில் உள்ள index.html கோப்பில் ஒரு HTML உலாவியை சுட்டிக்காட்டி பார்க்க முடியும். சிறந்த முடிவுகளுக்கு, அடுக்குகளின்பாவணைதாட்களை (CSS) ஆதரிக்கின்ற உலாவியைப் பயன்படுத்த வேண்டும் ( Mozilla Firefox, Google Chrome, Safari, சில சமயங்களில் IE8, IE9 , Opera ஆகியவற்றைப் பயன்படுத்தி உருவாக்கப்பட்ட வெளியீடு பரிசோதிக்கப்படுகின்றது).
HTML பிரிவின் சில இயல்புகளுக்கு (GENERATE_TREEVIEW அல்லது தேடுபொறி போன்றவை) இயக்கநேர HTML,ஜாவாஸ்கிரிப்ட் இயக்கப்பட்டதை ஆதரிக்கின்ற உலாவி தேவைப்படுகிறது.
LaTeX வெளியீடு
உருவாக்கப்பட்ட ஆவணங்கள் முதலில் ஒரு மொழிமாற்றியால் தொகுக்கப்பட வேண்டும் (Linux, MacOSX க்கான சமீபத்திய teTeX விநியோகம் , Windows க்கான MikTex ஆகியவற்றைப் பயன்படுத்திகொள்ளப்படுகின்றது). உருவாக்கப்பட்ட ஆவணங்களைத் தொகுக்கின்ற செயல்முறையை எளிதாக்க,doxygen ஒரு Makeகோப்பினை latex கோப்பகத்தில் எழுதுகிறது (விண்டோ இயங்குதளத்திலும் ஒரு make.bat எனும் தொகுதி கோப்பு உருவாக்கப்படுகிறது).
Makefile இல் உள்ள உள்ளடக்கங்களும் இலக்குகளும் USE_PDFLATEX அமைப்பைச் சார்ந்தது. இது முடக்கப்பட்டிருந்தால் (NO என அமைக்கப்பட்டதாகும்), latex கோப்பகத்தில் make என்று தட்டச்சு செய்தால் refman.dvi எனப்படும் dvi கோப்பு உருவாக்கப்படும். இந்தக் கோப்பை xdvi ஐப் பயன்படுத்தி திரையில் காணலாம் அல்லது make ps என தட்டச்சு செய்வதன் மூலம் refman.ps என்ற போஸ்ட்ஸ்கிரிப்ட்(பின்குறிப்பு) கோப்பாக மாற்றலாம் (இதற்கு dvips தேவை).
உண்மையான ஒரு தொட்டுணரக்கூடிய பக்கத்தில் 2 பக்கங்களை வைக்க, அதற்குப் பதிலாக ps_2on1 ஐப் பயன்படுத்திடுக. இதன் விளைவாக வரும் பின்குறிப்பு கோப்பை அச்சிடுமாறு அனுப்பலாம். பின்குறிப்பு அச்சுப்பொறி இல்லையெனில், பின்குறிப்பை நம்முடைய அச்சுப்பொறியே புரிந்து கொள்ளும் வகையில் மாற்ற பின்குறிப்பைப் பயன்படுத்த முயற்சி செய்யலாம்.
பின்குறிப்பு மொழிபெயர்ப்பாளரை நிறுவுகைசெய்திருந்தால் PDF ஆக மாற்றுவதும் சாத்தியமாகும்;அவ்வாறு செய்ய pdf என தட்டச்சு செய்திடுக (அல்லது pdf_2on1 ஐ உருவாக்கிடுக).
PDF வெளியீட்டிற்கான சிறந்த முடிவுகளைப் பெற, PDF_HYPERLINKS, USE_PDFLATEX ஆகிய குறிச்சொற்களை YES என அமைக்க வேண்டும். இந்த வழக்கில் Makefile நேரடியாக refman.pdf ஐ உருவாக்குவதற்கான இலக்கை மட்டுமே கொண்டிருக்கும்.
RTF வெளியீடு
Doxygenஆனது RTF வெளியீட்டை refman.rtf எனப்படும் ஒரு கோப்புடன் இணைக்கிறது. இந்த கோப்பு மைக்ரோசாஃப்ட் வேர்டில் பதிவிறக்கம் செய்ய உகந்ததாக உள்ளது. புலங்களாக செயல்படுவனவற்றைப் பயன்படுத்தி சில தகவல்கள் குறியாக்கம் செய்யப்படுகின்றன. உண்மையான மதிப்பைக் காட்ட அனைத்தையும் தேர்ந்தெடுக்க வேண்டும் (Edit – select all)) பின்னர் புலங்களை மாற்றிடுக (சுட்டியின் வலது புறபொத்தானை சொடுக்குதல் செய்தபின்விரியும் கீழ்தோன்றும் பட்டியிலிருந்து option ஐத் தேர்ந்தெடுத்திடுக).
XML வெளியீடு
எக்ஸ்எம்எல் வெளியீடானது Doxygenஆல் சேகரிக்கப்பட்ட தகவல்களின் கட்டமைக்கப்பட்ட “dump” என்தை கொண்டுள்ளது. ஒவ்வொரு கலவையும் (இனம்/பெயர்வெளி/கோப்பு/…) அதன் சொந்த XML கோப்பு , index.xml எனப்படும் சுட்டுவரிசை கோப்பும் உள்ளது.
combine.xslt எனப்படுகின்ற ஒரு XSLT உரை கோப்பும் உருவாக்கப்படுகிறது, மேலும் அனைத்து XML கோப்புகளையும் ஒரே கோப்பாக இணைக்கப் பயன்படுத்தலாம்.
Doxygen இரண்டு XML அமைவு கோப்புகளை index.xsd (சுட்டுவரிசை கோப்பிற்கு) , compound.xsd (கலவையான கோப்புகளுக்கு) உருவாக்குகிறது. இந்த அமைவு கோப்புஆனது சாத்தியமான கூறுகள், அவற்றின் பண்புக்கூறுகள் , அவை எவ்வாறு கட்டமைக்கப்பட்டுள்ளன என்பதை விவரிக்கிறது, அதாவது இது XML கோப்புகளின் இலக்கணத்தை விவரிக்கிறது , சரிபார்ப்புக்கு அல்லது XSLT உரைநிரல்களை இயக்குவதற்குப் பயன்படுத்தலாம்.
addon/doxmlparser எனும் கோப்பகத்தில், doxygen மூலம் உருவாக்கப்படுகின்ற XMLஇன் வெளியீட்டை அதிகரிக்கின்ற வகையில் படிக்கின்ற ஒரு பாகுபடுத்தியின் நூலகத்தைக் காணலாம்
செயல்முறை பக்க வெளியீடு
உருவாக்கப்பட்ட செயல்முறை பக்கங்களை செயல்முறை நிரலைப் பயன்படுத்தி காணமுடியும். செயல்முறை கோப்பகம் செயல்முறை பாதையில் இருப்பதை உறுதி செய்திடுக. செயல்முறை பக்க வடிவமைப்பின் திறன்களுக்கு சில வரம்புகள் உள்ளன, எனவே சில தகவல்கள் (இனவரைபடங்கள், குறுக்கு குறிப்புகள் ,சூத்திரங்கள் போன்றவை) இழக்கப்படும்.
ஆவணபுத்தக வெளியீடு
Doxygen ஐ ஆவணபுத்தக(DocBook) வடிவத்திலும் வெளியீட்டை உருவாக்க முடியும்.
படிமுறை 3: ஆதாரங்களை ஆவணப்படுத்துதல்
ஆதாரங்களை ஆவணப்படுத்துவது படிமுறை 3 என வழங்கப்பட்டாலும், ஒரு புதிய செயல்திட்டத்தில் இது நிச்சயமாக படிமுறை 1 ஆக இருக்க வேண்டும். நம்மிடம் ஏற்கனவே சில குறிமுறைவரிகள் இருப்பதாக கருதிகொள்க, மேலும் நாம் API,ம் உள்ளகங்கள் , சில தொடர்புடைய வடிவமைப்புகளை விவரிக்கின்ற ஒரு நல்ல ஆவணத்தையும் டாக்சிஜன் உருவாக்க வேண்டும் எனக்கொள்க
தகவமைவு கோப்பில் (இயல்புநிலை) EXTRACT_ALL வாய்ப்பு NO என அமைக்கப்பட்டால், ஆவணப்படுத்தப்பட்ட நிறுவனங்களுக்கான ஆவணங்களை மட்டுமே doxygen உருவாக்குகின்றது. எனவே இவற்றை எவ்வாறு ஆவணப்படுத்துவது?
உறுப்பினர்கள், இனங்கள் , பெயர்இடைவெளிகளுக்கு அடிப்படையில் இரண்டு வாய்ப்புகள் உள்ளன:
1. உறுப்பினர், இனம் அல்லது பெயர்வெளியின் வெளியீட்டையும் அல்லது வரையறைக்கு முன் ஒரு தனிஆவணத் தொகுதியை வைத்திடுக. கோப்பு, இனம் பெயர்வெளி உறுப்பினர்களுக்கு ஆவணங்களை உறுப்பினருக்குப் பிறகு நேரடியாக வைக்க அனுமதிக்கப்படுகிறது.
. 2. ஒரு தனிஆவணத் தொகுதியை வேறு எங்காவது வைத்திடுக (மற்றொரு கோப்பு அல்லது மற்றொரு இடம்), ஆவணத் தொகுதியில் ஒரு கட்டமைப்பு கட்டளையை வைத்திடுக. ஒரு கட்டமைப்பு கட்டளைவரியானது ஆவணப்படுத்தக்கூடிய ஒரு குறிப்பிட்ட நிறுவனத்துடன் ஒரு ஆவணத் தொகுப்பினையை இணைக்கிறது (எ.கா. உறுப்பினர், இனம், பெயர்வெளி அல்லது கோப்பு).
முதல் வாய்ப்பின் நன்மை என்னவென்றால், நிறுவனத்தின் பெயரை மீண்டும் சொல்ல வேண்டியதில்லை. இரண்டாவது வாய்ப்பினைப் பயன்படுத்தி மட்டுமே கோப்புகளை ஆவணப்படுத்த முடியும், ஏனெனில் ஒரு கோப்பின் முன் ஆவணத் தொகுதியை வைக்க வழி இல்லை. நிச்சயமாக, கோப்பு ஆனது உறுப்பினர்களுக்கு (செயலிகள், மாறிகள், வகைவரையறைகள்ஆகியவற்றினை வரையறுக்கிறது) வெளிப்படையான கட்டமைப்பு கட்டளைவரி தேவையில்லை; ஒரு தனி ஆவணத் தொகுதியை முன்னால் அல்லது பின்னால் வைப்பது நன்றாக செயல்படுகின்றது. ஒரு தனி ஆவணத் தொகுதியில் உள்ள உரை HTML உம்/அல்லது வெளியீட்டு கோப்புகளில் எழுதப்படுவதற்கு முன்பும் பாகுபடுத்தப்படுகிறது. பாகுபடுத்தும் போது பின்வரும் படிமுறைகள் பின்பற்றப்பெறுகின்றன:
• Markdown வடிவமைப்பானது தொடர்புடைய HTML அல்லது தனிக் கட்டளைவரிகளால் மாற்றப்படுகிறது.
• ஆவணத்தில் உள்ள தனிக்கட்டளைவரிகள் செயல்படுத்தப்படுகின்றது.
• ஒரு கோடு சில இடைவெளிகளுடன் தொடங்கினால் ஒன்று அல்லது அதற்கு மேற்பட்ட நட்சத்திரக் குறியீடுகளும் (*) , வாய்ப்புகளுமாக அதிக இடைவெளி இருந்தால், அனைத்து இடைவெளிகளும் நட்சத்திரக் குறியீடுகளும் அகற்றப்படுகின்றது.
• அனைத்து வெற்று கோடுகளும் ஒரு பத்தி பிரிப்பான்களாக கருதப்படுகின்றன. உருவாக்கப்பட்ட ஆவணங்களை படிக்கக்கூடியதாக மாற்றுவதற்கு புதிய பத்தி கட்டளைகளை நாமே வைப்பதிலிருந்து இது நம்மை காக்கின்றது.
• ஆவணப்படுத்தப்பட்ட இனங்களுடன் தொடர்புடைய சொற்களுக்கு இணைப்புகள் உருவாக்கப்படுகின்றன (சொல்லிற்கு முன் % எனும் குறியீடு இருந்தால் தவிர; அந்த சொல் இணைக்கப்படாது , % எனும் அடையாளக்குறியீடு அகற்றப் படுகின்றது).
• உரையில் குறிப்பிட்ட வடிவமைப்புகள் காணப்படும் போது உறுப்பினர்களுக்கான இணைப்புகள் உருவாக்கப்படுகின்றது.
. • ஆவணத்தில் இருக்கும் HTML குறிச்சொற்கள் விளக்கப்பட்டு வெளியீட்டிற்கு சமமானவைகளாக மாற்றப்படுகின்றன.