ஆவணப்படுத்தல் பாணி வழிகாட்டி

புதிய உள்ளடக்கத்தை எழுதுதல் மற்றும் ஏற்கனவே உள்ள உள்ளடக்கத்தை மொழிபெயர்த்தல் ஆகியவற்றுடன் தொடர்புடைய, எதிர்பார்க்கப்படும் பாணி, MkDocs-க்கான பிரத்யேக இலக்கண அமைப்பு, பல்வேறு தேவையான கருவிகள் மற்றும் ஆவண மொழிபெயர்ப்பு ஆகியவை குறித்த தகவல்கள் இந்த வழிகாட்டியில் அடங்கும்.

பொதுவான பாணி

• தலைப்புகள் மற்றும் தலைவணக்கங்களில் முதல் சொல் மட்டுமே பெரிய எழுத்தில் இருக்க வேண்டும்.
• நாங்கள் அமெரிக்க எழுத்துப்பிடியை விரும்புகிறோம், மேலும் நிரலாக்கத்திற்கே உரிய சில பேச்சு வழக்குகளுக்கும் (எ.கா., "apps") பெயர்களைச் செயலாக்குவதற்கும் (எ.கா., "scrollable") சில சுதந்திரங்கள் எடுத்துக்கொள்கிறோம்.
• "artefact" மற்றும் "artefacts" ஆகியவற்றின் எழுத்துப்பிழை காட்டப்பட்டுள்ளபடி உள்ளது.
• ஒரு முழுக்குறியைத் தொடர்ந்து ஒற்றை இடைவெளியைப் பயன்படுத்தவும்.
• நாங்கள் ஒரு எம்-டாஷ் (அல்லது HTML — லிட்டரல்) ஆக, இடைவெளிகளால் சூழப்பட்ட ஒற்றை ஹைஃபனைப் பயன்படுத்துகிறோம்.
• ஒரு தயாரிப்புப் பெயரைக் குறிப்பிடும்போது, அந்தத் தயாரிப்பின் விரும்பப்படும் பெரியெழு எழுத்துப்பெயர்ப்பைப் பயன்படுத்த வேண்டும். (எ.கா., "macOS", "GTK", "pytest", "Pygame", "PyScript").
• ஒரு சொல் "கோடாக" பயன்படுத்தப்பட்டால், அதை அகராதியில் சேர்ப்பதற்குப் பதிலாக, ஒற்றை பேக்டிக்கள் (backticks) கொண்டு சுற்றி, இன்லைன் கோடாக மேற்கோள் காட்ட வேண்டும்.
• ஒரு பயனர் செய்ய வேண்டிய செயல்களை விவரிக்கும்போது, "வெறுமனே", "மட்டுமே", அல்லது "எளிதாக" போன்ற சொற்களைப் பயன்படுத்துவதை நாங்கள் தவிர்க்கிறோம். இந்தச் சொற்கள் இகழ்ச்சியாகப் புரிந்துகொள்ளப்படலாம், குறிப்பாக ஒரு பயனர் சிரமங்களை அனுபவிக்கும்போது.

தகவல்களைக் குறுக்கு-சரிபார்த்தல்

முடிந்தவரை ஆவணங்களில் உள்ள உள்ளடக்கத்தை குறுக்கு-சரிபார்க்க வேண்டும். இந்தப் பிரிவு, நீங்கள் அவ்வாறு செய்யக்கூடிய பல்வேறு வழிகளை உள்ளடக்கியது. அவை ஒவ்வொன்றும் குறிப்பிடப்படும் தகவலின் வகையை அடிப்படையாகக் கொண்டவை.

MkDocs, நிலையான மார்க் டவுன் வடிவமைப்புள்ள இணைப்புகளைக் காட்டுகிறது. நிலையான மார்க் டவுன் வடிவமைப்புள்ள இணைய இணைப்புகள் பின்வருமாறு:

[இணைப்பு உரை](https://example.com/)

உள்ளூர் கோப்புக்கு இணைக்கவும் இந்த வடிவத்தை நீங்கள் பயன்படுத்தலாம்:

[இணைப்பு உரை](path/to/file.md)

கோப்புகளின் குறிப்பிட்ட பிரிவுகளை அல்லது ஏபிஐ ஆவணங்களைக் குறிப்பிட, MkDocs குறிப்பு இணைப்பு வடிவத்தைப் பயன்படுத்த வேண்டும்.

தனிப்பயன் மார்க் டவுன் ஆங்கர்கள் மற்றும் உள்ளடக்கக் குறுக்கு-மேற்கோள்

மார்க்‌டவுன், தலைப்பின் உள்ளடக்கத்தின் அடிப்படையில் அனைத்து தலைப்புகளுக்கும் (ஒன்று முதல் ஆறு # குறியீடுகளுக்கு இடையில் தொடங்கும் ஒரு ஒற்றை வரியில் உள்ள எதுவும்) ஆங்கர்களை உருவாக்குகிறது. உதாரணமாக, இந்தப் பகுதிக்கு உருவாக்கப்பட்ட ஆங்கர் custom-markdown-anchors-and-content-cross---referencing ஆகும். இருப்பினும், எங்கள் மொழிபெயர்ப்புகள் செயல்படும் விதத்தின் காரணமாக, ஒரு பிரிவுத் தலைப்பு குறிப்பிடப்படும் ஒவ்வொரு முறையும், அது ஒரு தனிப்பயன் நங்கூரத்தைக் கொண்டிருக்க வேண்டும்.

MkDocs, மாற்றியமைக்கப்பட்ட மார்க் டவுன் இணைப்பைப் பயன்படுத்தி ஆவணத்தில் உள்ள பல்வேறு பிற கூறுகளுக்கு இணைக்க அனுமதிக்கும் ஒரு குறிப்பு இணைப்பு இலக்கணத்தை வழங்குகிறது. இதில், மற்றவற்றுடன், தனிப்பயன் மார்க் டவுன் தலைப்புகள் மற்றும் உரை நங்கூரங்களுக்கு இணைப்பது ஆகியவை அடங்கும்.

MkDocs குறிப்பு இணைப்புகள் என்பவை பின்வருமாறு வடிவமைக்கப்பட்ட எந்தவொரு இணைப்புகளாகும்:

[இணைப்பு உரை][இணைப்பு இலக்கு]

தனிப்பயன் தலைப்பு மற்றும் உள்ளடக்க ஆங்கர்கள் தேவை

BeeWare ஆவணத்தில் உள்ள MkDocs குறிப்பு இணைப்பு வழியாக உரை உள்ளடக்கத்தில் குறிப்பிடப்படும் எந்தவொரு தலைப்பு அல்லது உள்ளடக்கப் பகுதியிலும் ஒரு தனிப்பயன் ஆங்கர் இணைக்கப்பட்டிருக்க வேண்டும். இல்லையெனில், தலைப்பு உள்ளடக்கம் மொழிபெயர்க்கப்படும்போது இணைப்புகள் உடையக்கூடிய வாய்ப்புள்ளது.

நீங்கள் ஒரு தலைப்பு ஆங்கருக்கு இணைக்க விரும்பினால், நீங்கள் விரும்பிய உள்ளடக்கத்திற்காக ஒரு தனிப்பயன் ஆங்கரை உருவாக்க வேண்டும். ஒரு தனிப்பயன் ஆங்கரை அமைப்பதற்கான பொதுவான இலக்கணம் பின்வருமாறு:

தலைப்பு உரை { #anchor-name }

உதாரணமாக, இந்தப் பகுதிக்கான இணைப்பை custom-anchors எனத் தனிப்பயனாக்குவது பின்வரும் வடிவமைப்பைக் கொண்டு செய்யப்படும்:

## தனிப்பயன் மார்க்அப் நங்கூரங்கள் { #custom-anchors }

உரை மற்றும் குறியீட்டுப் பத்திகள் உட்பட, பொதுவான உள்ளடக்கத்தின் மீதும் நீங்கள் ஒரு நங்கூரத்தை உருவாக்கலாம். நீங்கள் இணைக்க விரும்பும் உள்ளடக்கத்திற்கு மேலே, பின்வரும் வடிவமைப்பு, மேலேயும் கீழேயும் புதிய வரிகளைக் கொண்டு, சேர்க்கப்பட வேண்டும்:

மேலே உள்ள உள்ளடக்கம்.

[](){ #anchor-name }

கீழே உள்ள உள்ளடக்கம், இது இப்போது மேலே உள்ள ஆங்கருடன் இணைக்கப்பட்டுள்ளது.

தனிப்பயன் ஆங்கர்கள் உருவாக்கப்பட்டவுடன், அதே ஆவணத்திலிருந்து அல்லது ஆவணத்தின் மற்ற பகுதிகளிலிருந்து அவற்றுடன் இணைக்கலாம்.

ஒரே கோப்பில் உள்ள ஒரு ஆங்கருக்கு இணைக்க ஸ்டாண்டர்ட் மார்க் டவுன் பயன்படுத்தப்படுகிறது, அது பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது:

[இணைப்பு உரை](#ஆங்கர்-பெயர்)

பிரிவான ஆவணத்தில் உள்ள ஒரு ஆங்கருக்கு இணைப்பது, MkDocs குறிப்பு இணைப்பு பாணியைப் பயன்படுத்துகிறது, அது பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது:

[இணைப்பு உரை][ஆங்கர்-பெயர்]

ஏபிஐ குறிப்பு இணைப்புகள்

MkDocs குறிப்பு இணைப்பு, ஆவணப்படுத்தப்பட்ட வகுப்புகள், வகுப்பு முறைகள் அல்லது பண்புகள், மற்றும் குறிப்பிட்ட வெளிப்புற ஆவணக் குறிப்புகள் உட்பட, குறுக்கு-குறிப்பு API ஆவணங்களையும் ஆதரிக்கிறது.

நீங்கள் ஒரே கோப்பிலிருந்து இணைக்கிறீர்களா அல்லது ஒரு தனி கோப்பிலிருந்து இணைக்கிறீர்களா என்பதைப் பொருட்படுத்தாமல், ஆவணப்படுத்தப்பட்ட ஒரு கிளாஸ், அல்லது ஒரு கிளாஸ் மெத்தட் அல்லது அட்ரியிபிய்ட்டுக்கு இணைக்க பல விருப்பங்கள் உள்ளன. கிளாஸ்கள் போன்றவற்றுடன் இணைக்கும்போது, பெயரை இன்லைன் கோடாகக் காட்ட, முதல் செட் சதுர அடைப்புக்குறிகளில் நீங்கள் பேக்டிக்களைச் சேர்க்க வேண்டும். இன்லைன் குறியீடாகக் காட்டப்படக்கூடாத தனிப்பயன் உரையைப் பயன்படுத்தினால் மட்டுமே பின்னடைகள் தேவையில்லை. இரண்டாவது செட் சதுர அடைப்புக்குறிகளில் பின்னடைகள் ஒருபோதும் சேர்க்கப்படக்கூடாது.

நெஸ்ஸ்பேஸைக் காண்பிக்கும்போது ஒரு வகுப்புக்கான இணைப்பு பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது:

[`module.ClassName`][]

ஒரு வகுப்பின் பெயரை மட்டும் காண்பித்து அதற்கு இணைக்கும்போது, அது பின்வரும் வடிவத்தில் அமைக்கப்பட்டுள்ளது:

[`ClassName`][module.ClassName]

பண்புக்கூறுகள் மேலே உள்ளதைப் போன்றே இருக்கும், பண்புக்கூறு பெயரும் சேர்க்கப்பட்டிருக்கும். பின்வருவது பெயர்வகையைக் காட்டுகிறது:

[`module.ClassName.attributename`][]

வகுப்புகளைப் போலவே, பண்புக்கூறு பெயரை மட்டும் காண்பிப்பது பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது:

[`attributename`][module.ClassName.attributeName]

மெத்தடுகள் நேம்ஸ்பேஸிற்குப் பிறகு () உடன் காட்டப்பட வேண்டும், எனவே அவை அட்ரிபியூட்களைப் போலல்லாமல் வேறுபட்ட முறையில் கையாளப்பட வேண்டும். ஒரு மெத்தட்டிற்கு இணைப்பைக் கொடுப்பதற்கான சரியான வழி பின்வருமாறு:

[`module.ClassName.methodname()`][module.ClassName.methodname]

பின்வருவது வகுப்பு மற்றும் முறை பெயரை மட்டும் காட்டுகிறது. பெயருக்குப் பிறகு அடைப்புக்குறிகளைச் சேர்ப்பதும் அவசியம்:

[`Classname.methodname()`][module.Classname.methodname]

பொருத்தமான நேம்ஸ்பேஸுடன் அதே முறையைப் பயன்படுத்தி, நீங்கள் ஒரு வகுப்பு, முறை அல்லது பண்புக்கூறுக்கு இணைப்பைக் கொடுக்கலாம். ஒரு வகுப்புடன் இதைச் செய்யும்போது அது பின்வருமாறு வடிவமைக்கப்படும்:

[இணைப்பு உரை][மாடுல்.வகுப்புப்பெயர்]

பைத்தான் கோர் ஆவணங்கள் மற்றும் பில்லோ ஆவணங்களுக்கும் நேரடியாக இணைப்பை அமைக்க முடியும். எடுத்துக்காட்டாக, int-க்கான ஆவணங்களுடன் இணைக்க:

[`int`][]

Pillow Image ஆவணத்துடன் இணைக்க:

[`PIL.Image.Image`][]

குறியீட்டுப் பகுதி குறிப்புகள்

மொழி மற்றும் குறியீடு முன்னிலைப்படுத்தல்

கோட்பிளாக்கிற்குள் உள்ள குறியீட்டிற்கான மொழியை, முதல் மூன்று பேக்டிக்களுக்குப் பிறகு இடைவெளி இல்லாமல் மொழிப் பெயரைச் சேர்ப்பதன் மூலம் நீங்கள் குறிப்பிடலாம். இது குறியீடு காட்டப்படும்போது பொருத்தமான குறியீடு முன்னிலைப்படுத்தலுக்கு வழிவகுக்கிறது. உதாரணமாக, பைத்தானைக் குறிப்பிட, நீங்கள் கோட்பிளாக்கை ```python எனத் தொடங்குவீர்கள்.

கன்சோல் கட்டளைகள் மற்றும் நகல் பொத்தான்

நீங்கள் கன்சோல் கட்டளைகள் அல்லது வெளியீட்டுடன் கூடிய கட்டளைகளைச் சேர்க்கும்போது, நீங்கள் யூனிக்ஸ் போன்ற (macOS உட்பட) இயக்க முறைமை அல்லது விண்டோஸைப் பற்றி விவரிக்கிறீர்களா என்பதைப் பொறுத்து, அதை console அல்லது doscon எனக் குறிப்பிடுங்கள். நீங்கள் இயக்க முறைமை வழங்கும் உள்நுழைவையும் சேர்க்கலாம்; நகல் பொத்தானைச் சொடுக்கும்போது, கட்டளை மட்டுமே நகலெடுக்கப்படும். எடுத்துக்காட்டாக, நீங்கள் ஒரு கோட்பொதியை ```console எனத் தொடங்கி, பின்வரும் உள்ளடக்கத்தைச் சேர்த்தால்:

$ mkdir test
$ ls
test

பின்னர், கோட்பிளாக்கில் உள்ள நகல் பொத்தானைக் கிளிக் செய்தால், அது கட்டளைகளை மட்டும் நகலெடுக்கும், மேலும் உரையாடல்களையும் வெளியீட்டையும் புறக்கணிக்கும். இது, அவை கன்சோல் கட்டளைகள் என்பதைக் குறிக்க உதவுகிறது, அதே நேரத்தில் பயனர்கள் நகல் பொத்தானைத் திறம்படப் பயன்படுத்தவும் அனுமதிக்கிறது.

குறிப்பிட்ட குறியீட்டு வரிகளை முன்னிலைப்படுத்துதல்

நீங்கள் குறிப்பிட்ட குறியீட்டு வரிகளை முன்னிலைப்படுத்தலாம். உதாரணமாக, 2-ஆம் வரியை முன்னிலைப்படுத்த, மொழிக்குப் பிறகு ஒரு இடைவெளி விட்டு, அதைத் தொடர்ந்து {hl_lines="2"} சேர்க்க வேண்டும். எனவே, உங்கள் குறியீட்டுப் பகுதி ```python {hl_lines="2"} என்று தொடங்கும். முடிவு:

import toga
from toga.style.pack import COLUMN, ROW

நீங்கள் பல வெவ்வேறு வரிகளை முன்னிலைப்படுத்தலாம். உதாரணமாக, python {hl_lines="3 5 9"} என்பது 3, 5 மற்றும் 9 ஆம் வரிகளை முன்னிலைப்படுத்தும். நீங்கள் வரிகளின் ஒரு வரம்பையும் முன்னிலைப்படுத்தலாம். உதாரணமாக, python {hl_lines="3-8"} என்பது 3 முதல் 8 வரையிலான வரிகளை முன்னிலைப்படுத்துகிறது. உதாரணமாக, python {hl_lines="9-18 23-44"} எனப் பல வரம்புகளை முன்னிலைப்படுத்தலாம்.

குறிப்பிட்ட வடிவமைப்பு தேவைப்படும் மார்க்அப் கூறுகள்

மொழிபெயர்ப்புக் கோப்புகள் உருவாக்கப்படும் விதத்தின் காரணமாக, எச்சரிக்கைகள், குறிப்புகள், தாவல்கள், ஜின்ஜா வழிமுறைகள், பட விளக்கக்குறிப்புகள் மற்றும் சீரமைப்பு போன்றவற்றிற்கான மார்க்அப் குறியீட்டில், தேவையான புதிய வரிகளைச் சேர்ப்பது முக்கியமாகும்.

எச்சரிக்கைகள் மற்றும் குறிப்புகள்

எச்சரிக்கைகள் பின்வரும் வடிவத்தில் வடிவமைக்கப்பட வேண்டும், மேலும் எச்சரிக்கை தொடக்கத்திற்கு முன்பும் பின்பும் ஒரு புதிய வரி (newline) இருப்பதை உறுதி செய்ய வேண்டும்:

மேல் உள்ளடக்கம்.

/// அறிவுரை | தலைப்பு

அறிவுரை உரை.

ஒரு இரண்டாவது பத்தி.

///

கீழ் உள்ளடக்கம்.

இது ஆதரிக்கப்படும் எந்தவொரு எச்சரிக்கை வகையிலும் ஒரே மாதிரியாக செயல்படும். எடுத்துக்காட்டாக, note எச்சரிக்கைகளுக்கு அதே வடிவமைப்பு மற்றும் புதிய வரிகள் தேவை:

மேல் உள்ள உள்ளடக்கம்.

/// குறிப்பு | குறிப்பு தலைப்பு

குறிப்பு உரை இங்கே.

///

கீழ் உள்ள உள்ளடக்கம்.

அனைத்து ஆதரிக்கப்படும் அறிவுறுத்தல் வகைகள் அறிவுறுத்தல்களாகப் பயன்படுத்தக் கிடைக்கின்றன.

தாவல் உள்ளடக்கம்

தாவப்பட்ட உள்ளடக்கம் பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது, இதில் உள்ளடக்கத் தொகுப்பின் தொடக்கத்திற்கு முன்பும் முடிவுக்குப் பின்பும் ஒரு புதிய வரி சேர்க்கப்பட்டுள்ளது:

மேல் உள்ளடக்கம்.

/// தாவல் | தாவல் ஒன்று தலைப்பு

தாவல் ஒன்று உரை

///

/// தாவல் | தாவல் இரண்டு தலைப்பு

தாவல் இரண்டு உரை.

///

/// தாவல் | தாவல் மூன்று தலைப்பு

தாவல் மூன்று உரை.

///

கீழ் உள்ளடக்கம்.

ஒரு உள்ளமைக்கப்பட்ட எச்சரிக்கையுடன் கூடிய ஒரு தாவல், உள்ளடக்கப் பகுதிக்கு முன்னும் பின்னும் ஒரு புதிய வரியைச் சேர்த்து, பின்வருமாறு வடிவமைக்கப்படும்:

மேல் உள்ள உள்ளடக்கம்.

/// தாவல் | விண்டோஸ்

தாவல் உரை.

/// அறிவுரை | அறிவுரை

அறிவுரை உரை.

///

///

கீழ் உள்ள உள்ளடக்கம்.

முடக்கப்பட்ட உள்ளடக்கம்

மடிக்கப்பட்ட உள்ளடக்கம், புதிய வரிகளை உள்ளடக்கியಂತೆ, பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது:

மேல் உள்ள உள்ளடக்கம்.

/// விவரங்கள்-குறிப்பு | சுருக்கப்பட்ட உள்ளடக்கத்தின் தலைப்பு

சுருக்கப்பட்ட உள்ளடக்கம்.

///

கீழ் உள்ள உள்ளடக்கம்.

அனைத்து ஆதரிக்கப்படும் அறிவுறுத்தல் வகைகள் சுருக்கப்பட்ட உள்ளடக்கத்துடன் பயன்படுத்தக் கிடைக்கின்றன, இருப்பினும், நீங்கள் அவற்றை details-admonitiontype என அறிவிக்க வேண்டும். எனவே, ஒரு "note" வகை சுருக்கப்பட்ட தொகுதி details-note (மேலே காட்டப்பட்டுள்ளபடி), ஒரு "warning" வகை சுருக்கப்பட்ட தொகுதி details-warning, மற்றும் பலவாக இருக்கும்.

ஜின்ஜா வழிகாட்டுதல்கள்

ஆவணத்தில் உரையில் ஜின்ஜா வழிமுறைகளைப் பயன்படுத்தும் சில அம்சங்கள் உள்ளன. ஜின்ஜா வழிமுறை அம்சங்களைப் பயன்படுத்தும் எதையும் புதிய வரிகளில் சுற்றப்பட வேண்டும். உதாரணமாக, BeeWare பயிற்சியில், பிரதான பக்கத்தில் எந்த எச்சரிக்கையைக் காட்ட வேண்டும் என்பதைத் தீர்மானிக்க, மாறிகளை அடிப்படையாகக் கொண்ட ஜின்ஜா நிபந்தனைகள் உள்ளன. அவை பின்வருமாறு வடிவமைக்கப்பட்டுள்ளன:

மேல் உள்ள உள்ளடக்கம்.



கீழ் உள்ள உள்ளடக்கம்.

குறியீடுகளை அல்லது உரையை மாற்றுவதற்கான இலக்கணமும் உள்ளது. இந்த இலக்கணம் என்பது, பொருந்தக்கூடிய இரட்டை வளைந்த அடைப்புக்குறிகளின் ஜோடியில் பொதி செய்யப்பட்ட ஒரு மாறி ஆகும், மேலும் அது தனியாக ஒரு வரியில் இருந்தால், அதற்கு முன் மற்றும் பின்னால் ஒரு புதிய வரியைச் சேர்க்க வேண்டும்.

மேலே உள்ள உள்ளடக்கம்.

{{ variable }}

கீழே உள்ள உள்ளடக்கம்.

பட வடிவமைப்பு

படங்களுக்கு அகலத்தை அமைக்கலாம், மேலும் அவற்றை இடது, வலது மற்றும் மையத்தில் சீரமைக்கலாம் ("மையம்" என்பதில் ஒரு நிபந்தனை உள்ளது). அணுகல்தன்மை நோக்கங்களுக்காக படங்களில் எப்போதும் அர்த்தமுள்ள மாற்று உரை (alt text) இருக்க வேண்டும்.

ஒரு படத்தின் அகலத்தில் 300px என அமைப்பது பின்வருமாறு வடிவமைக்கப்படும்:

![படத்தின் மாற்று உரை](../path/to/image.png){ width="300px" }

ஒரு படத்தை இடது (அல்லது வலது) பக்கத்திற்குச் சீரமைப்பது பின்வருமாறு வடிவமைக்கப்படும்:

![படத்தின் மாற்று உரை](../path/to/image.png){ align=left }

ஒரு படத்திற்கு தலைப்புச் சொற்றொடரைச் சேர்க்க, அதற்கு முன் மற்றும் பின்பு ஒரு புதிய வரி தேவைப்படுகிறது, மேலும் அது பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது:

மேல் உள்ள உள்ளடக்கம்.

![படத்தின் மாற்று உரை](/path/to/image.png)

/// தலைப்பு

தலைப்பு உள்ளடக்கம்.

///

கீழ் உள்ள உள்ளடக்கம்.

align பண்புக்கூறுடன் ஒரு படத்தின் மையத்தைச் சீரமைக்க முடியாது. இதற்கான மாற்று வழி, படத்தைத் தொடர்ந்து ஒரு வெற்று தலைப்பைச் சேர்ப்பது, அது படத்தை மையப்படுத்துவதாகும். ஒவ்வொரு பகுதிக்கு இடையில், மற்றும் அதற்கு முன்பும் பின்பும் நீங்கள் புதிய வரிகளைச் சேர்க்க வேண்டும். இது பின்வருமாறு வடிவமைக்கப்பட்டுள்ளது:

மேல் உள்ள உள்ளடக்கம்.

![படத்தின் மாற்று உரை](../path/to/image.png)

/// தலைப்பு

///

கீழ் உள்ள உள்ளடக்கம்.

குறிப்பிட்ட மார்க் டவுன் வடிவமைப்புடன் கூடிய செருகுநிரல்கள்

பின்வரும் பிரிவுகள், குறிப்பிட்ட மார்க் டவுன் வடிவமைப்பு தேவைப்படும் செருகுநிரல்களை எவ்வாறு பயன்படுத்துவது என்பதை விளக்குகின்றன.

வெளியிடப்பட்ட உள்ளடக்கத்தைச் சேர்க்க ஸ்னிப்பெட்ஸைப் பயன்படுத்துதல்

உள்ளூர் கோப்பு அல்லது URL-இலிருந்து வெளிப்புற உள்ளடக்கத்தை எவ்வாறு சேர்ப்பது என்பது பற்றிய விவரங்களுக்கு, Snippets நீட்டிப்பு ஆவணங்களைப் பார்க்கவும். ஆவணத்தில் செயல்படுத்தப்பட வேண்டிய ஜின்ஜா வழிமுறைகள் (Jinja directives) இல்லாத வரை ஸ்னிப்பெட்ஸ் பயன்படுத்தப்பட வேண்டும் (ஜின்ஜா செயல்படுத்தல், ஸ்னிப்பெட்ஸ் செயலாக்கத்துடன் ஒருசேர நடைபெறும், எனவே கோப்பில் உள்ள எந்தவொரு ஜின்ஜாவும் செயலாக்கப்படாது). ஒரு கோப்பின் குறிப்பிட்ட பகுதிகளைத் தனித்தனியாகச் சேர்க்க அனுமதிக்கும் பிரிப்பான்களைப் பயன்படுத்த விரும்பினால், ஸ்னிப்பெட்ஸ் அவசியமாகிறது. எடுத்துக்காட்டாக, மூல ஆவணம் ஒன்று மற்றவற்றிலிருந்து தனித்தனியாகச் செருகப்படும் பிரிவுகளாகப் பிரிக்கப்பட்டுள்ளது.

முக்கியக் குறிப்புகள்:

• நாங்கள் ஸ்னிப்பெட்ஸ் அடையாளமாக -8<- ஐப் பயன்படுத்துகிறோம். ஆவணங்கள் பல விருப்பங்களைக் காட்டுகின்றன; தயவுசெய்து எங்கள் பாணியைப் பின்பற்றவும்.
• BeeWare Docs Tools பகிரப்பட்ட உள்ளடக்கத்தில் காணப்படும் கோப்புகள் "உள்ளூர்" உள்ளடக்கமாகக் கருதப்படுகின்றன. எனவே, நீங்கள் ஒன்று கோப்பின் பெயரை மட்டும் பயன்படுத்த வேண்டும், -8<- "docs-style-guide.md" இல் உள்ளதைப் போல, அல்லது அந்த உள்ளடக்கம் ஒரு துணை கோப்பகத்தில் இருந்தால், கோப்பகம் மற்றும் கோப்பின் பெயரை மட்டும் பயன்படுத்த வேண்டும், -8<- "style/docs-style-guide.md" இல் உள்ளதைப் போல.
• நீங்கள் GitHub-இல் உள்ள ஒரு கோப்பிலிருந்து URL வழியாக வெளிப்புற உள்ளடக்கத்தைச் சேர்க்கிறீர்கள் என்றால், நீங்கள் கட்டாயமாக ராக் உள்ளடக்க URL-ஐப் பயன்படுத்த வேண்டும், இல்லையெனில் நீங்கள் அதைச் சேர்க்கும் இடத்தில் முழு வலைப்பக்கமும் உட்பொதிக்கப்பட்டுவிடும்.

BeeWare Docs Tools பகிரப்பட்ட உள்ளடக்கத்திலிருந்து உள்ளடக்கத்தைச் சேர்க்க மேக்ரோக்களைப் பயன்படுத்துதல்

நீங்கள் Macros MkDocs செருகுநிரலை பயன்படுத்தி BeeWare Docs கருவிகளின் பகிரப்பட்ட உள்ளடக்க கோப்பகத்திலிருந்து உள்ளடக்கத்தைச் சேர்க்கலாம். ஆவணத்தில் செயல்படுத்தப்பட வேண்டிய ஜின்ஜா வழிமுறைகள் இருந்தால் இந்த முறை அவசியமானது, மேலும் இந்தச் சூழ்நிலையில் மட்டுமே இதைப் பயன்படுத்த வேண்டும். இது ஒரு URL வழியாக வெளிப்புற உள்ளடக்கத்துடன் வேலை செய்யாது. மேக்ரோஸ் மாறி-மாற்றுதல் வழிமுறை இந்த முறையுடன் செயல்படுகிறது.

மேக்ரோக்களைப் பயன்படுத்தி உள்ளடக்கத்தைச் சேர்ப்பதற்கான விருப்பங்கள் உள்ளன:

1. ஆவணத்தில் வேறு எந்த கைமுறை மாற்றங்களையும் செய்யாமல் அதைச் சேர்க்க விரும்பினால், include ஜின்ஜா இலக்கணத்தைப் பயன்படுத்தவும்.

2. நீங்கள் ஆவணத்தில் ஜின்ஜா extends சொற்றொடரைச் சேர்த்துள்ளபட்சத்தில், குறிப்பிட்ட பிரிவுகளை மாற்றி அமைக்க அல்லது அவற்றில் சேர்க்க, [(https://jinja.palletsprojects.com/en/stable/templates/#child-template) ஜின்ஜா சொற்றொடரைப் பயன்படுத்தவும்].

pyspelling

நாங்கள் pyspelling எழுத்துப்பிழை சரிபார்ப்பைப் பயன்படுத்துகிறோம். இது லிண்ட்-சோதனைகளின் போது இயக்கப்படுகிறது.

pyspelling தவறாக எழுதப்பட்ட ஒரு வார்த்தையைக் கண்டறிந்தால், பெரும்பாலான சந்தர்ப்பங்களில், ஆவண உள்ளடக்கத்தில் அது திருத்தப்பட வேண்டும்.

pyspelling அகராதியில் இல்லாத ஒரு செல்லுபடியான வார்த்தையை அது கண்டறிந்தால், அரிதான அந்தச் சந்தர்ப்பத்தில், உங்களிடம் இரண்டு விருப்பங்கள் உள்ளன:

1. அது பலமுறை மீண்டும் பயன்படுத்தப்படக்கூடிய ஒரு வார்த்தையாக இருந்தால், அந்த வார்த்தையை spelling_wordlist டைரக்டரியில் உள்ள docs ஆவணத்தில் அகரவரிசைப்படி சேர்க்க வேண்டும்.
2. மீண்டும் பயன்படுத்தப்பட வாய்ப்பில்லாத ஒரு வார்த்தையாக இருந்தால், அதை <nospell> / </nospell> குறியீட்டில் மூடலாம், அப்போது pyspelling அதை உள்ளடக்கத்திலேயே புறக்கணித்துவிடும்.