Класс ODT2HTML: руководство разработчика

Если вы знакомы с языком программирования Python, то можно напрямую использовать класс ODT2HTML. Для этого нужно подключить модуль uodt2html из пакета unicross_odt и импортировать класс с помощью инструкции:

from unicross_odt.uodt2html import ODT2HTML

Конструктор класса имеет следующий формат:

<Объект> = ODT2HTML(filename, template, template_index="",
                    canonical_path="", lang="ru")

Параметры:

• filename — путь к файлу ODT. Параметр является обязательным;
• template — путь к файлу с HTML-шаблоном. Параметр является обязательным;
• template_index — путь к файлу с HTML-шаблоном оглавления. Если параметр не указан, то используется значение из параметра template;
• canonical_path — позволяет указать абсолютный URL-адрес, к которому будет добавлено название страницы. Полученное значение вставляется в тег <link rel="canonical" href="Значение">. Это значение используется поисковыми системами для определения уникального адреса страницы. Если параметр не задан, то тег не создается;
• lang — язык для сообщений об ошибках и предупреждений, а также для текста ссылок в панели навигации. Доступны значения "ru" (русский язык; используется по умолчанию) и "en" (английский язык).

Класс ODT2HTML содержит следующие методы:

• load() — загружает данные из ODT файла и разбивает их на автоматические стили и содержимое. Возвращает значение True, если загрузка выполнена успешно, и False — в противном случае;
• show_errors() — выводит сообщения об ошибках в окно консоли;
• get_errors() — возвращает сообщения об ошибках в виде строки;
• is_errors() — возвращает значение True, если существуют ошибки, и False — в противном случае;
• show_warnings() — выводит предупреждающие сообщения в окно консоли;
• get_warnings() — возвращает предупреждающие сообщения в виде строки;
• is_warnings() — возвращает значение True, если существуют предупреждения, и False — в противном случае;
• get_content_xml() — возвращает необработанное XML-содержимое из файла ODT;
• get_html() — возвращает необработанное XML-содержимое документа из файла ODT или обработанный текст в формате HTML в зависимости от этапа обработки;
• get_styles() — возвращает необработанные автоматические стили из файла ODT;
• start_processing() — запускает процесс обработки документа. Если документ не был загружен, то предварительно вызывает метод load(). Возвращает значение True, если обработка выполнена успешно, и False — в противном случае;
• save_one_html() — сохраняет обработанный документ в один файл без разбиения на страницы. Возвращает кортеж из двух элементов. Через первый элемент доступен логический статус сохранения. Если первый элемент содержит значение True, то через второй элемент доступен путь с названием файла. Если первый элемент содержит значение False, то через второй элемент доступны сообщения об ошибках;
• save_all_files() — сохраняет обработанный документ в несколько файлов в соответствии с разметкой внутри файла ODT. Возвращает кортеж из двух элементов. Через первый элемент доступен логический статус сохранения. Если первый элемент содержит значение True, то через второй элемент доступен путь к папке с файлами. Если первый элемент содержит значение False, то через второй элемент доступны сообщения об ошибках;
• add_keyword(<Ключевое слово>) — добавляет одно ключевое слово в список ключевых слов по умолчанию. Если переданное значение не является строкой, то генерируется исключение TypeError;
• update_keywords(<Список с ключевыми словами>) — добавляет несколько ключевых слов в список ключевых слов по умолчанию. Если переданное значение не является списком строк, то генерируется исключение TypeError;
• add_stop_keyword(<Ключевое слово>) — добавляет одно ключевое слово в список запрещенных ключевых слов. Если переданное значение не является строкой, то генерируется исключение TypeError;
• update_stop_keywords(<Список с ключевыми словами>) — добавляет несколько ключевых слов в список запрещенных ключевых слов. Если переданное значение не является списком строк, то генерируется исключение TypeError;
• get_canonical_path() — возвращает значение для тега <link rel="canonical" href="Значение">;
• set_code_lang(<Язык>) — задает язык программирования для листингов по умолчанию. Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_code_lang() — возвращает язык программирования для листингов по умолчанию;
• set_pic_prefix(<Префикс>) — задает префикс, добавляемый перед названием изображения. Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_pic_prefix() — возвращает префикс, добавляемый перед названием изображения;
• set_tab_size(<Значение>) — задает количество пробелов, вставляемых вместо табуляции. Если переданное значение не является целым числом, то генерируется исключение TypeError;
• get_tab_size() — возвращает количество пробелов, вставляемых вместо табуляции, в виде целого числа;
• show_navigation_bar(<Статус>) — если в качестве параметра указано значение True, то панель навигации будет отображаться на страницах. Значение False отключает отображение панели навигации. Если переданное значение не является логическим значением, то генерируется исключение TypeError;
• is_navigation_bar() — возвращает значение True, если нужно отобразить панель навигации, и False — в противном случае;
• set_nav_prev(<Текст>) — задает текст ссылки, ведущей на предыдущую страницу. Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_nav_prev() — возвращает текст ссылки, ведущей на предыдущую страницу;
• set_nav_next(<Текст>) — задает текст ссылки, ведущей на следующую страницу. Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_nav_next() — возвращает текст ссылки, ведущей на следующую страницу;
• set_nav_index(<Текст>) — задает текст ссылки, ведущей на оглавление. Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_nav_index() — возвращает текст ссылки, ведущей на оглавление;
• set_path_index(<Текст>) — задает относительный или абсолютный URL страницы с оглавлением. Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_path_index() — возвращает относительный или абсолютный URL страницы с оглавлением;
• set_ext_index(<Текст>) — задает расширение файла с оглавлением. Расширение добавляется к фрагменту "index.". Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_ext_index() — возвращает расширение файла с оглавлением;
• set_link_prefix(<Текст>) — задает префикс для названий страниц. Если переданное значение не является строкой, то генерируется исключение TypeError;
• get_link_prefix() — возвращает префикс для названий страниц;
• save_links() — генерирует уникальные названия страниц на основе заголовков и сохраняет их в файл. Возвращает кортеж из двух элементов. Через первый элемент доступен логический статус сохранения. Если первый элемент содержит значение True, то через второй элемент доступен путь с названием файла. Если первый элемент содержит значение False, то через второй элемент доступны сообщения об ошибках;
• remove_all_tags(<Строка>) — удаляет все теги из строки и возвращает обработанную строку;
• translit_yandex(<Строка>, <Удаление стоп-слов>=True) — возвращает обработанную строку, в которой все русские буквы заменены транслитом. Строку можно использовать в качестве названия страницы. Если во втором параметре указано значение True, то стоп-слова удаляются из результата.