[texinfo] Update CHANGES and relevant documentation.

This commit is contained in:
Jonathan Waltman
2013-02-20 04:09:50 -06:00
parent 8f74a80216
commit 50d4aec15c
2 changed files with 44 additions and 30 deletions

39
CHANGES
View File

@@ -4,12 +4,6 @@ Release 1.2 (in development)
* #1074: Add environment version info to the generated search index to avoid
compatibility issues with old builds.
* #1110: Added a new configuration value :confval:`texinfo_no_detailmenu` for
controlling whether the Texinfo writer generates a ``@detailmenu`` in the
"Top" node's menu.
* The Texinfo writer now only generates detailed menus for the "Top" node.
* New locales: #1097: Added Basque locale.
* Fix text builder did not respect wide/fullwidth characters:
@@ -97,8 +91,6 @@ Release 1.2 (in development)
* #955: Fix i18n transformation.
* Handle duplicate domain indices in texinfo.
* PR#74: Fix some Russian translation.
* PR#97: Fix footnote handling in translated documents.
@@ -145,6 +137,37 @@ Release 1.2 (in development)
* Added the Docutils-native XML and pseudo-XML builders. See
:class:`XMLBuilder` and :class:`PseudoXMLBuilder`.
* Texinfo builder
- An "Index" node is no longer added when there are no entries.
- "deffn" categories are no longer capitalized if they contain capital
letters.
- ``desc_annotation`` nodes are now rendered.
- ``strong`` and ``emphasis`` nodes are now formatted like
``literal``\s. The reason for this is because the standard Texinfo markup
(``*strong*`` and ``_emphasis_``) resulted in confusing output due to the
common usage of using these constructs for documenting parameter names.
- Field lists formatting has been tweaked to better display
"Info field lists".
- ``system_message`` and ``problematic`` nodes are now formatted in a similar
fashion as done by the text builder.
- "en-dash" and "em-dash" conversion of hyphens is no longer performed in
option directive signatures.
- ``@ref`` is now used instead of ``@pxref`` for cross-references which
prevents the word "see" from being added before the link (does not affect
the Info output).
- The ``@finalout`` command has been added for better TeX output.
- ``transition`` nodes are now formatted using underscores ("_") instead of
asterisks ("*").
- The default value for the ``paragraphindent`` has been changed from 2 to 0
meaning that paragraphs are no longer indented by default.
- #1110: A new configuration value :confval:`texinfo_no_detailmenu` has been
added for controlling whether a ``@detailmenu`` is added in the "Top"
node's menu.
- Detailed menus are no longer created except for the "Top" node.
- Fixed an issue where duplicate domain indices would result in invalid
output.
Release 1.1.3 (Mar 10, 2012)
============================

View File

@@ -173,17 +173,11 @@ some notes:
Texinfo info
------------
The Texinfo builder is currently in an experimental stage but has successfully
been used to build the documentation for both Sphinx and Python. The intended
use of this builder is to generate Texinfo that is then processed into Info
files.
There are two main programs for reading Info files, ``info`` and GNU Emacs. The
``info`` program has less features but is available in most Unix environments
and can be quickly accessed from the terminal. Emacs provides better font and
color display and supports extensive customization (of course).
.. _texinfo-links:
Displaying Links
@@ -197,13 +191,13 @@ to this section would look like::
In the stand-alone reader, ``info``, references are displayed just as they
appear in the source. Emacs, on the other-hand, will by default replace
``\*note:`` with ``see`` and hide the ``target-id``. For example:
``*note:`` with ``see`` and hide the ``target-id``. For example:
:ref:`texinfo-links`
The exact behavior of how Emacs displays references is dependent on the variable
``Info-hide-note-references``. If set to the value of ``hide``, Emacs will hide
both the ``\*note:`` part and the ``target-id``. This is generally the best way
both the ``*note:`` part and the ``target-id``. This is generally the best way
to view Sphinx-based documents since they often make frequent use of links and
do not take this limitation into account. However, changing this variable
affects how all Info documents are displayed and most due take this behavior
@@ -244,9 +238,6 @@ The following notes may be helpful if you want to create Texinfo files:
- Colons (``:``) cannot be properly escaped in menu entries and xrefs.
They will be replaced with semicolons (``;``).
- In the HTML and Tex output, the word ``see`` is automatically inserted before
all xrefs.
- Links to external Info files can be created using the somewhat official URI
scheme ``info``. For example::
@@ -256,18 +247,18 @@ The following notes may be helpful if you want to create Texinfo files:
info:Texinfo#makeinfo_options
- Inline markup appears as follows in Info:
- Inline markup
* strong -- \*strong\*
* emphasis -- _emphasis_
* literal -- \`literal'
The standard formatting for ``*strong*`` and ``_emphasis_`` can
result in ambiguous output when used to markup parameter names and
other values. Since this is a fairly common practice, the default
formatting has been changed so that ``emphasis`` and ``strong`` are
now displayed like ```literal'``\s.
It is possible to change this behavior using the Texinfo command
``@definfoenclose``. For example, to make inline markup more closely resemble
reST, add the following to your :file:`conf.py`::
The standard formatting can be re-enabled by adding the following to
your :file:`conf.py`::
texinfo_elements = {'preamble': """\
@definfoenclose strong,**,**
@definfoenclose emph,*,*
@definfoenclose code,`@w{}`,`@w{}`
texinfo_elements = {'preamble': """
@definfoenclose strong,*,*
@definfoenclose emph,_,_
"""}