Skip to content

Docs: hedit macros, help formatting

Kit Oliynyk edited this page Oct 14, 2021 · 1 revision

Когда-то давно для написания статей справки был добавлен нехитрый синтаксис, чтобы сократить часто повторяющиеся элементы.

Форматирование текста

  • *текст* - жирный текст, выделенный коричневым. То же, что {yтекст{w
  • _текст_ - темный текст. То же, что {Dтекст{w
  • =текст= - синий текст заголовка, превращается в {cтекст{w
  • (eng,рус) - в зависимости от настроек персонажа config rucommand, он увидит или eng или рус. То же, что написать {lEeng{lRрус{lx
  • [статья] - ссылки на другие статьи справки выделятся ярко-белым ({Wстатья{x), а в веб-клиенте превратятся в гипер-ссылку: {W{hhстатья{x

Ключевые слова

Ключевые слова, заключенные между % %, заменяются на такие строки:

%СЛОВО% Превращается в
H, HELP {W{lEhelp{lRсправка{lx{w
SA, SEEALSO См. также
U, USAGE Использование
FMT {wФормат:{w
FFF {w(7 пробелов){w
CMD название команды по-русски или по-английски
SKILL название умения по-русски или по-английски
SPELL название заклинания по-русски или по-английски
PAUSE stops help tag parsing
RESUME resumes help tag parsing
A *
CAST {lEcast{lRколдовать{lx
OBJ предмет
CHAR персонаж
PLR игрок
MOB монстр
VICT жертва
DIR направление
YES, NO {lRда{lEyes{lx, {lRнет{lEno{lx
ALL {lRвсе{lEall{lx
SHOW {lRпоказ{lEshow{lx
ON {lRвкл{lEon{lx
OFF {lRвыкл{lEoff{lx

Примеры

Внутри справки по команде throw эта строка

%FMT%  *%CMD%* _копье_ _%DIR%_ _%VICT%_

превратится в

Формат: {yметнуть {Dкопье направление жертва{x

или, если выключен config rucommand:

Формат: {ythrow {Dкопье направление жертва{x

Типичная ссылка на другие статьи справки в конце статьи:

%SA% %H% [(title,титул)]

в зависимости от настроек языка, превратится в:

См. также {W{hhhelp title{x

или

См. также {W?{hhтитул{x