Metadaten
Metadaten können einer Datei oder einer Miniseite optional beigefügt werden, indem eine Zeile mit dem @
-Zeichen begonnen wird, gefolgt von einem Schlüsselwort, einem Doppelpunkt und einem dem Schlüsselwort zugeordneten Wert oder Verweis.
@ author: Martin Janecke
@ lang: de
@ license: ->http://example.org/license
@ style: ->data:text/css;base64,Lldhcm51bmcge2NvbG9yOnJlZH0=
@ stylesheet: ->/gemein/style.css
@ title: Metadaten – Aneamal
Beim Übersetzen werden manche Metadaten in den Kopfbereich der HTML-Datei eingefügt und beeinflussen das Verhalten von Suchmaschinen, andere verändern das Aussehen. Wieder andere Metadaten setzen das Dokument in Beziehung zu anderen Dokumenten.
Metadaten, deren Wert eine mit ->
eingeleitete URL ist, werden in der Übersetzung mit einem HTML-link
-Element realisiert, andere Metadaten mit dem HTML-meta
-Element.
Erkannte Schlüsselwörter
aside
[Eine Erklärung ist in Bearbeitung.]
canonical
[Eine Erklärung ist in Bearbeitung.]
charset
Mit charset
wird die Zeichensatz-Kodierung einer Datei angegeben. Der Standardwert ist UTF-8
und braucht nicht angegeben zu werden. Wird ein anderer Wert gesetzt, versucht der Konverter den Text automatisch nach UTF-8
zu übersetzen. charset
darf nicht in Miniseiten gesetzt werden – Miniseiten müssen dieselbe Zeichensatz-Kodierung aufweisen wie die Datei, in der sie stehen.
class
Mit class
lassen sich Dokumente oder Miniseiten Klassen zuordnen. Es können als Wert mehrere Klassen durch Kommas getrennt angegeben werden. Klassen können beispielsweise genutzt werden, um die Gestaltung per CSS zu beeinflussen. Wäre in einem CSS-Stylesheet beispielsweise .Warnung {color:red}
definiert, würde die Miniseite im folgenden Beispiel rote Schrift verwenden.
> @ class: Warnung
> Ein Mikrowellenherd ist kein Haartrockner!
Ein Mikrowellenherd ist kein Haartrockner!
classes
classes
ist gleichbedeutend mit class
.
description
[Eine Erklärung ist in Bearbeitung.]
dir
Mit dir
kann die Schreibrichtung ausdrücklich angegeben werden. Mögliche Werte sind ltr
(von links nach rechts) und rtl
(von rechts nach links). Wenn in einer Datei keine Schreibrichtung angegeben ist, wird ltr
angenommen. Miniseiten ohne Angabe der Schreibrichtung erben jene der Datei, in der sie stehen.
errormore
[Eine Erklärung ist in Bearbeitung.]
header
[Eine Erklärung ist in Bearbeitung.]
icon
[Eine Erklärung ist in Bearbeitung.]
javascript
Mit javascript
kann man JavaScript-Dateien benennen, die dann am Ende der HTML-Ausgabe referenziert werden. Programmierer können hier ihrer Kreativität Freilauf geben.
keywords
[Eine Erklärung ist in Bearbeitung.]
lang
Mit lang
oderwird die Sprache einer Datei oder einer Miniseite angegeben. Erwartet wird eine Angabe gemäß BCP47. Im einfachsten Fall ist das ein zweibuchstabiger ISO-639-1-Code, zum Beispiel de
für die deutsche Sprache.
language
language
ist gleichbedeutend mit lang
.
lang-…
Mit dem Schlüsselwort lang-
ergänzt um einen Sprachcode lässt sich eine anderssprachige Version des Dokumentes angeben. Dies hilft Suchmaschinen, ihren Benutzern die passende Version der Seite anzuzeigen.
@ lang-en: ->http://example.org/english/metadata
language-…
language-…
ist gleichbedeutend mit lang-…
.
layout
[Eine Erklärung ist in Bearbeitung.]
license
[Eine Erklärung ist in Bearbeitung.]
look
[Eine Erklärung ist in Bearbeitung.]
me
[Eine Erklärung ist in Bearbeitung.]
next
[Eine Erklärung ist in Bearbeitung.]
pixels
[Eine Erklärung ist in Bearbeitung.]
prev
[Eine Erklärung ist in Bearbeitung.]
publisher
[Eine Erklärung ist in Bearbeitung.]
robots
[Eine Erklärung ist in Bearbeitung.]
role
Das role
-Schlüsselwort kann genutzt werden, um mit ARIA-Rollen die Barrierefreiheit zu verbessern. Empfehlenswert ist, mit Rollen zurückhaltend umzugehen, wenn man sich mit den technischen Feinheiten der Barrierefreiheit nicht auskennt. Verzicht ist besser als falsch gesetzte role
-Attribute.
script
[Eine Erklärung ist in Bearbeitung.]
shortlink
[Eine Erklärung ist in Bearbeitung.]
style
Das Schlüsselwort style
gibt die Adresse einer in die HTML-Ausgabe zu integrierenden CSS-Datei an. Die Unterschiede zu stylesheet
sind technische Feinheiten: stylesheet
eignet sich besser für Stilangaben, die von mehreren Dokumenten genutzt werden, style
ist effizienter bei solchen, die nur in einem Dokument genutzt werden.
Beachte: Derzeit gilt ein Stylesheet stets für die gesamte Ausgabe, auch wenn das Stylesheet beispielsweise nur innerhalb einer Miniseite eingebunden wurde. Dies hat technische Gründe. Mit fortschreitender Unterstützung von HTML5 durch Browser wird sich dieses Verhalten ändern. Verlasse Dich also nicht darauf, dass ein über eine Miniseite oder externe Datei verknüpftes Stylesheet für das ganze Dokument gilt!
stylesheet
Das stylesheet
gibt die Adresse einer zu verknüpfenden CSS-Datei an. Die Unterschiede zu style
sind technische Feinheiten: stylesheet
eignet sich besser für Stilangaben, die von mehreren Dokumenten genutzt werden, style
ist effizienter bei solchen, die nur in einem Dokument genutzt werden.
Beachte: Derzeit gilt ein Stylesheet stets für die gesamte Ausgabe, auch wenn das Stylesheet beispielsweise nur innerhalb einer Miniseite eingebunden wurde. Dies hat technische Gründe. Mit fortschreitender Unterstützung von HTML5 durch Browser wird sich dieses Verhalten ändern. Verlasse Dich also nicht darauf, dass ein über eine Miniseite oder externe Datei verknüpftes Stylesheet für das ganze Dokument gilt!
textcap
[Eine Erklärung ist in Bearbeitung.]
title
Der Wert des title
-Schlüsselwortes wird in der HTML-Übersetzung für das HTML-title
-Element verwendet. Dieser Dokumenttitel wird beispielsweise von Suchmaschinen in Suchergebnissen angezeigt. Wird kein title
in den Metadaten angegeben, nutzt Aneamal automatisch die erste große Überschrift auch für den Titel.
translate
Mit den Werten yes
oder no
kann angegeben werden, ob der Text von automatischen Übersetzungsprogrammen übersetzt werden soll.
up
[Eine Erklärung ist in Bearbeitung.]
Beliebige Schlüsselwörter
[Eine Erklärung ist in Bearbeitung.]
Vererbung
[Eine Erklärung ist in Bearbeitung.]
Platzhalter
In Metaangaben lassen sich Platzhalter definieren. Sie bestehen aus dem Zeichen &
und einer arabischen Ziffer oder einem lateinischen Buchstaben. Groß- und Kleinbuchstaben stehen dabei für unterschiedliche Platzhalter.
Dem Platzhalter als Schlüsselwort kann HTML-Code als Daten-URI in base64-kodierter Form oder ein Link zu einer Datei mit HTML-Code zugewiesen werden. Der HTML-Code wird automatisch überall eingefügt, wo der Platzhalter im Text auftaucht. Damit lässt sich der Funktionsumfang von Aneamal erweitern.
Beispiele und mehr zu Platzhaltern findest Du auf der Seite Platzhalter.
Schlüsselwörter in Miniseiten/eingebundenen Dateien
In Miniseiten und eingebundenen Dateien haben nur Platzhalter und die Schlüsselwörter class
(classes
), dir
, errormore
, javascript
, lang
(language
), pixels
, role
, script
, style
, stylesheet
, translate
und bei eingebundenen Dateien charset
eine Wirkung. Andere Schlüsselwörter werden nur in Metadaten der direkt aufgerufenen Datei berücksichtigt.