Политика Wiki-редактирования

Перед началом редактирования следует ознакомиться с Положением и информационной политикой ресурса.

Эта статья поможет вам эффективно создавать разделы wiki-документации.

Мы настоятельно рекомендуем Вам, объявлять о создании новых страниц или производстве значительных изменений в список рассылки dev@documentation.openoffice.org.

Набор правил. Независимый проект

В начале смотрите главный набор правил Wiki Contribution Guidelines (в процессе перевода).

Перед началом редактирования

Прежде чем вы сможете редактировать, вам нужно зарегистрироваться. Это не сложно.

1. Щёлкните по Log in / create account в правом верхнем углу экрана и введите необходимую информацию.
   Мы рекомендуем использовать то же имя пользователя, что и на веб-сайте OpenOffice.org.
2. Затем вам надо будет подтвердить ваш адрес электропочты.

Для входа в систему используйте точку входа вверху страницы, введите ваш логин и пароль, щёлкнув по кнопке Log in.

На следующем шаге расскажите Сообществу о себе. Это безвредно и создаёт комфорт для работы в Wiki.

1. Когда вы вошли в систему, имя пользователя отображается вверху страницы красным цветом, до тех пор, пока вы не создадите свою страницу. Эта страница является вашим профилем. Щёлкните по своему имени, чтобы создать его.
2. На вашей странице, добавьте несколько разделов, как указано ниже, в ваш профиль OpenOffice Wiki;
   • Несколько слов о себе;
   • OpenOffice и вы;
   • Ваш вклад;
   • Направления развития;
   • Какие планы на будущее?;
   • Ссылки (по желанию);
   • Контакты.

Это небольшой шаблон для создания профиля.

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

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

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

Все важные замечания должны быть объявлены в списке рассылки dev@documentation.openoffice.org, дабы гарантировать, что их заметят.

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

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

Более подробная информация о создании обсуждений приведена в статье Mediawiki help about talk pages.

Структура раздела Документация в Wiki

Раздел "Документация" это только часть большой Wiki OpenOffice.org. Проект doc.oo.o пытается представить информацию в этом разделе так, чтобы она была легко доступна и хорошо структурирована для упрощения навигации как пользователей, так и участников

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

Русскоязычный раздел Документация находится на ранней стадии развития и будет поэтапно копировать соответствующие англоязычные разделы. Текущая структура англоязычного раздела выглядит следующим образом:

wiki.services.openoffice.org/wiki/Documentation
   |
   +---Dashboard
   +---Administration Guide
   +---FAQ
   +---How Tos
   +---OOoAuthors User Manual
   +---OOo3 User Guides
   +---Tutorials
   +---Samples, Templates and Clipart
   +---Setup Guide
   +---BASIC Guide
   +---Building Guide
   +---DevGuide
   +---Reference

Subpage	Description
Documentation/Dashboard	Раздел высокого уровня, отслеживающий подпроекты и создаваемое ими содержание.
Documentation/Administration Guide	Руководство по установке и администрированию OpenOffice.org в сети.
Documentation/FAQ	Сборник часто задаваемых вопросов.
Documentation/How Tos	Сборник ссылок на статьи "Как сделать".
Documentation/OOoAuthors User Manual	Сборник документации и руководств пользователя по OpenOffice.org 2.x с ресурса OOoAuthors
Documentation/OOo3 User Guides	Сборник документации и руководств пользователя по OpenOffice.org 3.x с ресурса OOoAuthors
Documentation/Tutorials	Сборники обучающих материалов.
Documentation/Samples, Templates and Clipart	Страница подпроекта шаблонов для бизнеса и личного использования (черновик)
Documentation/Setup Guide	Страница подрпоекта по процессу установки OpenOffice.org (в разработке)
Documentation/BASIC Guide	Введение в программирование на OpenOffice.org BASIC
Documentation/Building Guide	Руководство по разработке пользовательских приложений OpenOffice.org из исходных текстов.
Documentation/DevGuide	Руководство по программированию OpenOffice.org, использоую технологию UNO (Universal Network Objects).
Documentation/Reference	Сборник справочных материалов. Ссылки на эту страницу (Reference Lists)отображаются на главной странице проекта документации.

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

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

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

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

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

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

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

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

В русской языковой зоне существует дополнительное Положение о национальной языковой странице RU и информационная политика, обязательное к исполнению.

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

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

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

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

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

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

Дополнительная информация по категориям находится в документации MediaWiki.

Простой пример того, как использовать категории в книгах Wiki:

1. Создайте категорию с именем текущего раздела.
2. Добавьте новую метку категории для всех страниц этой главы.
3. Добавить теги категория для книги на вновь созданной странице категории.

Читатель может просматривать книгу категории. Книга категории включает все части книги. Если читатель щёлкнет по части категории, он увидит все страницы части в алфавитном порядке.

Не добавляйте категорию и её подкатегории на одну wiki-страницу. Дополнительная информация по категориям и подкатегориям в документации MediaWiki.

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

Шаблоны

Обратитесь к документации на mediawiki

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

• Если вы создаёте новый шаблон для использовании, допустим, в разделе wiki Документация, назовите его как дочернюю страницу Документация.
  • некорректно: новый_шаблон
  • корректно: Документация/новый_шаблон

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

Полностью имя шаблона выглядит так:

Template:RU/Документация/новый_шаблон

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

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

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

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

Имя шаблона	Где использовать	Пример использования
Template:Documentation/Banner	Вставляет "Банер" Проекта Документации в верхний правый угол страницы
Template:Documentation/OOo	Отображает логотип OpenOffice.org	Template:Documentation/OOo
Template:Documentation/PDF	Отображает логотип PDF	Template:Documentation/PDF
Template:Documentation/PRODUCTNAME	Переменная для вывода названия продукта OpenOffice.org.	Template:Documentation/PRODUCTNAME
Template:Documentation/hbar	Используется для рисования горизонтальных баров, для простых гистограмм
Template:RU/documentation/beingedited	Устанавливайте данный знак на странице, которую в настоящее время редактируете, чтобы избежать конфликта изменений. Используйте этот шаблон при выполнении больших изменений в статье, создание которых растягиваются более чем на один сеанс редактирования. Не забудьте добавить имя и дату "замок", добавив ~~~~ в качестве параметра шаблона: Template:RU/code	Template:RU/documentation/beingedited
Template:RU/documentation/needsrework	Отметка для статей, нуждающихся в дополнительной проверке на стилистическое оформление и точность содержания.	Template:RU/documentation/needsrework
Template:RU/documentation/helpneeded	Отметка для статей, нуждающихся в проверке орфографии.	Template:RU/documentation/helpneeded
Template:RU/documentation/checkedaccuracy	Отметка для статей, которые были проверены на точность. Следует, в качестве параметров, указать свой логин, имя и дату проверки: Template:RU/code	Template:RU/documentation/checkedaccuracy
Template:RU/documentation/outdated	Указывает, что статья устарела.	Template:RU/documentation/outdated
Template:RU/documentation/draftpage	Метка для страниц, которые находятся в процессе создания (стадия Черновика).	Template:RU/documentation/draftpage
Template:RU/documentation/imported	Отметка для статей, взятых из другого источника, с указанием автора и ссылкой на оригинал.	Template:RU/documentation/imported
Template:Documentation/Windows	Отображение логотипа Windows для ввода Windows-зависимого контента.	Windows-зависимый контент
Template:Documentation/Linux	Отображение логотипа Linux для ввода Linux-зависимого контента.	Linux-зависимый контент
Template:Documentation/OSX	Отображение логотипа Apple/OSX для ввода OSX-зависимого контента.	Mac-зависимый контент
Template:Bug	Ссылки на вопрос (баг) в Issuezilla.	Issue 123456
Template:Documentation/Note	Применяется для примечаний, для концентрации внимания. Например, объяснений и комментариев.	Это примечание
Template:Documentation/Tip	Применяется для выделения не критичной информации - например, для привлечения внимания к клавиатурным комбинациям.	Правый щелчок мышью для вызова контекстного меню
Template:Documentation/Caution	Примется для предупреждений, для потенциально опасной информации, например, влекущую потерю данных.	Стирание файла может его уничтожить.
Template:RU/documentation/seealso и Template:RU/documentation/devguide/seealso	DevGuide / Смотри также используются в Руководстве для разработчиков и должны быть исключены из создаваемых PDF и ODT книг.	Template:RU/documentation/seealso
Template:RU/fromforum	Отметка для статей, написанных по мотивам обсуждений на форуме community.i-rs.ru	Template:RU/fromforum
Template:Documentation/Abstract	Для краткого обобщения содержания главы руководства. Добавляется в верхнюю часть руководств.	См. например, this Administration Guide Chapter
Template:Documentation/*TOC	Несколько видов оглавлений, основанных на Template:Documentation/MasterTOC, используемых в руководствах.	См. например, Basic Guide TOC
Template:Documentation/MasterTOC	Это базовый шаблон для создания оглавлений. Для использования, кликните на имя шаблона.
Template:RU/documentation/oooversion	Этот шаблон используется для вставки на странице окна с номером версии OpenOffice.org.	Template:RU/documentation/oooversion
Template:RU/documentation/oooproversion	Этот шаблон используется для вставки на странице окна с номером версии OpenOffice.org pro.	Template:RU/documentation/oooproversion
Template:RU/documentation/sign	Этот шаблон используется для вставки в статью подписи с именем автора. Первый параметр - логин автора. Второй параметр - имя, которое будет отображено в подписи.	Template:RU/documentation/sign
Template:RU/documentation/signyear	Этот шаблон используется для вставки в статью подписи с именем автора и датой создания статьи. Первый параметр - логин автора. Второй параметр - имя, которое будет отображено в подписи. Третий параметр - дата, выводимая в подписи.	Template:RU/documentation/signyear
Template:RU/documentation/signtrans	Этот шаблон используется для вставки в статью подписи с именем переводчика и датой создания статьи. Первый параметр - логин переводчика. Второй параметр - имя, которое будет отображено в подписи. Третий параметр - дата, выводимая в подписи.	Template:RU/documentation/signtrans
Template:RU/documentation/signtransyear	Этот шаблон используется для вставки в статью подписи с именем переводчика и датой создания статьи. Первый параметр - логин переводчика. Второй параметр - имя, которое будет отображено в подписи. Третий параметр - дата, выводимая в подписи.	Template:RU/documentation/signtransyear
Template:OOoPro	Этот шаблон используется для вставки в статью названия сборки OpenOffice.org pro в любом месте текста.	OpenOffice.org pro
Template:OOo	Этот шаблон используется для вставки в статью названия OpenOffice.org в любом месте текста.	OpenOffice.org
Template:OOo1	Этот шаблон используется для вставки в статью названия OpenOffice.org 1.x в любом месте текста.	OpenOffice.org 1.x
Template:OOo2	Этот шаблон используется для вставки в статью названия OpenOffice.org 2.x в любом месте текста.	OpenOffice.org 2.x
Template:OOo3	Этот шаблон используется для вставки в статью названия OpenOffice.org 3.x в любом месте текста.	OpenOffice.org 3.x
Template:MSO	Этот шаблон используется для вставки в статью названия Microsoft Office в любом месте текста.	Microsoft Office
Template:MSO2003	Этот шаблон используется для вставки в статью названия Microsoft Office 2003 в любом месте текста.	Microsoft Office 2003
Template:MSO2010	Этот шаблон используется для вставки в статью названия Microsoft Office 2010 в любом месте текста.	Microsoft Office 2010
Template:MSW	Этот шаблон используется для вставки в статью названия MS Word в любом месте текста.	MS Word
Template:MSE	Этот шаблон используется для вставки в статью названия MS Excel в любом месте текста.	MS Excel
Template:MSA	Этот шаблон используется для вставки в статью названия MS Access в любом месте текста.	MS Access
Template:MSPP	Этот шаблон используется для вставки в статью названия MS Power Point в любом месте текста.	MS Power Point
Template:MSEq	Этот шаблон используется для вставки в статью названия MS Equation в любом месте текста.	MS Equation
Template:Key	Этот шаблон используется для вставки в статью обозначений сочетаний клавиш.	Ctrl  +  ⇧ Shift  +  →

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

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

• Заголовок картинки должен быть уникальным и информативным. Имя файла так же должно иметь смысл, например 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

* How to handle image and table numbering?

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

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

Возможно, вам пригодится страница помощи MediaWiki examples примеры ссылок (en).

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

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

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

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

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

Template:RU/documentation/outdated	Эта метка означает, что статья полностью устарела и требует переработки.
Template:RU/documentation/helpneeded	Если статья частично устарела или содержит неточную информацию, вы обнаружите эту метку как знак просьбы о помощи в редактировании.
Template:RU/documentation/needsrework	Вы можете найти набор страниц, отмеченных таким знаком, если нажмете на ссылку Страницы, требующие доработки на главной странице Wiki\RU.

Выбрав страницу, над которой хотите поработать,

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

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

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

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

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

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

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

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

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

Статьи, требующие стилевых и языковых исправлений, можно узнать по следующим меткам: Template:RU/documentation/helpneeded Template:RU/documentation/needsrework Набор статей, имеющих последнюю метку, вы можете получить, нажав на ссылку Страницы, требующие доработки на главной странице 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}}}]]

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

Удаление спама / удаление страниц

Если вы обнаружили спам, то пошлите сообщение по адресу dev@website.openoffice.org.

Также существует список администраторов Wiki (en) (пользователей, которые могут удалять страницы Wiki). Если вы считаете, что какие-то страницы Wiki должны быть удалены, вы можете либо послать сообщение кому-нибудь из этого списка, либо - что лучше - добавить отметку Wiki {{delete}} в любом месте страницы, которая должна быть удалена. Это переведет страницу в разряд "Кандидатов на удаление", и страница будет удалена WikiBot или каким-либо из пользователей, имеющих привилегии администратора.

Работа с Базой Знаний (RU/kb)

Для понимания структуры Базы Знаний и правил по размещению статей в ней, рекомендуется ознакомиться со следующими документами:

• Положение о Базе Знаний OpenOffice.org
• Инструкция по написанию статей на национальной языковой странице RU

Работа над Руководствами

На текущий момент в Wiki существуют следующие руководства:

• The Administration Guide (en)
• The BASIC Programming Guide (en)
• The Building Guide (OO.o from source) (en)
• The Developer's Guide (en)
• The User Guides for OpenOffice.org 2.x (en)
• Руководства для пользователя OpenOffice.org 3.x (в процессе перевода)

Если вы хотите поработать над созданием/редактированием Руководств для пользователя OpenOffice.org, пожалуйста, свяжитесь с группой OOoAuthors.

Доступна небольшая справка о Contributing to the Developer's Guide (en), которая может быть также полезна для Administration Guide и BASIC Programming Guide.

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

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

---

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