Допринеси
Овај извор документације је отворен за свакога ко жели да допринесе променама! Све што вам је потребно је GitHub налог и мало слободног времена. Чак не морате ни да знате Git, све можете да урадите преко веб интерфејса!
Ако желите да помогнете у одржавању одређеног језика, отворите PR над CODEOWNERS фајлом и додајте ред за директоријум вашег језика са вашим корисничким именом.
Измена садржаја
На свакој страници постоји дугме које вас води до GitHub странице за уређивање:
На пример, кликом на ово на SetVehicleAngularVelocity води вас до ове странице на којој можете да направите измене у фајлу (под условом да сте пријављени на GitHub).
Извршите своје измене и поднесите "Pull Request", што значи да ће администратори викија и остали чланови заједнице моћи да прегледају вашу промену, расправљају о томе да ли су потребне додатне промене и затим споје вашу измену.
Додавање новог садржаја
Додавање новог садржаја је мало захтевно. То можете урадити на 2 начина:
Гитхуб интерфејс
Када прегледате директоријум на GitHub-у, у горњем десном углу листе фајлова налази се дугме „Add file“ (Додај фајл).
Можете или да отпремите већ написан Markdown фајл или да га директно напишете у GitHub текстуалном уређивачу.
Фајл мора имати екстензију .md и мора да садржи Markdown. За више информација о Markdown-у погледајте овај водич.
Once that's done, hit "Propose new file" and a Pull Request will be opened for review.
Гит
Ако желите да користите Git, све што треба да урадите је да клонирате Wiki репозиторијум помоћу:
git clone https://github.com/openmultiplayer/wiki.git
Отворите га у свом омиљеном уређивачу. Препоручујем Visual Studio Code, јер пружа одличне алате за уређивање и форматирање Markdown фајлова. Као што можете видети, пишем ово у Visual Studio Code-у!
Препоручујем два додатка како бисте побољшали своје искуство:
- markdownlintод David Anson-а - овај додатак осигурава да је ваш Markdown исправно форматиран. Спречава одређене синтаксичке и семантичке грешке. Нису сва упозорења важна, али нека могу побољшати читљивост. Користите најбољу процену, а ако нисте сигурни, консултујте рецензента!
- Prettier од Prettier.js тима - ово је форматер који аутоматски форматира ваш Markdown тако да сви фајлови користе доследан стил. Wiki репозиторијум има одређена подешавања у свом
package.json, која би додатак требало аутоматски да примени. Обавезно омогућите опцију „Format On Save“ (Форматирање при чувању) у подешавањима уређивача, како би ваши Markdown фајлови били аутоматски форматирани сваки пут када их сачувате!
Белешке, савети и конвенције
Интерни линкови
Не користите апсолутне URL-ове за линкове унутар сајта. Користите релативне путеве.
-
❌
Користи се са [OnPlayerClickPlayer](https://www.open.mp/docs/scripting/callbacks/OnPlayerClickPlayer) -
✔
Користи се са [OnPlayerClickPlayer](../callbacks/OnPlayerClickPlayer)
../ значи „иди један директоријум горе“, па ако је фајл који уређујете унутар директоријума functions, а линкујете ка callbacks, користите ../ да се вратите на scripting/, затим callbacks/ да уђете у директоријум callbacks, а затим име фајла (без .md) за callback који желите да линкујете.
Слике
Слике се смештају у поддиректоријум унутар /static/images. Када линкујете слику помоћу ![](), користите /images/ као основни пут (без static, јер је то само за репозиторијум).
Ако нисте сигурни, погледајте неку другу страницу која користи слике и копирајте како је то тамо урађено.
Metadata
Метадата
Прва ствар у било ком документу овде треба да буду метаподаци:
---
title: Моја документација
sidebar_label: Моја документација
description: Ово је страна о стварима и стварчицама и бургерима, јупи!
---
Свака страна треба да укључује наслов и опис.
За комплетну листу онога што може ићи између ---, проверите документацију за Докусорус.
Наслови
Немојте креирати наслов нивоа 1 (<h1>) са #, јер се он аутоматски генерише. Ваш први наслов треба увек да буде ##.
-
❌
# Мој наслов
Ово је документација за ...
# Подсекција -
✔
Ово је документација за ...
## Подсекција
Користите Code за техничке референце
Када пишете пасус који садржи имена функција, бројеве, изразе или било шта што није стандардни писани језик, окружите их са `обратним апострофима`. Ово олакшава раздвајање описног језика од техничких елемената као што су имена функција и делови кода.
-
❌
Функција fopen ће вратити вредност са ознаком типа File:, нема проблема на тој линији јер се вредност чува у променљивој такође са ознаком File: (приметите да су случајеви исти). Међутим, на следећој линији се вредности 4 додаје хендлу фајла. 4 нема ознаку [...]
-
✔
Функција
fopenће вратити вредност са ознаком типаFile:, нема проблема на тој линији јер се вредност чува у променљивој такође са ознакомFile: (приметите да су случајеви исти). Међутим, на следећој линији се вредности4додаје хендлу фајла.4нема ознаку.
У горњем примеру, fopen је име функције, а не енглеска реч, па њено окружење са code маркерима помаже у разликовању од другог садржаја.
Такође, ако се пасус односи на блок пример кода, ово помаже читаоцу да повезује речи са примером.
Табеле
Ако табела има наслове, они иду у горњи део:
-
❌
| | |
| ------- | ------------------------------------ |
| Health | Engine Status |
| 650 | Undamaged |
| 650-550 | White Smoke |
| 550-390 | Grey Smoke |
| 390-250 | Black Smoke |
| < 250 | On fire (will explode seconds later) | -
✔
| Health | Engine Status |
| ------- | ------------------------------------ |
| 650 | Undamaged |
| 650-550 | White Smoke |
| 550-390 | Grey Smoke |
| 390-250 | Black Smoke |
| < 250 | On fire (will explode seconds later) |
Миграција са SA-MP Wiki
Већина садржаја је премештена, али ако наиђете на страну која недостаје, ево кратког водича за конвертовање садржаја у Markdown.
Добијање HTML-а
-
Кликните ово дугме:
(Firefox)
(Chrome)
-
Пређите мишем преко горњег левог дела главне wiki стране, у левом маргину или углу, док не видите
#content.
Или претражите
<div id=content>
-
Copy the inner HTML of that element
Сада имате само HTML код за стварни садржај странице, што је оно што нам је потребно, и можете га конвертовати у Markdown.
Конвертовање HTML-а у Markdown
За конвертовање основног HTML-а (без табела) у Markdown користите:
https://mixmark-io.github.io/turndown/
^^ Обратите пажњу како је погрешно конвертовао табелу...
HTML табеле у Markdown табеле
Пошто горњи алат не подржава табеле, користите овај алат:
https://jmalarcon.github.io/markdowntables/
И копирајте само <table> елемент:
Чишћење
Конверзија вероватно неће бити савршена. Мораћете ручно да исправљате неке детаље. Екстензије за форматирање поменуте изнад могу помоћи у томе, али можда ће ипак бити потребно уложити мало труда.
Ако немате времена, нема везе! Поднесите незавршен нацрт, па ће неко други наставити где сте стали!
Уговор о лиценцирању
Сви open.mp пројекти имају Споразум о лиценцирању доприноса. Ово углавном значи да пристајете да ми користимо ваш рад и ставимо га под лиценцу отвореног кода. Када први пут отворите Pull Request, CLA-Assistant бот ће објавити линк где можете потписати споразум.