Оформление статей

Материал из BiTel WiKi

Форматирование исходного кода скриптов

Используйте тег source (только без пробела в конце):

<source lang="java"> скрипт < /source>

Пример:

check = event.getCheck();
 
check.addString( "Приходите ещё" );
check.addString( "С новым годом!" );

Форматирование исходного кода SQL-запросов

Здесь также поможет тег source:

<source lang="sql"> запрос < /source>

Пример:

SELECT * FROM contract

Ссылки на другие статьи

Общий синтаксис:

[[Имя_страницы#секция|текст ссылки]]

Просто на страницу:

[[Имя_страницы|текст ссылки]] или [[Имя_страницы]]

Решётка позволяет указать подраздел (секцию) на странице. Если подраздел на той же странице, то название страницы можно опустить:

[[#секция|текст ссылки]] или [[#секция]]

Категории (теги)

Помогают лучше структурировать информацию и разбивать статьи по модулям, например. Категории рисуются внизу страницы (см. ниже категория "Помощь"). Чтобы отнести статью к одной или нескольким категориям, надо добавить в текст статьи одну или несколько записей вида

[[Категория:Имя категории]]

Захламлять категории разными похожими категориями не стоит, предпочтительнее брать готовые категории, список существующих категорий можно посмотреть здесь: Служебная:Categories

Оформление страницы модулей и плагинов

Для каждой главной страницы модулей и плагинов внизу полезно добавить табличку со всеми модулями и плагинами. Это делается вставкой внизу страницы кода:

{{Модуль}}

При добавлении нового модуля администраторам wiki необходимо добавить новые записи в этот шаблон "Модуль", через его редактирование.

Указание актуальности статьи номеру версии

При выкладывании каких-то решений чаще всего они соответствуют какой-то версии системы. При особенно строгом соответствии можно пользоваться шаблоном {{Актуальность Версии}}, чтобы обратить особое внимание, что на других версиях скорее всего работать не будет, во избежании многочисленных тем на форуме "сделал как wiki, не работает". Вот как выглядит эта плашка: