Hvorfor bruke XHTML?
Hjelpesystemet gir deg muligheten til å produsere dynamisk hjelpeinnhold ved å annotere XHTML-kodingen med spesielle koder for å filtrere, inkludere og oppgi ankere for utvidelser. Disse funksjonene er ikke tilgjengelige når du bruker HTML.
Slik oppgir du XHTML
Du oppgir XHTML-hjelpedokumenter stort sett på samme måte som HTML, bortsett fra at det finnes noen få viktige forskjeller som trengs for å støtte dynamisk innhold og søking. De nødvendige endringene er oppført nedenfor:
Du må binde XHTML-søkedeltakeren til doc-plugin-modulen.
Implementeringen av Eclipse-hjelpen bruker Lucene til å indeksere dokumentene for å øke hastigheten på søkene. Lucene må kunne lese formatet for at det skal være mulig å indeksere et dokument. Eclipse har allerede en søkedeltaker for indeksering av XHTML-dokumenter, så du trenger bare å be hjelpesystemet om å bruke den til dokumentene. Legg til denne utvidelsen i plugin-manifestet:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Hvis du bruker dynamisk innhold, må du binde produsenten av dynamisk XHTML-innhold til doc-plugin-modulen.
Hvis du vil produsere dynamisk innhold ved hjelp av XML-annotasjoner, må du be hjelpesystemet om å behandle dokumentene. Dette gjøres ved å binde produsenten av dynamisk XHTML-innhold til plugin-modulen.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Hvis du ønsker å bruke
inkluderinger i XHTML-kodingen, er formatet for
path
-attributtet slik: (forklart nedenfor)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
Der feltene er:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
-attributt i dette elementet (for eksempel my.element.id
)
Hvis du for eksempel
ønsker å inkludere avsnittet (elementet <p>
) med IDen my_copyright
fra
filen /copyrights/copyright.xhtml
i plugin-modulen my.product.plugin
,
oppgir du dette:
my.product.plugin/copyrights/copyright.xhtml/my_copyright