Hvorfor bruges XHTML?
Hjælpesystemet indeholder muligheden for at producere dynamisk hjælpeindhold ved at annotere XHTML-markup'en med specielle koder til filtre, inkluderinger og angive ankre til udvidelser. Disse funktioner er ikke tilgængelige i HTML.
Sådan leverer du XHTML
XHTML-hjælpedokumenter leveres stort set på samme måde som HTML, bortset fra nogle få, vigtige forskelle, der understøtter dynamisk indhold og søgning. Disse nødvendige ændringer vises nedenfor:
Du skal binde XHTML-søgedeltagere til din doc-plugin.
Eclipse-implementeringen af hjælpen anvender Lucene til at indeksere dokumenter for at øge søgehastigheden. For at indeksere et dokument skal Lucene være i stand til at læse formatet. Eclipse indeholder allerede en søgedeltager til indeksering af XHTML-dokumenter, så du skal blot angive, at hjælpesystemet skal bruge denne til dokumenterne. Tilføj følgende udvidelse til plugin-manifestet:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Hvis du bruger dynamisk indhold, skal du binde den dynamiske XHTML-indholdsproducent til din doc-plugin.
Hvis du vil producere dynamisk indhold vha. XML-annoteringer, skal du angive for hjælpesystemet, at det skal behandle dokumenterne. Det gøres ved at binde den dynamiske XHTML-indholdsproducent til din plugin.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Hvis du vil bruge inkluderinger i XHTML, er formatet for attributten
sti
som vist og forklaret nedenfor:
<plugin_id>/<sti_til_xhtml_fil>/<filnavn_xhtml>/<element_id>
Hvor felterne er:
org.eclipse.help
.
/min_folder/min_underfolder/
.
min_fil.xhtml
)
id
-attribut til elementet, f.eks. mit.element.id
)
Hvis du f.eks. vil inkludere et afsnit (elementet <p>
) med id'en min_copyright
fra filen/copyrights/copyright.xhtml
i plugin'en mit.produkt.plugin
, skal du angive følgende:
mit.produkt.plugin/copyrights/copyright.xhtml/min_copyright