Lightweight DITA

Lightweight DITA (LwDITA) is a simplified version of the Darwin Information Typing Architecture (DITA). In comparison to DITA XML, LwDITA has a smaller element and attribute set, stricter content models, and a reduced feature set. LwDITA also defines mappings between XML, HTML5, and Markdown, enabling authoring, collaboration, and publishing across different markup languages.

The DITA XML standard is a mature architecture with a deep set of advanced features. Those features, while useful for large projects, can also intimidate practitioners and academics interested in learning about DITA. LwDITA is a proposed standards-based alternative that offers a starting point for simple structured authoring scenarios that remains fully compatible with DITA XML and is more accessible to professional communicators who do not work in XML-based authoring workflows.

Some authoring communities have strong ties to specific formats, such as Markdown or HTML. While these formats do not have the same expressiveness as XML, they bring with them a set of tools and practices that can be a natural fit with a DITA ecosystem. LwDITA acknowledges the importance and popularity of lightweight languages and includes mappings for HTML5 and Markdown, thus becoming the first version of DITA to be truly cross-format —allowing authoring and delivery in a mix of native formats that are all mapped to a common semantic standard.

The Lightweight DITA subcommittee with OASIS developed this proposed standard identifying key authoring communities that were interested in the benefits that LwDITA could provide; it then identified scenarios including cross-format authoring and reuse. LwDITA represents common ground for the functionality that is needed by the following authoring communities: learning and training, software documentation authored by subject matter experts (SMEs), and marketing content.

The core goals of LwDITA are the following:

* Enable a simpler structured authoring experience than DITA provides, while retaining many core DITA features. * Specify syntaxes based on XML, HTML5, and Markdown, that enable individuals to: ** Author content in the format of their choice ** Easily exchange and publish content whose source exists in these different markup languages ** Foster the growth of new, low-cost tools and applications that support LwDITA. * Integrate with full DITA-based workflows, without requiring transformation or conversion of source content.

In its initial release, LwDITA specifies three authoring formats:

* XDITA, an XML-based variant * HDITA, an HTML5-based variant * MDITA, a Markdown-based variant

These authoring formats will enable and enhance collaboration across divisional silos. Engineers can author in Markdown, marketing writers can author in HTML5, and technical writers and others familiar with DITA can author in XML. Documents authored in the various authoring formats can be aggregated and published as a single document collection. They can also be published along with full DITA 1.3 topics and maps.

LwDITA is still under development as an open standard, but interested professional communicators from industry and academia can track its progress through the OASIS Lightweight DITA subcommittee.

~

EVIA, Carlos and HOUSER, Alan, 2018. Lightweight DITA: Making Structured Authoring More Accessible for Professional Communicators. In: 2018 IEEE International Professional Communication Conference (ProComm). Online. July 2018. p. 219–221. DOI 10.1109/ProComm.2018.00050. [Accessed 29 November 2023]. Lightweight DITA (LwDITA) provides a simplified standard (compared to XML-based alternatives) for authoring in a semantic markup language, while supporting multiple authoring formats. This paper describes the inception, goals, and development of the LwDITA standard.

[1] C. Evia & M. Priestley, “Structured Authoring without XML: Evaluating Lightweight DITA for Technical Documentation,” Technical Communication, vol. 631, no. 1, pp. 23-37, 2016.

[2] F. Sapienza, “Does Being Technical Matter? Xml, Single Source, and Technical Communication,” Journal of Technical Writing and Communication, vol. 32, no. 2, pp. 155–170, 2002.

[3] B. Gesteland McShane, “Why we should teach XML: An argument for technical acuity.” In G. Pullman & B. Gu (Eds.), Content Management Bridging The Gap Between Theory And Practice, Amityville, NY: Baywood Pub., 2009, pp. 73-85.

[4] M. Priestley, G. Hargis & S. Carpenter, S. “DITA: An XMLbased technical documentation authoring and publishing architecture,” Technical Communication, vol. 48, no. 3, pp. 352367, 2001.

[5] “Companies Using DITA,” January 18, 2012. Retrieved February 1, 2018, from http://www.ditawriter.com/companiesusing-dita/

[6] O’Keefe, S., & Kinsey, G. “The age of accountability: Unifying marketing and technical content with Adobe Experience Manager,” 2017. Retrieved February 1, 2018 from https://www.scriptorium.com/2017/05/the-age-of-accountability-unifying-marketing-and-technical-content-withadobe-experience-manager/

[7] A. Rockley and A. Cooper. Managing Enterprise Content: A Unified Content Strategy (2nd Edition), New Riders, 2012.

[8] N. Kaplan. “The death of technical writing, part 1.” 2014. Retrieved February 1, 2018 from https://customersandcontent.com/2014/05/03/the-death-oftechnical-writing-part-1/

[9] C. Evia et al. “Lightweight DITA: An introduction. OASIS Committee Not, 2018.