Add documentation and automatic entries for the guide element

This commit is contained in:
Roland Meister
2012-02-28 21:59:57 +01:00
parent 36988ddb02
commit 0d12036da0
4 changed files with 50 additions and 5 deletions

View File

@@ -81,7 +81,8 @@ The builder's "name" must be given to the **-b** command-line option of
This builder produces the same output as the standalone HTML builder, but
also generates an *epub* file for ebook readers. See :ref:`epub-faq` for
details about it. For definition of the epub format, have a look at
`<http://www.idpf.org/specs.htm>`_ or `<http://en.wikipedia.org/wiki/EPUB>`_.
`<http://idpf.org/epub>`_ or `<http://en.wikipedia.org/wiki/EPUB>`_.
The builder creates *EPUB 2* files.
Some ebook readers do not show the link targets of references. Therefore
this builder adds the targets after the link when necessary. The display

View File

@@ -852,6 +852,20 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
.. versionadded:: 1.1
.. confval:: epub_guide
Meta data for the guide element of :file:`content.opf`. This is a
sequence of tuples containing the *type*, the *uri* and the *title* of
the optional guide information. See the OPF documentation
at `<http://idpf.org/epub>`_ for details. If possible, default entries
for the *cover* and *toc* types are automatically inserted. However,
the types can be explicitely overwritten if the default entries are not
appropriate. Example::
epub_guide = (('cover', 'cover.html', u'Cover Page'),)
The default value is ``()``.
.. confval:: epub_pre_files
Additional files that should be inserted before the text generated by