|
|
(не показаны 83 промежуточные версии 1 участника) |
Строка 1: |
Строка 1: |
| {{DISPLAYTITLE: Справочник по синтаксису}}
| | == Видимый заголовок == |
| | |
| == Как создать новую страницу == | |
| Ссылки на страницы с русскоязычным наименованием смотрятся плохо, поэтому мы стараемся новые страницы называть короткой англоязычной фразой.
| |
| | |
| Чтобы создать страницу, введите в поле поиска название новой страницы и, если такой страницы нет, в результатах поиска будет фраза:
| |
| <pre>
| |
| Создать страницу «New Page» в этом вики-проекте!
| |
| </pre>
| |
| | |
| <span class="text-red">New Page</span> — это и есть ссылка на создание новой страницы: нажимаете, заполняете, сохраняете.
| |
| | |
| Если вы совсем не знакомы с Вики-синтаксисом, можете посмотреть живой пример в [[Sandbox | Статье-песочнице]].
| |
| | |
| == Видимое название ==
| |
| Страницам с англоязычным названием нужно назначать видимое название на русском языке, которое будет показано вверху страницы.
| |
| | |
| '''Код'''
| |
| | |
| <pre>
| |
| {{DISPLAYTITLE: Название }}
| |
| </pre>
| |
| | |
| == Абзацы ==
| |
| Чтобы текст легче читался, его нужно разбивать на абзацы — один абзац, одна мысль.
| |
| | |
| Чтобы разделить текст на абзацы, добавьте пустую строку между предложениями.
| |
| | |
| '''Код'''
| |
| <pre>
| |
| Чтобы текст легче читался, его нужно разбивать на абзацы — один абзац, одна мысль.
| |
| | |
| Чтобы разделить текст на абзацы, добавьте пустую строку между предложениями.
| |
| </pre>
| |
| | |
| == Заголовки ==
| |
| {{note|info| Первый уровень — это название статьи, оно есть всегда и в теле статьи мы его не используем.}}
| |
| | |
| Чтобы страницу было легко читать, мы структурируем её заголовками, начиная со второго уровня.
| |
| | |
| Текст, выделенный тегом <code>=</code> становится заголовком, количество чёрточек показывает его уровень. Тег парный, поэтому он ставится до и после текста.
| |
| | |
| '''Код'''
| |
| <pre> | | <pre> |
| == Заголовок второго уровня ==
| | {{DISPLAYTITLE: Наименование }} |
| | |
| === Заголовок третьего уровня ===
| |
| | |
| ==== Заголовок четвёртого уровня ====
| |
| </pre> | | </pre> |
|
| |
|
| == Перенаправление == | | == Перенаправление == |
| Иногда, на страницах может встретиться перенаправление, которое лучше не трогать — это может нарушить связи между страницами.
| |
|
| |
| Перенаправление ставят администраторы Wiki.
| |
|
| |
| '''Код'''
| |
| <pre> | | <pre> |
| #REDIRECT [[название_страницы]] | | #REDIRECT [[название_страницы]] |
| </pre> | | </pre> |
| | == Включение == |
| | |
| | Добавить на [[Список_шаблонов | страницу с шаблонами]] отдельной статьей новый шаблон, называть <code>Wbincludes:Name</code>. |
| | Так же список всех шаблонов доступен на [[Служебная:Все страницы|служебной странице]] в пространстве имен. |
|
| |
|
| == Включения (Инклуды) ==
| | Если нужно вставить только часть текста, отделить нужную часть тегами <onlyinclude> и </onlyinclude> — так нужно делать для вставки части одной таблицы в другую, чтобы не поломалась ее верстка. |
| === Как создавать ===
| |
| Если какой-то текст повторяется в нескольких статьях, то мы выносим его во включения. | |
|
| |
|
| В тексте это выглядит так:
| |
| <pre> | | <pre> |
| {{Wbincludes:Name}} | | {{Wbincludes:Name}} |
| </pre> | | </pre> |
|
| |
| Включения нужно изменять с большой осторожностью, так как изменение текста в одном месте повлияет на несколько страниц одновременно. Чтобы отредактировать включение, скопируйте текст между фигурными скобками, вставьте в поле поиска по документации и перейдите на предложенную страницу.
| |
|
| |
| Внутри включения можно использовать теги:
| |
| * onlyinclude — будет вставлен текст из этого тега, но он не будет отображаться на странице включения.
| |
| *:<pre><onlyinclude> Этот текст будет включен в другую страницу </onlyinclude></pre>
| |
| * noinclude — текст из этого тега будет виден на странице включения, но не будет вставлен в другую страницу.
| |
| *:<pre><noinclude> Этот текст не будет включен в другую страницу </noinclude></pre>
| |
|
| |
| По умолчанию, весь текст на странице включения будет вставлен в другую страницу.
| |
|
| |
| Список включений можно посмотреть на [[Список_шаблонов | странице с шаблонами]].
| |
|
| |
| === Подзаголовки ===
| |
| Так как включение становится полноценной частью страницы, то при клике у подзаголовка на ссылку «Править», можно отредактировать часть включения даже не подозревая об этом.
| |
|
| |
| Чтобы избежать таких ошибок, мы для подзаголовков во включениях используем html-теги <code>h2, h3, h4</code>. У такого подзаголовка пропадает кнопка «Править», что исключает ошибку.
| |
|
| |
| <syntaxhighlight lang="html">
| |
| <h2>Подзаголовок во включении</h2>
| |
| </syntaxhighlight>
| |
|
| |
| == Выделение текста ==
| |
| Для выделения текста нужно использовать wiki-разметку.
| |
|
| |
| ''Наклонный текст''
| |
| <pre>
| |
| ''Наклонный текст''
| |
| </pre>
| |
| '''Жирный текст'''
| |
| <pre>
| |
| '''Жирный текст'''
| |
| </pre>
| |
|
| |
| '''''Жирный наклонный текст'''''
| |
| <pre>
| |
| '''''Жирный наклонный текст'''''
| |
| </pre>
| |
|
| |
| == Списки ==
| |
| Список может быть нумерованным и маркированным, а также иметь вложения любого типа.
| |
|
| |
| === Нумерованный ===
| |
|
| |
| Нумерованный список:
| |
| <pre>
| |
| # Первый пункт
| |
| # Второй пункт
| |
| # Третий пункт
| |
| </pre>
| |
|
| |
| Результат:
| |
| # Первый пункт
| |
| # Второй пункт
| |
| # Третий пункт
| |
|
| |
| === Маркированный ===
| |
|
| |
| Маркированный список:
| |
| <pre>
| |
| * Первый пункт
| |
| * Второй пункт
| |
| * Третий пункт
| |
| </pre>
| |
|
| |
| Результат:
| |
| * Первый пункт
| |
| * Второй пункт
| |
| * Третий пункт
| |
|
| |
| === Вложенный ===
| |
| Обычно внутрь нумерованного списка нужно вложить маркированный:
| |
| <pre>
| |
| # Первый пункт
| |
| #* Первый пункт вложенного
| |
| #* Второй пункт вложенного
| |
| # Второй пункт
| |
| # Третий пункт
| |
| </pre>
| |
|
| |
| Результат:
| |
| # Первый пункт
| |
| #* Первый пункт вложенного
| |
| #* Второй пункт вложенного
| |
| # Второй пункт
| |
| # Третий пункт
| |
|
| |
| === Пункт из нескольких строчек ===
| |
| Иногда бывает так, что один пункт нужно разбить на несколько строчек, например, привести какой-то код, или добавить картинку.
| |
|
| |
| Чтобы такое провернуть, добавьте в начало строки символ <code>#:</code>:
| |
| <pre>
| |
| # Первый пункт
| |
| #: Вторая строка первого пункта
| |
| #: Третья строка первого пункта
| |
| # Второй пункт
| |
| #: [[Image: FileName.png |300px| Картинка в списке ]]
| |
| # Третий пункт
| |
| </pre>
| |
|
| |
| Результат:
| |
| # Первый пункт
| |
| #: Вторая строка первого пункта
| |
| #: Третья строка первого пункта
| |
| # Второй пункт, картинка:
| |
| #: [[Image: FileName.png |300px| Картинка в списке ]]
| |
| # Третий пункт
| |
|
| |
|
| == Ссылка == | | == Ссылка == |
Строка 186: |
Строка 29: |
| [[Название страницы | Отображаемое имя]] | | [[Название страницы | Отображаемое имя]] |
| </pre> | | </pre> |
|
| |
| Также можно сослаться на определённый раздел:
| |
| <pre>
| |
| [[#Название раздела]]
| |
| </pre>
| |
|
| |
| <pre>
| |
| [[Название страницы#Название раздела | Видимый текст]]
| |
| </pre>
| |
|
| |
| Но лучше добавить в страницу якорь и сослаться на него, так в случае, если заголовок раздела будет переименован, то ссылка не сломается:
| |
| # Добавляем якорь:
| |
| #:<pre>{{Anchor|anchor-name}}</pre>
| |
| # Ссылаемся на этот якорь по аналогии с заголовком:
| |
| #:<pre>[[#anchor-name]]</pre>
| |
|
| |
| '''Примеры:'''
| |
|
| |
| <pre>[[Заглавная страница]]</pre>
| |
| [[Заглавная страница]]
| |
|
| |
| <pre>[[Заглавная страница | Главная страница Wiki]]</pre>
| |
|
| |
| [[Заглавная страница | Главная страница Wiki]]
| |
|
| |
| <pre>
| |
| [[#Списки]]
| |
| </pre>
| |
| [[#Списки]]
| |
|
| |
| <pre>
| |
| [[Заглавная страница#Диммеры | Раздел «Диммеры» на главной странице]]
| |
| </pre>
| |
| [[Заглавная страница#Диммеры | Раздел «Диммеры» на главной странице]]
| |
|
| |
|
| === Внешняя === | | === Внешняя === |
Строка 226: |
Строка 35: |
| [https://wirenboard.com Отображаемое имя] | | [https://wirenboard.com Отображаемое имя] |
| </pre> | | </pre> |
| | | <pre> |
| [https://wirenboard.com/ru/product/WBIO-DI-WD-14/ Купить в интернет-магазине] | | [https://wirenboard.com/ru/product/WBIO-DI-WD-14/ Купить в интернет-магазине] |
| | </pre> |
|
| |
|
| == Изображение == | | == Изображение == |
| === Как загрузить новое изображение ===
| | По умолчанию изображения выравниваются по левому краю: |
| [[Image: FileName.png |300px|thumb|right| Изображение с выравниванием по правому краю]]
| |
| Чтобы ссылки на файлы смотрелись хорошо, давайте файлам имена латиницей.
| |
| | |
| Для добавления нового изображения, просто вставьте один из примеров ниже в текст страницы, поменяйте '''FileName.png''' на название вашего ещё не загруженного файла, и нажмите '''Предпросмотр'''. После на странице появится ссылка на добавление нового файла. Нажмите на ссылку, откроется окно, где можно выбрать файл изображения.
| |
| | |
| [[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="packed" heights="250px"> |
| Image: FileName1 | Описание | | Image: FileName1 |Подпись |
| Image: FileName2 | Описание | | Image: FileName2 |Подпись |
| Image: FileName3 | Описание | | Image: FileName3 |Подпись |
| </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>
| |
|
| |
|
| == Листинг команды == | | == Листинг команды == |
|
| |
|
| === Команда ===
| |
| Команды оформляются с помощью тега <code>syntaxhighlight</code>, в свойстве <code>lang</code> указываем <code>bash</code>.
| |
|
| |
| '''Код'''
| |
| <pre>
| |
| <syntaxhighlight lang="bash"> | | <syntaxhighlight lang="bash"> |
| apt update | | apt update |
| </syntaxhighlight> | | </syntaxhighlight> |
| </pre>
| |
|
| |
|
| '''Результат'''
| | Если вы хотите показать вывод, то копировать команды нужно с куском приглашения, без пользователя и имени хоста: |
| <syntaxhighlight lang="bash"> | | <syntaxhighlight lang="bash"> |
| apt update
| | ~# dpkg -s wb-hwconf-manager |grep Version |
| </syntaxhighlight>
| |
| | |
| === Команда с выводом ===
| |
| Команды с выводом оформляются с помощью тега <code>syntaxhighlight</code>, в свойстве <code>lang</code> указываем <code>console</code>.
| |
| | |
| '''Код'''
| |
| <pre>
| |
| <syntaxhighlight lang="console">
| |
| # dpkg -s wb-hwconf-manager |grep Version
| |
| Version: 1.37.0
| |
| </syntaxhighlight>
| |
| </pre>
| |
| | |
| '''Результат'''
| |
| <syntaxhighlight lang="console">
| |
| # 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''. |
|
| |
|
| == Путь к файлу и команды в тексте == | | == Путь к файлу == |
| В тексте пути к файлу оборачиваем в тег code: | | В тексте пути к файлу оборачиваем в тег code: |
| <pre> | | <pre> |
| <code>/etc/wb-mqtt-serial.conf</code> | | <code>/etc/wb-mqtt-serial.conf</code> |
| </pre> | | </pre> |
|
| |
| <code>/etc/wb-mqtt-serial.conf</code>
| |
|
| |
| == Горячие клавиши ==
| |
| Горячие клавиши можно выделять тегом kbd:
| |
| <pre>
| |
| <kbd>Ctrl</kbd>+<kbd>A</kbd>
| |
| </pre>
| |
|
| |
| <kbd>Ctrl</kbd>+<kbd>A</kbd>
| |
|
| |
|
| == Возведение в степень == | | == Возведение в степень == |
|
| |
| '''Код'''
| |
| <pre> | | <pre> |
| 4<sup>2</sup>
| | <sup>2</sup> |
| </pre> | | </pre> |
|
| |
|
| '''Результат'''
| | == Блок «Внимание» == |
| | | Пишем через двоеточие, слово «Внимание» выделяем жирным: |
| 4<sup>2</sup>
| | :'''ВНИМАНИЕ:''' это очень важно! |
| | |
| == Предупреждения == | |
| | |
| Блоки предупреждений формируются с помощью шаблона [[Шаблон:Note]]. Синтаксис смотрите на странице шаблона.
| |
| | |
| Оформлять текст в блоки следует только в крайнем случае, например, если действия пользователя потенциально опасно или может привести к ошибке, которую трудно отловить.
| |
|
| |
|
| == Цитата == | | == Цитата == |
Строка 416: |
Строка 105: |
|
| |
|
| == Таблица == | | == Таблица == |
| Ниже приведён пример простой таблицы из двух строк, заголовка и семи колонок.
| | * [https://www.mediawiki.org/wiki/Help:Tables/ru Синтаксис создания таблиц] |
| | |
| '''Код'''
| |
| <syntaxhighlight lang="html">
| |
| {| 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
| |
| |-
| |
| |}
| |
| </syntaxhighlight>
| |
| | |
| '''Результат'''
| |
| {| 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
| |
| |-
| |
| |}
| |
|
| |
|
| Полезно почитать про [https://www.mediawiki.org/wiki/Help:Tables/ru синтаксис создания таблиц], а ещё можно использовать [https://tablesgenerator.com/mediawiki_tables онлайн-генератор].
| | * [https://www.tablesgenerator.com/mediawiki_tables Генератор таблиц] |