June 28, 2004

IntelliJ as.....Writing Tool!

Trying to collaborate on some technical writing with Simon Harris led us to figure out a way to get the type of collaboration we are used to while coding when we're writing. this means having the content in a textual format so it can be merged, ruling out MS Word and other binary formats. We've been using a wiki a lot for this recently, but reading Martin Fowler's post about writing using XML made us want to give it a try. Now before you say DocBook, let me just say that that's just a little tooooo heavyweight for our needs. But the idea is right. So we knocked up a little DTD that incorporates a hierarchy of sections, with figures, code listing, cross references, external references, etc, and then used IntelliJ IDEA's DTD-driven XML editing to start writing the content. With the code folding and a few live templates, we pretty quickly had a nice intuitive editing experience that allows the separation of the creation of the content from the marking up thereof. With the addition of a little XSLT that automatically numbers the nested sections, voila! IntelliJ as author's workbench! Cool!

Posted by james at June 28, 2004 10:33 PM
Comments

You know, I've got a similar problem. Word is becoming to undwieldy in managing my docs. Can you share your DTD?

Thanks,

Carlos

Posted by: Carlos E. Perez at June 29, 2004 02:57 AM

Yes, please post your DTD and live templates.

Posted by: Blaine Kendall at June 29, 2004 03:09 AM

Hi James,

The Prag boys have been using an approach similar to this for a while. Check out their blog for more info:

http://pragprog.com/pragdave/Random/MikeExperience.rdoc

Posted by: Andy Marks at June 29, 2004 12:33 PM

LaTeX is really useful for generating nice documents. The Pragmatic Programmers used it to produce their original book.

Nice intro/overview:
http://pangea.stanford.edu/computerinfo/unix/formatting/latex.shtml

The wikipedia entry:
http://en.wikipedia.org/wiki/LaTeX

Posted by: Bob at July 2, 2004 08:00 AM
Post a comment









Remember personal info?





Please enter the security code you see here