Schema.org 标记中的“描述”是否必须不含 HTML 标签？

Question

All e-commerce websites with Product Schema.org Microdata that I found use plain text in description property.

Is there some specification that clearly prohibits markup with some text formatting tags like:

<div itemscope itemtype="http://schema.org/Product">
<meta itemprop="name" content="Name" />
<meta itemprop="description" content="<p>First paragraph with <b>bold words<b/>.</p><p>Second paragraph.</p>" />
</div>

Answer 1

If you are using the newer JSON-LD format for schema data then it seems (at least with Google) that it's OK to include HTML markup for some fields - indeed, they actually ask for it. See their recommendation for JobPostings , for example, where they state for description:

The full description of the job in HTML format.

You must format the description in HTML.

Their Structured Data Testing Tool certainly doesn't seem to complain about HTML in fields, though you probably want to limit it to basic tags. Whether other parsers are OK with it is difficult to say.

Answer 2

You are using the meta element . Its content attribute can only contain a string. If you'd provide a value like <b>bold</b> , <b> and </b> would be part of the value, and these would be interpreted as text , not as markup.

For Schema.org's description property, you can of course use a different element (like p ). This may contain markup, but the value for the description property will be the text value .

So for

<p itemprop="description">foo <b>bar</b></p>

the value would be "foo bar".

Answer 3

The datatype of description is defined as Text . I think it's clear that the intention is that this should be plain text.

In cases where the description ends up on a web page, such as in search engine results, the text will doubtless be HTML-encoded to prevent things like script injection, so will actually be displayed to the user with the angle brackets instead of as formatting.

Answer 4

Matthew is right, you should only provide text as value to description meta tag. But Unor is also right, the recommended method in this case is using microdata to the markup itself, like:

<div itemscope itemtype="http://schema.org/Product">
 <p itemprop="name">Product's Name</p>
 <p itemprop="description">Products description.<strong>Some bold text</strong></p>

Here you can see exactly as Google recommends it. And here you can test page by page or even paste your code there to test just a block.

You might want to read here why should you avoid using <b> for bold.

Answer 5

Though this is an old question. I have a different solution. The description had tags other than the tags so it was not read as text by google.

You can pass the description in the content property , like so.

  <p itemprop="description" content="<%:Model.Description %>"><%:Html.Raw(Model.Description) %> </p>

Perhaps the text should be cleaned before posting it. The tool seems to use it so seems ok to me.