Contributing
எவரும் மாற்றங்களைப் பங்களிக்க இந்த ஆவண ஆதாரம் திறக்கப்பட்டுள்ளது! உங்களுக்கு ஒரு GitHub கணக்கு மற்றும் சிறிது நேரம் மட்டுமே தேவை. நீங்கள் Git பற்றி தெரிந்து கொள்ள வேண்டிய அவசியமில்லை, இணைய இடைமுகத்தில் இருந்து நீங்கள் அனைத்தையும் செய்யலாம்!
ஒரு குறிப்பிட்ட மொழியைப் பராமரிக்க நீங்கள் உதவ விரும்பினால், CODEOWNERS
கோப்பிற்கு எதிராக PR ஐத் திறந்து, உங்கள் மொழி அடைவில் ஒரு வரியைச் சேர்க்கவும். பயனர் பெயர்.
உள்ளடக்கத்தைத் திருத்துதல்
ஒவ்வொரு பக்கத்திலும், திருத்துவதற்காக GitHub பக்கத்திற்கு உங்களை அழைத்துச் செல்லும் பொத்தான் உள்ளது:
எடுத்துக்காட்டாக, இதை SetVehicleAngularVelocity என்பதில் கிளிக் செய்வதன் மூலம், இந்தப் பக்கத்திற்கு .md) கோப்பில் மாற்றங்களைச் செய்ய உங்களுக்கு உரை திருத்தியை வழங்குகிறது (நீங்கள் GitHub இல் உள்நுழைந்திருக்கிறீர்கள் என்று வைத்துக்கொள்வோம்).
உங்கள் திருத்தத்தைச் செய்து, "இழுக்கும் கோரிக்கையை" சமர்ப்பிக்கவும், அதாவது விக்கி பராமரிப்பாளர்களும் பிற சமூக உறுப்பினர்களும் உங்கள் மாற்றத்தை மதிப்பாய்வு செய்யலாம், கூடுதல் மாற்றங்கள் தேவையா என்று விவாதிக்கலாம் மற்றும் அதை ஒன்றிணைக்கலாம்.
புதிய உள்ளடக்கத்தைச் சேர்த்தல்
புதிய உள்ளடக்கத்தைச் சேர்ப்பது கொஞ்சம் அதிகமாகவே உள்ளது. நீங்கள் அதை இரண்டு வழிகளில் செய்யலாம்:
GitHub இடைமுகம்
GitHub இல் ஒரு கோப்பகத்தை உலாவும்போது, கோப்பு பட்டியலின் மேல் வலது மூலையில் கோப்பைச் சேர் பொத்தான் உள்ளது:
நீங்கள் ஏற்கனவே எழுதிய Markdown கோப்பை பதிவேற்றலாம் அல்லது நேரடியாக GitHub உரை திருத்தியில் எழுதலாம்.
கோப்பில் .md
நீட்டிப்பு மற்றும் மார்க் டவுன் இருக்க வேண்டும். மார்க் டவுன் பற்றிய கூடுதல் தகவலுக்கு, இந்த வழிகாட்டி பார்க்கவும்.
அது முடிந்ததும், "புதிய கோப்பை முன்மொழியவும்" என்பதை அழுத்தவும், ஒரு இழுவை கோரிக்கை மதிப்பாய்வுக்காக திறக்கப்படும்.
Git
நீங்கள் Git ஐப் பயன்படுத்த விரும்பினால், நீங்கள் விக்கி களஞ்சியத்தை குளோன் செய்ய வேண்டும்:
git clone https://github.com/openmultiplayer/wiki.git
உங்களுக்கு பிடித்த எடிட்டரில் திறக்கவும். மார்க் டவுன் கோப்புகளைத் திருத்துவதற்கும் வடிவமைப்பதற்கும் சில சிறந்த கருவிகள் இருப்பதால் விஷுவல் ஸ்டுடியோ குறியீட்டை நான் பரிந்துரைக்கிறேன். நீங்கள் பார்ப்பது போல், நான் இதை விஷுவல் ஸ்டுடியோ குறியீட்டைப் பயன்படுத்தி எழுதுகிறேன்!
உங்கள் அனுபவத்தை மேம்படுத்த இரண்டு நீட்டிப்புகளைப் பரிந்துரைக்கிறேன்:
- markdownlint டேவிட் அன்சன் - இது உங்கள் மார்க் டவுன் சரியாக வடிவமைக்கப்பட்டுள்ளதா என்பதை உறுதிப்படுத்தும் நீட்டிப்பாகும். இது சில தொடரியல் மற்றும் சொற்பொருள் தவறுகளைத் தடுக்கிறது. எல்லா எச்சரிக்கைகளும் முக்கியமானவை அல்ல, ஆனால் சில வாசிப்புத்திறனை மேம்படுத்த உதவும். சிறந்த தீர்ப்பைப் பயன்படுத்தவும், சந்தேகம் இருந்தால், மதிப்பாய்வாளரிடம் கேளுங்கள்!
- Prettier Prettier.js குழு - இது உங்கள் மார்க் டவுன் கோப்புகளைத் தானாக வடிவமைக்கும் ஒரு வடிவமைப்பாகும், அதனால் அவை அனைத்தும் சீரான பாணியைப் பயன்படுத்துகின்றன. . விக்கி களஞ்சியமானது அதன்
package.json
இல் சில அமைப்புகளைக் கொண்டுள்ளது, அவை நீட்டிப்பு தானாகவே பயன்படுத்த வேண்டும். உங்கள் எடிட்டர் அமைப்புகளில் "பார்மட் ஆன் சேவ்" என்பதை இயக்குவதை உறுதிசெய்யவும், எனவே நீங்கள் சேமிக்கும் ஒவ்வொரு முறையும் உங்கள் மார்க் டவுன் கோப்புகள் தானாகவே வடிவமைக்கப்படும்!
குறிப்புகள், குறிப்புகள் மற்றும் மரபுகள்
உள் இணைப்புகள்
தளங்களுக்கு இடையேயான இணைப்புகளுக்கு முழுமையான URLகளைப் பயன்படுத்த வேண்டாம். தொடர்புடைய பாதைகளைப் பயன்படுத்தவும்.
- ❌
[OnPlayerClickPlayer] உடன் பயன்படுத்த (https://www.open.mp/docs/scripting/callbacks/OnPlayerClickPlayer)
- ✔
[OnPlayerClickPlayer] உடன் பயன்படுத்த வேண்டும்(../callbacks/OnPlayerClickPlayer)
../
என்றால் "ஒரு கோப்பகத்திற்கு மேலே செல்", எனவே நீங்கள் திருத்தும் கோப்பு செயல்பாடுகள்
கோப்பகத்திற்குள் இருந்தால், நீங்கள் கால்பேக்குகள்
உடன் இணைத்தால் ஸ்கிரிப்டிங்/ வரை செல்ல
../ஐப் பயன்படுத்துகிறீர்கள்
பின்னர் கால்பேக்குகள்/
கால்பேக் கோப்பகத்தில் உள்ளிடவும், பின்னர் நீங்கள் இணைக்க விரும்பும் அழைப்பின் கோப்புப் பெயர் (.md
இல்லாமல்).
படங்கள்
படங்கள் துணை அடைவுக்குள் /static/images
உள்ளே செல்கின்றன. நீங்கள் ஒரு படத்தை ![]()
இல் இணைக்கும் போது, அடிப்படை பாதையாக /images/
ஐப் பயன்படுத்துவீர்கள் (இது களஞ்சியத்திற்கு மட்டும் ஸ்டாடிக்
தேவையில்லை).
சந்தேகம் இருந்தால், படங்களைப் பயன்படுத்தும் மற்றொரு பக்கத்தைப் படித்து, அது எப்படி முடிந்தது என்பதை நகலெடுக்கவும்.
மெட்டாடேட்டா
இங்கே எந்தவொரு ஆவணத்திலும் முதல் விஷயம் மெட்டாடேட்டாவாக இருக்க வேண்டும்:
---
title: My Documentation
sidebar_label: My Documentation
description: இது பொருட்கள் மற்றும் பொருட்கள் மற்றும் பர்கர்கள் பற்றிய பக்கம், ஆம்!
---
ஒவ்வொரு பக்கமும் ஒரு தலைப்பையும் விளக்கத்தையும் கொண்டிருக்க வேண்டும்.
---
க்கு இடையில் என்ன செல்லலாம் என்பதற்கான முழுப் பட்டியலுக்கு, Docusaurus ஆவணத்தை பார்க்கவும்.
தலைப்புகள்
இது தானாக உருவாக்கப்படுவதால், #
உடன் நிலை 1 தலைப்பை (<h1>
) உருவாக்க வேண்டாம். உங்கள் முதல் தலைப்பு எப்போதும் ##
ஆக இருக்க வேண்டும்
- ❌
# எனது தலைப்பு
இதற்கான ஆவணம் இது...
# துணைப்பிரிவு
- ✔
இது அதற்கான ஆவணம்...
## துணைப்பிரிவு
தொழில்நுட்ப குறிப்புகளுக்கு code
துணுக்குகளைப் பயன்படுத்தவும்
செயல்பாட்டுப் பெயர்கள், எண்கள், வெளிப்பாடுகள் அல்லது நிலையான எழுத்து மொழி இல்லாத எதையும் உள்ளடக்கிய ஒரு பத்தியை எழுதும் போது, `backticks` மூலம் அவற்றைச் சுற்றி வைக்கவும். செயல்பாடுகளின் பெயர்கள் மற்றும் குறியீட்டுத் துண்டுகள் போன்ற தொழில்நுட்பக் கூறுகளின் குறிப்புகளிலிருந்து விஷயங்களை விவரிப்பதற்கான மொழியைப் பிரிப்பதை இது எளிதாக்குகிறது.
- ❌
fopen செயல்பாடு, File: வகையின் குறிச்சொல்லுடன் மதிப்பை வழங்கும், திரும்ப மதிப்பு ஒரு மாறியில் சேமிக்கப்படுவதால், அந்த வரியில் எந்தச் சிக்கலும் இல்லை, மேலும் File: என்ற குறிச்சொல்லுடன் (குறிப்புகளைக் கவனியுங்கள் அதே தான்). இருப்பினும் அடுத்த வரியில் கோப்பு கைப்பிடியில் 4 மதிப்பு சேர்க்கப்படும். 4 க்கு குறிச்சொல் இல்லை [...]
- ✔
fopen
செயல்பாடு,File:
வகையின் குறிச்சொல்லுடன் மதிப்பை வழங்கும், திரும்ப மதிப்பு ஒரு மாறியில் சேமிக்கப்படுவதால், அந்த வரியில் எந்தச் சிக்கலும் இல்லை, மேலும்File:
என்ற குறிச்சொல்லுடன் (குறிப்புகளைக் கவனியுங்கள் அதே தான்). இருப்பினும் அடுத்த வரியில் கோப்பு கைப்பிடியில்4
மதிப்பு சேர்க்கப்படும்.4
க்கு குறிச்சொல் இல்லை
மேலே உள்ள எடுத்துக்காட்டில், fopen
என்பது ஒரு செயல்பாட்டுப் பெயர், ஒரு ஆங்கில வார்த்தை அல்ல, எனவே அதைச் சுற்றியுள்ள code
துணுக்கு குறிப்பான்கள் மற்ற உள்ளடக்கத்திலிருந்து வேறுபடுத்த உதவுகிறது.
மேலும், பத்தியானது உதாரணக் குறியீட்டின் தொகுதியைக் குறிப்பிடுவதாக இருந்தால், இது வாசகருக்கு அந்த வார்த்தைகளை உதாரணத்துடன் இணைக்க உதவுகிறது.
அட்டவணைகள்
அட்டவணையில் தலைப்புகள் இருந்தால், அவை மேல் பகுதியில் செல்கின்றன:
- ❌
| | |
| -------------- | --------------------------------------- |
| ஆரோக்கியம் | எஞ்சின் நிலை |
| 650 | சேதமடையாத |
| 650-550 | வெள்ளை புகை |
| 550-390 | சாம்பல் புகை |
| 390-250 | கருப்பு புகை |
| < 250 | தீயில் (விநாடிகள் கழித்து வெடிக்கும்) |
- ✔
| ஆரோக்கியம் | எஞ்சின் நிலை |
| -------------- | -------------------------------------- |
| 650 | சேதமடையாத |
| 650-550 | வெள்ளை புகை |
| 550-390 | சாம்பல் புகை |
| 390-250 | கருப்பு புகை |
| < 250 | தீயில் (விநாடிகள் கழித்து வெடிக்கும்) |
SA-MP விக்கியிலிருந்து இடம்பெயர்கிறது
பெரும்பாலான உள்ளடக்கங்கள் நகர்த்தப்பட்டுள்ளன, ஆனால் நீங்கள் ஒரு பக்கத்தைக் காணவில்லை என்றால், உள்ளடக்கத்தை மார்க் டவுனுக்கு மாற்றுவதற்கான ஒரு சிறிய வழிகாட்டி இதோ.
HTML ஐப் பெறுதல்
-
இந்த பொத்தானை கிளிக் செய்யவும்
(Firefox)
(Chrome)
-
பிரதான விக்கி பக்கத்தின் மேல் இடதுபுறம், இடது ஓரத்தில் அல்லது மூலையில்
#content
ஐப் பார்க்கும் வரை வட்டமிடுங்கள்அல்லது தேடுங்கள்
<div id=content>
-
அந்த உறுப்பின் உள் HTML ஐ நகலெடுக்கவும்
இப்போது பக்கத்தின் உண்மையான content க்கான HTML குறியீடு மட்டுமே உள்ளது, நாங்கள் கவலைப்படும் விஷயங்கள், நீங்கள் அதை Markdown ஆக மாற்றலாம்.
HTML ஐ Markdown ஆக மாற்றுகிறது
அடிப்படை HTML ஐ (அட்டவணைகள் இல்லை) மார்க் டவுனுக்கு மாற்றுவதற்கு:
https://mixmark-io.github.io/turndown/
^^ இப்போது கவனியுங்கள் அது மேசையை முழுவதுமாக திருகிவிட்டது...
HTML அட்டவணைகள் முதல் மார்க் டவுன் அட்டவணைகள் வரை
மேலே உள்ள கருவி அட்டவணைகளை ஆதரிக்காததால், இந்த கருவியைப் பயன்படுத்தவும்:
https://jmalarcon.github.io/markdowntables/
மேலும் இதில் <table>
உறுப்பை மட்டும் நகலெடுக்கவும்:
சுத்தம் செய்
மாற்றம் சரியானதாக இருக்காது. எனவே நீங்கள் கைமுறையாக சுத்தம் செய்ய வேண்டும். மேலே பட்டியலிடப்பட்டுள்ள வடிவமைப்பு நீட்டிப்புகள் அதற்கு உதவ வேண்டும், ஆனால் நீங்கள் இன்னும் சிறிது நேரம் கைமுறையாக வேலை செய்ய வேண்டியிருக்கலாம்.
உங்களுக்கு நேரம் இல்லையென்றால், கவலைப்பட வேண்டாம்! முடிக்கப்படாத வரைவைச் சமர்ப்பிக்கவும், நீங்கள் நிறுத்திய இடத்திலிருந்து வேறு யாராவது எடுக்கலாம்!
உரிம ஒப்பந்தத்தின்
அனைத்து open.mp திட்டப்பணிகளும் Contributor License Agreement உள்ளது. இதன் அடிப்படையில், உங்கள் வேலையை நாங்கள் பயன்படுத்துவதற்கு நீங்கள் ஒப்புக்கொள்கிறீர்கள், மேலும் அதை ஒரு திறந்த மூல உரிமத்தின் கீழ் வைக்கவும். நீங்கள் முதன்முறையாக இழுக்கும் கோரிக்கையைத் திறக்கும் போது, CLA-அசிஸ்டண்ட் போட் நீங்கள் ஒப்பந்தத்தில் கையெழுத்திடக்கூடிய இணைப்பை இடுகையிடும்.