html文档中元数据的最佳实践？

时间：2012-05-10 12:15:26

标签： html html5 meta-tags w3c-validation

我在大规模，大批量，面向公众的Web应用程序上工作。应用程序的成功运行对业务非常重要，因此有许多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维基上注册这些名称值。

虽然我能做到这一点但感觉不对。我的一些meta标签是'通用的'（例如error和emailAddress），所以我可能会找到已注册的名称值并使用它。但是，大多数都是针对行业/组织的。注册名为subsessionid或partyId的公共名称值是错误的，因为这些值特定于我的组织和应用程序。

所以，问题是 - 在这种情况下，什么是最佳做法？我应该把它们留作html评论吗？我应该如上所述使用meta标签而不担心w3c验证失败吗？ （虽然这对组织来说越来越重要）我应该尝试在WHATWG wiki上注册我的元名称值，但是知道它们不是非常通用的吗？还是有另一种解决方案吗？

欣赏你的想法，欢呼

森

编辑以显示最终解决方案：

我要回答的完整答案如下。它基于Rich Bradshaws的回答，所以他是被接受的，但这就是我要完整的方式：

<!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"
    />
    ...

此验证，所以所有方框都勾选：）

4 个答案:

答案 0 :(得分：36)

W3C验证毫无意义。 HTML！= XML，因此没有任何架构可以验证它。没有浏览器会因为你添加了一个带有未注册名称的元元素而窒息。如果您真的很担心，可以在meta元素上使用data属性，如：

<meta data-details="52:AS6[rxSdsMd4RgYXJgeabsRAVBZ:0406139009]" data-policyId="0123456789" />

至少你知道未来的规范不会给你的数据带来意义。

欲了解更多信息，请阅读：http://www.whatwg.org/specs/web-apps/current-work/multipage/elements.html#custom-data-attribute

答案 1 :(得分：28)

虽然您的示例可能有效，但请注意关键字application-name仅适用于 Web应用程序。

对于不是网络应用程序的常规网页，或者如果不提供application-name，请参阅其他选项：

在data-*

中使用head属性

无需meta元素。

<!DOCTYPE html>
<html>
<head
    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">
</head>

使用Microdata

你可以创建一个词汇表，但那是not required for local use。

<!DOCTYPE html>
<html>
<head itemscope>
  <meta itemprop="details" content="52:AS6[rxSdsMd4RgYXJgeabsRAVBZ:0406139009]" />
  <meta itemprop="policyId" content="1234567890" />
  <meta itemprop="partyId" content="0987654321" />
  <link itemprop="emailAddress" href="mailto:user@email.com" /> <!-- or use a meta element if you don’t want to provide a full URI with "mailto:" scheme -->
  <meta itemprop="error" content="49" />
  <meta itemprop="subsessionid" content="bffd5bc0-a03e-42e5-a531-50529dae57e3" />
</head>

使用script

中的数据

script元素can be used for data blocks。您可以选择任何适合您需求的格式。纯文本示例：

<!DOCTYPE html>
<html>
<head>
  <script type="text/plain">
    details = 52:AS6[rxSdsMd4RgYXJgeabsRAVBZ:0406139009]
    policyId = 1234567890
    partyId = 0987654321
    emailAddress = user@email.com
    error = 49
    subsessionid = bffd5bc0-a03e-42e5-a531-50529dae57e3
  </script>
</head>

答案 2 :(得分：2)

如果您尝试使用数据格式向其添加自定义属性，如数据类型或数据名称并省略实名属性或者将其全部设置为“抽象”或其他内容（我不知道如果验证器会给重复的元名称带来问题）：

<meta data-name="details" content="52:AS6[rxSdsMd4RgYXJgeabsRAVBZ:0406139009]" />

因此，您可以引用该数据名称来处理您的元数据......

http://html5doctor.com/html5-custom-data-attributes/

答案 3 :(得分：0)

这两个选项在技术上都可行，但解决方案可以归结为您的组织对页面验证的感受。

正如您所说，将信息添加到自定义元数据标记中会使您的标记无效。

对于我的组织，页面验证是技术可访问性的一部分，被认为非常重要。不允许做任何阻止页面验证的内容。

我不会尝试注册新的元数据名称和值，因为这些名称和值是特定于您的组织的，而不是公开使用。

如果这已经适用于您的组织，我可能会将此信息保留为HTML注释。

相关问题
最新问题