Dynamiskt innehåll

Vad är dynamiskt innehåll?

I flera av komponenterna i användarhjälpen kan du tillhandahålla dynamiskt innehåll. Det innebär att innehåll kan ändras beroende på användarens miljö eller kontext. Du kan till exempel välja att ett avsnitt av hjälpdokumentet eller välkomstsidan endast visas om användaren har aktiverat en viss funktion.

Det finns två enkla sätt att skapa dynamiskt innehåll. Ett av dem är att lägga till märkord och attribut (anteckningar) till XML-märkordsuppsättningen med instruktioner till systemet att filtrera ut avsnitt eller dokument, inkludera avsnitt från andra dokument eller ange ankare som gör det möjligt för andra komponenter att utöka dokumentationen.

Den andra metoden är att skapa en egen innehållsproducent genom att använda Java-kod som skriver innehållet från början eller bearbetar befintliga statiska dokument i farten. Vi tar en titt på båda sätten.

XML-anteckningar

Det enklaste sättet att skapa dynamiskt innehåll är att använda anteckningar för XML-märkordsuppsättningen. Du lägger helt enkelt till vissa specialattribut och märkord till XML-märkordsuppsättningen så bearbetar systemet instruktionerna. Du kan använda följande märkord:

Om du vill ha mer information om de olika aspekterna av märkordsuppsättningen öppnar du länkarna ovan eller söker efter de relevanta avsnitten i innehållsförteckningen.

Det här visas i XHTML-fragmentet nedan:


<p>
Det här är ett statiskt stycke.
</p>

<!-- Det här märkordet ersätts med det refererade märkordet -->
<include path="my.plugin.id/path/my_other_document.xhtml/element_id"/>

<ul>
   <li>
      Det här är ett statiskt listobjekt.
   </li>
   <li filter="os=win32">
      Det här visas endast i Windows.
   </li>
   <li filter="plugin!=org.eclipse.help">
      Det här visas endast när plugin org.eclipse.help INTE är installerat.
   </li>
</ul>

<!-- En plats fär andra kan lägga till innehåll -->
<anchor id="my.anchor.id"/>

Innehållsproducenter

En innehållsproducent är en mekanism för att använda Java-kod för produktion av dokumentinnehåll i farten. Innehållsproducenter är mycket kraftfullare än XML-anteckningar men är mer komplicerade att använda.

Innehållsproducenter kan användas i följande delar av användarhjälpen: