Syntax: различия между версиями

Материал из Wiren Board
(не показано 45 промежуточных версий этого же участника)
Строка 1: Строка 1:
{{DISPLAYTITLE: Справочник по синтаксису}}
{{DISPLAYTITLE: Синтаксис элементов страницы}}


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


Чтобы создать страницу, введите в поле поиска название новой страницы и, если такой страницы нет, в результатах поиска будет фраза:
Таким страницам нужно назначать видимое название на русском языке, которое будет показано вверху страницы.
<pre>
Создать страницу «New Page» в этом вики-проекте!
</pre>
 
<span class="text-red">New Page</span> — это и есть ссылка на создание новой страницы: нажимаете, заполняете, сохраняете.
 
Если вы совсем не знакомы с Вики-синтаксисом, можете посмотреть живой пример в [[Sandbox | Статье-песочнице]].
 
== Видимое название ==
Страницам с англоязычным названием нужно назначать видимое название на русском языке, которое будет показано вверху страницы.


'''Код'''
'''Код'''
Строка 60: Строка 50:
</pre>
</pre>


== Включения (Инклуды) ==
== Включение ==
=== Как создавать ===
Если какой-то текст повторяется в нескольких статьях, то мы выносим его во включения.
Если какой-то текст повторяется в нескольких статьях, то мы выносим его во включения.


Строка 69: Строка 58:
</pre>
</pre>


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


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


Список включений можно посмотреть на [[Список_шаблонов | странице с шаблонами]].
Список включений можно посмотреть на [[Список_шаблонов | странице с шаблонами]].
=== Подзаголовки ===
Так как включение становится полноценной частью страницы, то при клике у подзаголовка на ссылку «Править», можно отредактировать часть включения даже не подозревая об этом.
Чтобы избежать таких ошибок, мы для подзаголовков во включениях используем html-теги <code>h2, h3, h4</code>. У такого подзаголовка пропадает кнопка «Править», что исключает ошибку.
<syntaxhighlight lang="html">
<h2>Подзаголовок во включении</h2>
</syntaxhighlight>


== Выделение текста ==
== Выделение текста ==
Строка 153: Строка 133:
#* Второй пункт вложенного
#* Второй пункт вложенного
# Второй пункт
# Второй пункт
# Третий пункт
=== Пункт из нескольких строчек ===
Иногда бывает так, что один пункт нужно разбить на несколько строчек, например, привести какой-то код, или добавить картинку.
Чтобы такое провернуть, добавьте в начало строки символ <code>#:</code>:
<pre>
# Первый пункт
#: Вторая строка первого пункта
#: Третья строка первого пункта
# Второй пункт
#: [[Image: FileName.png |300px| Картинка в списке ]]
# Третий пункт
</pre>
Результат:
# Первый пункт
#: Вторая строка первого пункта
#: Третья строка первого пункта
# Второй пункт, картинка:
#: [[Image: FileName.png |300px| Картинка в списке ]]
# Третий пункт
# Третий пункт


Строка 195: Строка 154:
[[Название страницы#Название раздела | Видимый текст]]
[[Название страницы#Название раздела | Видимый текст]]
</pre>
</pre>
Но лучше добавить в страницу якорь и сослаться на него, так в случае, если заголовок раздела будет переименован, то ссылка не сломается:
# Добавляем якорь:
#:<pre>{{Anchor|anchor-name}}</pre>
# Ссылаемся на этот якорь по аналогии с заголовком:
#:<pre>[[#anchor-name]]</pre>


'''Примеры:'''
'''Примеры:'''
Строка 230: Строка 183:


== Изображение ==
== Изображение ==
=== Как загрузить новое изображение ===
По умолчанию изображения выравниваем по правому краю:
[[Image: FileName.png |300px|thumb|right| Изображение с выравниванием по правому краю]]
Чтобы ссылки на файлы смотрелись хорошо, давайте файлам имена латиницей.
 
Для добавления нового изображения, просто вставьте один из примеров ниже в текст страницы и нажмите '''Предпросмотр'''. После на странице появится ссылка на добавление нового файла. Нажмите на ссылку, откроется окно, где можно выбрать файл изображения.
 
[[Image: Add new file link.png |372px| Так выглядит ссылка на добавление нового файла]]
 
=== Примеры ===
По умолчанию изображения добавляем с выравниванием по левому краю, такое выравнивание особенно хорошо смотрится в списках:
<pre>
[[Image: FileName.png |300px| Подпись ]]
</pre>
[[Image: FileName.png |300px| Изображение в тексте по левому краю]]
 
Ещё есть выравнивание центру, так хорошо смотрятся большие изображения в абзаце:
<pre>
<pre>
[[Image: FileName.png |500px|center| Подпись ]]
[[Image: FileName |300px|thumb|right| Подпись ]]
</pre>
</pre>


[[Image: FileName.png |500px|center| Изображение в тексте по центру]]
Если нужно показать на изображении определенные шаги, то можно сделать выравнивание по центру:
 
Главное изображение страницы или раздела можно выровнять по правому краю:
<pre>
<pre>
[[Image: FileName.png |300px|thumb|right| Подпись ]]
[[Image: FileName |300px|thumb|none| Подпись ]]
</pre>
</pre>


Из-за перехода на новую тему мы глобально ограничили ширину боковых изображений 300px. Поэтому для всех новых боковых изображений указывайте ширину не больше 300px.
Если изображений много — оформить в виде [[#Галерея | галереи]].
 
Советы:
# Если изображений много — оформить в виде [[#Галерея | галереи]].
# Не злоупотребляйте боковыми картинками — они плохо сочетаются с таблицами и небольшим количеством текста, оставляя дыры рядом с собой. Руководствуйтесь здравым смыслом и убирайте выравнивание по правому краю там, где это выглядит плохо.
# Если вы выбрали вариант изображения без рамки и подписи, то подпись в коде лучше добавить — она станет всплывающей подсказкой и попадёт в тег <code>alt</code>, который отобразится на странице, если картинка вдруг не загрузится.
# При масштабировании изображения может случиться так, что оно начнёт «мылить». В этом нет ничего страшного, особенно, если изображение большое и без масштабирования будет смотреться плохо, но есть ряд ситуаций, в которых этого можно избежать: изображение шириной 350 px, а мы уменьшаем его до 200px — почти всегда такое изображение можно разместить в полный рост:
#:[[Image: FileName_alt.png |250px| Из-за неверного выбора размера изображение «мылит» ]]
#:[[Image: FileName_alt.png |342px| Изображение чёткое — размер подобран верно]]


== Галерея ==
== Галерея ==
Галерея позволяет компактно разместить несколько изображений. При уменьшении ширины экрана они уедут друг под друга.
Галерея позволяет компактно разместить несколько изображений. При уменьшении ширины экрана они уедут друг под друга.
 
В зависимости от задачи, используйте один из вариантов ниже.
 
Общие атрибуты:
* <code>widths</code> и <code>heights</code> — это размеры одного изображения
* <code>perrow=4</code> — это не больше четырёх изображения в ширину,
* <code>caption</code> — название галереи,
* <code>mode</code> — тип.
 
Параметры можно комбинировать или не указывать.
 
=== Тип 1 ===
'''traditional''' — галереи традиционного вида с рамкой вокруг изображений и ячейками одинаковой ширины.
 
<syntaxhighlight lang="html">
<gallery mode="traditional" widths ="260px" heights="200px">
Image: FileName1 | Описание
Image: FileName2 | Описание
Image: FileName3 | Описание
</gallery>
</syntaxhighlight>
 
<gallery mode="traditional" widths ="260px" heights="200px">
Image: Installation WB-CT309.png | Выбор схемы обжима в зависимости от ориентации трансформаторной сборки
Image: WBCT_RJ12_pinout.png | Схема 1. Обжим витой пары для подключения трансформаторной сборки. Серийный вариант
Image: WBCT_RJ12_pinout invert.png | Схема 2. Обжим витой пары для подключения '''перевёрнутой''' трансформаторной сборки
</gallery>
 
=== Тип 2 ===
'''packed''' — ряды изображений, выровненных по высоте с равными промежутками. Ширина галереи может подстраиваться под текущее разрешение экрана, а подписи располагаются под изображениями.
 
В режиме ''packed'' параметры ''widths и heights'' задают не точную высоту, а работают, как рекомендации при разбиении, то есть размер картинки подстраивается так, чтобы разбивать галерею на приблизительно равные строки.


<syntaxhighlight lang="html">
<syntaxhighlight lang="html">
<gallery mode="packed" heights="150px" caption="Галерея">
<gallery mode="traditional " widths ="500px" heights="250px">
Image: FileName1 | Описание
Image: FileName1 | Описание
Image: FileName2 | Описание
Image: FileName2 | Описание
Строка 309: Строка 205:
</gallery>
</gallery>
</syntaxhighlight>
</syntaxhighlight>
<gallery mode="packed" heights="150px" caption="Галерея">
Image: Installation WB-CT309.png | Выбор схемы обжима в зависимости от ориентации трансформаторной сборки
Image: WBCT_RJ12_pinout.png | Схема 1. Обжим витой пары для подключения трансформаторной сборки. Серийный вариант
Image: WBCT_RJ12_pinout invert.png | Схема 2. Обжим витой пары для подключения '''перевёрнутой''' трансформаторной сборки
</gallery>


== Листинг команды ==
== Листинг команды ==
Строка 334: Строка 224:


=== Команда с выводом ===
=== Команда с выводом ===
Команды с выводом оформляются с помощью тега <code>syntaxhighlight</code>, в свойстве <code>lang</code> указываем <code>console</code>.
Если вы хотите показать вывод, то копировать команды нужно с куском приглашения, без пользователя и имени хоста.


'''Код'''
'''Код'''
<pre>
<pre>
<syntaxhighlight lang="console">
<syntaxhighlight lang="bash">
# dpkg -s wb-hwconf-manager |grep Version
~# dpkg -s wb-hwconf-manager |grep Version
Version: 1.37.0
Version: 1.37.0
</syntaxhighlight>
</syntaxhighlight>
Строка 345: Строка 235:


'''Результат'''
'''Результат'''
<syntaxhighlight lang="console">
<syntaxhighlight lang="bash">
# dpkg -s wb-hwconf-manager |grep Version
~# dpkg -s wb-hwconf-manager |grep Version
Version: 1.37.0
Version: 1.37.0
</syntaxhighlight>
=== Скрипт wb-rules ===
Команды оформляются с помощью тега <code>syntaxhighlight</code>, в свойстве <code>lang</code> указываем <code>ecmascript</code>.
'''Код'''
<pre>
<syntaxhighlight lang="ecmascript">
//Пример скрипта wb-rules
log("test");
</syntaxhighlight>
</pre>
'''Результат'''
<syntaxhighlight lang="ecmascript">
//Пример скрипта wb-rules
log("test");
</syntaxhighlight>
</syntaxhighlight>


== Листинг кода ==
== Листинг кода ==
<pre>
<syntaxhighlight lang="html">
<syntaxhighlight lang="html">
код
код
</syntaxhighlight>
</syntaxhighlight>
</pre>
 
Список языков:  https://pygments.org/languages/, для подсветки листинга правил использовать язык ''ecmascript''.
Список языков:  https://pygments.org/languages/, для подсветки листинга правил использовать язык ''ecmascript''.


Строка 440: Строка 312:
|}
|}


Полезно почитать про [https://www.mediawiki.org/wiki/Help:Tables/ru синтаксис создания таблиц], а ещё можно использовать [https://tablesgenerator.com/mediawiki_tables онлайн-генератор].
Полезно почитать про [https://www.mediawiki.org/wiki/Help:Tables/ru синтаксис создания таблиц].

Версия 16:49, 25 августа 2021


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

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

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

Код 

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

Абзацы

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

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

Код 

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

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

Заголовки

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

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

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

Код 

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

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

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

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

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

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

Код 

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

Включение

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

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

{{Wbincludes:Name}}

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

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

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

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

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

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

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

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

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

Жирный текст 

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

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

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

Списки

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

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

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

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

Результат:

  1. Первый пункт
  2. Второй пункт
  3. Третий пункт

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

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

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

Результат:

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

Вложенный

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

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

Результат:

  1. Первый пункт
    • Первый пункт вложенного
    • Второй пункт вложенного
  2. Второй пункт
  3. Третий пункт

Ссылка

Внутренняя

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

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

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

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

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

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

Примеры: 

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

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

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

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

[[#Списки]]

#Списки 

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

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

Внешняя

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

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

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

Изображение

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

[[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>

/etc/wb-mqtt-serial.conf

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

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

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

Ctrl+A

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

Код 

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

Полезно почитать про синтаксис создания таблиц.

Источник — https://wirenboard.com/wiki/index.php?title=Syntax&oldid=53811