[Docutils-users] Re: Docutils

[Aaron B. <aar...@ut...>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi David,

David Goodger wrote:
> I don't fully understand your use of subdocuments, like why you use
> them instead of using subsections.  Are they separate files that are
> pulled into the main document?

Our tool is a web application, and we have a help system that provides
clickable links.  These links launch smaller help windows when clicked.
  Both the main pages and the help are written in ReST.

Originally, we designed it so that the help was stored in separate
files.  But our authors didn't like doing it that way.  They wanted to
keep the help text in the same file, unless the same help text applied
to multiple pages (which is rare).

That was when we started storing these separate documents within the
same file.  So when parsed, they are separate documents and do not
appear in the main document at all.  But they are stored as part of the
same ReST document.

> There's a well-known line number bug, but I don't know if it's
> related to what you're seeing.

No, our problem is just that we parse the subdocuments separately, so
their line numbers start at 1, when they may actually be line 100 or
later in the real document.

> I encourage you to take this discussion to
> doc...@li...; you'll get better and quicker
> replies.  Real-world use cases like yours are always welcome, and help
> to make Docutils a better tool.

You got it.

Aaorn


-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org

iD8DBQFEdfQa0F+nu1YWqI0RAh0LAJ9eTWjQf92b/n6xEBa8Wm1de+zNuQCfRJ1x
1mwyqKcwcZg1F/67rfgstkA=
=/g6v
-----END PGP SIGNATURE-----