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

Referencing into output #5

Open
hcw70 opened this issue Apr 4, 2023 · 2 comments
Open

Referencing into output #5

hcw70 opened this issue Apr 4, 2023 · 2 comments

Comments

@hcw70
Copy link
Contributor

hcw70 commented Apr 4, 2023

Is there a way to reference into a specific topic (class / member) from the doxygen 2 dita output
from "hand-written" dita content (i.e. via keyref or reltables)?

Can support for this be added?

My main reason for using this plugin would be to combine "hand-written" dita content with
doxygen output and allow cross referencing between topics.

@jason-fox
Copy link
Owner

According to Doxygen, Doxygen supports most of the XML commands, but doesn't do anything with <include> right now. The term definition can be found in ECMA-334

D.3.6

This tag allows including information from an XML document that is external to the source code file. The
external file must be a well-formed XML document, and an XPath expression is applied to that document
to specify what XML from that document to include. The tag is then replaced with the selected
XML from the external document.

Syntax:
<include file="filename" path="xpath" />
where

  • file="filename" is the file name of an external XML file. The file name is interpreted relative to the
    file that contains the include tag.
  • path="xpath" is an XPath expression that selects some of the XML in the external XML file.

Example:
If the source code contained a declaration like:
/// <include file="docs.xml" path="...">

I would assume that if <include> could be parsed into the doxygen.xml file then an XSLT transform could be added to read that file as an external DITA snippet and blindly paste it into the generated topics.

@hcw70
Copy link
Contributor Author

hcw70 commented Jun 9, 2023

Maybe i was a bit unclear on what i want to do.
I want to have a main.ditamap which includes

  • The topicref to the doxygen.xml as processed by your plugin
  • A topicref to some introductionary topics
  • A reltable between doxygen elements and the intro topics.

This seems to not work based on any keyref / keys attributes.
Is there something you can do to the created doxygen2dita output of the plugin to link to
a class / namespace / function via dita keys in a reltable / xref element?

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

2 participants