Ich arbeite an einer groß angelegten, hochvolumigen, öffentlich zugänglichen Webanwendung. Der erfolgreiche Betrieb der Anwendung ist für das Unternehmen sehr wichtig, und daher gibt es eine Reihe von MI-Tools, die dagegen laufen.
Eines dieser MI-Tools untersucht im Wesentlichen das HTML, das für jede Seitenanforderung an den Browser gesendet wird (ich habe es ziemlich vereinfacht, aber für den Zweck dieser Frage ist es ein Tool, das einige Analysen des HTML durchführt).
Damit dieses MI-Tool die benötigten Daten erhält, fügen wir Metadaten in das Head-Element ein. Derzeit machen wir es als HTML-Kommentare:
<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" class="">
<head>
<!-- details = 52:AS6[rxSdsMd4RgYXJgeabsRAVBZ:0406139009] -->
<!-- policy id = 1234567890 -->
<!-- party id = 0987654321 -->
<!-- email address = [email protected] -->
<!-- error = 49 -->
<!-- subsessionid = bffd5bc0-a03e-42e5-a531-50529dae57e3-->
...
Und das Tool sucht einfach nach einem bestimmten Metadaten-Kommentar mit einer Regex
Da es sich bei diesen Daten um Metadaten handelt, möchte ich sie in HTML-Meta-Tags ändern, da sie sich semantisch korrekt anfühlen. Etwas wie das:
<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" class="">
<head>
<meta name="details" content="52:AS6[rxSdsMd4RgYXJgeabsRAVBZ:0406139009]" />
<meta name="policyId" content="1234567890" />
<meta name="partyId" content="0987654321" />
<meta name="emailAddress" content="[email protected]" />
<meta name="error" content="49" />
<meta name="subsessionid" content="bffd5bc0-a03e-42e5-a531-50529dae57e3" />
...
Das fühlt sich semantischer an, und ich kann das MI-Tool problemlos dazu bringen, damit zu arbeiten – nur ein Fall, in dem die regulären Ausdrücke geändert werden müssen. Allerdings gibt es jetzt ein Problem mit dem w3c-Validator. Es wird nicht validiert, da die von mir verwendeten Metanamen nicht erkannt werden. Ich erhalte die Fehlermeldung „Ungültige Wertdetails für Attributname auf Elementmeta: Schlüsselwortdetails sind nicht registriert.“ und es schlägt vor, dass ich diese Namenswerte im WHATWG-Wiki registriere.
Obwohl ich das könnte, fühlt es sich nicht richtig an. Einige meiner Meta-Tags sind „allgemein“ (z. B. Fehler und E-Mail-Adresse), sodass ich wahrscheinlich einen bereits registrierten Namenswert finden und diesen verwenden könnte. Die meisten von ihnen sind jedoch branchen-/organisationsspezifisch. Es fühlt sich falsch an, einen öffentlichen Namenswert namens subsessionid oder partyId zu registrieren, da diese für meine Organisation und die Anwendung spezifisch sind.
Die Frage ist also: Was gilt in diesem Fall als Best Practice? Soll ich sie als HTML-Kommentare hinterlassen? Sollte ich Meta-Tags wie oben verwenden und mir keine Sorgen machen, dass die w3c-Validierung fehlschlägt? (obwohl das für die Organisation immer wichtiger wird) Sollte ich versuchen, meine Meta-Namenswerte im WHATWG-Wiki zu registrieren, obwohl ich weiß, dass sie nicht sehr allgemein sind? Oder gibt es eine andere Lösung?
Schätze deine Gedanken, Prost
Nathan
Bearbeitet, um die endgültige Lösung zu zeigen:
Die vollständige Antwort, mit der ich gehe, lautet wie folgt. Es basiert auf Rich Bradshaws Antwort, also ist seine die akzeptierte, aber der Vollständigkeit halber gehe ich mit:
<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" class="">
<head>
<meta name="application-name" content="Our app name"
data-details="52:AS6[rxSdsMd4RgYXJgeabsRAVBZ:0406139009]"
data-policyId="1234567890"
data-partyId="0987654321"
data-emailAddress="[email protected]"
data-error="49"
data-subsessionid="bffd5bc0-a03e-42e5-a531-50529dae57e3"
/>
...
Dies bestätigt, also sind alle Kästchen angekreuzt 🙂
Laut Spezifikation bei whatwg.org/specs/web-apps/current-work/multipage/…, die Datenattribute dürfen keine Großbuchstaben enthalten. Deine tun es. Nicht, dass mich das persönlich beleidigt hätte.
– Greg Maletic
6. August 2013 um 21:40 Uhr