Broadly, how would one achieve nice web docs as DITA-OT output?

209 views
Skip to first unread message

Tristan Harward

unread,
Nov 13, 2014, 9:34:18 AM11/13/14
to dita-o...@googlegroups.com
I haven't found a good tutorial or guide anywhere that shows how to customize the HTML output such that it's a nice, clean, HTML5 structure with a TOC, header, and footer.

For example: I assume the DITA-OT docs themselves were generated by DITA-OT, as seen here: https://dita-ot.github.io/2.0/

This output demonstrates exactly what I desire. Clean semantic HTML5 with a header, footer, integrated with a site style (bootstrap or otherwise), with a left-hand TOC that is not an iframe.

Are there any documents or tutorials explaining what would be required to achieve this? Are the source files of the DITA-OT site transformation itself available?

Thanks for any help!

Jarno Elovirta

unread,
Nov 13, 2014, 10:43:24 AM11/13/14
to Tristan Harward, dita-o...@googlegroups.com
Hi,

DITA-OT site is built in Jekyll, the source of the site is at https://github.com/dita-ot/dita-ot.github.io

The documentation pages are generated from DITA, using DITA-OT plug-in https://github.com/dita-ot/dita-ot/tree/develop/src/main/plugins/net.sourceforge.dita-ot.html. The plug-in generates HTML fragment pages with only the main page content and a TOC fragment, with some additional metadata for Jekyll; you can see source for an example page e.g. at https://github.com/dita-ot/dita-ot.github.io/blob/master/2.0/readme/DITA-ant.html

To generate a website from DITA content with DITA-OT, you first need to pick which publishing system you want to use. Do you want

* static HTML pages that contain everything you want in a page, or
* HTML fragments that are used to construct the final page by e.g. Jekyll or Wordpress

After that, you would write plug-in (or modify an existing plug-in) to create the HTML and configuration files.

Cheers,

Jarno

--
You received this message because you are subscribed to the Google Groups "DITA-OT Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dita-ot-user...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

signature.asc
Reply all
Reply to author
Forward
0 new messages