search

alps-io / spec

ALPS Specification documents.
59 stars 13 forks source link

Use of <xref>with content</xref> has incorrect syntax. #63

Closed fosrias closed 9 years ago

fosrias commented 9 years ago

Per RFC2629, putting content in an xref element results in generating an extra element that shows up in html as [something]. Thus, in our current spec, the html version has thinks like 'descriptor' [prop-descriptor] all over.

The way to fix this is not to use content, but rather format="title" in the tag per xml2rfc FAQS Section 3.11.

So for example we need to change throught the document things like:

 <xref target="prop-descriptor">'descriptor'</xref>

to

 <xref target="prop-descriptor" format="title"/>
mamund commented 9 years ago

Right. Good catch. On Feb 28, 2015 3:17 PM, "Mark W. Foster" notifications@github.com wrote:

Per RFC2629 https://tools.ietf.org/html/rfc2629#section-2.3.1.4, putting content in an xref element results in generating an extra element that shows up in html as [something]. Thus, in our current spec, the html version has thinks like 'descriptor' <#14bd1d5bee027aae_> [prop-descriptor] all over.

The way to fix this is not to use content, but rather format="title" in the tag per xml2rfc FAQS Section 3.11 http://xml2rfc.ietf.org/xml2rfcFAQ.html#anchor19.

So for example we need to change throught the document things like:

'descriptor'

to

— Reply to this email directly or view it on GitHub https://github.com/alps-io/spec/issues/63.