Einbindungsaktionen

Die Aktionsdatei enthält Script-Erstellungsaktionen, die für Themen und Informationssichten ausgeführt werden können. Gegenwärtig gibt es nur einen Aktionstyp, nämlich die Aktion insert (Einfügen). Mit dieser Aktion werden Themen in Informationssichten an bestimmten Positionen, den so genannten Einfügemarken eingefügt. Sowohl Informationssichten als auch Themen können als Einfügemarken verwendet werden. Nur Themen, die eine optionale ID definieren, können als Einfügemarke verwendet werden. (Informationssichten muss immer eine ID zugeordnet sein.)

Beim Definieren der Einfügeaktion gibt das Attribut to die Zieleinfügemarke an. Im Attribut from wird das einzufügende Thema angegeben.

Mögliche Methoden zum Einfügen eines Themas:

Einfügeaktionen können verschachtelt werden, um "alternative" Einfügeaktionen zu definieren, die ausgeführt werden sollen, wenn die übergeordnete Einfügeaktion fehlschlägt. Dies kann hilfreich sein, wenn sich Einfügemarken in anderen Plug-ins befinden, die installiert oder nicht installiert sein können. Sie können Ihr Thema in das Thema eines anderen Plug-ins einfügen, und - für den Fall, dass die Einfügeaktion fehlschlägt (weil dieses andere Plug-in nicht installiert ist) - das Thema zusätzlich in einer anderen Position installieren. Sobald eine Einfügemarke erfolgreich verwendet wurde, werden verschachtelte Einfügeaktionen ignoriert.

Aktionsdateien wenden ihre Aktionen immer auf eine einzelne Informationssicht an. Wenn Sie Ihre Themen in unterschiedliche Informationssichten einbinden wollen, benötigen Sie für jede Sicht eine Aktionsdatei. Ein Thema kann innerhalb einer bestimmten Informationssicht nur ein Mal verwendet werden. Wenn Sie in einer Informationssicht zwei Mal auf ein Thema verweisen wollen, müssen Sie ein weiteres Themenelement (mit einer anderen ID) erstellen, dass dieselben Werte für die Attribute label (Bezeichnung) und href (Link) verwendet.

Themen integrieren

Jetzt können Sie die Themen endgültig in die übergeordneten Themen der Informationssicht "Content" integrieren. Hierzu benötigen Sie eine weitere Aktionsdatei, die im Beispiel mit actions_All.xml benannt wird (weil sie alle Themen integriert).

actions_All.xml

<actions infoview="com.example.helpexample.view_Contents">

 <insert

     from="com.example.helpexample.conceptsAll"

     to="com.example.helpexample.conceptsRoot"

     as="child"/>

 <insert

     from="com.example.helpexample.refAll"

     to="com.example.helpexample.refRoot"

     as="child"/>

 <insert

     from="com.example.helpexample.plainTasks"

     to="com.example.helpexample.tasksRoot"

     as="child"/>

 <insert

     from="com.example.helpexample.funTasks"

     to="com.example.helpexample.funRoot"

     as="child"/> </actions>

Sie erinnern sich, dass eine Reihe von taskbezogenen HTML-Dateien vorhanden war und die Struktur/Navigation dieser Dateien wie folgt durch topics_tasks.xml definiert wurde:

topics_tasks.xml

<topics id="tasksAll">

 <topic id="plainTasks" label="Plain Stuff">

     <topic label="Task1" href="doc/tasks/task1.html"/>

     <topic label="Task2" href="doc/tasks/task2.html"/>

 </topic>

 <topic id="funTasks" label="Fun Stuff" >

     <topic label="Task3_1" href="doc/tasks/task3_1.html"/>

     <topic label="Task3_2" href="doc/tasks/task3_2.html"/>

 </topic>

</topics>

In den oben angegebenen Aktionsdateien wird das Einfügen als Kindaktion verwendet, damit das Thema mit der ID com.example.helpexample.plainTasks übernommen und zusammen mit seinen Unterthemen unter dem Thema mit der ID com.example.helpexample..tasksRoot eingefügt wird.

<insert

     from="com.example.helpexample.plainTasks"

     to="com.example.helpexample.tasksRoot"

     as="child"/>

Die Aktionsdatei übernimmt auch einige der Tasks aus der Kategorie "Fun Stuff" und fügt sie in den Bereich "Fun Things" des Dokumentationsnetzes ein. Hierzu wird die folgende Aktion verwendet:

<insert

     from="com.example.helpexample.funTasks"

     to="com.example.helpexample.funRoot"

     as="child"/>