search

dita-community / doxygen2dita

Open Toolkit plugins for converting Doxygen XML to DITA maps and topics
Apache License 2.0
5 stars 1 forks source link

Grouping support #3

Open sethpark opened 8 years ago

sethpark commented 8 years ago

Hi Eliot. Have you worked with grouping in the Doxygen flow (https://www.stack.nl/~dimitri/doxygen/manual/grouping.html)? Our current doxygen-to-dita flow is a customization of the HTML generation program, which builds the navigation in a way that considers "grouping" instructions. The XML output does not seem to respect grouping information explicitly. We are analyzing the XML to determine whether we can infer grouping information and rebuild the DITA map taking into account this grouping information. If you've done some analysis here, I would appreciate your guidance.

drmacro commented 8 years ago

I have not done anything with grouping instructions (didn't know those were a thing). If the information is not in the XML then I don't have it available.

For the Oculus-driven work I'm doing I simply emulating the organization of what they've publicly published. I have no idea how generally applicable that code will be.

If you can point me to specifications or examples I can see what I figure out.

sethpark commented 8 years ago

Thanks, Eliot. Tushar is doing a first round of analysis and we'll publish the results.

amantalwar04 commented 8 years ago

Hi All, Grouping is great way to categorize information generated by Doxygen. However, grouping is optional and it is therefore, you do not see any group information generated when you process the index.xml file. It is important to note that if you have groups defined in your source files, you should see 'group__.xml' files generated in your output folder. You may want to look into the .xsd files to see if you can include the group information there. Similar to the DoxygenLayout.xml file that control the appearance of the HTML/PDF output formats. Eliot, I observed the Oculus developer documentation and you're right groups are not defined in the source files.

I have always been looking for a similar solution and am already excited!!!

-Aman Talwar

On Tue, May 10, 2016 at 8:24 PM, sethpark notifications@github.com wrote:

Thanks, Eliot. Tushar is doing a first round of analysis and we'll publish the results.

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/dita-community/doxygen2dita/issues/3#issuecomment-218183161