Oppgi XHTML-hjelpedokumenter

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:

Inkludere format i XHTML

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:

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