Skip to content
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

Update TDG, chapter Assemblies (missing association) #79

Open
tomschr opened this issue Jul 29, 2021 · 0 comments
Open

Update TDG, chapter Assemblies (missing association) #79

tomschr opened this issue Jul 29, 2021 · 0 comments

Comments

@tomschr
Copy link
Member

tomschr commented Jul 29, 2021

Problem

Chapter "Assemblies", section "Relationships" contains a description about the relationship(s) structure.

The section shows this example:

<relationship type="seealso">
  <instance linkend="tut1"/>
  <instance linkend="tut2"/>
  <instance linkend="task1"/>
</relationship>

However, this example is a bit misleading as it seems to be incomplete. The section and the example has the following issues:

  • Does not mention <relationships> (plural!) element
  • Does not distinguish between <relationships> (plural) and <relationship> (singular)
  • Does not mention <association> element as it required in DocBook 5.2*

Possible solution

IMHO, we should amend this example like this:

<relationships>
  <relationship type="seealso">
    <association>???</association>
    <instance linkend="tut1"/>
    <instance linkend="tut2"/>
    <instance linkend="task1"/>
  </relationship>
</relationship>

Not sure what we should put inside the <association> element.

Related issue

docbook/docbook#214

@ndw ndw transferred this issue from docbook/docbook Jul 29, 2021
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

No branches or pull requests

1 participant