Перейти к содержанию

Создание и оформление страниц вики

Материал из Wiki yaboard

Кто может добавлять свои материалы?

Любой, кто хочет и имеет нужные навыки! У нас нет ограничений по «уровню вхождения», и, при необходимости, мы отредактируем и отформатируем любой интересный материал, это не проблема.

По корректировке текста и всем сомнениям «а получится ли» смело пишите в личку telegram @arkrusinov, всегда поддержу и помогу с текстом, графикой и оформлением.

По предложениям развития wiki (новые расширения, настройки, и т.д.) — к @ZioSHik

Создание и оформление

А правила у нас самые простые:

  • При создании страницы сразу продумайте короткое, отражающее суть, название.
  • Если информация — не ваш личный опыт, указывайте источник информации.
  • Если используете главы, то ПЕРЕД каждым заголовком и ПОСЛЕ делайте по ДВА ПЕРЕНОСА строки.
    <button type="button" class="spoilers-button" aria-expanded="false">Вот так</button>
  • Не забывайте о форматировании: списки, отступы, выделение жирным шрифтом.
  • Не размещайте ссылки внутри == Заголовка ==
    Это неочевидно, дезориентирует читателя. Вместо этого напишите в тексте самой главы однозначное пояснение ("Скачать данную версию можно здесь", или "Информация взята отсюда").
  • Не злоупотребляйте, но и не забывайте присваивать новым страницам категории (пример: [[Category:Своими руками]]).
  • В начале каждой страницы обязательно вставляйте один из вариантов metadesc:
    • {{metadesc| Вступительный абзац или краткое описание статьи }} (будет подставлено ваше описание, без названия страницы, но плюс общее описание сайта)
    • {{metadesc| Вступительный абзац или краткое описание статьи | }} (будет подставлено только ваше описание, без названия страницы)
    • {{metadesc|{{PAGENAME}} }} (автоподстановка названия страницы и общего описания сайта) или
    • {{metadesc|{{PAGENAME}} | Вступительный абзац или расширенное описание статьи }} (название страницы + ваше расширенное описание статьи)
  • Следом за metadecs вставляйте волшебное слово __NOEDITSECTION__, оно отключает правку отдельных секций (а при этом сбрасываются отступы между секциями).
На тех страницах, где правка секций не отключена, используйте правку всей страницы, и тоже сразу вставляйте в начало страницы директиву __NOEDITSECTION__, заранее спасибо )
  • Если разделов немного, но оглавление необходимо, впишите в следующей строке волшебное слово __TOC__, и оглавление появится в указанном месте.
  • Создав статью, обязательно отпишитесь нам об этом: @ZioSHik, @arkrusinov (Telegram).

Быстрые шаблоны оформления

Плашки

Какая вики без плашек )) У нас их немного; как правило, они предупреждающие. Это:

{{Skills}}, {{Hands}}, {{HighVoltage}}, {{Underconstruct}} и {{Obsolete}}.

Знания Применение информации с этой страницы требует специальных знаний и навыков
Всё описанное на этой странице вы производите на свой страх и риск, включая нарушение работы программного обеспечения и выход из строя оборудования, а также риск поражения током и травмы.
Материал носит информационный характер, и не является прямым указанием к действию!
Требуются прямые руки И вдумчивое отношение к инструкции
Мы не несём никакой ответственности за правильное или неправильное применение, или неприменение, и/или неспособность применить данное руководство.
Телефон вызова экстренных служб - 112.
Высокое напряжение Опасность поражения током
Не повторяйте эти действия, если не обладаете нужными знаниями и природной осторожностью.
Телефон вызова экстренных служб - 112.
Черновая версия Cтраница не завершена
Информация на этой странице не проверена до конца. Текст дорабатывается, обозначенные решения могут быть неполными или не совсем точными.
Страница устарела Неактуальные данные
С момента создания страницы или последних правок появилась новая информация (изменилось API, появились более прямые способы подключения, навыки, информация перешла в статус официальной и её изменения больше не поддерживаются).

Стили и выделение цветом

Конечно, можно выделить текст примерно так: <b class="red">Текст</b>, но предпочтительнее использовать отдельный блок (в вики для этого строка должна начинаться с пробела. Можно обрамить этот блок тегом <pre> и задать улучшенное цветовое оформление через класс). Пример:


<pre class="red">

Текст (эта строка начинается с пробела)

</pre>

Поддерживаются три класса с простыми цветами: red, green, blue: 

 Красный

 Жёлтый

 Зелёный :)

Простая строка, начинающаяся с пробела и не обрамлённая в <pre>, выглядит так.
Вторая строка следом, начинающаяся с пробела, блок не разрывает.

Видео и изображения

Пример миниатюры видео с ограничением по ширине
Пример миниатюры фото с ограничением по ширине
Пример миниатюры фото БЕЗ ограничения

Мы используем такие правила:

  • полноразмерное отображение видео из youtube: <youtube>//youtu.be/fEiA9uyB_HQ</youtube>
  • полноразмерное отображение закачанного на вики видео: [[Файл:Имя_закачанного_файла.MP4]]
  • миниатюра закачанного на вики фото\видео справа от текста: [[Файл:Имя_закачанного_файла.mp4|мини|справа|Подпись под видео]]
  • то же, с ограничением по ширине: [[Файл:Имя_закачанного_файла.mp4|200px|мини|справа|Подпись под видео]]. Ограничение ширины в пикселях необязательно, но может пригодиться при большом количестве медиафайлов и небольшом — текста, чтобы отобразить их на странице более гармонично.


Как видно на примерах справа, наша страница — как раз тот случай, когда ограничение ширины необходимо, так как высота главы значительно меньше высоты колонки предпросмотра медиафайлов.


Важно!

[[Файл:Имя_файла|мини|справа] и

[[Файл:Имя_файла|thumb|right]

равноценны, но предпочтительнее англоязычный вариант.


Ещё один важный момент с миниатюрами справа от текста. Дело в том, что они "разрывают" заголовки, располагаясь самостоятельной лентой по правому краю, и иногда иллюстрация противоречит или не совпадает с текстом слева, что может быть истолковано неверно.

Тогда перед нужным заголовком вместо одного из переноса строк разместите код


<br style="clear:both">
== Заголовок раздела, который нельзя разрывать ==


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

Дополнительно

Не понимаю, как создать страницу?

Самый быстрый способ — впишите желаемое название прямо в строку поиска вики.

Если такой страницы нет — вики автоматически предложит создать новую (нужно быть авторизованным в этот момент):

Пример:

Ссылка, выделенная желтым, приведёт в редактор, уже настроенный для создания страницы с таким именем.

Подумайте над названием несколько раз, прежде чем начнёте создавать свою страницу. Оно должно точно отражать тематику и быть как можно более коротким.

Как назвать страницу?

Рассмотрим на паре практических примеров.

Страница о настройках поиска Алисы через приложение Яндекс

  • "Настройка поиска Алисы через приложение Яндекс" — слишком длинно, содержит лишнюю информацию. Вряд ли кто-то ищет, как настроить именно через приложение. Хотя бы потому, что если он это знает — ему уже нечего рассказать.
  • "Настройка поиска" — слишком коротко, ничего не объясняет. Где поиск? По вики? В Яндекс.Телефоне? На любом устройстве с Алисой?
  • "Настройка поиска в Алисе" — твёрдая «четвёрка». Ничего лишнего, есть все уточнения. Но все ли? С какой целью люди ищут настройки поискового фильтра? И мы приходим к:
  • "Безопасный поиск с Алисой" — выделена причина, по которой наверняка будет разыскиваться информация, уточнена область применения статьи.

Страница о подключении Яндекс.Телефона к MacOS

  • "Как подключить через USB к MacOS" — что подключить? Умную колонку? Навигатор?
  • "Как подключить Яндекс.Телефон через USB к MacOS" — подробно, точно. Был бы лучшим вариантом. Но длинновато, и не входит в одну строки колонки на главной, например.
  • "Как подключить Телефон к MacOS по USB" — разумный компромисс, так как в пределах нашей вики Телефон с заглавной буквы подразумевает именно Телефон Яндекса. При этом не потеряна ни целевая ОС, ни способ подключения. «Через» заменено на более короткое «по».

Категории

Общее форматирование

Размещение на главной

Если твёрдо уверены, что ваша статья должна иметь ссылку с главной страницы, напишите об это нам (@ZioSHik, @arkrusinov). Во-первых, форматирование главной основано на более сложной вёрстке, и на html вместо обычной вики-разметки. А во-вторых, управление главной страницей — сфера обязанностей модераторов вики.

Потренироваться

Для этого есть специальная Тестовая страница — на ней можно делать всё.


В меру, конечно. Желательно не удалять верхнюю строку, поясняющую, что страница предназначена для теста набора и форматирования текста и графики.


Есть небольшой риск, что этой страницей пользуется сейчас кто-то другой, и перепишет вашу страницу своим тестом в самый неподходящий момент. Минимизировать его можно двумя приёмами:

  • Перед отправкой «Записать страницу» копируйте весь текст в буфер (горячие клавиши Ctrl-A, Ctrl-C под Windows, например)
  • Вместо «Записать страницу» использовать кнопку «Предварительный просмотр». Это самый лучший способ потому, что:
    • вообще не перезаписывает страницу
    • позволяет одновременно и смотреть изменяемую страницу, и редактировать её.
Источник — https://wiki.yaboard.com/index.php?title=Создание_и_оформление_страниц_вики&oldid=3066