Синтаксис элементов страницы

Как создать новую страницу

Ссылки на страницы с русскоязычным наименованием смотрятся плохо, поэтому мы стараемся новые страницы называть короткой англоязычной фразой.

Чтобы создать страницу, введите в поле поиска название новой страницы и, если такой страницы нет, в результатах поиска будет фраза:

Создать страницу «New Page» в этом вики-проекте!

New Page — это и есть ссылка на создание новой страницы: нажимаете, заполняете, сохраняете.

Если вы совсем не знакомы с Вики-синтаксисом, можете посмотреть живой пример в Статье-песочнице.

Видимое название

Страницам с англоязычным названием нужно назначать видимое название на русском языке, которое будет показано вверху страницы.

Код

{{DISPLAYTITLE: Название }}

Абзацы

Чтобы текст легче читался, его нужно разбивать на абзацы — один абзац, одна мысль.

Чтобы разделить текст на абзацы, добавьте пустую строку между предложениями.

Код

Чтобы текст легче читался, его нужно разбивать на абзацы — один абзац, одна мысль.

Чтобы разделить текст на абзацы, добавьте пустую строку между предложениями.

Заголовки

Первый уровень — это название статьи, оно есть всегда и в теле статьи мы его не используем.

Чтобы страницу было легко читать, мы структурируем её заголовками, начиная со второго уровня.

Текст, выделенный тегом = становится заголовком, количество чёрточек показывает его уровень. Тег парный, поэтому он ставится до и после текста.

Код

== Заголовок второго уровня ==

=== Заголовок третьего уровня ===

==== Заголовок четвёртого уровня ====

Перенаправление

Иногда, на страницах может встретиться перенаправление, которое лучше не трогать — это может нарушить связи между страницами.

Перенаправление ставят администраторы Wiki.

Код

#REDIRECT [[название_страницы]]

Включения (Инклуды)

Как создавать

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

В тексте это выглядит так:

{{Wbincludes:Name}}

Включения нужно изменять с большой осторожностью, так как изменение текста в одном месте повлияет на несколько страниц одновременно.

Внутри включения можно использовать теги:

onlyinclude — будет вставлен текст из этого тега, но он не будет отображаться на странице включения.
```
<onlyinclude> Этот текст будет включен в другую страницу </onlyinclude>
```
noinclude — текст из этого тега будет виден на странице включения, но не будет вставлен в другую страницу.
```
<noinclude> Этот текст не будет включен в другую страницу </noinclude>
```

По умолчанию, весь текст на странице включения будет вставлен в другую страницу.

Список включений можно посмотреть на странице с шаблонами.

Подзаголовки

Так как включение становится полноценной частью страницы, то при клике у подзаголовка на ссылку «Править», можно отредактировать часть включения даже не подозревая об этом.

Чтобы избежать таких ошибок, мы для подзаголовков во включениях используем html-теги h2, h3, h4. У такого подзаголовка пропадает кнопка «Править», что исключает ошибку.

<h2>Подзаголовок во включении</h2>

Выделение текста

Для выделения текста нужно использовать wiki-разметку.

Наклонный текст

''Наклонный текст''

Жирный текст

'''Жирный текст'''

Жирный наклонный текст

'''''Жирный наклонный текст'''''

Списки

Список может быть нумерованным и маркированным, а также иметь вложения любого типа.

Нумерованный

Нумерованный список:

# Первый пункт
# Второй пункт
# Третий пункт

Результат:

Первый пункт
Второй пункт
Третий пункт

Маркированный

Маркированный список:

* Первый пункт
* Второй пункт
* Третий пункт

Результат:

Первый пункт
Второй пункт
Третий пункт

Вложенный

Обычно внутрь нумерованного списка нужно вложить маркированный:

# Первый пункт
#* Первый пункт вложенного
#* Второй пункт вложенного
# Второй пункт
# Третий пункт

Результат:

Первый пункт
- Первый пункт вложенного
- Второй пункт вложенного
Второй пункт
Третий пункт

Ссылка

Внутренняя

Все ссылки на страницы и ресурсы на Wiki оформляем как внутренние:

[[Название страницы]]

[[Название страницы | Отображаемое имя]]

Также можно сослаться на определённый раздел:

[[#Название раздела]]

[[Название страницы#Название раздела | Видимый текст]]

Примеры:

[[Заглавная страница]]

Заглавная страница

[[Заглавная страница | Главная страница Wiki]]

Главная страница Wiki

[[#Списки]]

#Списки

[[Заглавная страница#Диммеры | Раздел «Диммеры» на главной странице]]

Раздел «Диммеры» на главной странице

Внешняя

Ссылки на интернет-магазин и внешние ресурсы оформляем как внешние:

[https://wirenboard.com Отображаемое имя]

Купить в интернет-магазине

Изображение

По умолчанию изображения выравниваем по правому краю:

[[Image: FileName |300px|thumb|right| Подпись ]]

Если нужно показать на изображении определенные шаги, то можно сделать выравнивание по центру:

[[Image: FileName |300px|thumb|none| Подпись ]]

Если изображений много — оформить в виде галереи.

Галерея

Галерея позволяет компактно разместить несколько изображений. При уменьшении ширины экрана они уедут друг под друга.

Можете выбрать один из вариантов ниже: widths и heights — это размеры одного изображения, perrow=4 — это не больше четырёх изображения в ширину, caption — название галереи.

<gallery widths=322px heights=200px perrow=4 caption="Описание">
Image: FileName | 
Image: FileName | 
Image: FileName | 
</gallery>

<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 указываем console.

Код

<syntaxhighlight lang="console">
# dpkg -s wb-hwconf-manager |grep Version
Version: 1.37.0
</syntaxhighlight>

Результат

# dpkg -s wb-hwconf-manager |grep Version
Version: 1.37.0

Скрипт wb-rules

Команды оформляются с помощью тега syntaxhighlight, в свойстве lang указываем ecmascript.

Код

<syntaxhighlight lang="ecmascript">
//Пример скрипта wb-rules
log("test");
</syntaxhighlight>

Результат

//Пример скрипта wb-rules
log("test");

Листинг кода

код

Список языков: https://pygments.org/languages/, для подсветки листинга правил использовать язык ecmascript.

Путь к файлу и команды в тексте

В тексте пути к файлу оборачиваем в тег code:

<code>/etc/wb-mqtt-serial.conf</code>

/etc/wb-mqtt-serial.conf

Горячие клавиши

Горячие клавиши можно выделять тегом kbd:

<kbd>Ctrl</kbd>+<kbd>A</kbd>

Ctrl+A

Возведение в степень

Код

4<sup>2</sup>

Результат

4²

Предупреждения

Блоки предупреждений формируются с помощью шаблона Шаблон: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

Полезно почитать про синтаксис создания таблиц, а ещё можно использовать онлайн-генератор.

Навигация

Синтаксис элементов страницы

Содержание

Как создать новую страницу

Видимое название

Абзацы

Заголовки

Перенаправление

Включения (Инклуды)

Как создавать

Подзаголовки

Выделение текста

Списки

Нумерованный

Маркированный

Вложенный

Ссылка

Внутренняя

Внешняя

Изображение

Галерея

Листинг команды

Команда

Команда с выводом

Скрипт wb-rules

Листинг кода

Путь к файлу и команды в тексте

Горячие клавиши

Возведение в степень

Предупреждения

Цитата

Таблица