Создание и редактирование статей встроенной Справки

From The Document Foundation Wiki
Jump to: navigation, search

Самый простой способ редактирования Справки LibreOffice -- это использование расширения HelpAuthoring.

Настройки для редактирования Справки LibreOffice

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

Полную документацию для редактирования и создания новых статей Справки можно найти в файле Understanding, Authoring and Editing OpenOffice.org HELP (PDF).

Расширение HelpAuthoring

Для установки расширения выполните следующие шаги:

  • скачайте последниюю версию расширения (файл оканчивается на .oxt);
  • откройте LibreOffice и пройдите с меню Сервис ▸ Управление расширениями..., в открывшемся окне нажмите кнопку Добавить... и, выбрав скачаный файл, нажмите Открыть;
  • после установки перезапустите LibreOffice (Ctrl+Q, и запустите снова).

Когда откроется LibreOffice Writer вы увидите в гравном меню пункт Help Authoring.

При использовании Help Authoring в первый раз, вы должны установить корневой каталог документов (Help Authoring ▸ Set Document Root...). Корневой каталог - это каталог с подкаталогами source/, в который вы скачали из git исходные тексты справки. Установив один раз, в дальнейшем он будет браться из конфигурации. Версия HelpAuthoring-3.1.1.oxt или более новая попросит вас установить корневой каталог, если он не был установлен до этого.

Исходные тексты справки

Исходные тексты справки находятся в git-репозитории. Для получения их необходимо выполнить следующую команду:

git clone git://gerrit.libreoffice.org/help

В дальнейшем, работа с git будет заключаться в 2 шагах:

  • Получение последних правок из git
git pull -r
  • Отправка ваших изменений на подтверждение в gerrit.

Подробнее о работе с gerrit можно прочитать в статьях How to setup gerrit the first time и How to send a patch for review. При возникновении проблем с gerrit можно обращаться на канал #libreoffice-dev connect via webchat в сети freenode или в почтовую рассылку разработчиков.

Редактирование справки

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

Как найти файл для изменений

Когда у нас есть исходный код Справки и строка, которую мы хотим изменить (например, "wide variety of options" в https://help.libreoffice.org/Writer/Writer_Features#Designing_and_Structuring), можно выполнить следующее:

Перейдите в папку help
cd help
И выполните поиск
git grep "wide variety of options"

Это вернёт нам:

source/text/swriter/main0503.xhp:<paragraph role="paragraph" id="par_id3147239" xml-lang="en-US" l10n="U" oldref="10">$[officename] offers ...

Это означает, что текст находится в файле source/text/swriter/main0503.xhp .

Как изменять файл

При помощи расширения HelpAuthoring

Выберите в меню Help Authoring ▸ Open Help File, перейдите к файлу source/text/swriter/main0503.xhp и нажмите Открыть. Файл Справки откроется в новом окне.

После того как поправите всё что необходимо (например "options" на "possibilities"), нажмите Сохранить на панели инструментов. Когда выйдет диалоговое окно с предупреждением о формате, выберите Использовать формат Help (xhp). После этого вы увидите диалоговое окно с надписью "Validation finished.", и сохранение на этом закончится.

При помощи простого текстового редактора

Практически любой текстовый редактор способен открыть файл .xhp (например, в KDE - это Kate; в Gnome - gedit; Windows - Notepad2; можно также использовать vim или специализированный xml-редактор).

  1. Откройте файл при помощи меню редактора Файл ▸ Открыть или из файлового менеджера при помощи функции Открыть с помощью... ( например для KDE: щелкните на файле правой кнопкой мыши и в меню выберите Открыть с помощью... ▸ Kate).
  2. Так как файлы справки могут быть большие и в них много xml-тегов, воспользуйтесь поиском по файлу (обычно это Правка ▸ Найти... или Ctrl+F).
  3. Выполните необходимые изменения (если вы не уверено чувствуете себя среди xml-тегов файлов справки, убедитесь что вы их не затронули).
  4. Сохраните файл.

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

Как проверить правильность внесенных изменений

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

В первый раз необходимо собрать LibreOffice. В дальнейшем это можно делать время от времени, чтобы иметь актуальную версию. Саму Справку можно будет пересобрать без сборки всего пакета LibreOffice. Подробнее о сборке LibreOffice можно прочитать на страницах посвященных этой теме: для Linux, для Windows, для MacOs.

При сборке LibreOffice необходимо использовать флаг --with-help:

./autogen.sh --with-help

При этом будут скачаны в папку helpcontent2 и собраны файлы справки. В дальнейшем, для проверки правильности файлов справки их можно поместить, соблюдая относительные пути, в папку helpcontent2 и запустить сборку командой make в ней. Файлы для запуска Libreoffice можно будет найти в каталоге каталог_с_исходниками_Libreoffice/instdir/program/. Откройте LibreOffice запустив файл soffice или swriter и нажмите F1 для открытия Справки.

Примечание: Сборка LibreOffice , в зависимости от мощности компьютера, занимает от 3 до 8 часов. Сборка Справки занимает около минуты.

Как отправить изменения на подтверждение

Следуйте инструкциям, описанным в статье How to send a patch for review.

Если при работе с gerrit вы получаете подобные ошибки

fatal: remote error: access denied or repository not exported: /help

попробуйте использовать следующую команду:

git config remote.origin.pushurl ssh://logerrit/help