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

Syntax (просмотреть исходный код)

Версия 17:19, 23 января 2024

11 039 байт добавлено ,  3 месяца назад
→‎Тип 2
 
(не показано 47 промежуточных версий этого же участника)
Строка 1: Строка 1:
{{DISPLAYTITLE: Синтаксис элементов страницы}}
{{DISPLAYTITLE: Справочник по синтаксису}}


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


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


'''Код'''
'''Код'''
Строка 10: Строка 20:
<pre>
<pre>
{{DISPLAYTITLE: Название }}
{{DISPLAYTITLE: Название }}
</pre>
== Абзацы ==
Чтобы текст легче читался, его нужно разбивать на абзацы — один абзац, одна мысль.
Чтобы разделить текст на абзацы, добавьте пустую строку между предложениями.
'''Код'''
<pre>
Чтобы текст легче читался, его нужно разбивать на абзацы — один абзац, одна мысль.
Чтобы разделить текст на абзацы, добавьте пустую строку между предложениями.
</pre>
</pre>


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


Текст, выделенный тегом <code>=</code> становится заголовком, количество чёрточек показывает его уровень. Тег парный, поэтому он ставится до и после текста:
Текст, выделенный тегом <code>=</code> становится заголовком, количество чёрточек показывает его уровень. Тег парный, поэтому он ставится до и после текста.
 
'''Код'''
<pre>
<pre>
== Заголовок второго уровня ==
== Заголовок второго уровня ==
Строка 36: Строка 60:
</pre>
</pre>


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


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


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


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


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


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


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


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


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


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


Если изображений много — оформить в виде [[#Галерея | галереи]].
[[Image: FileName.png |500px|center| Изображение в тексте по центру]]
 
Главное изображение страницы или раздела можно выровнять по правому краю:
<pre>
[[Image: FileName.png |300px|thumb|right| Подпись ]]
</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="traditional " widths ="500px" heights="250px">
<gallery mode="packed" heights="150px" caption="Галерея">
Image: FileName1 | Описание
Image: FileName1 | Описание
Image: FileName2 | Описание
Image: FileName2 | Описание
Строка 191: Строка 309:
</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>


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


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


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


'''Результат'''
'''Результат'''
<syntaxhighlight lang="bash">
<syntaxhighlight lang="console">
~# 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''.


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


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