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

Подготовка HTML к импорту

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

Чтобы подготовить свой контент к импорту, необходимо создать .zip архив со всеми необходимыми файлами (HTMLCSSJS и изображениями). Чаще всего в приложениях по разработке документации это делается автоматически.

Иерархия архива

Структура Дерева страниц, создаваемого Документеррой, зависит от иерархии папок, содержащих HTML-файлы, в импортируемом архиве.   Это означает, что Дерево страниц может быть организовано по-разному в зависимости от архивных папок. Возможны две ситуации: 1) все файлы находятся на одном уровне, 2) некоторые файлы находятся во вложенных папках.

Все HTML-файлы на одном уровне

Предположим, что все файлы расположены в одной папке архива следующим образом:

  • introduction.html
  • support.html
  • system-requirements.html
  • upload.png
  • style.css

В результате в Дереве страниц будет отсутствовать уровневая иерархия. Это будет выглядеть следующим образом:

Дерево страниц без уровневой иерархии

Некоторые HTML-файлы могут находиться во вложенной папке

Представьте, что у вас такая структура:

  • Introduction
    • introduction.html 
    • support.html 
  • system-requirements.html 
  • upload.png 
  • style.css 

После импорта, в новом Проекте будет один элемент в виде папки без контента (что соответствует папке Введение) с двумя дочерними элементами — Введение и Поддержка.

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

Если требуется создать родительский элемент с контентом, а не элементы в виде папок без контента, необходимо переименовать HTML-файл, который будет использоваться в качестве источника контента, в index.html.

  • Introduction
    • index.html
    • support.html 
  • system-requirements.html 
  • upload.png 
  • style.css 

В этом случае элемент Введение станет страницей, а его контент будет перенесен из файла index.html.
Дерево страниц с родительским элементом с контентом

Кодирование символов в HTML

Настоятельно рекомендуется указывать набор символов в исходных HTML-файлах .

Существуют различные кодировки символов. Один и тот же символ может выглядеть по-разному в разных кодировках. Общая рекомендация для верстальщиков (HTML-программистов) - указывать кодировку своего файла в самом файле. Это можно легко сделать, добавив в HTML-файл специальный meta тег:

  • HTML4 <meta http-equiv="Content-Type" content="text/html;charset=ISO-8859-1">
  • HTML5 <meta charset="UTF-8">

Чтобы узнать больше о HTML-кодировании, ознакомьтесь с этим документом W3Schools:  HTML Charset

Если вы видите странные символы после импорта HTML или CHM, это означает, что в исходных файлах не указана кодировка. Ее указание поможет системе Документерра правильно обработать символы.

Если кодировка не указана, по умолчанию предполагается UTF-8 .