Ich arbeite an einer groß angelegten, öffentlich zugänglichen Webanwendung mit hohem Volumen. Der erfolgreiche Betrieb der Anwendung ist für das Unternehmen sehr wichtig. Daher gibt es eine Reihe von MI-Tools, die dagegen ausgeführt werden.
Eines dieser MI-Tools betrachtet 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 zum HTML-Code 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 = user@email.com -->
<!-- error = 49 -->
<!-- subsessionid = bffd5bc0-a03e-42e5-a531-50529dae57e3-->
...
Und das Tool sucht einfach nach einem bestimmten Metadatenkommentar mit einem regulären Ausdruck
Da es sich bei diesen Daten um Metadaten handelt, möchte ich sie in HTML-Metatags ä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="user@email.com" />
<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 zum Laufen bringen - nur ein Fall, in dem die regulären Ausdrücke geändert werden. Jetzt gibt es jedoch 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 Attributnamen in Element-Meta: Schlüsselwortdetails sind nicht registriert." und es schlägt vor, dass ich diese Namenswerte im WHATWG-Wiki registriere.
Obwohl ich das tun könnte, fühlt es sich nicht richtig an. Einige meiner Meta-Tags sind 'generisch' (wie error und emailAddress), sodass ich wahrscheinlich einen bereits registrierten Namenswert finden und diesen verwenden könnte. Die meisten von ihnen sind jedoch branchenspezifisch / 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 wird in diesem Fall als Best Practice angesehen? 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 dies für die Organisation immer wichtiger wird) Sollte ich versuchen, meine Metanamenwerte im WHATWG-Wiki zu registrieren, aber wissen, dass sie nicht sehr allgemein sind? Oder gibt es eine andere Lösung?
Schätzen Sie Ihre Gedanken, Prost
Nathan
Bearbeitet, um die endgültige Lösung anzuzeigen:
Die vollständige Antwort lautet wie folgt. Es basiert auf der Antwort von Rich Bradshaws, daher ist seine Antwort die akzeptierte, aber der Vollständigkeit halber gehe ich folgendermaßen vor:
<!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="user@email.com"
data-error="49"
data-subsessionid="bffd5bc0-a03e-42e5-a531-50529dae57e3"
/>
...
Dies bestätigt, also alle Kästchen angekreuzt :)