[publican-list] Comments in XML files, good, bad, or ugly?

Jared Smith jaredsmith at jaredsmith.net
Wed Oct 15 13:15:39 UTC 2008


On Wed, 2008-10-15 at 15:49 +1100, Lana Brindley wrote:
> Who reads documentation in vim?

Not only am I sick and twisted enough to read documentation in vim, I
actually write books in DocBook in vim.  Scary, isn't it?!?

To add additional clarification, however, that vim command is something
I picked up from the Fedora Documentation team, and they have something
similar for emacs as well.  All in all, it looks something like:

<!--
Local variables:
mode: xml
fill-column: 72
End:
-->
<!-- 
vim: softtabstop=2:shiftwidth=2:expandtab:textwidth=72 
-->

Yes, some people don't like it, as it overrides their own personal
settings.  At the same time, it makes it much cleaner for working with
tabs, etc. when working in a group environment.  I'm not saying it's a
perfect fit for anyone (myself included), but I thought I'd throw it out
there for two reasons: first as an example of where a remark would be
cumbersome (if not impossible), and second just in case anyone on the
list (or in the archives later) finds it useful for them.

-Jared






More information about the publican-list mailing list