Зачем нужны XHTML?
Справочная система предоставляет возможность создания динамического содержимого справки, сопровождая текст XHTML специальными тегами для фильтров и вставок, и задавая метки для расширений. Эти функциональные возможности недоступны при работе с HTML.
Вставка XHTML
Справочные документы XHTML вносятся в основном так же, как HTML, за исключением нескольких существенных отличий, которые внесены для поддержки динамического содержимого и поиска. Эти необходимые изменения перечислены ниже:
Необходимо связать агент поиска XHTML с модулем документов.
В справке eclipse для индексирования документов применяется Lucene, что позволяет ускорить поиск. Для того чтобы проиндексировать документ, Lucene должен прочитать его формат. Eclipse предоставляет агента поиска для индексации документов XHTML, так что следует просто настроить его применение в справочной системе. Добавьте следующее расширение в манифест модуля:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
При использовании динамического содержимого необходимо связать поставщика динамического содержимого XHTML с модулем документов.
Если необходимо создавать динамическое содержимое с применением аннотаций XML, то следует указать справочной системе на необходимость обработки документов. Для этого необходимо связать поставщика динамического содержимого XHTML с модулем.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Если необходимо использовать вставки в XHTML,
то формат атрибута path
будет иметь следующий вид: (см. пояснения ниже)
<ИД_модуля>/<путь_к_файлу_xhtml>/<имя_файла_xhtml>/<ИД_элемента>
Поля имеют следующие значения:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
к данному элементу (например,
my.element.id
)
Например, если следует включить абзац (элемент <p>
) с ИД
my_copyright
из файла /copyrights/copyright.xhtml
в модуль my.product.plugin
, необходимо указать следующее:
my.product.plugin/copyrights/copyright.xhtml/my_copyright