Commit Graph

221 Commits

Author SHA1 Message Date
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
Fred Drake ccc627200a write_idxfile(): New function. Isolate format of the external index
data file used by buildindex.py.

next_argument_id():  Removed; no longer used.

next_argument():  Doesn't use next_argument_id(), just does the work.

gen_target(), gen_target_name():  Removed, no longer used.  The only
	place that used them now does the (trivial) work directly.


Lots of little changes so we never have to pass around $br_id values
all over the place.  The only places they're used now new IDs are
generated as needed.
1999-01-05 22:16:29 +00:00
Fred Drake 7d45f6dcc4 do_cmd_methodline(): New function, implements indexing version of
\methodline.

Fixed up support for \withsubitem, hopefully improving the fidelity of
the index a bit.
1999-01-05 14:39:27 +00:00
Fred Drake 32f7ae0066 Fix many of the specific targets in links from the index.
In a number of places, I called next_argument() instead of
next_argument_id() when the ID was also needed.  (7 places)
1998-12-22 23:41:07 +00:00
Fred Drake 2eff3c5273 do_cmd_rfc(): Make the "RFC ###" a hyperlink to the master RFC
repository.
1998-12-22 18:02:25 +00:00
Fred Drake 15796f791a do_cmd_textohtmlinfopage(): Rip out most of the boilerplate and move
it to the about.dat file.  Only what really needs to be
	generated is, and the remainder is easier to maintain than
	Perl code.
1998-11-30 19:25:47 +00:00
Fred Drake 28e7b4cce1 add_link(): Fix to use $section_info instead of $toc_section_info,
based on email from Ross Moore <ross@mpce.mq.edu.au>.

Set $HTML_VERSION to 4.0, since that's what we really generate (well,
4.0 "transitional").
1998-10-20 18:14:20 +00:00
Fred Drake 649e8c1f7f ArabictoRoman(): Removed, since it wasn't used anywhere. 1998-10-19 16:33:06 +00:00
Fred Drake d64a40dbc0 do_cmd_methodlineni(): New function, needed because the ref. manual now
actually uses this markup.
1998-09-10 18:59:13 +00:00
Fred Drake a0e4b78233 img_tag(): For \n to be interpreted as a newline, the string must use double
quote, not single quotes.  Ugh.
1998-08-14 15:03:48 +00:00
Fred Drake 062bc6e598 Do the magic to use the new buttons (with shorter names!) instead of the old
ones.  Get the <IMG> width & height right.  New design for the navigation
bars, including the document title as well as the navigation links/buttons.
1998-08-13 22:03:46 +00:00
Fred Drake 9f7adc4f22 Get the <IMG> sizes right for the navigation buttons. 1998-08-11 19:33:38 +00:00
Fred Drake 6aa5d482fb Control when/where navigation bars will appear: top & bottom of each page.
Include an additional button to the module index in the nav. bars if we
generate a module index.  Still need a button image, but the ALT text should
do for now.
1998-08-11 03:14:50 +00:00
Fred Drake 62e436955b do_cmd_moduleauthor(),
do_cmd_sectionauthor():  Parallel the new macros.
1998-08-10 19:40:44 +00:00
Fred Drake 4d10b43c26 insert_index(): Take two additional parameters: $columns and $letters. Call
buildindex.py appropriately.

add_idx(),
add_module_idx():  Add the appropriate parameters to the calls to
	insert_index().
1998-08-07 20:51:58 +00:00
Fred Drake aa3f9fb7d5 By default, use a two-column index. 1998-08-07 19:52:37 +00:00
Fred Drake 0cb76200ef Guido's white background. 1998-08-07 16:43:29 +00:00
Fred Drake 1ca8fdc446 Remove modified setting of $ICONSERVER; this isn't the right way to do it. 1998-08-05 04:36:09 +00:00
Fred Drake 45f2601cf3 get_chapter_id(): Separate two aspects of string replacement to allow the
need for each to vary independently.
1998-08-04 22:07:18 +00:00
Fred Drake d05177fa84 tohtml(): Use a table instead of a definition list for module synopses. 1998-07-29 04:45:23 +00:00
Fred Drake 514cd87d40 do_cmd_maketitle(): No <hr> at the end of the "title page". 1998-07-28 21:52:57 +00:00
Fred Drake 53af049499 do_cmd_localmoduletable(): Cause the child links table to be dropped when
there's a local module list.
1998-07-27 20:48:26 +00:00
Fred Drake 897d12bb87 do_cmd_versionadded(),
do_cmd_versionchanged():  Support for new macros.
1998-07-27 20:33:17 +00:00
Fred Drake f7685d79e2 Fix up the synopsis table stuff so it gets things right at each chapter,
instead of stringing it all together.

Yay!
1998-07-25 03:31:46 +00:00
Fred Drake b3a3ed8f72 Update @INC so we can 'require' modules in Doc/perl/.
Call the localmoduletable handling once the document is complete & synopses
have been collected.
1998-07-24 22:17:34 +00:00
Fred Drake a0f4c94af6 Added module synopsis support with one (big) caveat: All the modules are
listed in each chapter that has a \localmoduletable.  This will be fixed,
and everything else seems to be working fine.
1998-07-24 22:16:04 +00:00
Fred Drake 2903d03e2d tohtml(): Make module names anchors. 1998-07-24 22:13:37 +00:00
Fred Drake 7313b03469 My first Perl object. ;-)
SynopsisTable objects are used to store the table of module synopses for
a single chapter it the manual.
1998-07-24 20:34:59 +00:00
Fred Drake 885215c3da Added support for AMK's {definitions} environment; thanks for the reminder! 1998-05-20 21:32:09 +00:00
Fred Drake e194beb829 Don't use a separate node for footnotes; see if people scream. ;-) 1998-05-19 19:38:49 +00:00
Fred Drake a4565b0796 Update to use latex2html 98.1p5. 1998-05-15 17:14:17 +00:00
Fred Drake 5b73cdfe60 Revise comment about \let support a little to more accurately reflect the
support that's offered.
1998-05-15 16:59:38 +00:00
Fred Drake 7a4ad0fc83 Extend handling for \let a bit, to also allow \let\something=<character>. We
still don't support things like \let^^M=\something, where ^^M could actually be
any active character.  Print a decent warning if we find one we can't handle.
1998-05-15 13:45:54 +00:00
Fred Drake e16f6798ae do_cmd_let(): Simple implementation to allow \let to be used to establish
synonyms for macros.  This supports:

	\let\newname = \oldname
	\let\newname\oldname

This is useful sometimes, and can at least avoid real errors at other times.
1998-05-15 04:28:37 +00:00
Fred Drake d07868ae52 Added support for \developer, \developers, \developersaddress. 1998-05-14 21:00:28 +00:00
Fred Drake 2e7edb80e3 do_cmd_kwindex(): Re-implement now that \kwindex is used again (ref man). 1998-05-11 18:31:17 +00:00
Fred Drake 41814bc51f In package Override, use the getcwd() function from the Cwd module instead of
the one from Override.pm (part of latex2html).

Absolutize the TEXINPUTS environment variable, since we can't count on
latex2html doing it for us (even though I sent in a patch, and it really
should).
1998-05-11 18:23:35 +00:00
Fred Drake 89a1d4ad3a Set $TEXINPUTS='' to make l2h pick up the right thing from the environment. 1998-04-29 16:58:13 +00:00
Fred Drake 310094ccce do_cmd_sectcode(): Obsolete; removed. 1998-04-28 18:38:40 +00:00
Fred Drake 08c5dfc5a4 do_cmd_key(): Obsolete; removed. 1998-04-28 18:31:17 +00:00
Fred Drake d757165df9 Change the default $ADDRESS. 1998-04-23 20:06:24 +00:00
Fred Drake 5ccf330e4c next_optional_argument(): Don't include the square brackets in the return
value.

ArabictoRoman():  Acquired function from Robert Donohue
	<donahue@cfassp48.harvard.edu>; might be useful someday, and I don't
	want to figure it out again!
1998-04-17 20:04:09 +00:00
Fred Drake 08932054e9 New helper functions to help deal with parameter parsing.
Use the helpers in do_cmd_*() and do_env_*(); *much* cleaner!
1998-04-17 02:15:42 +00:00
Fred Drake 64bdc24301 Code cleanup, some syntax modernization. 1998-04-17 02:14:12 +00:00
Fred Drake 3ad125e611 Fix bug in little-used markup: don't forget to pass the source text along! 1998-04-13 14:18:57 +00:00
Fred Drake a608febd5f Fix typo. (What I get for trying to fix bugs at home and running conversions
at work....)
1998-04-12 03:58:13 +00:00
Fred Drake ae9bc67e0e Don't append () to the name of an object attribute in the index. 1998-04-12 03:49:46 +00:00
Fred Drake 1072e46263 Added a simpler, working {verbatim} support that generates legitimate HTML.
(2 lines, explained by 6 lines of comments....)
1998-04-12 02:16:34 +00:00
Fred Drake b73bc31e39 Removed partially broken {verbatim} support. 1998-04-12 02:13:14 +00:00
Fred Drake ee60191d1d Lighten up tables. 1998-04-11 20:53:03 +00:00
Fred Drake 9d4b6c52c3 Update the module index support to use the changed field separator for the
input file to buildindex.py.
1998-04-11 05:21:14 +00:00
Fred Drake 756a9e87b1 do_env_memberdesc(): Fix argument parsing for {memberdesc} environments.
(The bug was detected by the Q/A team -- me!  Please, help review the docs!)
1998-04-11 03:12:06 +00:00
Fred Drake 5cca42e0b7 do_cmd_lineii(),
do_cmd_lineiii():  Fix markup style conversion to HTML tags for first column.
	(The endtag wasn't formed properly.)
1998-04-09 17:59:11 +00:00
Fred Drake 166abbabf9 Remove option to strip out <tt>...</tt> from index entry text; this is now
left to the buildindex.py script.

Change the field separator used in the index.dat file so utilities like grep
are useful on these files; they can't typically handle NUL bytes.

Protect index entries for environment variables from being handled as
case-insensitive by buildindex.py.
1998-04-08 23:10:54 +00:00
Fred Drake 3f3c25fc03 Set flag to remove <tt>...</tt> markup from the index entries; it just ends up
looking really bad in popular browsers, mostly due to vertical size differences
between the roman and monospaced fonts.
1998-04-08 13:46:24 +00:00
Fred Drake 10ad52e8af Minor cleanliness. 1998-04-04 04:19:20 +00:00
Fred Drake 5a52519a6e add_idx(): Restore message to stdout when formatting the general index. 1998-04-02 22:39:05 +00:00
Fred Drake 2b8093ab96 Match python.sty a little better. 1998-04-02 22:33:44 +00:00
Fred Drake 1191692d3d Lots of little nits.
Big fix:  the module index for the Python Library Reference is once more in a
separate file!  Yeah!
1998-04-02 22:30:57 +00:00
Fred Drake 58b2bfd0bf This fixes a (minor) problem discovered by AMK when you don't want any
special markup for the first column of a table using {tableii} or {tableiii}.
In LaTeX, this requires using "textrm" as the formatting function, and this
is needed to remove the bogus "<textrm>" that gets generated otherwise.
There should probably be a more general mapping of specified markup to useful
markup, but that doesn't appear needed at the moment.

do_env_tableii(), do_env_tableiii():  If the markup for the first column is
	\textrm, make it empty.

do_cmd_lineii(), do_cmd_lineiii():  If the markup for the first column is
	empty, don't add markup around the text.
1998-04-02 20:14:04 +00:00
Fred Drake 1a7af3959b Implemented one more special markup item. 1998-04-01 22:44:56 +00:00
Fred Drake 982d91fb51 Change $ICONSERVER to conform to the value AMK & I have discussed for this;
doing this here may prove to not be such a good idea, but we'll see.
1998-03-27 06:53:13 +00:00
Fred Drake 235e6b1428 Some cleanup.
Remove index generation from Perl; use an external script instead.
1998-03-27 05:19:43 +00:00
Fred Drake 42b31a5536 Lots and lots and lots.....
Implemented some new features of python.sty for methods & members.

Fixed some bugs.

Cleaned up some perl code and made some basic regular expressions more robust.
1998-03-27 05:16:10 +00:00
Fred Drake c9a4438c16 Coding cleanups.
Fix some small but messy buglets.
1998-03-17 06:29:13 +00:00
Fred Drake 13210ed55f Get the index working at least partway again.
Some small cleanups.
1998-03-17 06:28:05 +00:00
Fred Drake fc16e78f3c Bring this up to date. Some things still don't work right. 1998-03-12 21:03:26 +00:00
Fred Drake c9f2c14d49 Somewhat more direct way of locating the file, using __FILE__.
Leave find_my_file() around for now, even though we're not using it at the
moment.
1998-03-11 12:08:21 +00:00
Fred Drake db34a1e2d8 Use the location of the initialization file to augment the style-specific
.perl file search path, rather than making assumptions about the current
directory.
1998-03-10 23:02:57 +00:00
Fred Drake b3c9bca242 Misc. revisions to LaTeX2HTML support. 1998-03-06 21:20:08 +00:00
Fred Drake bc7101dff0 Relocated .latex2html-init to l2hinit.perl.
howto.perl is new; supports LaTeX2HTML for HOWTO documents.
1998-03-06 21:18:55 +00:00
Fred Drake c113745498 For verbatim text, don't bounce down a size. 1998-03-05 17:00:55 +00:00
Fred Drake 2da947af87 Comment out the attempt to get index-related stuff processed in the right
order.  LaTeX2HTML just doesn't do things the same way as LaTeX, and this
wasn't the fix.

Simplify the generated HTML for \file{}.

For \samp{}, use "..." instead of `...'; many fonts make that look pretty
bad.   ;-(
1998-03-04 05:30:49 +00:00
Fred Drake 986c100735 Perish Evil Revelry and Lamentation. 1998-03-03 22:27:28 +00:00
Fred Drake 6659c30b67 Convert LaTeX support to create a new class of documents. HTML generation
now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress).

This means that doing things to change the formatting of the manuals (at the
"normal user" level, like A4 paper), can happen in just one place, rather
than in each document file.
1998-03-03 22:02:19 +00:00