Документерра: руководство пользователя

Справочник мастера импорта проекта

В этой теме рассказывается о Мастере импорта проектов и его опциях. Чтобы открыть Мастер, перейдите на Панель автора и нажмите кнопку Импортировать документ.

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

Шаг 1. Начало

Стартовая страница мастера импорта всегда одинакова, независимо от того, импортируется ли контент из приложения по управлению документацией, например, из Confluence, или из такого формата как, например, HTML.

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

Стартовая страница Мастера импорта проектов

Настройки, доступные на данной странице:

Формат импорта. Формат входных данных. Это поле автоматически заполняется наиболее подходящим форматом для приложения, выбранного в верхней части Мастера. Например, при выборе Word система установит для параметра Формат импорта значение Microsoft Word file (.doc или .docх). Однако впоследствии вы можете изменить этот параметр вручную.
Импортировать в. Здесь указывается место назначения для импорта документов: новый или существующий проект.
Название проекта. Название проекта, которое будет отображаться во всем интерфейсе. Эта опция видна только при импорте в новый проект.
Идентификатор (ID) проекта. URL-версия названия проекта. Обычно ID проекта полностью состоит из строчных символов и содержит только буквы, цифры и дефисы. По умолчанию идентификатор проекта основан на его названии, а само поле скрыто - под полем "Название проекта" отображается только предварительный просмотр URL. Но вы можете изменить идентификатор проекта, нажав на кнопку Изменить ID проекта справа от предварительного просмотра URL. Эта опция видна только при импорте в новый проект.
Язык проекта. Устанавливает язык, который используется системой для различных оптимизаций. Чтобы узнать больше, см. раздел Изменить язык проекта. Эта опция видна только при импорте в новый проект.

Шаг 2. Настройки импорта

Примечание

Начиная с этого шага, Мастер импорта из Confluence довольно сильно отличается от мастеров всех остальных форматов, поэтому для получения более подробной информации обратитесь к разделу Справочник Мастера импорта из Confluence.

На второй странице мастера можно выбрать настройки формата и загрузить один или несколько исходных файлов.

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

В мастере OpenAPI/Swagger Import Wizard есть параметр Upload an OpenAPI definition from URL:, который позволяет указать путь к файлу определения OpenAPI/Swagger.

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

Кодировка страниц. Настраивает кодирование, используемое в исходном файле; по умолчанию используется Автоматическое определение. Этот параметр доступен только для форматов CHM (Microsoft Compiled Help), HTML-подобных форматов (HTML, XHTML) и Open Document (.odt). Эта настройка доступна только для формата CHM.

Разбивка на страницы по параметру. Данная опция определяет, как система будет разбивать исходный документ на страницы. Существует четыре возможных варианта:
- Разбивка по стилю текста (Заголовок 1, Заголовок 2...) Новая страница будет создаваться с заголовком, указанным в документе. Заголовки будут ранжироваться по уровням: основной заголовок и подзаголовки.
- Разбивка по абзацам. Страницы создаются в зависимости от параметров абзаца документа. Иерархия сохраняется.
- Разбивка по полям ТС. Страницы создаются согласно полям TC (специальным скрытым элементам, используемым в Microsoft Office для создания Дерева страниц) документа MS Word. Это поле недоступно при импорте из HTML.
- Импортировать как одну страницу. Весь документ рассматривается как одна страница. Это поле недоступно при импорте из HTML.
Максимальная глубина разбивки. Устанавливает глубину Дерева страниц. Это поле недоступно при импорте из HTML.
Оптимизировать стили, Сохранить исходные стили, и Не импортировать стили. Кнопки-переключатели («радиокнопки») позволяют настроить обработку стилей из исходного документа. You can learn the details by reading the Handling Content Styles topic.
Создать CSS-классы. Если на этой опции установлен флажок, встроенные стили из исходного документа копируются в CSS-файл проекта с расширением .css. Им автоматически присваиваются имена. Это поле недоступно при импорте из HTML.
Импорт стилей в. Определяет, импортировать ли стили в новый или существующий CSS-файл. Это поле доступно, только если вы импортируете контент в существующий проект, и установлен флажок Создать CSS-классы.
Формат изображения. Формат, используемый при импорте изображений. Эта настройка доступна для форматов Word (.doc, .docx и RTF) и Open Document (.odt).

Более подробно об импорте из каждого приложения/формата можно прочитать в соответствующих разделах:

Шаг 3. Прогресс выполнения задачи

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

Шаг 4. Завершение

Это последняя страница Мастера импорта проектов.

После успешного импорта появятся ссылки на CSS-файлы, связанные с проектом, чтобы вы могли сразу же отредактировать их при необходимости. Более подробную информацию см. в разделе Работа со стилями контента страниц.

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

Импорт и перенос контента Перенос контента в систему Документерра