Skip to content

Conversation

@claudius108
Copy link
Contributor

Description of 'xref' element: http://docbook.org/tdg5/en/html/xref.html.

This element makes easier to maintain the pages, compared to 'ulink' element, as the content of the generated HTML 'a' element is generated automatically from the text content of the 'title' child element of the referenced element (which can be, for instance, a 'section' element).

Copy link
Member

@joewiz joewiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This <ulink> element looks genuinely useful, and I think it could make the job of maintaining documentation easier. And it's supported in DocBook 4, which the documentation is still written in. There seem to be some unintended changes in the commit, though - removing CDATA blocks and escaping the XML that had been inside this. I feel bad that your commit has been waiting so long, so we could accept as is - but Claudius, if it's not too hard, could you switch the CDATA blocks back? They make it much easier to maintain the sample code.

Update: I just realized I now have commit access, so I will make the CDATA changes.

Update: The code samples elsewhere in this document all used escaped XML, so Claudius's decision to remove CDATA actually made the document more consistent. I approve the PR.

Copy link
Member

@joewiz joewiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All is good now.

Copy link
Member

@dizzzz dizzzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I see the added value.

@adamretter
Copy link
Contributor

@joewiz @dizzzz Can this be merged then?

@joewiz
Copy link
Member

joewiz commented Feb 27, 2017

@wolfgangmm Just awaiting your approval?

@dizzzz dizzzz merged commit f257ceb into eXist-db:master Mar 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants