API documentation with DITA
Post here questions and problems related to editing and publishing DITA content.
-
- Posts: 4
- Joined: Sat Mar 12, 2016 2:41 pm
API documentation with DITA
I am trying to make api reference with dita, but I have read this, but there is written 
and didn`t understood it(can I create new DITA element by using DTD, souldn`t this make the DITA XML invalid). I also looked here but am not sure if there already exist such elements for the creation of API referenceFor example, API documentation is a particular kind of reference information and requires more specific rules and descriptive markup than a generic reference type. DITA lets you define a new type and reuse the processing of the base type (providing new processing only for different requirements of the new type). As a result, topics from different domains with different markup and markup rules can be built together into one help file, Web site, or book

-
- Posts: 9473
- Joined: Fri Jul 09, 2004 5:18 pm
Re: API documentation with DITA
Hi,
DITA has support for specializations, meaning that there is an officially approved way of creating new DTDs to add new DITA elements to your vocabulary.
Eliot Kimber has a tutorial in which he describes various types of specializations:
http://www.xiruss.org/tutorials/dita-specialization/
Once a DTD specialization is made, it can be bundled as a DITA Open Toolkit plugin and integrated in the DITA Open Toolkit used by Oxygen for publishing and validation:
https://www.oxygenxml.com/doc/versions/ ... ation.html
Regards,
Radu
DITA has support for specializations, meaning that there is an officially approved way of creating new DTDs to add new DITA elements to your vocabulary.
Eliot Kimber has a tutorial in which he describes various types of specializations:
http://www.xiruss.org/tutorials/dita-specialization/
Once a DTD specialization is made, it can be bundled as a DITA Open Toolkit plugin and integrated in the DITA Open Toolkit used by Oxygen for publishing and validation:
https://www.oxygenxml.com/doc/versions/ ... ation.html
Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
<oXygen/> XML Editor
http://www.oxygenxml.com
Return to “DITA (Editing and Publishing DITA Content)”
Jump to
- Oxygen XML Editor/Author/Developer
- ↳ Feature Request
- ↳ Common Problems
- ↳ DITA (Editing and Publishing DITA Content)
- ↳ Artificial Intelligence (AI Positron Assistant add-on)
- ↳ SDK-API, Frameworks - Document Types
- ↳ DocBook
- ↳ TEI
- ↳ XHTML
- ↳ Other Issues
- Oxygen XML Web Author
- ↳ Feature Request
- ↳ Common Problems
- Oxygen Content Fusion
- ↳ Feature Request
- ↳ Common Problems
- Oxygen JSON Editor
- ↳ Feature Request
- ↳ Common Problems
- Oxygen PDF Chemistry
- ↳ Feature Request
- ↳ Common Problems
- Oxygen Feedback
- ↳ Feature Request
- ↳ Common Problems
- Oxygen XML WebHelp
- ↳ Feature Request
- ↳ Common Problems
- XML
- ↳ General XML Questions
- ↳ XSLT and FOP
- ↳ XML Schemas
- ↳ XQuery
- NVDL
- ↳ General NVDL Issues
- ↳ oNVDL Related Issues
- XML Services Market
- ↳ Offer a Service