В начале рассмотрения этого примера были созданы модуль и файлы документации. Затем были созданы файлы оглавления, описывающие структуру содержимого. На заключительном этапе все сведения необходимо объединить в главном файле оглавления и указать его в качестве дополнения в файле plugin.xml.
В первую очередь следует создать файл toc.xml, предоставляющий три созданных в начале файла оглавления. Для упоминания существующих файлов оглавления вместо тега href применяется атрибут link.
<toc label="Online Help Sample" topic="html/book.html"> <topic label="Concepts"> <link toc="toc_Concepts.xml" /> </topic> <topic label="Tasks"> <link toc="toc_Tasks.xml" /> </topic> <topic label="Reference"> <link toc="toc_Ref.xml" /> </topic> </toc>
Затем следует обновить файл plugin.xml, добавив в него главное оглавление:
<extension point="org.eclipse.help.toc"> <toc file="toc.xml" primary="true" /> </extension>
Обратите внимание, каким образом применяется атрибут primary. Если для
этого атрибута указано значение true, то связанный файл toc всегда отображается в
структуре навигации. Даже в том случае, если он не упомянут в других файлах toc.
Таким образом, "главное" оглавление гарантированно отображается в
списке разделов. Поскольку оно не упоминается в других оглавлениях, оно будет показано
на верхнем уровне списка.
Примечание: Если с этим оглавлением связаны другие файлы, недоступные в навигации, но упомянутые в других разделах, то для добавления этих разделов в индекс службы поиска
применяется атрибут extradir.
И наконец, следует добавить отдельные файлы оглавления.
<extension point="org.eclipse.help.toc"> <toc file="toc_Concepts.xml" /> <toc file="toc_Tasks.xml" /> <toc file="toc_Reference.xml" /> </extension>
Поскольку для этих файлов не указан атрибут primary, они не будут показаны на верхнем уровне структуры книг. Файлы оглавления, не указанные в качестве главных, отображаются в структуре документации только в том случае, если они упоминаются в одном из главных файлов оглавления, либо добавляются главным файлом.
Манифест модуля завершен. Скопируйте каталог модуля в каталог платформы plugins, запустите платформу и выберите Справка->Оглавление справки. Данный пример должен появиться в списке книг. Щелкнув на ссылке "Online Help Sample", вы можете просмотреть структуру оглавления: