07 Mrz 13 Every Page Is Page One

Behandeln Sie jede Seite einer Onlinehilfe oder eines eBooks wie eine Einstiegsseite: bieten Sie Orientierung für die nächsten Schritte und Vertiefung in weitere Themen in Form von Links an.

Dieser Artikel verdankt sein Entstehen dem glücklichen Eintreten zweier Ereignisse:

1. Ich hatte über die Metadaten den Dateinamen eines Artikels im sichtbaren Text ausgeben können. Beschrieben ist die Vorgehensweise im Artikel Metadaten im Text – Name des Topics, im eBook enthalten.
   

   Dateiname metadata-output_con sichtbar oben rechts

2. Mark Baker veröffentlicht seinen Blogpost A New Approach to Organizing Help. Er bloggt unter der selbsterklärenden Domain Everypageispageone.com mit dem Motto Readers can enter anywhere. Is your content ready to receive them?

Jede Seite hat ein Thema und viele Aspekte – verlinken Sie!

Mark Bakers Blogname Every Page Is Page One ist programmatisch. Die Frage, ob ich eine komplexe Sache in eine große Online-Hilfe mit einem großen Inhaltsverzeichnis bündele oder die vielen Themen in mehrere Online-Hilfen splitte und somit ein aussagekräftigeres Inhaltsverzeichnis erhalte, beschäftigt viele Technische Redakteure. Doch das ist gar nicht nötig, meint Baker.

Every piece of content is rich in subject affinities. That is, the people, places, objects, actions, and ideas mentioned in the piece are connected to those people, places, objects, actions, and ideas, and thus have a connection (an “affinity”) to content that describes those people, places, objects, actions, and ideas.

Yet it is those affinities that actually define the place of a topic in its broader subject area. A traditional book index is an ordered list of the subject affinities in the book. A hypertext link in a Web page is the expression of an affinity between the content in which it occurs and content it links to. Subject affinities anchor a piece of content in time, culture and the reader’s experience.

When the user has landed in your help by way of a Google search, in search of information on a particular problem they are trying to solve, what kinds of additional information are they likely to need if the current topic does not entirely satisfy their needs? It is not information from other general categories of the help system, which is what the TOC provides. It is information related to the subject affinities of the current topic. [1]

In den Zeiten des Standards DITA 1.1 hieß es oftmals: Setzen Sie innerhalb des Textes keine Links zu anderen Topics! Dies lenkt den Leser ab und bringt Sie in Teufels Küche, so bald eine Topic-Datei mal verschoben oder gelöscht wird. Doch nun haben wir im Standard DITA 1.2 die Technologie des relatvien Verlinkens via keys und keyref[2]. Ein Link innerhalb des Textes ist nun kein Teufelszeug mehr. Ändert sich der Speicherort einer Datei, braucht dieser nur noch an einer Stelle geändert werden. Die Hyperlinks, die sich mit keyref auf diese Datei beziehen, aktualisieren die URL ganz von allein.

Dateiname gleich keys

Nun habe ich also den Mut, aus jeder Seite eine EPPO-Seite zu machen (Sie werden die Abk. dechiffrieren). D.h. ich werde nicht scheuen, zu anderen Seiten der Onlinehilfe oder des eBooks auch innerhalb des Textes zu verlinken. So können Sie vorgehen:

1. keys vergeben

Geben Sie in der ditamap in jedem topicref auch einen Begriff für keys ein.

<topicref href="../onlinehilfe/metadata-mailto_con.xml"
keys="metadata-mailto_con" scope="local" toc="yes" type="concept"
xml:lang="de-de"/>

Achten Sie darauf, dass Sie für keys einfach den Dateinamen eintragen. Hier im Beispiel metadata-mailto_con. Die Dateierweiterung xml ist nicht vonnöten.

2. Mit keyref auf keys referenzieren

Sie finden in einer anderen Datei ein Schlüsselwort (z.B. Feedback), zu welchem Details vorliegen und Sie verlinken könnten? Dann machen Sie das mithilfe der Elemente keyword oder xref und dem dazugehörigen Attributs keyref.

<keyword keyref="metadata-mailto_con">Feedback</keyword>

Während keyword standardmäßig nicht im PDF-Output ausgegeben wird, können Sie bei xref sicher sein, dass der Link im Online- als auch PDF-Output funktioniert.

<xref keyref="metadata-mailto_con">Feedback</xref>

Sie bearbeiten also die Quelldatei in Ihrem Editor und können parallel im vorher generierten Output schauen, zu welchen Seiten sie verlinken möchten. Der Seitenname wird ja jetzt oben rechts ausgegeben. Kopieren Sie ihn einfach und fügen Sie ihn bei keyref als Wert ein. Im obigen Beispielbild ist der Dateiname metadata-mailto_con auch der Wert, den Sie in der ditamap-Datei auch bei keys hinterlegt haben.

Der Dateiname wird also als Identifikation für die E-Mail-Rückmeldung des Nutzers benutzt, aber auch als schnelle Linkmöglichkeit für den keys-keyref-Mechanismus.

Links zum Artikel

[1] A New Approach to Organizing Help, Mark Baker, 2013, zum Link

[2] DITA 1.2 feature article: Keyref overview, Sowmya Kannan, 2009, zum Link

Tags: HTML-Help, Metadaten, XHTML