Documentation/Help Content/ru

Эта страница описывает шаги для создания новых статей или изменения одной из существующих во встроенной Справке LibreOffice.

Файлы Справки имеют формат .xhp. Это XML файлы, которые трансформируются в LibreOffice в формат HTML. Поэтому эти файлы будут содержать всю информацию, необходимую для такой трансформации. Так как LibreOffice -- это не редактор XML, то для соответствия тегам XML будут использованы стили и другие элементы. Эти элементы будут добавлены с помощью макросов Basic.

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

Скачайте файл расширения с именем HelpAuthoring.oxt. Установите его, используя диалог Управление расширениями: Расширение добавит в меню Writer пункт с именем и шаблон xmlhelptemplate, который можно найти пройдя в меню  в каталоге.
 * нажмите на кнопку Добавить в нижней части диалога;
 * найдите скачанное расширение на своем компьютере и выделите его;
 * нажмите на кнопку Открыть.

Получение файлов справки
Файлы Справки LibreOffice находятся в GIT репозитории. В связи с этим для работы с файлами Справки необходимо иметь на своем компьютере установленную рабочую среду Git. Можно скопировать файлы Справки в любое место на компьютере, расширение должно создать файл helpauthoring.cfg в каталоге пользователя, в котором будет прописан путь до файлов. Команда для получения файлов:

Файлы, которые будут необходимы в первую очередь будут находиться в каталоге source/text.

Редактирование файлов
Есть полная документация о структуре Справки и о методах её редактирования (англ.), однако ниже представлены некоторые основные инструкции для начала работы.

Открытие/Сохранение

 * Открытие
 * Чтобы открыть файл Справки, в меню Help Authoring выберите пункт Open Help File или выберите файл типа .xhp в диалоге и откройте его.
 * Документ откроется в Writer. При этом некоторая информация из файла показана не будет (такая, как par_id), однако такие места будут отмечены небольшим жёлтым значком. Для таких мест обязательно нужно использовать стили из шаблона, любые другие стили будут проигнорированы при работе парсера при обработке файла.


 * Сохранение
 * При сохранении документа будет запущена проверка файла на корректность. Эта проверка не очень хорошо проверяет синтаксис, поэтому убедитесь в отсутствии пустых абзацев или в наличии всех ID.

Меню Help Authoring
Ниже кратко описаны пункты меню Help Authoring: localize="false" которое появляется, как par_id0202201317491162_NOL10N в документе мой комментарий здесь  Insert;Name VAR ID="newvariable">
 * создает новый файл в формате .xhp, основанный на шаблоне. Если шаблон не доступен, файл создан не будет и появится сообщение об ошибке.
 * : отображает номер версии расширения
 * : позволяет задать документ в качестве корневого файла
 * : позволяет дать название файлу справки и оставить комментарий. Радиокнопки Indexing позволяют включать или игнорировать файл при выполнении поиска
 * : запускает несколько проверок структуры XML файла
 * : устанавливает аттрибут локализации в положение false:
 * : добавляет ID к абзацу
 * : позволяет добавить примечание в файл
 * : вставляет таблицу в документ
 * : вставляет ссылку на другой файл
 * : вставляет закладку тэга перехода типа
 * : вставляет теги, маркирующие элемент алфавитного указателя
 * : вставляет теги, маркирующие всплывающие подсказки. Диалоговое окно спросит нужно ли их скрыть. Если ответить YES, то они появятся в интерфейсе, но не в онлайн Справке.
 * : вставляет раздел с именем How To Get
 * : позволяет вставить ссылку на изображение
 * : вставляет раздел, с именем Section
 * : вставляет переменную, диалоговое окно позволяет назвать его
 * : позволяет включить другой существующий абзац
 * : вставляет раздел Связанные темы, который содержит ссылки на другие статьи Справки. Обычно помещается в конце страницы.