Treść dynamiczna

Co to jest treść dynamiczna?

Niektóre komponenty pomocy dla użytkowników umożliwiają udostępnianie treści dynamicznej. Oznacza to, że treść może ulegać zmianie zależnie od środowiska lub kontekstu, w którym pracuje użytkownik. Przykładowo część dokumentu pomocy lub strony powitania może być wyświetlana wyłącznie w przypadku, gdy użytkownik włączy określoną funkcjonalność.

Istnieją dwa podstawowe sposoby tworzenia treści dynamicznej. Pierwszy z nich polega na umieszczaniu w kodzie XML znaczników i atrybutów (adnotacji) nakazujących systemowi odfiltrowywanie sekcji bądź dokumentów, włączanie sekcji z innych dokumentów lub określanie zakotwiczeń umożliwiających rozszerzanie dokumentacji przy użyciu innych komponentów.

Drugi sposób polega na napisaniu własnego narzędzia do tworzenia treści poprzez podłączenie odpowiedniego fragmentu kodu języka Java. Umożliwia to tworzenie treści od podstaw lub przetwarzanie na bieżąco dotychczasowych dokumentów statycznych. Poniżej znajduje się dokładniejsze omówienie obu metod.

Adnotacje XML

Najprostszym sposobem na tworzenie treści dynamicznej jest korzystanie z adnotacji w kodzie XML. W tym celu wystarczy umieścić w kodzie XML specjalne atrybuty i znaczniki, które nakazują systemowi przetwarzanie instrukcji. Elementy te można wykorzystywać do:

Więcej informacji na temat poszczególnych aspektów kodu można uzyskać za pośrednictwem powyższych odsyłaczy lub odpowiednich tematów w spisie treści.

Poniżej znajduje się przykładowy fragment kodu XHTML:


<p>
W tym miejscu znajduje się akapit statyczny.
</p>

<!-- Ten znacznik zostanie zastąpiony znacznikiem, którego dotyczy odwołanie. -->
<include path="identyfikator-wtyczki/ścieżka/inny_dokument.xhtml/identyfikator_elementu"/>

<ul>
   <li>
      W tym miejscu znajduje się statyczna pozycja listy.
   </li>
   <li filter="os=win32">
      Ten fragment jest wyświetlany wyłącznie w systemie Windows.
   </li>
   <li filter="plugin!=org.eclipse.help">
      Ten fragment jest wyświetlany wyłącznie w przypadku, gdy wtyczka org.eclipse.help NIE została zainstalowana.
   </li>
</ul>
        
<!-- W tym miejscu inne osoby mogą dodawać treść. -->
<anchor id="identyfikator_zakotwiczenia"/>

Narzędzia do tworzenia treści

Narzędzie do tworzenia treści to mechanizm umożliwiający podłączanie kodu w języku Java, który pozwala na bieżąco tworzyć treść dokumentu. Narzędzia do tworzenia treści oferują większe możliwości niż adnotacje XML, ale korzystanie z nich jest bardziej złożone.

Narzędzia do tworzenia treści można stosować w następujących obszarach pomocy dla użytkowników: