Contenuto dinamico

What is dynamic content?

Diversi componenti di assistenza utente consentono di fornire un contenuto dinamico. Ciò significa che il contenuto può cambiare a seconda dell'ambiente o del contesto dell'utente. Ad esempio, è possibile decidere che un documento della guida o la pagina di benvenuto venga visualizzata solo se l'utente ha determinate funzioni abilitate.

Esistono due modi per creare un contenuto dinamico. Uno consiste nell'aggiungere tag e attributi (annotazioni) alla markup XML che indica al sistema di filtrare le sezioni o i documenti, comprese le sezioni da altri documenti, oppure specificare ancoraggi che consentano ad altri componenti di estendere la documentazione.

L'altro metodo consiste nello scrivere il proprio produttore argomenti aggiungendo del codice Java che scriverà il contenuto da zero o elaborerà i documenti statici esistenti al momento stesso. In questa sezione verranno esaminati entrambi gli approcci.

XML Annotations

Il modo più semplice per creare un contenuto dinamico consiste nell'utilizzare le annotazioni di markup XML. In questo modo, vengono semplicemente aggiunti attributi speciali e tag alla markupXML e il sistema elaborerà le istruzioni. È possibile utilizzare questa markup per:

Per ulteriori informazioni sulla markup, seguire i link precedenti o ricercare gli arogmenti adatti nell'indice.

Questo approccio è dimostrato dal frammento di codice XHTML riportato di seguito:


<p>
Questo è un paragrafo statico.
</p>

<!-- Questa tag verrà sostituita con la tag di riferimento -->
<include path="my.plugin.id/path/my_other_document.xhtml/element_id"/>

<ul>
   <li>
      Questo è un elemento di elenco statico.
   </li>
   <li filter="os=win32">
      Esso viene visualizzato solo se in esecuzione su Windows.
   </li>
   <li filter="plugin!=org.eclipse.help">
      Questo viene visualizzato solo se plugin org.eclipse.help non è installato.
   </li>
</ul>

<!-- Spazio in cui altri possono aggiungere un contenuto -->
<anchor id="my.anchor.id"/>

Content producers

Un produttore di contenuto è un meccanismo per imporre al codice Java di produrre il contenuto del documento al momento stesso. Tali produttori sono più efficaci delle annotazioni XML, ma meno complessi da utilizzare.

I produttori di contenuto correnti sono supportati nelle seguenti aree: