RuVDRWiki:Правила
Материал из RuVDRWiki
Содержание |
О правилах Википедии
Общие принципы: нейтральная точка зрения, уважительное отношение к авторским правам, лицензия GNU и некоторые другие, — обязательны для всех разделов. Технические правила оформления статей, отношения внутри сообщества и тому подобное регулируется сообществом внутри раздела. Наши правила, как и любые правила, неидеальны, со временем меняются, и в этом процессе могут участвовать все желающие. Но метания от одной системы правил к другой (а потом, возможно, обратно) не принесут большой пользы: давно действующие правила изучены множеством участников, на них построено много существующих статей, поэтому, чтобы их изменить, нужны веские причины и немало труда по внедрению изменений.
Статья
Название
Если статье можно дать много названий, применяйте то, которое чаще встречается, а с остальных вариантов сделайте перенаправления.
Структура
Соблюдайте удобную для читателя последовательность повествования и размещения служебных пометок в исходном тексте статьи.
Модули расширения
Статьи о модулях расширений принципиально пишутся с маленькой буквы. Имя состоит из названия модуля и прибавления -plugin, например
название-plugin
Патчи
Статьи о заплатках принципиально пишутся с маленькой буквы. Имя состоит из названия заплатки и прибавления -patch, например
название-patch
Дистрибутивно-специфические статьи
VDR Wiki уделяет особое внимание обще принятым описаниям дистрибутивов. Все же имеются статьи, которые основаны на свойствах и особенностях определенных дистрибутивов. Чтобы избечь столкновения с другими статьями по той же самой теме, но с другим дистрибутивом, дистрибутивно-специфические статьи должны быть написаны большими буквами с названием дистрибутива, например
Дистрибутив - Название статьи
Таким образом статья однозначно обозначена и настоящий заголовок все еще узнаваем.
Классификация
Общее
Модули расширения
При внесении модуля в список, пожалуйста обратите внимание следущему:
| Модуль | Описание |
|---|---|
| <name>|<status>]] | Краткое описание модуля (желательно на русском) |
- <name> Название модуля без дополнения -plugin
- <status> Цвет
- lime
- Работаспособный с актуальной версией VDR 1.4.X
- yellow
- Работаспособный с версией 1.2.x/1.3.x (или должен сделаться работаспособным только посредством модификации )
- red
- Технически устаревший, не работаспособный
- blue
- Демонстрационные модули расширения
- lightgrey
- Не классифицирован
Статья о модуле содержит следующее содержание (смотри также Шаблоны):
== Описание ==
'''Автор:''' <Имя-1>, <Имя-2>
Сюда описание модуля расширения.
===Статус===
==Патчи==
При возможно наличествующих или необходимых патчей, так же вносится здесь.
==Картинки==
{|
|[[Изображение:<plugin>-plugin-00.jpg|thumb|none|''короткое описание'']]
|[[Изображение:<plugin>-plugin-01.jpg|thumb|none|''короткое описание'']]
|}
== Управление ==
Список необходимых клавиш и их функции, а также несколько дополнительных примечаний.
{| width="100%" class="wikitable"
|-
!Кнопка
!Функция
|-
| Вправо, FastFwd || Быстрое перепрыгивание во времени вперёд (5 сек.)
|-
| Влево, FastRew || Быстрое перепрыгивание во времени назад (5 сек.)
|-
| Вверх || Следующий(ая)
|}
=== [[SVDRP]] команды ===
Если модуль может вводит собственные команды SVDRP, то внесите их здесь, например:
{| border=1 cellpadding=5 cellspacing=0
|- bgcolor=#efefef
!Параметр
!Описание
|-
| OPEN || Открыть
|-
| QUIT || Закрыть
|}
== Требования к аппаратному обеспечению ==
* Требование 1
* Требование 2
== Требования к программному обеспечению==
* Требование 1
* Требование 2
Здесь оказались пригодным аббревиатуры.
* <нуждается в следущем> = (одинаковая) '''<версия>'''
* <нуждается в следущем> >= (одинаковая или выше) '''<версия>'''
* <нуждается в следущем> <= (одинаковая или ниже) '''<версия>'''
* Например:
* vdr >= '''1.3.35''' означает -> модуль требует vdr версии 1.3.35 или выше.
* ...
При определенной версии (Software), напишете версию модуля.
* Требование (модуль-<ВЕРСИЯ>)
== Установка ==
Под этим подразумевается решаемые зависимости для модуля, например установка софта.
Но не сам модуль, например:
apt-get install <модуль>
Такое принадлежит на соответствующие страницы диструбутивов.
===Опции===
Здесь могут представляться и описываться.
===Source===
Указания при компиляции исходников.
===[[Arch-Linux]]===
pacman -S <пакеты>
===[[Crux]]===
prt-get <пакеты>
===[[Debian]]===
apt-get <пакеты>
===[[Gentoo]]===
emerge <пакеты>
===[[SuSE]]===
yast -i <пакеты>
===[[Другие]]===
Команды
== Конфигурация ==
Под конфигурацией могут описываться необходимые установки системных файлов или конфигурационные файлы модуля расширения.
=== Установки ===
В большинстве случаев подразумеваются установки модуля расширения..
=== Параметры ===
Здесь вносятся параметры командной строки модуля.
{| border=1 class="wikitable"
|-
!Параметр (сокр.)
!Параметр (полн.)
!Описание
|-
| -a ABC || --aaa=ABC || какой-либо параметр
|-
| -b || --bbb || другой параметр
|}
== Прочее ==
===Проблемы===
Проблемы нужно группировать для разборчивости ради.
* Проблема 1
* Проблема 2
* Проблема 3
=== Полезности ===
Полезности нужно группировать для разборчивости ради.
* Полезность 1
* Полезность 2
* Полезность 3
=== Список пожеланий ===
Пожелания нужно группировать для разборчивости ради.
* Пожелание 1
* Пожелание 2
* Пожелание 3
=== Snapshot ===
cvs ... login
cvs ... co ...
== Ссылки ==
# [http:// Homepage модуля]
[[Категория:Plugins]]
{{i18n|НАЗВАНИЕ МОДУЛЯ-plugin}}
Если не имеется никаких сведений к определенным пунктам, заголовок затемняется, это делается таким образом:
<!-- ==Установка== -->
Если что-нибудь не понятно, тогда посмотрите у дригих модулей раширения.
Патчи
Формат такойже как и у модулей расширений (смотри RuVDRWiki:Шаблоны#Патчи), небольшое различие только в данных изображений и категорий:
[[Изображение:название-patch-00.jpg]] [[Категория:Patches]]
Изображение для патча, конечно, делает только тогда смысл, если он производит визуальное изменение.
Форматирование / оформление
Номера версии
Каталоги
Если в тексте появляется название каталога как /usr/local/bin , то его лучше всего выделять жирным шрифтом:
[...] '''/usr/local/bin''' [...]
Hardcodet
Пожалуйста, не используйте указание путей в (независимо от дистрибутива) общих статьях (модули расширения и тд.). Например.
Это значит:
$SOURCEDIR
а не:
/usr/local/src
Ещё лучше ссылка к источнику:
cp $SOURCEDIR/VDR/PLUGINS/src/loadepg/loadepg.conf $VDRCONFIG
Часто используемые сокращения:
$HOME ~/vdr $SOURCEDIR /usr/local/src $PATH /usr/bin:/usr/local/bin:$PATH $VDRCONFIG /usr/etc/vdr
Ссылки
Пожалуйста создавайте ссылки на примере 1 + 2, смотри также Ссылки.
Пример1
Пример2
Пример3
| [1] | http://www.geoimage.ch/177468 | Namib-Bilddokumentation |
| [2] | http://safarinow.com/destinations/Namib-Desert/?a=10986 | Lodges in der Namib |
| [2] | http://www.gobabeb.org/index.htm | Gobabeb Training & Research Centre |
Изображения
Название
Общее
Screenshot, или картинка украшает текст и может иллюстрировать объект описания внушительным способом.
Если речь идёт о скриншотах программ, тогда используйте название программы + дополнение -screenshot , например:
название программы-screenshot-00.jpg
причем "хх" идёт от 0 до 99.
Модули расширения
Добавте к к тексту модуля скриншот, это украсит текст и кроме того, каждый хочет то-нибудь увидеть. Избегайте прямых ссылок, так как адрес может в любое время поменяться + это не безупречно законно?!
Для того, чтобы быстро найти скриншот модуля, изображение должно иметь название модуля и возможно номер:
название-plugin-xx.jpg
причем "хх" идёт от 0 до 99.
Патчи
Изображение для патча, конечно, делает только тогда смысл, если он производит визуальное изменение. Избегайте прямых ссылок, так как адрес может в любое время поменяться + это не безупречно законно?!
Для того, чтобы быстро найти скриншот патча, изображение должно иметь название модуля и возможно номер:
название-patch-xx.jpg
причем "хх" идёт от 0 до 99.
Формат
Общее
Для фотографий и скриншотов лучше всего подходит JPG-формат. Для эскизов и рисунков лучше использовать PNG-формат.
Разрешения как 800х600 (фотографии) и 768х576 (ТВ) вполне достаточны, но перед загрузкой не забудьте оптимизировать фото/скриншот. Для создания VDR-скриншотов, используйте Svdrp#GRAB:
svdrpsend.pl grab "/video/"$(date --iso-8601=seconds)".jpg" jpeg 50
svdrpsend.pl grab "<FILENAME>.jpg" 50
или (необходимо sharutils):
svdrpsend.pl 'grab -' | sed -n -e 's/^216-//p' -e '1ibegin-base64 644 -' -e '$a====' | uudecode > "/tmp/<FILENAME>.jpg" svdrpsend.pl 'grab -' | sed -n -e 's/^216-//p' -e '1ibegin-base64 644 -' -e '$a====' | uudecode -o "/tmp/<FILENAME>.jpg"
Категории
Категории позволяют логически сортировать статьи по некоторой общности в содержании.
Относить статью к категории очень просто — нужно поставить в конце статьи
[[Категория:Plugins]]
, при этом если такой категории ещё нет, она появится автоматически. Если вы поставите для статьи несколько категорий, то статья попадёт во все перечисленные категории. На служебной странице Категории статей перечислены уже существующие категории статей.
