Участник:Виталик Штепсель/Абсурдопедия:Техническое руководство

Материал из Абсурдопедии
Перейти к навигации Перейти к поиску


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

Оформление кода[править]


CSS[править]


  • Не стоит использовать устаревшие свойства и значения свойств CSS. Не буди Ктулху, пока оно тихо.

Комментарии[править]


Пример[править]


/* Шапка портала
*/
.portal-header-box {
    background-color: black;
    color: white;
    border: 2px solid white; /* с такой границей нормально смотрится */
}

JS (JavaScript)[править]


Комментарии[править]


Вики-разметка[править]


Глобальные страницы пространства MediaWiki (CSS и JS)[править]


Глобальные страницы пространства MediaWiki — это Common.css, Common.js и другие, подробный список есть в документации Mediawiki: Interface/Stylesheets и Interface/JavaScript.

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

Гаджеты[править]


Список гаджетов прописывается на странице MediaWiki:Gadgets-definition (редактировать могут только админы). Подробная информация по гаджетам есть в официальной документации к расширению Gadgets.

Обычно у гаджета может быть таблица на языке CSS и скрипт на языке JavaScript.

Шаблоны[править]


Список шаблонов для использования в статьях есть на странице Абсурдопедия:Шаблоны.

Базовые шаблоны[править]


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

и прочих…

Стили CSS и параметры HTML[править]


  • Не стоит использовать устаревшие параметры элементов.
  • Не стоит использовать устаревшие свойства и значения свойств CSS.
  • Лучше всего прописывать свойства CSS в классах на отдельной странице с CSS-кодом шаблона и подключать её через расширение TemplateStyles.

Пример использования TemplateStyles[править]

На странице шаблона вставляется тег templatestyles:

<templatestyles src="Шаблон:MyCoolTemplate/styles.css" />

Где вместо MyCoolTemplate следует указать имя шаблона.

У шаблона создаётся подстраница /styles.css, там и прописывается CSS-код для стилей.

Документация к шаблонам[править]


В шаблонах следует делать ссылку на документацию через шаблон {{doc}}, например:

<noinclude>{{doc}}</noinclude>

В самой документации стоит указать:

  • Шаблон {{docpage}} — просто потому что надо, и всё тут.
  • Зачем нужен шаблон, где его использовать;
  • Какие у шаблона параметры (через список);
  • Примеры использования;
  • При необходимости — дополнительную техническую информацию: как реализован шаблон, где лежат стили CSS, и так далее.

Пример[править]


В качестве примера можно глянуть на документацию шаблона {{Цитата}}: {{Цитата/doc}}.

Порталы[править]


Ненавижу порталы!
~ Геральт про трудности работы с вики-разметкой

Порталы должны лежать в пространстве имён «Портал:» (Правда, что-ли?).

Оформление порталов и заглавной страницы[править]


Файлы[править]


Для файла следует указывать лицензию (это можно сделать через выбор на странице загрузки), а если он откуда-то взят, то хорошо бы и источник, иначе придёт авторское право с бейсбольной битой, аки Фрэнки Ниагара из Max Payne.

См. также[править]

Ссылки[править]