FAQ по документации

Материал из Mandriva Russian Community Wiki

Установка с CD/DVD и обновление до Cooker

Для работы с документацией Mandriva Linux необходимо обновить систему до Cooker, чтобы получить доступ к последним возможностям и реализациям пользовательского интерфейса.

После установки alpha или beta, или RC с CD/DVD выполните следующие действия:

• получите права администратора при помощи команды su и выполните команду edit-urpm-sources.pl;
• уберите галочки с существующих источников приложений, затем нажмите Добавить и выберите зеркало для добавления источника пакетов приложений;
• нажмите OK, чтобы добавить источники;
• выполните команду urpmi --auto --auto-select для автоматического обновления всех пакетов;
• после перезагрузки вы получите систему с самыми свежими пакетами.

Примечание

• Само собой разумеется, всё это НЕ СЛЕДУЕТ производить на рабочих компьютерах, задействованных в производстве или любой ответственной работе.
• Из-за особого характера Cooker всё может закончиться крахом системы, поэтому делайте это на свой страх и риск.
• Желательно выполнять urpmi.update -a && urpmi --auto --auto-select время от времени, чтобы иметь последние пакеты из Cooker.

Изменение темы Free на PowerPack

Для создания снимков экрана (скриншотов) должна использоваться тема PowerPack. Чтобы изменить тему оформления Free на PowerPack, сделайте следующее:

• удалите ярлык «Обновить до PowerPack» с рабочего стола или любые другие ярлыки, расположенные на рабочем столе;
• выполните rpmdrake (от администратора) и выберите следующие пакеты (и возможные зависимости):
  • mandriva-release-Powerpack;
  • mandriva-theme-Powerpack;
  • mandriva-theme-Powerpack-screensaver;
  • powerpack-kde*-config;

• примените и подтвердите установку ПО.
• выберите для удаления следующие пакеты (и возможные зависимости):
  • free-kde*-config;
  • mandriva-theme-Free;
  • mandriva-theme-Free-screensaver;
  • mandriva-release-Free;

• примените и подтвердите удаление ПО;
• в окне терминала, удалите папки ~/.kde и/или ~/.kde4 для пересоздания пользовательского пространства с нуля. Помните, это удалит ваши настройки, а также данные приложений KDE.
• перезагрузите систему и наслаждайтесь темой оформления PowerPack!

Ручная проверка XML-модулей перед добавлением в репозиторий

Если вы не используете редактор, проверяющий XML, например как XXE, вам следует проверить свои файлы перед добавлением их в репозиторий.

Помните, что если вы не проверите файлы, это не нарушит весь репозиторий, т. к. система сборки игнорирует некорректные файлы. Также утилита svnnav показывает некорректные файлы и выводит список ошибок на странице модуля.

Итак, для ручной проверки своих логических файлов:

1. загрузите спецификацию XML: wget http://www.docbook.org/xml/5.0/rng/docbookxi.rng;
2. проверьте свои файлы используя метод relaxng, описанный здесь.

Примечание

Вы можете получить подобные ошибки:

"drakconsole" is referenced by an IDREF, but not defined.

Так происходит потому что мы ссылаемся (xref) на идентификаторы, которые есть в другом модуле и это недопустимо для программы проверки. Просто проигнорируйте это.

Использование PO для перевода документации

Команда документации уже давно решила использовать XML для перевода документов (Сделать: Добавить краткое резюме на тему сравнения преимуществ XML над PO). Мы знаем что большинство переводчиков, занимающихся переводом программного обеспечения (и с командным, и с графическим интерфейсом) используют формат (gettext) и утилиты PO . Мы включили этот отрывок чата (спасибо reinouts и gnome-doc ppl!) в надежде на то, что переводчики, которые использовали PO могли переводить нашу XML документацию, используя привычный им формат и утилиты.

<claude> reinouts: базовую документацию по xml документам можно увидеть здесь:
<claude> http://live.gnome.org/GnomeDocUtilsCreateNew
<reinouts>  тогда можно использовать xml2po
<claude> reinouts: и xml2po -e -u ll.po ../C/orig.xml для генерации переведенной документации
reinouts: Вы также можете взглянуть на функции doc_l10n_stats и generate_translated_docs в /damned-lies/trunk/update-stats.py чтобы увидеть, как можно автоматизировать процесс
<reinouts> (это ссылка на http://svn.gnome.org/viewvc/damned-lies/trunk/update-stats.py?revision=885&view=markup)

Помните: обратите внимание, что ссылка GnomeDocUtilsCreateNew предполагает, что перевод документации осуществляется для приложения gnome, поэтому Вам не нужно адаптировать его в соответствие со стилем документации Mandriva Linux.

Сделать: Подчистить для соответствия со стилем документации Mandriva Linux.

Пиктограммы

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

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

• предпочтительный размер — 48x48 пикселов;
• вместо прозрачного фона используется белый фон (который, как известно, затрагивает отрисовку PDF, что приводит к чёрному фону на выходе);
• пиктограмма желательно должна иметь исходное название при копировании в common/images/.

Размещение снимков экрана в формате SVG

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

1. откройте SVG и отметьте название изображения PNG (правый щелчок мышью → Свойства изображения);
2. сделайте новый скриншот, если возможно, используйте тот же размер изображения;
3. замените PNG-файл на SVG с новым скриншотом;
4. удалите скриншот из SCG в inkscape, чтобы избежать искажений, если размеры различаются;
5. импортируйте новый PNG inkscape;
6. улучшите схему, если это необходимо (поместите скриншот в фон, добавьте стрелки и т. п.).