Commit Graph

193 Commits

Author SHA1 Message Date
Fred Drake 5381588073 Revise the markup related to the grammar productions to increase the
level of predictability.  This is not really "good" markup, but is arguably
better than we had before.
This closes SF bug #523117.
2002-03-15 23:21:37 +00:00
Fred Drake f171ad9d99 Change the way \textasciitilde is implemented so it works more consistently
(dropping tildes into data that still goes through LaTeX-like processing is
a bad idea).
2002-03-13 02:44:50 +00:00
Fred Drake 58fb237948 Add implementations for \textgreater and \textless, defined in (relatively)
recent versions of LaTeX2e but not support in LaTeX2HTML.
2002-03-05 04:04:06 +00:00
Fred Drake 6ca33771f8 Add a new environment for whole-paragraph (or longer) notes & warnings. 2001-12-14 22:50:06 +00:00
Fred Drake e27f86820a The valign attribute to control the vertical alignment of a table cell should
be on the <tr> element, not the <table> element.
Partially fixes SF bug #493243.
2001-12-14 16:54:53 +00:00
Fred Drake be6dd3083c Remove crufty whitespace in a block of index entries.
Minor, but generates slightly smaller HTML & makes it easier to see what's
happening when debugging the HTML.
2001-12-11 20:49:23 +00:00
Fred Drake bb7775a6ae Fix SF bug #479967: Appearantly I broke something that made the index
insertion work.  This fix makes things at least somewhat more explicit, and
adds a little sanity checking (and verbosity!) to
add_bbl_and_idx_dummy_commands().
2001-12-04 17:03:54 +00:00
Fred Drake 5ed35fd149 Add a new environment in the Python docs markup: seealso*. This is similar
to seealso, but does not add the "See also:" header or put the content in a
box in the HTML version.

Updated the description of \seeurl to better indicate when it should be used;
the old description was written before we had \seetitle.
2001-11-30 18:09:54 +00:00
Fred Drake fb6499fd9c Clean up the tables of child links generated by stock LaTeX2HTML so we get
consistent (lack of) vertical space between sections, and remove some of the
unnecessary cruft that was added in (finally we get to *remove* something
that got generated!).
2001-10-26 14:16:23 +00:00
Fred Drake af07b2c34f Add yet more markup that let's a stylesheet pick out a small bit of the
presentation.  This is acceptable since it only occurs in the formatted
output and does not affect the document markup.
2001-10-26 03:09:27 +00:00
Fred Drake a219b411af Add better support for Mozilla's use of <link> elements. 2001-10-22 16:57:49 +00:00
Fred Drake cc2e306592 Support for the iSilo conversion. 2001-10-19 21:08:36 +00:00
Fred Drake 92350b3a1f New markup: \note{...} and \warning{...} 2001-10-09 18:01:23 +00:00
Fred Drake 479384e1ff Move the styling for the HTML version of \mailheader into the CSS file.
In both the HTML and typeset versions of the documentation, add a colon
after the name of a mail header so that it is more easily distinguished
from other text.
2001-09-26 18:46:36 +00:00
Fred Drake 16bb41934c New \grammartoken markup, similar to \token but allowed everywhere. 2001-08-20 21:36:38 +00:00
Fred Drake 2dc07946bf Make sure that ampersand escaping is still performed on the contents of
local module tables (the lists of modules documented within a chapter,
inserted at the beginning of the chapter).  If this is not done here,
the text is not part of the resulting documents when latex2html does the
processing normally.

This fixes a little bit more of SF bug #451556.
2001-08-17 17:20:44 +00:00
Fred Drake cb19976f1a fix_font(): Instead of using a long if/elsif cluster, use a bloody
dictionary.  Added some entries to the dictionary to fix part of
    SF bug #451556.
2001-08-16 21:56:24 +00:00
Fred Drake 9443dc31c1 Remove the use of the "cat" program. This improves portability to non-Unix
platforms.

This is part the response to SF patch #429611.
2001-08-10 20:12:09 +00:00
Fred Drake 7eac0cb04c Define the \mailheader macro and document conventions for using it. 2001-08-03 18:36:17 +00:00
Fred Drake f269e59232 Define new markup for 5-column tables. 2001-07-17 23:05:57 +00:00
Fred Drake 77602f2e32 Add support for \ulink and hyperlink grammars.
do_cmd_verbatiminput():  Write out a text file containing the content of the
    input file with a .txt extension, and add a link to it at the bottom of
    the presentation.  This easier retrieval of example source code for
    copy & paste use.
2001-07-06 22:43:02 +00:00
Fred Drake 6fe4660f61 Added support for our new \infinity and \plusminus macros, and the
standard \textbar macro (not supported in many versions of LaTeX2HTML).

Added newline to error message.
2001-06-23 03:13:30 +00:00
Fred Drake dce975c820 Update to use the newly separated values $PACKAGE_VERSION and $RELEASE_INFO.
Normalize all HTML attributes to be written as name="value" instead of
name='value'.
2001-06-20 21:31:36 +00:00
Fred Drake f1927a6d80 Added support for new \setreleaseinfo macro.
Normalize all generated HTML so that attribute names come out as
name="value" instead of name='value'.
Changed the target of RFC links to point to the hypertext RFCs at
www.faqs.org instead of the plain text RFCs at www.ietf.org.
2001-06-20 21:29:30 +00:00
Fred Drake 57e52ef076 Implement the \verbatiminput LaTeX macro; this contains more magic than
it should, but only enough that LaTeX2HTML doesn't bite us.
2001-06-15 21:31:57 +00:00
Fred Drake 06a01e84b9 Define a new environment, classdesc*, which can be used to document a
class without providing any information about the constructor.  This
should be used for classes which only exist to act as containers rather
than as factories for instances.
2001-05-11 01:00:30 +00:00
Fred Drake caa79a9ee4 Minor adjustments to HTML for the module synopsis tables. 2001-05-09 15:32:14 +00:00
Fred Drake 056a71da76 The (fairly recent) \textasciicircum is not supported by LaTeX2HTML; add
support for it here.
2001-04-21 05:48:07 +00:00
Fred Drake c2b29d0fee Added support for optional explanation parameter to the \versionadded
macro.

Refactored do_cmd_versionadded() and do_cmd_versionchanged() to do most
of the work in a helper function, with the do_cmd_*() wrappers just supplying
a portion of the replacement text.
2001-04-18 03:11:04 +00:00
Fred Drake e0197bfaeb When forming the <A> tag for a \seepep or \seerfc, make sure we strip
HTML markup from the string used as the title in the TITLE attribute.

This fixes formatting in the "What's New in Python 2.1" document.
2001-04-12 04:03:22 +00:00
Fred Drake 86333606f6 Add corresponding support for the alltt environment to the HTML generator. 2001-04-10 17:13:39 +00:00
Fred Drake c612a14e9e Remove the spurious space of uncertain origin from the output for function,
method and constructor signatures.  Suggested by Peter Funk on the Doc-SIG
mailing list.
2001-03-29 18:24:08 +00:00
Fred Drake ab357ecf7f Label classes and exceptions explicitly in the documentation (for their
*desc environments).
2001-03-02 18:57:05 +00:00
Fred Drake afc7ce118e Fix \seepep handling -- correct URL to the online PEP repository on SF is
now generated.  (SF bug #129692.)

Patch from Anthon van der Neut <anthon@mnt.org>:
Work around the removal of content-less paired tags used for name
anchors in some places.  (SF bug #116008.)

Move some class attributes from an artificial SPAN element to otherwise
"useful" elements that are being generated anyway.  Added the class
"versionnote", used for \deprecated, \versionadded, \versionchanged.
2001-01-22 17:33:24 +00:00
Fred Drake 42181dba8e Added a --global-module-index option to specify a (possibly relative) URL
to the Global Module Index for a set of documents.  This is used to include
a reference to the global index from the per-document module indexes, so
that it is just a little easier to find.

(Someone suggested this, but I do not remember who.  Please let me know if
it was you -- thanks!)
2001-01-09 22:02:10 +00:00
Fred Drake b31d36cf01 Fix the bugfix for SF bug #127151 -- make sure we map "previous_page" to
"previous" and "next_page" to "next".  This way the proper icons are found.
2001-01-04 15:16:01 +00:00
Fred Drake d18722b99d Do not cache <img> tags for navigation icons as agressively; this fixes
bug #127151.
2001-01-02 22:08:48 +00:00
Fred Drake de77bc5468 For the title page, insert the package version number before the date.
This makes the title area more like the title are of the top-level
index, and puts the information more people are interested in first.
2000-12-14 18:36:12 +00:00
Fred Drake e463f8e4cd A few small refinements to the table building code. 2000-11-30 07:17:27 +00:00
Fred Drake 5942b439b3 define_module(): Change the "index sub-item" for definitions at module
scope to be " (in module <name>)" instead of
                  " (in <name>)" to be consistent with \withsubitem
                  usage throughout the documentation.  This achieves
                  consistency in indexing throughout the documentation.
2000-10-30 06:24:56 +00:00
Fred Drake 351960de94 Normalize the HTML generated for table headers. 2000-10-26 20:14:58 +00:00
Fred Drake 7497bd3e3d Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
whatever is being documented, not necessarily Python.  (These tools are
also used for the How-To documents, etc.)


get_version_text():  New function.  Returns HTML fragment describing the
        software version and documentation date.

bot_navigation_panel():  Include the result of get_version_text() at the
        end, so the information is available on every page.
2000-10-25 16:18:10 +00:00
Fred Drake d04592a46b Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number for
whatever is being documented, not necessarily Python.  (These tools are
also used for the How-To documents, etc.)
2000-10-25 16:15:13 +00:00
Fred Drake 5f84c9b55e $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides a
definition provided by previously loaded configuration code, and
        testing whether it's defined isn't needed since the default was
        false anyway.

get_link_icon():  Add support for $OFF_SITE_LINK_ICON_HEIGHT and
        $OFF_SITE_LINK_ICON_WIDTH, giving the dimensions of the icon
        being used.  This can make for faster page display.  Both are
        optional.

make_my_titlegraphic():  Fix insertion of the off-site icon link.

do_env_funcdesc():  Remove debugging print.

handle_rfclike_reference():  Remove trailing colon from first line; it
        doesn't really make sense and looks bad if we add an icon to
        mark off-site links.
2000-10-03 06:05:25 +00:00
Fred Drake 7a40c0702e make_icon_filename(): Convenience function to turn a partial filename
into a usable filename using $ICONSERVER and
                       $IMAGE_TYPE as needed.

get_link_icon():  Function to examine a URL and return the string to use
                  to insert an icon if the link points off-site, if needed
                  and $OFF_SITE_LINK_ICON is set.

Adjusted appropriate places to use these new functions.
2000-10-02 14:43:38 +00:00
Fred Drake 38178fd951 use_sans_serif(),
use_italics():  Remove both functions, inlining use_italics() at its
                only call site.

init_myformat():  Uncomment line so that some internal markup does not
                  get generated, since it is not properly removed later.
                  (Fix on aspect of SourceForge bug #114749.)

Modified call to process_commands_wrap_deferred(), removing \code from
the list since it had a bad interaction with other changes in some contexts.
2000-09-22 17:05:04 +00:00
Fred Drake da72b93a01 Add new environments: longtableii, longtableiii, and longtableiv, to
support long tables which might break across page boundaries.  Otherwise
identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
Fred Drake 02c7082745 make_nav_sectref(): Create more minimal HTML, hanging the class attribute
off an existing anchor tag if available (I think it
                     always is, but am not completely sure).
2000-09-19 15:36:19 +00:00
Fred Drake 1681627ebf Push more of the display control into the style sheet. 2000-09-16 20:40:44 +00:00
Fred Drake aaa238585f When there is a Module Index, make sure the icon actually links to it. 2000-09-14 22:20:41 +00:00