Перевод(ы): English - Español - Français - Indonesia - Русский

(!) Discussion


РУКОВОДСТВО ПО РЕДАКТИРОВАНИЮ ВИКИ

Эта статья предназначена для людей, желающих редактировать вики Debian.

Есть также Быстрый старт для новичков.

Если Вам нужна помощь для работы с moinmoin, посетите соответствующую страницу - HelpContents. Есть в наличии и справка о синтаксисе '''moinmoin'''. Вы можете экспериментировать в вики-песочнице.

Если Вы нашли ошибку или несогласны с чем-либо, что изложено ниже, закомментируйте соответствующую строку, затем создайте новое обсуждение в соответствующем разделе.

Ваш аккаунт

Ваша личная вики-страница

При создании Вашей личной вики-страницы Вы можете использовать шаблон личной страницы HomepageTemplate. На личной странице можно оставить следующую информацию.

Удостоверьтесь, что проставили тег CategoryHomepage в конце Вашей личной страницы (есть по умолчанию в шаблоне HomepageTemplate).

Подписка

Забыли пароль?

Если Вы потеряли или забыли пароль от своего вики-акканута, пройдите на страничку восстановления пароля(recoverpass), затем следуйте инструкциям (напишите Ваш email и нажмите кнопку "Отправить мне данные моей учетной записи").

Стили написания / Вики-этикет

Есть по меньшей мере 5 основных стилей вики-страниц

Для более подробной информации воспользуйтесь указанными ссылками.

Попробуйте соблюдать баланс, когда пишете. Избегайте перекосов. Если Вы знаете, что Ваши комментарии носят спорный характер, подчеркните это, чтобы остальные чувствовали себя более свободными, чтобы опровергнуть их или привести альтернативную точку зрения.

Смотрите также GoodStyle.

Ссылки

Не злоупотребляйте ссылками. Если их слишком много, читатель не будет знать, какая из них наиболее полезна. Вы можете вставить несколько ссылок в раздел "See also", располагающийся внизу страницы (но опять же, не слишком много).

Когда ссылки ведут к страницам на другом языке, добавляйте "(in $language)", вот так: ?Something (in French)

Смотрите также помощь по moinmoin

Внутренние ссылки

Внутренние ссылки (в границах этой вики)

  1. [[FooPage]] - предпочитаемый синтаксис. Например, [[ru/DebianWiki/Contact]] - ru/DebianWiki/Contact.

  2. [[SomeParentPagewith/FooPage|FooPage]] - часто используется, чтобы сократить длинную ссылку. Например, [[ru/DebianWiki/Contact|Contact]] - Contact.

  3. [[EditorGuide|editor guide]] может быть использовано для того, что привести ссылку в нормальном виде, то есть полностью написанной строчными буквами. Например, [[ru/DebianWiki/Contact|связь с людьми, работающими над вики Debian]] - связь с людьми, работающими над вики Debian.

  4. Не "переименовывайте" коренным образом ссылки, используя [[PageName|Another title]] (если Вы делаете так, то, возможно, это говорит о том, что статья по ссылке неправильно названа).

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

Для ссылки на подраздел внутри статьи, Вы должны определить место, используя т.н. якорь (anchor) - <<Anchor(bar)>> (смотрите HelpOnMacros), тогда используйте [[#bar|Bar Chapter]] или [[Foo#bar|Bar Chapter]] (где Bar Chapter - это название параграфа). Например, в начале раздела "Ссылки" настоящей статьи поставлен якорь links (<<Anchor(links)>>, можно посмотреть в "Правка" в самом верху страницы, только не изменяйте ничего, если новичок). Теперь можно ссылаться на параграф "Ссылки" настоящей статьи используя конструкцию [[#links|Ссылки]] - Ссылки. Или же ссылка на параграф другой страницы [[DebianWiki/EditorGuide#links|Links]] - Links.

Ссылки на внешние сайты

Предпочтительный способ ссылаться на внешние ресурсы:

(избегайте записей, скрывающих само тело ссылки [[http://www.foo.com|link label]], кроме тех случаев, когда этого требует контекст, например "Вася Пупкин предоставил скрипт test.sh.")

Используйте InterWiki-формат, чтобы ссылаться на пакеты Debian, отчеты об ошибках, стандарты и статьи википедии.

Ссылки с внешних сайтов

Если на страницу вики ссылаются из других ресурсов Debian, полезным будет пометить эту страницу тегом CategoryPermalink, чтобы никто не смог по ошибке её удалить.

Форматирование

Header section

Материал, который располагается вверху страницы в header-области, включает в себя:

Посмотрите шаблон DefaultTemplate. Не используйте макрос <<Include()>> для автоматического выбора нужного языка (?). Почему? Потому что, если он будет использоваться на каждой странице, то сервер вики будет перегружен. Главная страница вики - единственное исключение из этого правила.

Disambiguation banner

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

Disambiguation : This page is about Debian Conferences.
For Debian configuration management system, see debconf.

Debian "official material" banner

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

Образец ссылки на некую официальную страницу, связанную с текущей статьей

Table of Contents sections (содержание статьи)

Если статья обширна, вы можете добавить в нее таблицу с содержанием (Table of Contents). Образец можно посмотреть вверху этой страницы!

Раздел FAQ

Типичный FAQ может быть оформлен так:

Q. Как я могу сделать XXXX?
A1) Вы можете сделать XXXX, совершив X.
A2) Вы можете сделать XXXX, попробовав Y.

Код (необходим пробел в начале строки):

 Q. Как я могу сделать XXXX? :: A1) Вы можете сделать XXXX, совершив X.
 :: A2) Вы можете сделать XXXX, попробовав Y.

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

Page Fragments

Не только вики-код может быть многократно использован, содержание статей тоже! Если Вы хотите, чтобы нужный обрывок текста был повторен на других страницах, Вы можете использовать page fragment каждый раз. (Но не злоупотребляйте этим, дублируя контент повсюду!)

Пример доступен по ссылкам InstallingDebianOn (статья куда вставлен фрагмент) и InstallingDebianOn/PageFragments/Philosophy (сам фрагмент). Вы также можете обратить своё внимание на то, как фрагмент вставляется в таблицу (но не используйте это в качестве обходного пути при форматировании с помощью moinmoin: смотри Complex Formatting).

Продвинутое форматирование/Complex Formatting

Избегайте продвинутое форматирование (использование таблиц, include, и т.д.)

Изображения, медиа-контент и другие вложения

Смотрите также: для moinmoin - HelpOnLinking.

Авторское право

Добавьте информацию об авторском праве внизу страницы, где Вы вставили изображение, таким образом:

## attachments:
##  openlogo-100.jpg  Copyright 1999 "Software in the Public Interest" from http://www.debian.org/logos/openlogo-100.jpg

Расположение

Лучше будет прикреплять изображение к родительской странице (а потом уже ссылаться на нее из других мест).

Для переведенных страниц прикрепляйте изображение к англоязычной версии (кроме локализованных изображений, например, с не-англоязычными надписями).

Скриншоты

Если Вы хотите вставить скриншот, возможно, стоит сохранить его на ресурсеhttp://screenshots.debian.net/, и тогда можно будет применить код:

Образец:

Расположение изображения

http://www.debian.org/logos/openlogo-nd-75.jpg

Можно сдвигать изображение вправо, используя CSS' float:right:

||<tablestyle="float:right; width:100px; background:transparent; margin: 0 0 1em 1em;" style="padding:0.5em; border-style:none;"> {{http://www.debian.org/logos/openlogo-nd-75.jpg}} ||

"Work needed" теги

Тег - это пометка, которая имеет особое значение для сообщества. Его используют для группы страниц, для поиска по тегам и/или просмотра всех страниц, которые помечены этим тегом. Если используете MoinMoin, то необходимо применять Categories.

Используемые в данное время вики-теги:

  • FixMe - страница нуждается в исправлениях.

  • ToDo - статья нуждается в помощи, чтобы закончить ее.

  • CleanMe - вики-тег, связанный с последней миграцией с вики-движка Kwiki на нынешний MoinMoin.

Перечисленные теги относятся к т.н. Work needed.

Важно: не используете #deprecated, так как это мешает дальнейшему редактированию статьи (например, исправлению устаревших ссылок). Если Вы хотите, пометить страницы, нуждающиеся в улучшении/удалении, используйте в них соответствующие вики-теги.

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

Статьи вики (страницы)

Требования к именам страниц и ссылкам

Создание статей

До создания статьи задайте себе несколько вопросов:

Если сомнений нет, то вперед:

Смотрите также: moinmoin's HelpOnPageCreation.

Переименование статей

Хорошие URIs не изменяются (w3). Всё же, иной раз необходимо переименовать статью, когда ее название не совсем точно отражает содержание.

До того, как Вы переименуете страницу:

Если сомнений не осталось:

Важно: Если переименовывание требует создания страницы перенаправления, то, возможно, идея сменить название плоха.

Удаление статей

Прочитайте Переименование статей, так как советы оттуда применимы и в данном случае.

Если Вы думаете, что страница должна быть удалена, Вы можете либо:

Не будьте несдержанными: не копируйте содержание существующих статей (с последующим их удалением) в какую-либо новую. Лучше посмотрите Слияние и разделение статей.

Опять же, если имеются переведенные версии, то удаляйте и их!

Слияние и разделение статей

Реорганизация вики - это хорошо. В следующих ситуациях:

По возможности сохраняйте историю работы над статьей:

Для переводов: если Вы не можете слить/разделить страницы на других языках, оставьте комментарии для иноязычных редакторов, чтобы они могли сделать это сами.

Страницы перенаправления

В некоторых случаях, Вам, возможно, будет необходимо создать страницу перенаправления (которая автоматически перенаправит браузер по нужному адресу).

Не злоупотребляйте этим инструментом.

Код:

#redirect DestinationPage
go to [[DestinationPage]]

Имейте ввиду, что #refresh не поддерживается в этой вики.

Смотрите также: moinmoin's HelpOnProcessingInstructions.

Категории

Помощь moinmoin wiki: using categories.

Список категорий, используемых в этой вики: CategoryCategory.

Порталы

Порталы - это узловые страницы, содержащие ссылки на статьи. Они образуют систему взаимосвязей внутри вики, вместе с категориями и поисковой машиной.

Порталы должны быть основаны на шаблоне портала PortalTemplate.

Создание порталов

Чтобы сделать из статьи портал, добавьте тег CategoryPortal в её подвал.

Не создавайте порталы, наполненные недействующими ссылками.

База данных изображений

Используемые сообществом иконки и логотипы порталов могут храниться в Portal/IDB. Это полезный инструмет для переводящихся на другой язык порталов и для создания единого оформления.

Переводы

В верхней части каждой статьи обычно есть ссылки к её вариантам на других языках - см. Headers section, а также можете посмотреть шаблон статьи DefaultTemplate.

Основы:

Синхронизация переводов

Это когда Вы обновляете статью для соответствия с другими языковыми версиями (т.н. "синхронизация" версий),

Переводчики вики

Участники, вовлеченные в перевод статей вики Debian, могут добавить тег CategoryWikiTranslator на свою домашнюю страницу.

Помощь wiki.debian.org

Вы можете улучшить wiki.debian.org:

Debian нужна помощь не только в IT-области, но и в других сферах (в юридической сфере; маркетинге; организации мероприятий; сборе средств; связях с общественностью и многое другое). Смотрите также Как помочь Debian?.

Продвижение wiki.debian.org

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

Если Вам задали вопрос в листе рассылки, на форуме или на IRC-канале,

Часто задаваемые вопросы (FAQ)

Q) Могу я получить список всех страниц этой вики?

A) Да, смотрите TitleIndex.

Q) Может, чтобы улучшить вики, стоит коренным образом реорганизовать её?
A) Возможно, но реструктуризованная вики может создать множество трудностей. Гораздо более важно наполнить нынешний её вариант полезным содержанием.
Q) Есть какой-нибудь способ вывести список статей-сирот (статьи без ссылок на них)?

A) Нет (OrphanedPages не работает; ссылки в виде [[PageName|Link Label]] в счёт не идут). Но существование сирот представляет собой проблему только в том случае, если есть страницы, которые должны ссылаться на них, но не ссылаются (тогда исправьте это), или если статья-сирота не показывается в результатах поиска (тогда убедитесь в том, что она включает в себя соответствующие ключевые слова, и без ошибок).

Q) Как я могу отслеживать изменения?
A) Используя два способа, представленные на верхней панели:
  • ссылка на страницу RecentChanges (отслеживание изменений ограничено неделей для обычных посетителей, 90 днями для залогинившихся пользователей);

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

Техническая информация

Эта вики запущена на ПО moinmoin, версия 1.9 (Системная информация). На данный момент всё запущено на оборудовании, предоставленном Dembach Goo Informatik GmbH & Co KG (и железо, и хостинг, и канал).