Es gibt zwei "generische" Arten von Metadaten-Tags in DITA, dem Datenelement und dem Schlüsselwortelement. Natürlich gibt es auch das andere Meta, aber anscheinend soll das bald veraltet sein, und der Name deutet irgendwie auf eine Art letzten Ausweg hin.
So scheint das Schlüsselwort den Tags in Webanwendungen sehr ähnlich zu sein, d. h. was üblicherweise für "Folksonomien" verwendet wird. Aber was ist der genaue Unterschied zwischen Daten und Schlüsselwort, und wann sollten Sie welches verwenden?
Das Element <data> ist hauptsächlich für Spezialisierungen gedacht, daher ist es wahrscheinlich nicht ratsam, es direkt zu verwenden. Das Element <keyword> ist besser.
Dies:
%Vor%
rendert dies in der DITA-OT XHTML-Transformation:
%Vor%
Wenn Sie Tags hinzufügen möchten, sollten Sie Subjektschema-Maps verwenden, mit denen Sie eine Liste kontrollierter Werte hinzufügen können.
Wenn Sie das Attribut @base oder @props spezialisieren, können Sie Metadaten mit viel mehr Kontrolle hinzufügen. Hier haben wir ein Attribut @props , das auf @era spezialisiert ist.
Sie können dann das Attribut @era zu einem Element in einem Zweig oder zum Element <topicref> in einer Map hinzufügen.
%Vor%
Sie sind hier ein wenig abseits; Das Schlüsselwortelement ist KEIN Metadatenelement. Das Schlüsselwortelement ist ein allgemeines Textelement, das häufig für Produktnamen verwendet wird. Ich denke, das Element, das Sie wahrscheinlich hier angeben wollten, war das keywords-Element. Außerdem wollen Sie das andere Meta-Element wirklich nicht abschreiben; Es ist nicht veraltet und ziemlich nützlich.
Schlüsselwortelement
Das keywords-Element kann entweder auf der Themen- oder Kartenebene verwendet werden. Es enthält eine Liste von Begriffen aus einem Fachvokabular, die entweder mit dem Schlüsselwort oder den indexterm-Elementen versehen sind. Die Elemente keyword und indexterm werden als Metadatenelemente betrachtet und sollten in der Ausgabe entsprechend dem Medium angezeigt werden. Die indexterm-Elemente erzeugen üblicherweise Indizes; Bei der XHTML-Ausgabe werden die Schlüsselwortelemente im Allgemeinen dem XHTML hinzugefügt und für die Suchmaschinenoptimierung verwendet. (Dies ist die Standardfunktionalität von DITA-OT, obwohl die kostenlose PDF-Rendering-Engine, die im Lieferumfang von DITA-OT enthalten ist, keinen Index generiert.)
Datenelement
Bei der Verwendung des Datenelements handelt es sich um eine Eigenschaft innerhalb eines DITA-Themas oder einer DITA-Map. Die folgenden sind die wichtigsten Aspekte:
Standardmäßig ignorieren Prozessoren den Inhalt von Datenelementen. Es kann jedoch eine benutzerdefinierte Verarbeitung erstellt werden, die den Inhalt bestimmter Datenelemente zum Formatieren usw. verwendet.
Als Grundlage für die Spezialisierung ist das Datenelement besonders nützlich. Es ermöglicht präzisere Semantiken sowie Aufzählungen von kontrollierten Listen von Attributen für bestimmte Elemente. Sie können viele Beispiele für seine Verwendung als Spezialisierungsbasis sehen, wenn Sie die Metadatenelemente untersuchen, die in der Bookmap verwendet werden, und lernen & amp; Trainingsspezialisierungen.
Siehe das Datenelement Thema in der DITA 1.2 Spezifikation für einige konkrete Beispiele.
sonstiges Element
Das othermeta-Element enthält Inhalte, für die kein vorhandenes Metadatenelement zu gelten scheint. Es enthält im Wesentlichen ein Name-Wert-Paar. Sie verwenden das @ name-Attribut, um die Eigenschaft zu benennen, und das @ content-Attribut, um den Wert zu speichern.
Wann sollten Sie welches Element verwenden?
Das Datenelement hat die Attribute @href und @name und @value für den Schlüssel.
Sie können also jede Eigenschaft definieren, die Sie für Ihren Build benötigen.
%Vor%Ich habe ein paar Szenarien, in denen ich abhängig von der Zielgruppe meiner Dokumentation einige Pfadinformationen bereitstellen muss. Ich kann das Datenelement dafür verwenden.
%Vor%Hier kann ich wissen, welches die aktive Zielgruppe ist, wenn ich die Dokumentation
filtereEin anderes Beispiel wäre, ein JavaScript anzuhängen, das spezifisch für eine Karte ist
Ich arbeite gerade an einer Webmap-Spezialisierung, bei der ich spezielle Daten für Javascript und CSS bereitstelle.
* update 2 *
Das Datenelement könnte verschachtelt sein. Eliot Kimber erklärt dies in einem Beitrag. Ich kann mich nicht erinnern, welches. Die Idee ist, dass es eine Sammlung von Eigenschaften darstellen kann
%Vor%Diese Struktur ist sehr nützlich für Spezialisierungszwecke.
Nach meinem Verständnis ist das Datenelement nicht spezifisch. Es ist eine Möglichkeit für Autoren, sehr spezifische Bedürfnisse, spezialisiert oder nicht, zu dokumentieren. Es ist einfach, die Werte später im Build-Prozess mit xsl abzurufen.
Der genaue Unterschied? Es gibt viele Unterschiede. Lesen Sie die Spezifikation (Entschuldigung, ich will nicht unfreundlich klingen).
Hier ist ein Unterschied zu der Spezifikation, die bereits erwähnt wurde, aber ich denke, es ist es wert, hervorgehoben zu werden, weil es Ihnen helfen kann, zu entscheiden, ob Sie / lt; data & gt; verwenden oder nicht:
Prozessoren sollten den Inhalt der & lt; data & gt; Element standardmäßig, so dass die & lt; data & gt; Element sollte nur für Eigenschaften und nicht zum Einbetten von Text für die Formatierung als Teil des Themenbereichs verwendet werden.
(Siehe auch Text an anderer Stelle im Spezifikationsanfang: "benutzerdefinierte Verarbeitung kann ...".)
Sie können & lt; Keyword & gt; "Text für die Formatierung als Teil des Ablaufs des Themenkörpers einbetten", aber Sie sollten das nicht mit & lt; data & gt;.
machenKönnen Sie Ihren speziellen Anwendungsfall beschreiben? (Welche Informationen möchten Sie markieren?)