Varför använda XHTML?
I hjälpsystemet kan du skapa dynamiskt hjälpinnehåll genom att lägga till specialmärkord i XHTML-märkordsuppsättningen för filter och include-element och ange anchors för utökningar. De här funktionerna är inte tillgängliga när du använder HTML.
Så här lägger du till innehåll i XHTML
Du lägger till innehåll i XHTML-hjälpdokument på ungefär samma sätt som i HTML förutom några få viktiga skillnader som är nödvändiga för att det ska gå att använda dynamiskt innehåll och sökfunktioner. De här nödvändiga ändringarna anges nedan:
Du måste binda XHTML-sökdeltagaren till insticksprogrammet för dokumentation.
I Eclipse-hjälpimplementationen används Lucene till att indexera dokument vilket gör att sökning går snabbare. Lucene måste kunna läsa formatet för ett dokument för att kunna indexera det. Eclipse tillhandahåller redan en sökdeltagare för indexering av XHTML-dokument så du behöver bara ange att det ska användas i hjälpsystemet för dina dokument. Lägg till följande utökning till manifestet för insticksprogram:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Om du använder dynamiskt innehåll måste du binda producenten för dynamiskt XHTML-innehåll till insticksprogrammet för dokumentation.
Om du vill skapa dynamiskt innehåll med hjälp av XML-anteckningar måste du ange att hjälpsystemet ska bearbeta dina dokument. Det gör du genom att binda producenten för dynamiskt XHTML-innehåll till insticksprogrammet.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
XHTML-format för include-element
Om du vill använda include-element i XHTML är formatet för attributet path
det följande: (förklaras nedan)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
Där fälten är:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
till elementet (till exempel my.element.id
)
Om du till exempel vill inkludera stycket (<p>
-element)
med ID:t my_copyright
från filen /copyrights/copyright.xhtml
i insticksprogrammet my.product.plugin
anger du följande:
my.product.plugin/copyrights/copyright.xhtml/my_copyright