-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add chapters of keywords etc. to language part (#27)
Closes: #26
- Loading branch information
1 parent
74aec89
commit f33fd8b
Showing
12 changed files
with
4,899 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
authors: | ||
- alex | ||
tags: | ||
- документация | ||
- syntax | ||
- синтаксис | ||
- язык QSP | ||
--- | ||
# Ключевые слова, системные переменные и спецсимволы QSP | ||
|
||
Поскольку этот раздел был практически полностью написан мной в другом проекте, я решил слегка его отредактировать и перенести сюда. | ||
|
||
[Это раздел](../../../../docs/language/qsp-keywords/), в котором собраны все операторы, функции, системные переменные, а так же спецсимволы и синтаксемы языка QSP. | ||
|
||
:::warning[Важно помнить:] | ||
Раздел охватывает полностью ключевые слова и т.д. для версий плееров 5.8.0, и частично затрагивает плееры версии 5.9.0. А значит, в будущем требует дополнения. | ||
::: | ||
|
||
В процессе работы над разделом, я выяснил, что редактировать документацию удобнее всего, используя Обсидиан, благодаря тому, что обсидиан сам следит за правильностью всех созданных в проекте ссылок при перемещении или переименовании статей и разделов. | ||
|
||
Чтобы комфотно работать в Обсидиане и не терять функциональность ссылок в Докузаурус, необходимо следовать некоторым правилам: | ||
|
||
- Имена файлов должны начинаться с буквы, но ни в коем случае не с цифры. | ||
:::note[Потому что:] | ||
Докузаурус опускает числа в начале имён файлов. Из-за этого ссылки валидные в Обсидиане не будут работать в Докузаурусе. (Соответственно порядок размещения статей должен определяться через поле `sidebar_position` в yml-заголовке документа). | ||
::: | ||
- Необходимо смириться с тем, что ссылки на `index.md` раздела не будут работать в докузаурусе, либо, если их "обрезать" для докузауруса, не будут работать в обсидиане. Лучше избегать создания разделов `index.md` для комфортной работы и там и там. | ||
- Ссылки на файлы статей должны быть относительными (чтобы работать и там и там), и включать так же расширение файлов (`.md`). | ||
`../language/qsp-keywords/qsp-keywords-functions.md` | ||
:::note[Потому что:] | ||
Докузаурус опускает расширение `.md` в ссылках и таким образом в процессе работы ссылки поддерживаются и в обсидиане и в докузаурусе. После сборки ссылки во всех статьях приобретают вид валидный для докузауруса, но невалидный для Обсидиана. | ||
`https://dev.qsp.org/docs/language/qsp-keywords/qsp-keyword-operators` | ||
::: | ||
- Необходимо смириться с тем, что обсидиан не поддерживает те же якоря заголовков, что и докузаурус, из-за чего сослаться на заголовок в обсидиане так же как в докузаурусе невозможно. Это не мешает обсидиану поддерживать такие ссылки при изменении местоположения статей и разделов. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Язык QSP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
position: 99 | ||
label: Зарезервированные слова, системные переменные, спецсимволы |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,175 @@ | ||
--- | ||
sidebar_position: 6 | ||
--- | ||
|
||
# Указатель | ||
|
||
:::warning[Внимание!] | ||
Вычеркнутые команды не работают в плеерах версии 5.8.0 и выше. | ||
::: | ||
|
||
- [Неявный оператор](qsp-keyword-operators#неявный-оператор) | ||
- [`!` (комментарий)](qsp-keyword-operators.md#-комментарий) | ||
- [`!` (не равно)](qsp-keyword-operacion.md#-не-равно-1) | ||
- [`&` (конкатенация)](qsp-keyword-operacion.md#-конкатенация) | ||
- [`&` (перечисление команд)](qsp-keyword-syntaxems.md#амперсанд-) | ||
- [`:` (метки)](qsp-keyword-syntaxems.md#метки-) | ||
- [`,` (разделитель аргументов)](qsp-keyword-syntaxems.md#запятая-) | ||
- [`""` (кавычки)](qsp-keyword-syntaxems.md#кавычка-) | ||
- [`''` (апострофы)](qsp-keyword-syntaxems.md#апостроф-) | ||
- [`{}` (Фигурные скобки)](qsp-keyword-syntaxems.md#фигурные-скобки-) | ||
- [`()` (круглые скобки)](qsp-keyword-syntaxems.md#круглые-скобки-) | ||
- [`[]` (квадратные скобки)](qsp-keyword-syntaxems.md#квадратные-скобки-) | ||
- [`@` (коммерческое "эт")](qsp-keyword-syntaxems#%D1%81%D0%B8%D0%BC%D0%B2%D0%BE%D0%BB-%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D1%80%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B5-%D1%8D%D1%82-) | ||
- [`$` (знак доллара)](qsp-keyword-syntaxems#%D1%81%D0%B8%D0%BC%D0%B2%D0%BE%D0%BB-%D0%B7%D0%BD%D0%B0%D0%BA-%D0%B4%D0%BE%D0%BB%D0%BB%D0%B0%D1%80%D0%B0-) | ||
- [`%` (знак процента)](qsp-keyword-syntaxems#%D1%81%D0%B8%D0%BC%D0%B2%D0%BE%D0%BB-%D0%B7%D0%BD%D0%B0%D0%BA-%D0%BF%D1%80%D0%BE%D1%86%D0%B5%D0%BD%D1%82%D0%B0-) | ||
- [`*`](qsp-keyword-operacion.md#-умножение) | ||
- [`*=`](qsp-keyword-operacion.md#-умножение-присвоение) | ||
- [`+`](qsp-keyword-operacion.md#-сложение) | ||
- [`+=`](qsp-keyword-operacion.md#-сложение-присвоение) | ||
- ~~[`+` (унарный)](qsp-keyword-operacion.md#--унарный-минус)~~ | ||
- [`-`](qsp-keyword-operacion.md#--вычитание) | ||
- [`-=`](qsp-keyword-operacion.md#--вычитание-присвоение) | ||
- [`-` (унарный)](qsp-keyword-operacion.md#--унарный-минус) | ||
- [`/`](qsp-keyword-operacion.md#-деление) | ||
- [`/=`](qsp-keyword-operacion.md#-деление-присвоение) | ||
- [`<`](qsp-keyword-operacion.md#-меньше) | ||
- [`<=`](qsp-keyword-operacion.md#-меньше-либо-равно) | ||
- [`<>`](qsp-keyword-operacion.md#-не-равно) | ||
- [`=` (равно)](qsp-keyword-operacion.md#-равно) | ||
- [`=` (присвоение)](qsp-keyword-operacion.md#-присвоение) | ||
- [`=<`](qsp-keyword-operacion.md#-равно-либо-меньше) | ||
- [`=>`](qsp-keyword-operacion.md#-равно-или-больше) | ||
- [`>`](qsp-keyword-operacion.md#-больше) | ||
- [`>=`](qsp-keyword-operacion.md#-больше-либо-равно) | ||
- [`ACT`](qsp-keyword-operators.md#act) | ||
- ~~[`ADDLIB`](qsp-keyword-operators.md#inclib)~~ | ||
- [`ADDOBJ`](qsp-keyword-operators.md#addobj) | ||
- ~~[`ADDQST`](qsp-keyword-operators.md#inclib)~~ | ||
- [`AND`](qsp-keyword-operacion.md#and) | ||
- [`ARGS`](qsp-keyword-sys-var.md#args) | ||
- [`ARRCOMP`](qsp-keyword-functions.md#arrcomp) | ||
- [`ARRITEM`](qsp-keyword-functions.md#arritem) | ||
- [`ARRPOS`](qsp-keyword-functions.md#arrpos) | ||
- [`ARRSIZE`](qsp-keyword-functions.md#arrsize) | ||
- [`$BACKIMAGE`](qsp-keyword-sys-var.md#backimage) | ||
- [`BCOLOR`](qsp-keyword-sys-var.md#bcolor) | ||
- [`CLA`](qsp-keyword-operators.md#cla) | ||
- [`CLEAR`](qsp-keyword-operators.md#clear-1) | ||
- [`*CLEAR`](qsp-keyword-operators.md#clear) | ||
- [`CLOSE`](qsp-keyword-operators.md#close) | ||
- [`CLOSE ALL`](qsp-keyword-operators.md#close-all) | ||
- [`CLR`](qsp-keyword-operators.md#clear-1) | ||
- [`*CLR`](qsp-keyword-operators.md#clear) | ||
- [`CLS`](qsp-keyword-operators.md#cls) | ||
- [`CMDCLEAR`](qsp-keyword-operators.md#cmdclear) | ||
- [`CMDCLR`](qsp-keyword-operators.md#cmdclear) | ||
- [`COPYARR`](qsp-keyword-operators.md#copyarr) | ||
- [`$COUNTER`](qsp-keyword-sys-var.md#counter) | ||
- [`COUNTOBJ`](qsp-keyword-functions.md#countobj) | ||
- [`$CURACTS`](qsp-keyword-functions.md#curacts) | ||
- [`$CURLOC`](qsp-keyword-functions.md#curloc) | ||
- [`DEBUG`](qsp-keyword-sys-var.md#debug) | ||
- [`DELACT`](qsp-keyword-operators.md#delact) | ||
- ~~[`DELLIB`](qsp-keyword-operators.md#freelib)~~ | ||
- [`DELOBJ`](qsp-keyword-operators.md#delobj) | ||
- [`$DESC`](qsp-keyword-functions.md#desc) | ||
- [`DISABLESCROLL`](qsp-keyword-sys-var.md#disablescroll) | ||
- ~~[`DISABLESUBEX`](qsp-keyword-sys-var.md#disablesubex)~~ | ||
- [`DYNAMIC`](qsp-keyword-operators.md#dynamic) | ||
- [`DYNEVAL`](qsp-keyword-functions.md#dyneval) | ||
- [`ELSE`](qsp-keyword-operators.md#if-else-elseif) | ||
- [`ELSEIF`](qsp-keyword-operators.md#if-else-elseif) | ||
- [`END`](qsp-keyword-syntaxems.md#end) | ||
- [`EXIT`](qsp-keyword-operators.md#exit) | ||
- [`FCOLOR`](qsp-keyword-sys-var.md#fcolor) | ||
- [`$FNAME`](qsp-keyword-sys-var.md#fname) | ||
- [`FREELIB`](qsp-keyword-operators.md#freelib) | ||
- [`FSIZE`](qsp-keyword-sys-var.md#fsize) | ||
- [`FUNC`](qsp-keyword-functions.md#func) | ||
- [`$GETOBJ`](qsp-keyword-functions.md#getobj) | ||
- [`GOSUB`](qsp-keyword-operators.md#gosub) | ||
- [`GOTO`](qsp-keyword-operators.md#goto) | ||
- [`GS`](qsp-keyword-operators.md#gosub) | ||
- [`GT`](qsp-keyword-operators.md#goto) | ||
- [`IF`](qsp-keyword-operators.md#if-else-elseif) | ||
- [`IIF`](qsp-keyword-functions.md#iif) | ||
- [`INCLIB`](qsp-keyword-operators.md#inclib) | ||
- [`$INPUT`](qsp-keyword-functions.md#input) | ||
- [`INSTR`](qsp-keyword-functions.md#instr) | ||
- [`ISNUM`](qsp-keyword-functions.md#isnum) | ||
- [`ISPLAY`](qsp-keyword-functions.md#isplay) | ||
- [`JUMP`](qsp-keyword-operators.md#jump) | ||
- [`KILLALL`](qsp-keyword-operators.md#killall) | ||
- [`KILLOBJ`](qsp-keyword-operators.md#killobj) | ||
- ~~[`KILLQST`](qsp-keyword-operators.md#freelib)~~ | ||
- [`KILLVAR`](qsp-keyword-operators.md#killvar) | ||
- [`$LCASE`](qsp-keyword-functions.md#lcase) | ||
- [`LCOLOR`](qsp-keyword-sys-var.md#lcolor) | ||
- [`LEN`](qsp-keyword-functions.md#len) | ||
- [`LET`](qsp-keyword-operators.md#let) | ||
- [`LOC`](qsp-keyword-operacion.md#loc) | ||
- [`LOCAL`](qsp-keyword-operators.md#local) | ||
- [`LOOP`](qsp-keyword-operators.md#loop) | ||
- [`$MAINTXT`](qsp-keyword-functions.md#maintxt) | ||
- [`MAX`](qsp-keyword-functions.md#max) | ||
- [`MENU`](qsp-keyword-operators.md#menu) | ||
- [`$MID`](qsp-keyword-functions.md#mid) | ||
- [`MIN`](qsp-keyword-functions.md#min) | ||
- [`MOD`](qsp-keyword-operacion.md#mod) | ||
- [`MSECSCOUNT`](qsp-keyword-functions.md#msecscount) | ||
- [`MSG`](qsp-keyword-operators.md#msg) | ||
- [`NL`](qsp-keyword-operators.md#nl-1) | ||
- [`*NL`](qsp-keyword-operators.md#nl) | ||
- [`NO`](qsp-keyword-operacion.md#no) | ||
- [`NOSAVE`](qsp-keyword-sys-var.md#nosave) | ||
- [`OBJ`](qsp-keyword-operacion.md#obj) | ||
- [`$ONACTSEL`](qsp-keyword-sys-var.md#onactsel) | ||
- [`$ONGLOAD`](qsp-keyword-sys-var.md#ongload) | ||
- [`$ONGSAVE`](qsp-keyword-sys-var.md#ongsave) | ||
- [`$ONNEWLOC`](qsp-keyword-sys-var.md#onnewloc) | ||
- [`$ONOBJADD`](qsp-keyword-sys-var.md#onobjadd) | ||
- [`$ONOBJDEL`](qsp-keyword-sys-var.md#onobjdel) | ||
- [`$ONOBJSEL`](qsp-keyword-sys-var.md#onobjsel) | ||
- [`OPENGAME`](qsp-keyword-operators.md#opengame) | ||
- [`OPENQST`](qsp-keyword-operators.md#openqst) | ||
- [`OR`](qsp-keyword-operacion.md#or) | ||
- [`P`](qsp-keyword-operators.md#p-1) | ||
- [`*P`](qsp-keyword-operators.md#p) | ||
- [`PL`](qsp-keyword-operators.md#pl-1) | ||
- [`*PL`](qsp-keyword-operators.md#pl) | ||
- [`PLAY`](qsp-keyword-operators.md#play) | ||
- [`$QSPVER`](qsp-keyword-functions.md#qspver) | ||
- [`RAND`](qsp-keyword-functions.md#rand) | ||
- [`REFINT`](qsp-keyword-operators.md#refint) | ||
- [`$REPLACE`](qsp-keyword-functions.md#replace) | ||
- [`RESULT`](qsp-keyword-sys-var.md#result) | ||
- [`RGB`](qsp-keyword-functions.md#rgb) | ||
- [`RND`](qsp-keyword-functions.md#rnd) | ||
- [`SAVEGAME`](qsp-keyword-operators.md#savegame) | ||
- [`$SELACT`](qsp-keyword-functions.md#selact) | ||
- [`$SELOBJ`](qsp-keyword-functions.md#selobj) | ||
- [`SET`](qsp-keyword-operators.md#set) | ||
- [`SETTIMER`](qsp-keyword-operators.md#settimer) | ||
- [`SHOWACTS`](qsp-keyword-operators.md#showacts) | ||
- [`SHOWINPUT`](qsp-keyword-operators.md#showinput) | ||
- [`SHOWOBJS`](qsp-keyword-operators.md#showobjs) | ||
- [`SHOWSTAT`](qsp-keyword-operators.md#showstat) | ||
- [`$STATTXT`](qsp-keyword-functions.md#stattxt) | ||
- [`$STR`](qsp-keyword-functions.md#str) | ||
- [`STRCOMP`](qsp-keyword-functions.md#strcomp) | ||
- [`$STRFIND`](qsp-keyword-functions.md#strfind) | ||
- [`STRPOS`](qsp-keyword-functions.md#strpos) | ||
- [`$TRIM`](qsp-keyword-functions.md#trim) | ||
- [`$UCASE`](qsp-keyword-functions.md#ucase) | ||
- [`UNSEL`](qsp-keyword-operators.md#unselect) | ||
- [`UNSELECT`](qsp-keyword-operators.md#unselect) | ||
- [`USEHTML`](qsp-keyword-sys-var.md#usehtml) | ||
- [`$USERCOM`](qsp-keyword-sys-var.md#usercom) | ||
- [`$USER_TEXT`](qsp-keyword-functions.md#user_text) | ||
- [`$USRTXT`](qsp-keyword-functions.md#user_text) | ||
- [`VAL`](qsp-keyword-functions.md#val) | ||
- [`VIEW`](qsp-keyword-operators.md#view) | ||
- [`WAIT`](qsp-keyword-operators.md#wait) | ||
- [`XGOTO`](qsp-keyword-operators.md#xgoto) | ||
- [`XGT`](qsp-keyword-operators.md#xgoto) |
Oops, something went wrong.