Re: [Monotone-devel] info file: "monotone" -> "mtn"

[Daniel Carosone]

On Tue, Apr 25, 2006 at 02:58:36AM -0700, Nathaniel Smith wrote:
> > OK, here it goes! :-)
> 
> Dude, we (I ;-)) did miss a lot.

Dang, we (I too) did. Sorry about that :-(

One thing that will/would help with this kind of thing in the future
is to be highly vigorous and vigilant with using more markup, so that
(for this example) the semantic difference between "monotone" as a
project name and "monotone" as a command name is explicitly..
well.. marked up in the source.  The same might apply for future UI
changes to options and subcommands.  It can also help creating
better-quality indexes and such.

I'm not terribly familiar with texinfo markup, but I'll see what I can
do to write up a simple markup style guide, based on current usage.

In the meantime, for those making document changes, please keep this
request in mind and look to annotate your content accordingly.  Don't
get hung up on it, though: good content without markup is more useful
than markup of poor content.

--
Dan.

PS: We don't need to also turn this into display markup (via whatever
stylesheet for the relevant output format) for it to be useful for
document maintenance.  I have seen it work, though: a special
"document maintainer" stylesheet that colours/displays every possible
markup style differently - horridly flashy and distracting to read as
a user, but helpful to spot missing/incorrect markup as an editor.

pgppZgak3_xgW.pgp
Description: PGP signature