Re: [Docutils-users] The docutils document tree

[David G. <go...@py...>]

[Roberto Alsina]
> Hello, I am writing an application to write documents, and I would
> like to use a docutils document tree to store the document
> information
...
> I have been reading the docs, but I can't quite understand how to do
> it.
>
> When I read a file using publish_tree, I get the tree, ok.

Do you mean docutils.core.publish_doctree?

> But, for example, the document title is not in the document node.

That's the job of the docutils.transforms.frontmatter.DocTitle
transform, which is specified by the standalone reader.  The
standalone reader is the default reader for
docutils.core.publish_doctree, and the DocTitle transform should
therefore be selected and applied automatically.

If that's not happening, I don't know why.  Please show us your code.

> I see from the docs that "After applying transforms, the section
> title is promoted to become the document title".

See PEP 258 (docs/peps/pep-0258.txt in the Docutils distro) for a
description of how transforms work.  In a nutshell, transforms are
specified by (or attached to) individual components (parser, reader,
writer), and applied by the Transformer after the Reader & Parser have
done their jobs.

> How can I apply the transforms, so I get the transformed tree?

You set up and run the Publisher, which runs the Transformer, and *it*
applies the transforms.  I suppose you could apply transforms manually,
but why go to the trouble?

-- 
David Goodger <http://python.net/~goodger>