Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 146552 - Corrections on Metadata doc. (part of Gentoo Dev. Handbook)
Summary: Corrections on Metadata doc. (part of Gentoo Dev. Handbook)
Status: RESOLVED FIXED
Alias: None
Product: Community Relations
Classification: Unclassified
Component: Developer Relations (show other bugs)
Hardware: All Linux
: High minor (vote)
Assignee: Gentoo Community Relations Team
URL: http://www.gentoo.org/proj/en/devrel/...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-09-06 07:19 UTC by Aggelos Orfanakos (RETIRED)
Modified: 2006-09-07 04:13 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
hb-guide-metadata.xml.diff (hb-guide-metadata.xml.diff,891 bytes, patch)
2006-09-06 07:20 UTC, Aggelos Orfanakos (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Aggelos Orfanakos (RETIRED) gentoo-dev 2006-09-06 07:19:46 UTC
A couple of corrections for the Gentoo Metadata documentation. A .diff follows.
Comment 1 Aggelos Orfanakos (RETIRED) gentoo-dev 2006-09-06 07:20:09 UTC
Created attachment 96171 [details, diff]
hb-guide-metadata.xml.diff
Comment 2 Tim Yamin (RETIRED) gentoo-dev 2006-09-06 07:29:40 UTC
Fixed in CVS, thanks. Not sure what the second hunk of your patch was about, looked like a typo to me so I didn't change that.
Comment 3 Aggelos Orfanakos (RETIRED) gentoo-dev 2006-09-06 07:58:18 UTC
Uhm, it was not a typo. AFAIK, in XML, '<' and '>' in places other than tags are illegal; '&lt;' and '&gt;' should be used instead. This is what the docs say too, if I am not mistaken. But to have HTML to display '&lt;' and '&gt;' properly in the guide, one needs to use the HTML entity of '&', thus '&amp;lt;' and '&amp;gt;'. Otherwise '&lt;', '&gt;' are rendered back to '<', '>' in HTML.
Comment 4 Tim Yamin (RETIRED) gentoo-dev 2006-09-06 09:11:44 UTC
Fixed -- I didn't notice the example was one of XML, thanks for the explanation :)
Comment 5 Xavier Neys (RETIRED) gentoo-dev 2006-09-07 03:24:19 UTC
He he, thanks for noticing, fixing & explaining :)

Only & and < need an entity. We often use &gt; to be safe and balance &lt;, but > would work fine.
&quot; and &apos; are almost never required, except when mixed inside an attribute.
I changed some &quot; to " and used sources.g.o in a link

FYI, I took this opportunity to add the <version> and <date> tags. They were meant to become compulsory a long time ago and it's about time someone took care of this.
Comment 6 Aggelos Orfanakos (RETIRED) gentoo-dev 2006-09-07 04:13:57 UTC
Oh OK. It's just that the example was inconsistent with the paragraph above it that said "use &lt; and &gt; instead of < and >". Anyhow, glad to contribute.