Best file structure for DITA

user234
Posts: 8
Joined: Wed May 22, 2019 11:54 am

Best file structure for DITA

Post by user234 » Fri May 24, 2019 7:42 am

Hello

What is the best method to store DITAMAPS and their TOPICS?
Can you expand on the sentence:
"The ideal file structure for a DITA project is to have ditamaps at the root level of the documentation repository folder, and content topics stored in sub-folders down from the root. This structure ensures that topicref links to content always move down the tree structure. As ditamaps are an informational superset of topics, having ditamaps in a superfolder is a logical approach."

Can you post a visual of the file path structure? Thanks,
Natalie.

Radu
Posts: 6329
Joined: Fri Jul 09, 2004 5:18 pm

Re: Best file structure for DITA

Post by Radu » Fri May 24, 2019 9:24 am

Hi Natalie,

Your quote is from the "DITA Style Guide". It's a book written by DITA consultant Tony Self and hosted on our web site. So it is not content produced by Oxygen's technical writers or content part of the Oxygen user's manual.
At some point I created on the Oxygen XML GitHub organization a DITA project exemplifying some best practices:

https://github.com/oxygenxml/dita-proje ... -practices

The Oxygen's user's guide in DITA format is another example:

https://github.com/oxygenxml/userguide/tree/master/DITA

I would suggest storing the main DITA Map in the top folder, you can store submaps separately in a "maps" folder, have separate folders for "images", "filters" and then maybe try to have subfolders based on the various major components of your applications (we have not yet applied this last one in our user's manual). For example if Oxygen can be split into three main parts: "XML Editor", "XSLT Debugger", "Database Explorer", you would have a subfolder for each. In each subfolder you could store topics/concepts/tasks. An older approach was to store tasks separately in a "tasks" folder, concepts separately in a "concepts" folder but I thing this approach is not that used anymore.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com

user234
Posts: 8
Joined: Wed May 22, 2019 11:54 am

Re: Best file structure for DITA

Post by user234 » Mon May 27, 2019 11:37 am

Thank You!

Post Reply