Commit Graph

224 Commits

Author SHA1 Message Date
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
Fred Drake 3cdb89d5ec do_cmd_shortversion(),
do_cmd_setshortversion():  Implementation for new markup.

convert_args():  New helper function.

do_cmd_optional():  Modified to understand when it is called from within
                    a convert_args() invocation.

do_env_funcdesc(),
do_env_funcdescni(),
do_cmd_funcline(),
do_cmd_funclineni(),
handle_classlike_descriptor(),
do_env_methoddesc(),
do_end_methoddescni(),
do_cmd_methodline(),
do_cmd_methodlineni():  Modified to use helper convert_args().

The convert_args() helper and related changes fix the generation of HTML
for the \optional markup, so that bogus </var>...<var> is not generated.
This closes SourceForge bug #113800.
2000-09-14 20:17:23 +00:00
Fred Drake c56817353d Re-wrapped some wide comments.
Fixed Module Index generation.
2000-09-12 20:13:04 +00:00
Fred Drake 48449985f4 \seetitle: New macro for building reference list content. 2000-09-12 17:52:33 +00:00
Fred Drake 643d76d735 Add support for new \pep, \seepep, excclassdesc markup.
Update processing of module synopsis tables (found at the beginning of
most chapters of the library reference) to reflect changes in the
processing pattern of recent versions LaTeX2HMTL.  Requires most
recent change to SynopsisTable.pm.

This does not fix the module index problem.
2000-09-09 06:07:37 +00:00
Fred Drake 75c6cb909c Add support for a filename to record the name of the node in which the
table will be presented.  Accessor methods are used to access the
attribute.
2000-09-09 05:53:41 +00:00
Fred Drake f730fc3e4e Be a little more careful to avoid including style information in the
generated markup.

Don't be careless with the navigation icons!  We should use the blank
icon where there is not anyplace to go for a particular position in the
navigation bar.
2000-08-31 07:19:07 +00:00
Fred Drake 3be2074758 Push some table header formatting to the style sheet; this also helps
separate some of the ties between l2hinit.perl and python.perl.

Revamp the "title page" construction to allow more flexibility.
2000-08-31 06:22:54 +00:00
Fred Drake 241551c16c do_env_cfuncdesc(): Push as much of the generated HTML into one place
as possible for better readability.  Revise a comment.
2000-08-11 20:04:19 +00:00
Fred Drake cb0fc9c2ce fix_font(): Handle one more case for the magical first column of tables. 2000-08-09 13:45:04 +00:00
Fred Drake 3d5a04ab18 do_cmd_moreargs(),
do_cmd_unspecified():  New functions to reflect previously unused markup.

do_cmd_file():  Simplified generated markup to only make use of the
	existing stylesheet.

do_cmd_makevar():  Make the markup more stylesheet-friendly.
2000-08-03 17:25:44 +00:00
Fred Drake 4640e13259 Change as suggested by Peter Funk <pf@artcom-gmbh.de>:
Move around the navigational links on the left-hand side of the navigation
bar to be more like the cursor keys.
2000-07-31 20:13:23 +00:00
Fred Drake 85d14c9d02 Many changes to work with newer versions of LaTeX2HTML. This has been
tested with version 99.2beta8.
2000-07-31 17:53:45 +00:00
Fred Drake 7388f730a3 Support constant as a font name for the first column of a table using the
tableii & friends markup family.
2000-06-28 21:06:08 +00:00
Fred Drake c3fd45fe80 do_cmd_textasciitilde(): New function. 2000-06-15 22:41:48 +00:00
Fred Drake ef4d111b2a do_cmd_seeurl(): New function. 2000-05-09 16:17:51 +00:00
Fred Drake 52e7684af1 do_cmd_versionchanged():
Added support for optional parameter explaining the change
        that was made in the specified version.
2000-05-02 17:37:42 +00:00
Fred Drake 638ae9d0bb Support for the special macros used by the distutils documentation. 2000-04-27 21:27:49 +00:00
Fred Drake 37cc0c0e9f ref_module_index_helper(): Use "my" instead of "local".
get_rfc_url():  New function; returns the URL for a numbered IETF RFC.

do_cmd_rfc():  Use get_rfc_url() instead of hard-coding in the HTML
               formatting.

do_cmd_seerfc():  New function.

do_env_definitions():  Small change to avoid "local".
2000-04-26 18:05:24 +00:00
Fred Drake 0cd6021339 do_cmd_longprogramopt(): New function. 2000-04-11 18:46:59 +00:00
Fred Drake c2578c5bb6 load_refcounts(),
do_env_cfuncdesc():  Support the "null" value for the refcounts field
        in refcounts.dat.
2000-04-10 18:26:45 +00:00
Fred Drake adb272ceee do_cmd_datalineni(): New function, to implement the non-indexing form
of \dataline.
2000-04-10 17:47:14 +00:00
Fred Drake e15956b465 Merged changes from the 1.5.2p2 release. 2000-04-03 04:51:13 +00:00
Fred Drake c9f5fe0d1c do_cmd_programopt(): New function, similar to do_cmd_program().
do_cmd_citetitle():  New function.  Extracts one optional and one
                     required parameter.  If the optional one is
                     provided, it is used a URL (or relative URL) and
                     the text of the required parameter is turned into
                     a hyperlink.
1999-11-09 16:59:42 +00:00
Fred Drake b35f2b7ef8 Remove some <SPAN> elements that were used only to carry a CLASS
attribute; stick the CLASS on an existing element.

Use a variable for the name of the file to get "About this
document..." text from.
1999-09-23 16:53:09 +00:00
Fred Drake d37cecfda4 Remove some <SPAN> elements that were used only to carry a CLASS
attribute; stick the CLASS on an existing element.
1999-09-23 16:45:08 +00:00
Fred Drake d3d28d39f8 img_tag(): Tighten up the generated SRC attribute a bit; if the image
relative URL starts with "./", remove "./".
1999-09-23 15:29:45 +00:00
Fred Drake d52879ccdc do_cmd_rfc(): Simplify the generated markup. 1999-09-22 19:58:51 +00:00
Fred Drake 191439ab6b Some updates to allow ../tools/mkhowto to add various bits to the
supplemental l2h initialization file it creates and still get all the
right behavior.  In particular, it can change the image type and icon
location and not get inconsistent results.

Some code to help suppress various navigational pages; this might be
interesting when generating HTML to create HTML Help documents, since
the navigation support creates confusing hits in the full text
search.  HTML Help also provides a lot of the navigational
infrastructure, so duplicating it makes it more tedious to use.
1999-09-22 19:50:51 +00:00
Fred Drake 6b3fb78ca8 do_cmd_funclineni(): New function; non-indexing form of \funcline. 1999-07-12 16:50:09 +00:00
Fred Drake f930d827bb Use the same names for CLASS attributes as elsewhere. 1999-07-12 16:28:50 +00:00
Fred Drake 3e4c614c16 define_module(): Check the module type for validity before using.
This reflects the changes made in
		  ../texinputs/python.sty.
1999-05-17 15:00:32 +00:00
Fred Drake ab03215204 make_index_entry(): Remove. Not only did this override the
l2hinit.perl version of the function (which
		     overrode a version in latex2html), but
		     do_cmd_index() was overridden.  Since
		     do_cmd_index() was the only caller, we can trash
		     this.

define_indexing_macro():  New function used during setup to support
			  more dynamic dispatch for indexing.

process_index_macros():  New function; implement dynamic dispatching
			 of indexing support functions, allowing many
			 targets used in indexing to be shared by
			 multiple index entries.  I.e., something like
			 \index{foo}\bifuncindex{bar} can now share a
			 single target anchor.

These indexing changes reduce the amount of clutter in the generated
HTML files.  In the reference manual, this cuts the number of targets
by 44%.  Targets are less affected when generated by environments
rather than macros.
1999-05-13 18:36:54 +00:00
Fred Drake 76febdf3fd make_index_entry(): Remove. This is overridden in python.perl and
was never called in this incarnation.  The
		     other version is simpler as well.
1999-05-13 16:41:19 +00:00
Fred Drake 84bd6f3b18 Change the look of \seemodule output to fit in better. 1999-05-11 15:42:51 +00:00
Fred Drake a00754468f make_nav_panel(): Remove the spurious NAME="tex2html\d+" attributes
added to the anchors in the navigation bars.  These
		   are added somewhere deep with l2h, and are stupid.
1999-04-29 19:06:56 +00:00
Fred Drake ea07f2751a setup_column_alignments(): Adding valign=baseline to the <td> tag
makes the alignment work on Navigator as
			    well as IE.  Uglier HTML, but it looks
			    right.
1999-04-28 17:11:21 +00:00
Fred Drake ac3dc83eb6 Fix up the HTML generated for envdesc and macrodesc environments.
Make it possible for the user to tell the difference.  ;-)
1999-04-28 16:42:29 +00:00
Fred Drake d02573d13b Handle \p and \op in parameter lists for the environment and macro
description environments.
1999-04-28 16:33:04 +00:00
Fred Drake f74e5b7936 Control the layout of output tables a little better so they're easier
to debug.  Small code cleanup around tables.
1999-04-28 14:58:49 +00:00
Fred Drake 79189b5fd5 do_cmd_seetext(): Clean up so we get proper nesting of <div>s. This
fixes a rendering problem on IE5.

General adjustments to the table* environments, including using
<thead> and <tbody>.  Attempt to adjust the vertical alignment of the
table cells so that the baseline of the first cell matches the
baseline of the remaining cells:  When the first cell is small and the
second cell of the same row is multi-line, the first cell was
vertically centered by default.  Specifying valign=baseline fixes the
problem on IE, but Netscape seems to ignore both valign=top and
valign=baseline (even though valign is NS's fault!).  Make the
horizontal alignment of 'p' columns left instead of center (for the
headings).
1999-04-28 13:54:30 +00:00
Fred Drake ca675e491b do_cmd_funcline(): Remove some bogus generated stuff from the output
(some text was only intended for the index).
1999-04-21 15:58:58 +00:00
Fred Drake 085b8121eb Fix some remaining index & consistency nits. (Many data member
references were being omitted from the general index.)
1999-04-21 14:00:29 +00:00
Fred Drake 9444df0844 Don't include the verbatim style; the default handling is better. 1999-04-13 22:17:55 +00:00
Fred Drake 1cc5899742 Fix problem of LaTeX leakage in the module synopsis tables at the
beginning of chapters.  Known problem reported by Barry Scott
<barry@scottb.demon.co.uk>.
1999-04-13 22:08:59 +00:00
Fred Drake bb584d3f6e Be more stylesheet friendly. 1999-03-25 22:18:30 +00:00
Fred Drake a608a1df87 Require the verbatim package (similar to the LaTeX version). 1999-03-25 22:17:29 +00:00
Fred Drake 2cafcbb440 Remove \platformof support, since it's been removed from the LaTeX
style sheet.

Small nits.
1999-03-25 16:57:04 +00:00
Fred Drake 03dffcce0e LaTeX2HTML support for the ltxmarkup package. 1999-03-18 16:42:28 +00:00
Fred Drake 62cc360e38 add_module_idx(): If \ignorePlatformAnnotation is used, only ignore
the specified annotation, not any annotation.
1999-03-04 18:41:17 +00:00
Fred Drake aa99a5071e Be a little more friendly for the generation of the text version: for
"blank" navigation icons, use ALT="" instead of ALT="blank"; also add
ALIGN=CENTER for the table, to get a slightly better affect in the
text (the table is full-width, so this doesn't change the appearance
when browsing the HTML).
1999-03-03 16:21:34 +00:00
Fred Drake 557460cb7a swallow_newline(): Removed function; not really needed. Modified all call
sites.

do_cmd_ignorePlatformAnnotation(),
do_cmd_platform(),
do_cmd_platformof():  New functions to support platform dependency
		      information.

process_all_platformofs():  New function to post-process \platformof macros
	using information collected during the initial pass.

process_python_state():  New function. Call all post-processing functions
	defined in this file to avoid having to have too much knowledge of
	the internals for this stuff in l2hinit.perl.
1999-03-02 16:05:35 +00:00
Fred Drake 2383f6dbbc Improve handling of module index, to deal with platform annotations a little
better.
1999-03-02 16:00:37 +00:00
Fred Drake 50cdd97ec4 do_cmd_arabic(): Override the l2h-provided version to remove that
obnoxious <SPAN CLASS="arabic">...</SPAN> markup.
1999-02-19 23:04:59 +00:00
Fred Drake 90fdda5404 Become more stylesheet-friendly. 1999-02-16 20:27:42 +00:00
Fred Drake beb27bfef7 Make navigation panels more CSS-friendly.
Make sure the contents page always has the "table of child links"
turned off; this wasn't being handled properly by latex2html for
"howto" ("article") documents, so just do it ourselves for all
document types.
1999-02-16 17:22:32 +00:00
Fred Drake cce8d2a85a Adjust cellspacing attribute of the navigation bar tables to get some
space between cells on all (major) browsers.
1999-02-16 14:21:54 +00:00
Fred Drake f32834c206 Minor fix that helps out with the index. 1999-02-12 22:06:32 +00:00
Fred Drake 15799edd34 Make table headers the same color as the navigation bars so they stand
out a little better.

Make sure the boxes for the last column of tables always get drawn;
these are often left empty of content when used as a "Notes" column.
They look a little better this way.
1999-02-12 19:23:17 +00:00
Fred Drake 7a9ed71e95 Moved the navigation-bar background color to a variable. 1999-02-12 19:00:38 +00:00
Fred Drake 2e1ee3eb19 Fix up some routines to coordinate the "indexsubitem" stuff so that
the subitem text is updated correctly when each module section is
processed.

Print [<modulename>] when we start on \declaremodule so we can more
easily track progress during the library reference.
1999-02-10 21:17:04 +00:00
Fred Drake 72e5a901c2 Remove unnecessary <p> from top navigation bar. 1999-02-10 17:35:41 +00:00
Fred Drake 95474f9696 Change the navigation bar to be a little prettier and more consistent
with the python.org style.
1999-02-09 18:45:50 +00:00
Fred Drake 2d1f81ea22 do_cmd_maketitle(): Small nit in creating the "title page". 1999-02-09 16:03:31 +00:00
Fred Drake 1a4c5392b5 Back out some of the fine tuning; something in all that interacted
badly in practice and botched the whole thing.  Wasn't obvious when
looking at the local effects (which worked), but completely broke
entire pages.  ;-(
1999-02-09 15:31:52 +00:00
Fred Drake 2ff880e2cf More magic to tighten up a little of the formatting. 1999-02-05 18:31:29 +00:00
Fred Drake 2116d983bf Make \versionadded and \versionchanged less prominant -- neither bold
nor a separate paragraph.
1999-02-02 18:02:48 +00:00
Fred Drake 9bbdce5945 add_module_idx(), add_idx_hook():
Change the message printed before running buildindex.py;
	"Doing the index..." wasn't clear and could be misinterpreted
	with an inappropriate mindset.  ;-)
1999-01-19 16:30:10 +00:00
Fred Drake 2581704dfa do_cmd_refmodule(): New function to support new \refmodule macro. 1999-01-13 17:06:34 +00:00
Fred Drake 5a0ca4e55c do_cmd_methodline(): Fixed reference to method name when generating
the output HTML.
1999-01-12 04:16:51 +00:00