New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow external info links with href #30

Closed
shaunix opened this Issue Jun 5, 2015 · 1 comment

Comments

Projects
None yet
1 participant
@shaunix
Copy link
Contributor

shaunix commented Jun 5, 2015

Currently, any info links have to be xref links to other pages or sections within the document (or potentially in a larger help system with an extended xref syntax). This goes for topic, guide, seealso, and next links, as well as any other links defined by extensions or future Mallard versions.

Sometimes it's useful to link to an external page within topic links or seealso links. We could allow this by allowing an href attribute on info link elements. But then we need a way to get information like title, desc, thumb, etc. So we could allow that information as child elements to the link element.

<info>
  <link type="topic" href="http://projectmallard.org/">
    <title>Mallard</title>
    <desc>We built the help system.</desc>
  </link>
</info>

Basically, the contents of the link element are treated as if they're the contents of an info element for the thing you're linking to. This allows stuff like sort and text titles, revision info, etc. The current content model for info link elements is just external. Switching it to info contents, which allows external, shouldn't present any compatibility issues.

@shaunix shaunix added the NeedsMEP label Jun 5, 2015

@shaunix shaunix added this to the 1.1 milestone Jun 5, 2015

gnomesysadmins pushed a commit to GNOME/yelp-xsl that referenced this issue Jun 6, 2015

Allow external info links for topic links
This is the first step in allowing external info links:

projectmallard/projectmallard.org#30

This commit only adds them for topic links, but it adds all the
machinery necessary for other link types to use external links.
The various templates for outputting link content can now all
take an additional info parameter, which is provided by the
templates that list info links.

This commit also adds templates for outputting the desc, which
was previously done ad-hoc in each place desc is used for links.
This not only helps this use, but it will be necessary if we add
multiple descs with roles in a future version of Mallard.
@shaunix

This comment has been minimized.

Copy link
Contributor Author

shaunix commented Jan 4, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment