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

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

(Различия между версиями)

Текущая версия на 02:53, 17 апреля 2014

Содержание

1 Внешние ссылки
2 Изображения
3 Форматирование исходного кода скриптов
4 Форматирование исходного кода SQL-запросов
5 Ссылки на другие статьи
6 Категории (теги)
7 Оформление страницы модулей и плагинов
8 Указание актуальности статьи номеру версии

Внешние ссылки

Полезные внешние страницы имеют обыкновение становиться недоступными через некоторое время. Для предотращения утери рекомендуется их архивировать сервисом archive.is либо подобным и размещать ссылку в виде (пример): http://archive.is/qcMzV#http://wikiold.bitel.ru/index.php/Работа_с_SQL_в_Java. Ссылка после # позволит сохранить оригинальный URL на случай краха самого archive.is и удалив префикс до # в адресной строке браузера насладиться оригиналом статьи, если он ещё доступен.

Изображения

Удобно для восприятия оформлять следующим образом:

Круглосуточно

Рабочее

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

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

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

Пример:

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

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

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

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

Пример:

SELECT * FROM contract

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

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

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

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

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

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

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

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

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

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

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

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

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

{{Модуль}}

Вот как она выглядит:

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

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

При выкладывании каких-то решений чаще всего они соответствуют какой-то версии системы. При особенно строгом соответствии можно пользоваться шаблоном

{{Актуальность Версии|версия=5.1}}

(с указанием нужной версии), чтобы обратить особое внимание, что на других версиях скорее всего работать не будет, во избежании многочисленных тем на форуме "сделал как wiki, не работает". Вот как выглядит эта плашка:

Внимание! Данное решение/метод/статья относится к версии 5.1 и для других версий может быть неактуальна! Вам нужно самостоятельно поправить решение под свои нужды или воспользоваться помощью на форуме. Будем признательны, если внизу страницы или отдельной статьёй вы разместите исправленное решение для другой версии или подсказки что надо исправить.

@@ Строка 1: / Строка 1: @@
+[[Категория:Помощь]]
+== Внешние ссылки ==
+Полезные внешние страницы имеют обыкновение становиться недоступными через некоторое время. Для предотращения утери рекомендуется их архивировать сервисом [http://archive.is archive.is] либо подобным и размещать ссылку в виде (пример): [http://archive.is/qcMzV#http://wikiold.bitel.ru/index.php/Работа_с_SQL_в_Java http://archive.is/qcMzV#http://wikiold.bitel.ru/index.php/Работа_с_SQL_в_Java]. Ссылка после # позволит сохранить оригинальный URL на случай краха самого archive.is и удалив префикс до # в адресной строке браузера насладиться оригиналом статьи, если он ещё доступен.
+== Изображения ==
+Удобно для восприятия оформлять следующим образом:
+{|
+|- valign=top
+| [[Изображение:time_type_all.png|thumb|300px|Круглосуточно]]
+| [[Изображение:time_type_work.png|thumb|300px|Рабочее]]
+|}
 == Форматирование исходного кода скриптов ==
-Используйте тег source:
+Используйте тег source (только без пробела в конце):
 <source lang="xml">
-<![CDATA[
-<source lang="java"> скрипт </source>
+<source lang="java"> скрипт < /source>
-]]>
 </source>
+Пример:
+<source lang="java">
+check = event.getCheck();
+check.addString( "Приходите ещё" );
+check.addString( "С новым годом!" );
+</source>
+== Форматирование исходного кода SQL-запросов ==
+Здесь также поможет тег source:
+<source lang="xml">
+<source lang="sql"> запрос < /source>
+</source>
+Пример:
+<source lang="sql">
+SELECT * FROM contract
+</source>
+== Ссылки на другие статьи ==
+Общий синтаксис:
+<tt><nowiki>[[Имя_страницы#секция|текст ссылки]]</nowiki></tt>
+Просто на страницу:
+<tt><nowiki>[[Имя_страницы|текст ссылки]]</nowiki></tt> или <tt><nowiki>[[Имя_страницы]]</nowiki></tt>
+Решётка позволяет указать подраздел (секцию) на странице. Если подраздел на той же странице, то название страницы можно опустить:
+<tt><nowiki>[[#секция|текст ссылки]]</nowiki></tt> или <tt><nowiki>[[#секция]]</nowiki></tt>
+== Категории (теги) ==
+Помогают лучше структурировать информацию и разбивать статьи по модулям, например. Категории рисуются внизу страницы (см. ниже категория "Помощь"). Чтобы отнести статью к одной или нескольким категориям, надо добавить в текст статьи одну или несколько записей вида
+<tt><nowiki>[[Категория:Имя категории]]</nowiki></tt>
+Захламлять категории разными похожими категориями не стоит, предпочтительнее брать готовые категории, список существующих категорий можно посмотреть здесь: [[Служебная:Categories]]
+== Оформление страницы модулей и плагинов ==
+Для каждой главной страницы модулей и плагинов внизу полезно добавить табличку со всеми модулями и плагинами. Это делается вставкой внизу страницы кода:
+<tt><nowiki>{{Модуль}}</nowiki></tt>
+Вот как она выглядит:{{Модуль}}
+При добавлении нового модуля администраторам wiki необходимо добавить новые записи в этот шаблон "Модуль", через его редактирование.
+== Указание актуальности статьи номеру версии ==
+При выкладывании каких-то решений чаще всего они соответствуют какой-то версии системы. При особенно строгом соответствии можно пользоваться шаблоном
+<tt><nowiki>{{Актуальность Версии|версия=5.1}}</nowiki></tt>
+(с указанием нужной версии), чтобы обратить особое внимание, что на других версиях скорее всего работать не будет, во избежании многочисленных тем на форуме "сделал как wiki, не работает". Вот как выглядит эта плашка:
+{{Актуальность Версии|версия=5.1}}