Лучшая практика для метаданных в html-документе?
Я работаю над крупномасштабным, объемным, общедоступным веб-приложением. Успешная работа приложения очень важна для бизнеса, поэтому существует ряд инструментов MI, которые противодействуют этому.
Один из этих инструментов MI, по сути, просматривает HTML-код, который отправляется в браузер для каждого запроса страницы (я довольно сильно упростил его, но для целей этого вопроса это инструмент, который выполняет некоторый анализ на html)
Чтобы этот инструмент MI мог получить необходимые данные, мы поместили метаданные в элемент head. В настоящее время мы делаем это в виде html-комментариев:
<!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-->
...
И инструмент просто ищет заданный комментарий метаданных с помощью регулярного выражения
Поскольку эти данные являются метаданными, я хотел бы изменить их на метатеги html, потому что это выглядит семантически. правильный.Что-то вроде этого:
<!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" />
...
Это кажется более семантическим, и я могу заставить инструмент MI работать с ним без проблем - просто случай изменения регулярных выражений. Однако теперь у меня возникла проблема с валидатором w3c. Это не пройдет проверку, потому что мета-имена, которые я использую, не распознаются. Я получаю сообщение об ошибке «Неверные сведения о значении для имени атрибута в метаэлементе: сведения о ключевом слове не зарегистрированы». и предлагает мне зарегистрировать эти значения имен на вики WHATWG.
Хотя я мог бы сделать это, это кажется неправильным. Некоторые из моих метатегов являются «универсальными» (например, ошибка и адрес электронной почты), поэтому я, вероятно, мог бы найти уже зарегистрированное значение имени и использовать его. Однако большинство из них зависят от отрасли/организации. Кажется неправильным регистрировать значение общедоступного имени с именем subsessionid или partyId, поскольку они специфичны для моей организации и приложения.
Итак, вопрос в том, что в данном случае считается лучшей практикой? Должен ли я оставить их как html-комментарии? Должен ли я использовать метатеги, как указано выше, и не беспокоиться о том, что проверка w3c не пройдена? (хотя это становится все более важным для организации) Должен ли я попытаться зарегистрировать свои значения мета-имени на вики WHATWG, но зная, что они не очень общие? Или есть другое решение?
Спасибо за ваши мысли, привет.
Натан
Отредактировано, чтобы показать окончательное решение:
Полный ответ, который я предлагаю, выглядит следующим образом. Он основан на ответе Рича Брэдшоу, так что он является принятым, но это то, что я собираюсь использовать для полноты:
<!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"
/>
...
Это подтверждает, поэтому все поля отмечены :)