Правила Энциклопедии — Rules Encyclopedia

Содержание

< Энциклопедия | Правила Энциклопедии — Rules Encyclopedia

Перед началом редактирования страниц в зоне RU следует ознакомиться с Правилами ресурса:

Все действующие инструкции перечислены на странице Правила Энциклопедии.

Этот документ поможет более эффективно работать над Wiki-документацией.

1 Об этих правилах
2 Страницы обсуждений
3 Создание новых страниц
- 3.1 Использование категорий
4 Шаблоны
- 4.1 Добавление нового шаблона документов
- 4.2 Список существующих шаблонов документации
5 Изображения и графика
6 Расстановка ссылок
7 Основные работы по редактированию

Об этих правилах

Данный документ описывает общие методы работы с системой MediaWiki, используемой в качестве технологической платформы Энциклопедии.

Данный документ отвечает на вопрос "как сделать".

Вопросы "почему" и "зачем" освещены в Полном своде правил Энциклопедии: Правила Энциклопедии.

Страницы обсуждений

Страницы обсуждений предназначены для комментирования и обсуждения статей. Каждая статья имеет свою собственную страницу обсуждений.

Чтобы добавить комментарий к странице, необходимо:

Щёлкнуть по вкладке Обсуждение вверху страницы.
- Чтобы начать новую тему в обсуждении, щёлкнуть по знаку [+] справа от вкладки Править вверху страницы, заполнить тему и записать свой комментарий в текстовом поле.
- Чтобы добавить комментарий к существующей дискуссии, нужно создать отступ перед своим ответом (он должен быть больше, чем отступ у абзаца перед комментарием). Для этого требуется вставить одно или несколько двоеточий (:) в начале каждого абзаца комментария. Одно двоеточие эквивалентно одному табулятору.
Подписать сообщение. Для этого нужно вставить четыре тильды подряд (~~~~). Они преобразуются в подпись и текущую дату. Это можно сделать автоматически с помощью кнопки ( ) на панели инструментов.
По окончании, в поле «Описание изменений» ввести краткое описание сделанных изменений и щёлкнуть по кнопке Записать страницу.

Более подробная информация о создании обсуждений приведена в статье Help:Talk pages/ru.

Создание новых страниц

Перед созданием страницы необходимо убедиться, что по данной теме уже не создана страница.

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

 http://wiki.services.openoffice.org/wiki/национальная_языковая_страница/имя_новой_страницы

При создании страницы таким образом, необходимо учитывать существующее дерево wiki-страниц. То есть если страница относится к какому-либо разделу, то в своём имени она должна содержать имя этого раздела. Например, если создаётся страница в проекте "qa" (контроль качества) в русскоязычной языковой зоне, в браузере в строке URL нужно ввести:

 http://wiki.services.openoffice.org/wiki/RU/qa/имя_новой_страницы

Рекомендуемый метод заключается в предварительном поиске нужной информации (поле Поиск на странице слева), и если требуемая страница не найдена (не существует), будет предложено создать данную страницу щелчком по ссылке «Создать страницу» на странице результатов поиска.

Создание страниц напрямую через URL допустимо только если затем будут добавлены ссылки на эту страницу с других страниц. В противном случае эта страница окажется «потерянной» в wiki.

Подробные правила изложены в разделе Правила Энциклопедии и обязательны к исполнению.

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

Использование категорий

Из-за проблемы "процентного кодирования" нелатинских символов в URL, механизм категорий в Энциклопедии не используется для пользовательской навигации и поиска информации.

Категориям в Энциклопедии отводится вспомогательная техническая роль.

Категории, в которые включена страница, как правило, перечислены в нижнем колонтитуле страницы. Щелчок по категории ведёт к просмотру страницы заголовков страниц, которые отнесены к данной категории. Таким образом, категории являются тегом (меткой) для страниц, с помощью которого возможно просмотреть тематически связанные страницы.

Для добавления страницы в категорию необходимо добавить ссылку [[Category:''Имя_Категории'']] в конце страницы.

В Энциклопедии крайне не рекомендуется ручное категоризирование страниц. На каждой странице помещается шаблон подвала, в котором уже указана необходимая категория. Подробнее: (Разраб.) Инструкция. Шаблоны, общие для всех национальных языковых страниц.

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

Не нужно создавать дубликаты категорий по одной теме. Имена категорий должны быть уникальными. В противном случае станет весьма затруднительно использовать систему категорий для поиска информации в wiki.

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

Шаблоны

Рекомендуется обратиться к документации на MediaWiki

Добавление нового шаблона документов

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

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

Для того чтобы все шаблоны собрать в одну категорию, необходимо добавить к шаблону собственную категорию, которая, при этом, не будет влиять на категоризацию страницы, на которой будет применён шаблон. Данная категория помещается между тегами <noinclude>. Подробнее об этом изложено в документации: MediaWiki help: Template (en).

Созданный шаблон нужно добавить в одну из нижеприведённых инструкций, описывающих соответствующую серию шаблонов.

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

Список существующих шаблонов документации

Это список шаблонов документации и примеров их использования

Имя шаблона	Где использовать	Пример использования
Template:Documentation/hbar	Используется для рисования горизонтальных баров, для простых гистограмм {{Documentation/hbar`\|`width=100`\|`bg=#3333FF}} {{Documentation/hbar`\|`width=57`\|`bg=#33FF33}} {{Documentation/hbar`\|`width=112`\|`bg=#FF3333}}
Template:Bug	Ссылки на вопрос (баг) в Issuezilla. {{Bug`\|`123456}}	Issue 123456
Template:HeaderBlock	Оформительский шаблон. Предназначен для оформления самых важных ссылок в виде подобия кнопки. {{HeaderBlock`\|`[[RU]]}}	RU
Template:*TOC	Несколько видов оглавлений, основанных на Template:MasterTOC, используемых в руководствах.	См. например, Basic Guide TOC
Template:MasterTOC	Это базовый шаблон для создания оглавлений. Для использования нужно кликнуть на имени шаблона.

Изображения и графика

Вот основные правила для картинок.

Заголовок картинки должен быть уникальным и информативным. Имя файла так же должно иметь смысл, например scr_writer_conf_slovar.png отлично подойдёт для скриншота(scr) окна настройки(conf) словаря(slovar) в OOo Writer(writer).
Загружать картинки лучше в их оригинальном разрешении, если это возможно. Wiki автоматически создаёт уменьшенные картинки, которые в последствии можно вставлять в статьи.
Рекомендуется отредактировать картинку так, чтобы сделать основную её часть более заметной. Например: подчеркнуть красной линией нужную команду в меню.
Всегда необходимо помнить о том, что статью с этим изображением могут перевести на другой язык. Поэтому желательно избегать подписей и сносок на самой картинке, это упростит процедуру перевода.
Форматы: JPG для фотографий, SVG для значков, логотипов и т. п., PNG — для снимков экрана. Запрещается использовать BMP. (Paint давно поддерживает другие форматы)

Перед вставкой в статью картинку необходимо загрузить на сервер. Для этого на боковой панели существует ссылка «Загрузить файл» в разделе инструменты. На странице описания картинки необходимо кратко сформулировать, что содержится на ней, а также акцентировать внимание на авторских правах на изображение, если это необходимо.

Загруженные картинки размещаются на странице с помощью следующего тега:

[[Image:<имя>|<предпр.>|<положение>|<размер в px>|<надпись>]]

Имя: имя файла загруженной картинки.
Предпр.: thumb — создать уменьшенную копию и поместить в обрамление; none — вставить как есть.
Положение: положение картинки на странице, left — слева с обтеканием; right — справа с обтеканием; none — картинка расположится слева, без обтекания.
Размер: максимальная ширина картинки в px. Если изображение больше этого значения, то оно будет смасштабировано, если меньше, то останется как есть.

Если не указаны положение и размер, то изображение будет расположено справа в виде маленькой картинки.

Например:[[Image:'''LoadSaveOptions.png'''|thumb|left|250px|Окно настройки OOo]]

Окно настройки OOo

* Как управлять нумерацией изображений и таблиц?

Расстановка ссылок

Хотя окно редактирования предлагает помощь в создании внутренних и внешних ссылок, рекомендуется просмотреть MediaWiki страницу помощи по ссылкам для лучшего понимания того, как ссылки работают в Wiki.

Возможно, также будет полезной страница помощи MediaWiki примеры ссылок (en).

При создании текста ссылки необходимо следовать руководству по стилю using links (en).

Основные работы по редактированию

Редактирование возможно только после входа под своим именем. Редактировать можно сразу всю страницу, щёлкнув по вкладке править на самом верху. Но обычно удобнее редактировать отдельные разделы страницы, щёлкнув по ссылке [править] справа от заголовка раздела. При редактировании, просьба соблюдать принятые стили оформления (en) в целях обеспечения единства стилей всех статей. Перед сохранением изменений, рекомендуется использовать кнопку «Предварительный просмотр».

Исправление несоответствующей действительности, неточной или устаревшей информации

Информация, не являющаяся актуальной, обычно отмечается одним из следующих знаков:

{{OutDated`\|`RU}}	Эта метка означает, что статья устарела и информация из неё актуальна только для предыдущих версий офиса.	Эта статья нуждается в помощи: Проверка орфографии	Если статья частично устарела или содержит неточную информацию, эта метка будет знаком просьбы о помощи в редактировании.
Эта статья должна быть проверена на точность и соответствие стилю.	Набор страниц, отмеченных таким знаком, может быть найден по ссылке Страницы, требующие доработки на главной странице Wiki\RU.

Выбрав страницу для редактирования, необходимо:

проверить, что описанные инструкции всё ещё действуют для текущей версии OpenOffice.org;
войти в систему и сделать необходимые исправления.

Удобно работать в двух вкладках браузера: одна вкладка — для чтения описанных инструкций, вторая — для редактирования.

Закончив редактирование, нужно удалить метку (или метки) о том, что статья требует редактирования, и поставить отметку «Проверена формальная точность» (как описано в Шаблонах предыдущего раздела). Затем щёлкнуть кнопку Записать страницу .

Исправление незначительных ошибок и опечаток

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

Исправление картинок и снимков экрана

Для редактирования графики в Wiki необходимо щёлкнуть правой кнопкой мыши по картинке и выбрать пункт Сохранить изображение как…. После редактирования картинки на своем компьютере нужно вернуться на страницу Wiki, щёлкнуть по картинке и на странице описания изображения выбрать пункт Загрузить новую версию этого файла.

Чтобы загрузить новую версию снимка экрана, нужно щёлкнуть на соответствующий снимок экрана Wiki и выбрать пункт Загрузить новую версию этого файла на странице описания изображения.

Стилевые и языковые исправления

Статьи, требующие стилевых и языковых исправлений, можно узнать по следующим меткам:

Эта статья нуждается в помощи:

Проверка орфографии

Эта статья должна быть проверена на точность и соответствие стилю.

Набор статей, имеющих последнюю метку, можно получить, нажав на ссылку Страницы, требующие доработки на главной странице Wiki/RU.

Чтобы улучшить такую статью, необходимо войти в систему, щёлкнуть по ссылке редактирования и внести соответствующие изменения. Затем удалить метку (или метки) и щёлкнуть кнопку Записать страницу .

Ссылки на локализованные страницы

Ссылки между страницами на разных языках можно делать, используя синтаксис ссылок Interwiki [[ISO_Lang_code:Page_Title]].
Например,

[[zh:Zh/Documentation/DevGuide/OpenOffice.org_Developers_Guide]]

добавляет ссылку на китайский перевод первой страницы Руководства разработчика. Эта ссылка показывается в левом столбце под заголовком «на других языках». При добавлении новых локализаций более практичным будет воспользоваться шаблонами Wiki.

В Руководстве разработчика используется шаблон для создания ссылок на страницы переводов.
Синтаксис Wiki следующий:

{{Documentation/DevGuideLanguages|Page_Title}}

Page_Title — это имя текущей страницы Wiki.

Например,

{{Documentation/DevGuideLanguages|Documentation/DevGuide/OpenOffice.org/Developers Guide}}

добавит ссылки на локализованные страницы для первой страницы Руководства разработчика.

Чтобы увидеть ссылку на локализацию на свой язык страниц Wiki Руководства разработчика, нужно просто добавить свой язык в шаблон

Template:Documentation/DevGuideLanguages

Например, для немецкого языка необходимо добавить

[[nl:NL/{{{1}}}]]

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

Проверка содержимого

Локализация контента

Для локализации материалов вики на с других языков, разработаны Принципы перевода страниц.

Content on this page is licensed under the Public Documentation License (PDL).

К началу страницы

Введение в Wiki-редактирование — Introduction to the Wiki-editing

Contents