Синтаксис элементов страницы
Видимый заголовок
Ссылки на страницы с русскоязычным наименованием смотрятся плохо, поэтому мы стараемся новые страницы называть короткой англоязычной фразой.
Таким страницам нужно назначать видимый заголовок, который будет показан вверху страницы.
Код
{{DISPLAYTITLE: Наименование }}
Перенаправление
Иногда, на страницах может встретиться перенаправление, которое лучше не трогать — это может нарушить связи между страницами.
Перенаправление ставят администраторы Wiki.
Код
#REDIRECT [[название_страницы]]
Включение
Если какой-то текст повторяется в нескольких статьях, то мы выносим его во включения.
В тексте это выглядит так:
{{Wbincludes:Name}}
Включения нужно изменять с большой осторожностью, так как изменение текста в одном месте повлияет на несколько страниц одновременно.
Внутри включения можно использовать теги:
- onlyinclude — будет вставлен текст из этого тега, но он не будет отображаться на странице включения.
<onlyinclude> Этот текст будет включен в другую страницу </onlyinclude>
- noinclude — текст из этого тега будет виден на странице включения, но не будет вставлен в другую страницу.
<noinclude> Этот текст не будет включен в другую страницу </noinclude>
По умолчанию, весь текст на странице включения будет вставлен в другую страницу.
Список включений можно посмотреть на странице с шаблонами.
Ссылка
Внутренняя
Все ссылки на страницы и ресурсы на Wiki оформляем как внутренние:
[[Название страницы]]
[[Название страницы | Отображаемое имя]]
Внешняя
Ссылки на интернет-магазин и внешние ресурсы оформляем как внешние:
[https://wirenboard.com Отображаемое имя]
[https://wirenboard.com/ru/product/WBIO-DI-WD-14/ Купить в интернет-магазине]
Изображение
По умолчанию изображения выравниваются по правому краю:
[[Image: FileName |300px|thumb|right| Подпись ]]
Если нужно показать на изображении определенные шаги, то можно сделать выравнивание по центру:
[[Image: FileName |300px|thumb|none| Подпись ]]
Если изображений много — оформить в виде галереи.
Галерея
Галерея позволяет компактно разместить несколько изображений. При уменьшении ширины экрана они уедут друг под друга.
<gallery mode="traditional " widths ="500px" heights="250px">
Image: FileName1 | Описание
Image: FileName2 | Описание
Image: FileName3 | Описание
</gallery>
Листинг команды
Команда
Команды оформляются с помощью тега syntaxhighlight
, в свойстве lang
указываем bash
.
Код
<syntaxhighlight lang="bash"> apt update </syntaxhighlight>
Результат
apt update
Команда с выводом
Если вы хотите показать вывод, то копировать команды нужно с куском приглашения, без пользователя и имени хоста.
Код
<syntaxhighlight lang="bash"> ~# dpkg -s wb-hwconf-manager |grep Version Version: 1.37.0 </syntaxhighlight>
Результат
~# dpkg -s wb-hwconf-manager |grep Version
Version: 1.37.0
Листинг кода
код
Список языков: https://pygments.org/languages/, для подсветки листинга правил использовать язык ecmascript.
Путь к файлу
В тексте пути к файлу оборачиваем в тег code:
<code>/etc/wb-mqtt-serial.conf</code>
Возведение в степень
Код
4<sup>2</sup>
Результат
42
Предупреждения
Блоки предупреждений формируются с помощью шаблона Шаблон:Note. Синтаксис смотрите на странице шаблона.
Оформлять текст в блоки следует только в крайнем случае, например, если действия пользователя потенциально опасно или может привести к ошибке, которую трудно отловить.
Цитата
<blockquote> Цитата </blockquote>
Таблица
Ниже приведён пример простой таблицы из двух строк, заголовка и семи колонок.
Код
{| border="1" class="wikitable"
! Head1 || Head2 || Head3 || Head4 || Head5 || Head6 || Head7
|-
| Col1 || Col2 || Col3 || Col4 || Col5 || Col6 || Col7
|-
| Col1 || Col2 || Col3 || Col4 || Col5 || Col6 || Col7
|-
|}
Результат
Head1 | Head2 | Head3 | Head4 | Head5 | Head6 | Head7 |
---|---|---|---|---|---|---|
Col1 | Col2 | Col3 | Col4 | Col5 | Col6 | Col7 |
Col1 | Col2 | Col3 | Col4 | Col5 | Col6 | Col7 |
Полезно почитать про синтаксис создания таблиц.