Commit Graph

459 Commits

Author SHA1 Message Date
Fred Drake 2394c98c05 Minor updates. 1999-07-29 22:14:09 +00:00
Fred Drake ada2de67b3 Use the (new) buildFragment() method of the EsisBuilder rather than
implementing it all here.
1999-07-29 22:13:31 +00:00
Fred Drake f032cdbb24 Some minor cleanup. 1999-07-29 22:03:52 +00:00
Fred Drake bc2285eb60 Conversion specification, used by a new path through latex2esis.py.
The specific markup conversion is coded here instead of an even more
cryptic table in the code of latex2esis.py.
1999-07-29 22:03:11 +00:00
Fred Drake 478a265057 Minor update. 1999-07-29 22:01:39 +00:00
Fred Drake 5772f33b6c Add support for bzip2 using --bzip2. 1999-07-27 16:29:30 +00:00
Fred Drake 8ea15f3495 Add --zip parameter; make this able to produce .zip files as well as
.tgz files.
1999-07-23 16:09:11 +00:00
Fred Drake 06c5a8b52e Make the default target xml instead of sgml. 1999-07-22 13:57:12 +00:00
Fred Drake 7dbde51f97 Make the default target xml instead of sgml.
Use a temporary file to pass results from latex2esis.py to
docfixer.py; this makes for better error detection by make (if the
first pipeline stage fails, make wasn't catching it).
1999-07-22 13:56:51 +00:00
Fred Drake 924b42de9c When looking for things that might be modules, include *module.c from
the Modules/ directory.  Most of the remaining undocumented modules
seem to be living there.
1999-06-17 18:49:18 +00:00
Fred Drake 0eb7b2a659 Enhanced docstring and some comments.
_begin_macro_rx:  Fixed RE that didn't properly allow a space after
		  the name of the macro.  This affects the conversion
		  of the tutorial.
1999-05-19 17:37:37 +00:00
Fred Drake c4811d8208 Modify to perform "---" to "—" conversion outside of
verbatim-like environments.  The list of verbatim-like environments is
a defined by a variable in main().
1999-05-18 17:34:51 +00:00
Fred Drake c41e1e5f5e Remove the "---" to "—" conversion; this is wrong in verbatim
environments.  Move the conversion to esis2sgml.py.
1999-05-18 17:33:01 +00:00
Fred Drake e779d4f03b Lots of adjustments to deal with the document content now being stored
in a fragment rather than the main document object.
1999-05-10 19:36:52 +00:00
Fred Drake 54fb7fb9d0 Some more fixes.
Add controls for some of the esoteric indexing macros.
1999-05-10 19:36:03 +00:00
Fred Drake 2697694e4a ExtendedEsisBuilder.push(): Override inherited definition. We don't
want to push nodes into the document, but into a document
	fragment, since we're not necesarily working with something
	that's well-formed.
1999-05-07 21:14:28 +00:00
Fred Drake f79acbdaa1 Fix some bugs introduced in the previous checkin. 1999-05-07 21:12:21 +00:00
Fred Drake 96c00b0b5e Define & use a Conversion object. It's still really ugly, but at
least there's a token object in here now!  ;-)
1999-05-07 19:59:02 +00:00
Fred Drake a871c2e747 Make it work for "manual" documents as well as "howto" documents.
This still doesn't understand anything about multiple source files or
checking time dependencies.
1999-05-06 19:37:38 +00:00
Fred Drake 4437fdf265 Make sure latex2html doesn't produce a hard link between foo/foo.html
and foo/index.html.  Make a copy instead.  (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
1999-05-03 14:29:07 +00:00
Fred Drake d2d1eef025 Make sure latex2html doesn't produce a hard link from $part/$part.html
and $part/index.html.  Make a copy instead.  (Appearantly some tar
openers on non-Unixlike systems can't handle hard links.)
1999-05-03 14:27:45 +00:00
Fred Drake c1db512b2b Nasty hack to add a --numeric parameter to skip the use of "logical"
names.
1999-04-29 18:28:48 +00:00
Fred Drake c4a623ebdc Add command line flags to just list the files that contain the
offending lines or to include line numbers in the output.
1999-04-22 20:32:21 +00:00
Fred Drake 693a2c6581 Script to locate uses of \module where the module referred to is not
the module being documented at that point in the documentation; these
are candidates for conversion to \refmodule, which produces a
hyperlink in the HTML and PDF versions of the output.
1999-04-22 13:08:09 +00:00
Fred Drake c260c0bcdb Further refinement, to allow this to handle the library reference as
well as the other "manual" documents.
1999-04-14 13:13:32 +00:00
Fred Drake 79d41ccdd3 Add some support for the module index, so this can be used to build
the .aux file for any of the "manual" class documents.
1999-04-14 05:02:06 +00:00
Fred Drake 2e1094e4ef Use #!/usr/bin/env python instead of #!/usr/local/bin/python. 1999-04-09 14:53:35 +00:00
Fred Drake e3fd1064de Make this simpler; don't care about the paper size. Require that the
files exist in the current directory.

Add "Documenting Python" to the list of documents listed.
1999-03-18 14:57:53 +00:00
Fred Drake 87a42cd61b Add support for <platform>, some cleanup of module section after
creating the <moduleinfo>.
1999-03-11 17:35:12 +00:00
Fred Drake 1acb8740eb Oops, missed a couple of substitutions in the templates. 1999-03-04 21:33:55 +00:00
Fred Drake 5f7832d125 Allow many more aspects of the generated page to be parameterized, and
add a useful usage message.  Use 'mkmodindex --help' to display it.
1999-03-04 21:19:57 +00:00
Fred Drake aaa0d9a3a4 Record the value of $TEXINPUTS in the transcript.
Job.message():  New method.  Takes care of writing a message to the
		user and adding it to the transcript.
1999-03-03 21:57:58 +00:00
Fred Drake b1d839866c Obsolete; use the Python version instead. 1999-03-03 20:28:17 +00:00
Fred Drake 8b88093b95 Re-written mkhowto in Python; this should be at least a little more
portable.

Several things that had been done by running a python script are now a
matter of importing the right module and running a function with a few
parameters.
1999-03-03 20:24:30 +00:00
Fred Drake 749f943a6b process(): New function that contains the "orchestration" of the
actual work.

main():  Just handle the command line and filename determination,
	 calling process() to do the work.

These changes make this more import-friendly.
1999-03-03 19:36:23 +00:00
Fred Drake 7c8754fafb process(): New function that contains the "orchestration" of the
actual work.

main():  Just handle the command line and filename determination,
	 calling process() to do the work.

These changes make this more import-friendly.
1999-03-03 19:25:56 +00:00
Fred Drake 7f492ad7b8 Be more flexible to support platform annotations. 1999-03-02 16:22:56 +00:00
Fred Drake 75ab7a6fa4 Clean up *.pla files -- platform annotation information. 1999-03-02 16:22:26 +00:00
Fred Drake 093c97a36f ignore_from_idx(): Fixed bug in regular expression. 1999-02-24 18:39:47 +00:00
Fred Drake 2ef38a7a42 Script to combine module index files. Given a list of files that look
like modindex.html, create a combined modindex.html file that lists
all the modules.  Takes the same parameters as buildindex.py.
1999-02-24 17:33:07 +00:00
Fred Drake 711fe02ac3 process_nodes(): New function.
main():  Moved the node processing between input and ouptut to
	 process_nodes().
1999-02-24 16:36:48 +00:00
Fred Drake b6cf9a4fc4 Script to help identify undocumented modules. Use -h or --help for
usage information.
1999-02-23 23:07:48 +00:00
Fred Drake 93d762fc7a Mark <verbatim> elements that represent interactive sessions; these
become <interpreter-session> elements.
1999-02-18 16:32:21 +00:00
Fred Drake 997eec7cca Minor adjustments to reflect esis2sgml.py changes.
Added "esis" target to only generate the ESIS data.
1999-02-18 16:31:05 +00:00
Fred Drake 607aed7a2c Some adjustments, mostly to make it more general. 1999-02-18 16:30:16 +00:00
Fred Drake 4cc902f464 Make the _rmtt regular expression deal with the new CSS-friendly
changes to the HTML documentation.
1999-02-18 16:11:12 +00:00
Fred Drake f6838c0f5e Copy in the stylesheet after latex2html is done. 1999-02-16 20:43:53 +00:00
Fred Drake fcf57ad959 Copy in the stylesheet after latex2html is done. 1999-02-16 20:28:25 +00:00
Fred Drake f43ce00531 Make sure errors get propogated. 1999-02-16 20:05:43 +00:00
Fred Drake efa641c45a Add an optional parameter to make the script run latex only once to
generate an .aux file.  This can make HTML generation a bit faster
when print formats aren't needed.

Explained parameters in a comment.
1999-02-15 19:27:07 +00:00
Fred Drake 3618c14f72 Use a common definition for $(SUBMAKE) instead of repeating everything
all over the place.
1999-02-15 16:50:28 +00:00
Fred Drake 5d59d3df7f Added --l2h-config option to add additional initialization files for
latex2html.  Can be useful in setting up things like the upward
external link for the top of the documents.
1999-02-15 16:27:42 +00:00
Fred Drake ec5c0b41ae Revert previous change; there's a better way to do it. 1999-02-10 17:08:00 +00:00
Fred Drake dfb4e24431 Respond to suggestion from "Albert" <hat@se-46.wpa.wtb.tue.nl> to add
document titles to the list of files.

Also added total page count and a note that comments should be
directed to python-docs@python.org.
1999-02-05 20:50:59 +00:00
Fred Drake bb79438d26 This seems to fix a problem with targeting from the indexes. 1999-02-02 18:57:12 +00:00
Fred Drake 7281b3b779 Updated comments on version of XML package needed. 1999-01-29 22:35:23 +00:00
Fred Drake 1dd152d036 Added support to handle \versionadded in a reasonable way. 1999-01-29 22:12:29 +00:00
Fred Drake 279ca75a5b Be a little smarter on some attribute values, making an assumption about
the DTD.
1999-01-29 21:35:50 +00:00
Fred Drake 3a7ff998ac fixup_descriptors(): Change the way we look for descriptor nodes;
this takes 5 minutes off the conversion of the whole tree by
	reducing the number of tree-traversals from 14 to 1.
1999-01-29 21:31:12 +00:00
Fred Drake 666e60095b Added the Doc/sgml/ directory to the tarball. 1999-01-29 21:22:55 +00:00
Fred Drake cb65781d93 Rewrite code that converts the little descriptor environments to build
the right <signature>s and <description>.  This seems to work a lot
better now!
1999-01-29 20:55:07 +00:00
Fred Drake 75930b31e2 Added table entries for \funcline and \funclineni. 1999-01-29 20:09:27 +00:00
Fred Drake fdfd50f815 Convert <version> to &version;. 1999-01-29 16:29:25 +00:00
Fred Drake 7dab6affba Update the docstring.
Lots of changes to get the paragraph marking to work, and not go into
an infinite recursion.

Start to rationalize markup of method signatures; not complete.

find_all_elements():  similar to getElementsByTagName(), but operates
	on the not-quite-legal fragments we deal with here.
	Simplifies several individual transforms.

fixup_sectionauthors():  Convert \sectionauthor items to <author> just
	after the <section>'s <title>.
1999-01-28 23:59:58 +00:00
Fred Drake 3f3b09657f Added table entries for \methodline, \methodlineni. 1999-01-28 23:49:37 +00:00
Fred Drake 1453a8caf9 Constructor arguments for classes should be called <args>. 1999-01-28 23:10:48 +00:00
Fred Drake ffc4811a40 Simplify slightly. 1999-01-27 18:40:36 +00:00
Fred Drake a49a4eabbf Add "term" to AUTOCLOSE. 1999-01-22 22:48:24 +00:00
Fred Drake 43278f01dc convert(): Added parameter "autoclose", which should be a sequence of
general identifiers for which closing tags will be omitted
	when SGML is generated.  This can be used to tell the markup
	generator to drop stuff like </para>.  Note that it needs to
	be possible for the closing tag to *always* be omitted for it
	to be included in "autoclose".

main():  Added command-line option "-a" / "--autoclose" to set the
	list of general identifiers passed to the convert() function
	as the "autoclose" parameter.  The list may only be specified
	once (not additive) and GIs should be comma-separated.  The
	default list includes only "para".
1999-01-20 20:35:05 +00:00
Fred Drake 0a5b8de5e2 Modified the "sgml" and "xml" targets to stop if the sub-makes fail in
any subdirectory; don't continue with remaining subdirs.

Added "api", "ext", "lib", "mac", "ref", and "tut" targets to only do
submakes in those directories.  This is just a lot easier to use than
to cd into the subdir and use make.rules directly.
1999-01-20 17:26:56 +00:00
Fred Drake 4259f0db04 create_module_info(): If there's a \moduleauthor, move it to an
<author> inside the <moduleinfo> element.

Fix problems with paragraph identification.
1999-01-19 23:09:31 +00:00
Fred Drake 36dfe58694 isnmtoken(), istoken(): Fix to ensure the regex has to match the
entire attribute value.

Add ability to save list of "empty" elements to a file -- enabled by
constant in the code.
1999-01-19 23:03:04 +00:00
Fred Drake 2664db9f76 handle_labels(): Fix problem for document fragments containing more
than one "root" that prevented all the <label id=...> items
	from being promoted to id attributes on the enclosing chapter/
	section/... properly.
1999-01-19 21:46:48 +00:00
Fred Drake d6ced7d199 convert(): Change the element name remapping to convert <refmodule>
to <module link>.
1999-01-19 17:11:23 +00:00
Fred Drake f82e4ab617 format_attrs(): Attempt a bit more minimization for SGML output. 1999-01-19 17:10:31 +00:00
Fred Drake 589bc63e84 Add a "tarball" target. 1999-01-14 22:35:05 +00:00
Fred Drake 6038f54b74 Adjust so that we are no longer using special entities for well-known
names.  These are too much of a pain for occaissional authors.
1999-01-14 21:44:56 +00:00
Fred Drake 3effeedad3 Shorten the name of the <rfc> "number" attribute to "num". 1999-01-14 21:18:52 +00:00
Fred Drake d24167baf2 Make <rfc> no longer an empty element but a container. The text
currently generated by the LaTeX and LaTeX2HTML processes is generated
here as well, making it more flexible in the SGML version.

Reduce the <args> element so that <optional> goes away; just use
square brackets to indicate what's optional.  This makes it easier to
read than the LaTeX, and the processor can do any checking it needs to
in order to make sure it's legit.  Possible shortcoming: DSSSL
processors may need more explicit markup.  Can probably hack around it
for this case, but we'll see.
1999-01-14 21:18:03 +00:00
Fred Drake f8ebb5521d Several new functions to re-write tables to be at least partly
conformant with the OASIS Exchange model.  There's a little more
massage left to do, but not much.
1999-01-14 19:45:38 +00:00
Fred Drake a50a1df588 Added clean and clobber targets. 1999-01-14 18:26:23 +00:00
Fred Drake 54bad44f25 Update to the latest version of Michael Ernst's script. 1999-01-14 18:17:07 +00:00
Fred Drake 3a7a3d745d "Driver" makefile to convert all documents to SGML or XML at once. 1999-01-14 18:13:59 +00:00
Fred Drake 7727416686 Add usage of the "driver" Makefile. 1999-01-14 18:12:33 +00:00
Fred Drake 9d1c3b565f Elaborate a comment on the format of the table that drives the
conversion.
1999-01-14 18:10:09 +00:00
Fred Drake d7acf02290 Adjustments to allow elements with subelements as parameters. This is
used to deal with the table headings and entries.

An additional flag in the element table is used to indicate elements
which have no "general" content, but which do have subelement
content.  These must be flagged distinctly from empty elements.
Currently used for \lineii, \lineiii, and \lineiv.
1999-01-14 17:38:12 +00:00
Fred Drake 79ad1f19dc Escape special characters on output. 1999-01-14 17:06:09 +00:00
Fred Drake 701f10fbea Simplify command that extracts the number of pages from a PostScript
file; use "grep -c" instead of "grep | wc -l | cut ... | tr ...".
1999-01-12 19:28:41 +00:00
Fred Drake 8e2c9457a2 output_body(): For <address> elements, just skip, since they're
always part of the page trailer.
1999-01-11 22:30:34 +00:00
Fred Drake ed94dde4b9 No longer useful. 1999-01-08 15:48:47 +00:00
Fred Drake dd21c32169 It's finally gone! 1999-01-08 15:40:16 +00:00
Fred Drake c4e9263010 Add a few comments. 1999-01-08 15:32:27 +00:00
Fred Drake c58f346374 New support scripts for HTML->info conversion that use Michael Ernst's new
conversion tools.
1999-01-08 15:27:17 +00:00
Fred Drake 3fe1d32693 New conversion tools for HTML->info from Michael Ernst
<mernst@cs.washington.edu>.

Thanks!
1999-01-08 15:25:29 +00:00
Fred Drake 637ad47e61 convert(): Make sure no line has trailing whitespace. (docfixer.py
checks for \n\n as a paragraph separator, LaTeX allows white
	space between the newlines.)
1999-01-07 18:47:07 +00:00
Fred Drake fcc5910090 Preliminary code to mark paragraphs. Seems to work, but very slow. 1999-01-06 22:50:52 +00:00
Fred Drake 26f0f65653 Remove obsolete comment. 1999-01-05 20:53:43 +00:00
Fred Drake 3b07480a17 trim_ignored_letters(): Simplify a little. 1999-01-04 22:00:56 +00:00
Fred Drake 03a0235793 Print a line to the console reporting the number of index nodes
processed.  This can be interesting to see.
1998-12-28 20:46:53 +00:00
Fred Drake aaed9710e9 create_module_info(): New function: Modify a <section> to create a
<moduleinfo> element based on various meta information, and
	strip some cruftiness.  This is more usable for information
	extraction, and organizes the information more clearly.

cleanup_synopses():  Rewrite to use create_module_info(), so this
	will work with multi-rooted "documents".
1998-12-10 20:25:30 +00:00
Fred Drake 4abcffb233 Don't pass around a list of known empty elements, since the ESIS
contains "e" events for them.  This wasn't used anyway.
1998-12-10 18:31:37 +00:00
Fred Drake fba0ba2a6f Added a transform to start cleaning up the modulesynopsis stuff a
little; more thinking is needed about what we really want.
1998-12-10 05:07:09 +00:00
Fred Drake c166331cd3 Handle SGML variant as well as XML variant. SGML is *much* more
likely to be used.
1998-12-10 04:56:00 +00:00
Fred Drake 86bc7b01b5 General comments on what's here and how to try it out. Note
dependence on the XML package.
1998-12-02 17:21:35 +00:00
Fred Drake 3695b1212c Support conversions to both SGML and XML; SGML is the "default".
Add dependency on esistools.py for the ESIS intermediate files.
1998-12-01 19:05:56 +00:00
Fred Drake aeea9810cd Use esistools.
Lots of changes to the conversion table.
1998-12-01 19:04:12 +00:00
Fred Drake 4db5b4636c Use esistools.
Generate ESIS data instead of XML.
Misc. changes to some transforms.
1998-12-01 19:03:01 +00:00
Fred Drake f077b9d61f Use esistools, getopt. 1998-12-01 19:01:53 +00:00
Fred Drake 3843bae969 Utility functions and misc. classes used in handling ESIS data. 1998-12-01 19:00:58 +00:00
Fred Drake f954b6516e Remove $(CUTCRUFT) garbage; now in fixgenents.sh.
Separate ESIS generation from XML generation.  This will evolve a bit
more in a couple of days.
1998-11-30 22:31:45 +00:00
Fred Drake 3d5e2c032d Move nasty cruft from make.rules' $(CUTCRUFT) here, mostly to clean up
make.rules.
1998-11-30 22:30:29 +00:00
Fred Drake ca6d6355d7 l2hoption: Do the "right thing" to quote the right-hand-side of Perl
assignments.  This allows '"', '$', and '@' to be included in
	the values passed to parameters like --address.
1998-11-30 20:30:26 +00:00
Fred Drake 7777e36c21 Add a -address parameter to the LaTeX2HTML command line to direct
documentation comments appropriately.  In response to comment from
Martijn Faassen <faassen@vet.uu.nl>.
1998-11-30 20:27:31 +00:00
Fred Drake 42f5298ab5 Several small adjustments. 1998-11-30 14:45:24 +00:00
Fred Drake 87dfd3cfbf Handle output of \geq and \leq. 1998-11-30 14:36:26 +00:00
Fred Drake 4c5e533693 Do the right stuff to convert what was originally \e, \ldots, and ---
in the LaTeX sources.
1998-11-25 19:28:02 +00:00
Fred Drake d8faf85d40 Supplemental rules to convert a .tex file to a .xml file. Both XML and
SGML will be supported soon, probably using an ESIS representation saved
in a temp file.
1998-11-24 17:40:33 +00:00
Fred Drake 6942e57f87 Script to convert things like <C/> and <Cpp/> to &C; and &Cpp;. This is
something that con't be done with the DOM as far as I can tell.
1998-11-24 17:38:49 +00:00
Fred Drake 1cb330c383 The & character is also escaped using \. 1998-11-23 23:11:12 +00:00
Fred Drake 1ff6db484f Add some additional cleanup transformations. 1998-11-23 23:10:35 +00:00
Fred Drake 5701482ea7 Fix comment regex so we don't screw up structured comments with
different internal indentation levels.
1998-11-23 18:21:54 +00:00
Fred Drake 0320473a29 Script to squirrel around with the DOM tree of document fragments from the
LaTeX-based ESIS streams to be a little better structured, and generally
perform clean-up.

Preliminary.
1998-11-23 17:02:03 +00:00
Fred Drake 30a68c7a2b Moved into tools/sgmlconv/. 1998-11-23 16:59:39 +00:00
Fred Drake 63de8f6d55 Moving to sgmlconv/ subdir. 1998-11-23 16:58:48 +00:00
Fred Drake bbd7509dbe Fix up the extraction of optional parameters a little.
Be more informative in an exception message.
1998-11-23 16:30:18 +00:00
Fred Drake c16149b17b Some cleanup.
Don't duplicate the information on what's empty; rely on the input
data for that.  (This means that the DOM may need more work.)
1998-11-23 15:14:18 +00:00
Fred Drake 96b07a9453 Fix some minor problems.
Make the table of attribute information contain only one kind of
entry.  Simplifies some stuff in subconvert().
1998-11-23 15:12:00 +00:00
Fred Drake 99ff8c4361 First cut at a script to generate SGML/XML from an ESIS event stream,
probably only usable for the Python docs.  But also probably more
useful than latex2esis.py.
1998-11-18 23:28:24 +00:00
Fred Drake 95f4f92b47 First cut at a script to generate ESIS events from LaTeX source,
probably only usable for the Python docs.
1998-11-18 23:27:24 +00:00
Fred Drake 566b6d5b59 Support the use of bibtex. This is transparent to the user.
Switch from bash to ksh, in the hope that more systems support it (one
report of a site without an available bash).
1998-10-27 21:59:03 +00:00
Fred Drake d29cf379b9 Added --tools option, to package only the framework (no documents). 1998-10-21 14:26:26 +00:00
Fred Drake fbddddee49 Reflect new name of index style file. 1998-10-19 21:48:05 +00:00
Fred Drake 9dcc9f7764 No longer needed since we have nice, contributed navigation buttons. 1998-10-19 21:40:45 +00:00
Fred Drake a5de730d2d If building HTML and the icons should be served from the same
directory as the HTML (--iconserver .), copy the icons into place.

Clarify that lynx is needed for --text in the usage message.

Fix a typo in a comment.
1998-10-19 19:14:42 +00:00
Fred Drake b521095952 In build_html(), strip off leading "./" from filename, added by
kpsewhich.  This caused a problem with the latest latex2html beta.
1998-10-16 17:34:34 +00:00
Fred Drake 437ff8600a Change the default split level to not split on marked \paragraph and
\subparagraph sections.  Indicate the default in the --help message.
1998-10-07 16:46:54 +00:00
Fred Drake b0b1900198 If --debug was used, don't delete the temporary .perl file used to
pass options to latex2html.
1998-10-07 16:41:40 +00:00
Fred Drake 8c1e114d1a Don't attempt to add paragraph and subparagraph sections to the PDF
outline.

Work around font-long bogosity caused by ' in docstring.
1998-10-07 14:12:20 +00:00
Fred Drake 47f69067d5 Script to generate page counts of the PostScript files. 1998-08-28 21:16:28 +00:00
Fred Drake e1feb8f2dc Support long options that take arguments of the form --option=value as well
as --option value.

Minor nits cleaned up.
1998-08-28 20:21:04 +00:00
Fred Drake 9f6f0da084 Improved some error messages for command line processing.
Added --all to produce all formats at once.
1998-08-12 18:07:51 +00:00
Fred Drake 78b8c3d0d6 Oops, the --text option wasn't documented! 1998-08-12 17:52:16 +00:00
Fred Drake c794c38187 Added a comment about not using a symbolic link to access the script. 1998-08-12 17:50:07 +00:00
Fred Drake 15c417eb77 Helper script used in creating navigation buttons. 1998-08-11 19:35:03 +00:00
Fred Drake af06a0b4ee Use Perl's rename() function instead of system(); there's no need for two
additional processes for each name change!
1998-08-11 18:17:47 +00:00
Fred Drake f6b6bbceb6 Add a comment explaining that this script is probably not useful outside the
standard Python documentation, since the mkhowto.sh script is.  Let there be
no doubts....
1998-08-11 14:10:40 +00:00
Fred Drake 077fffa874 The letter headings must be requested explicitly with --letters. 1998-08-07 20:49:54 +00:00
Fred Drake 7cbf462acf Allow multi-column indexes to be produced. 1998-08-07 19:50:13 +00:00
Fred Drake 9940bd717c Variant of AMK's patch to produce text versions of HOWTO documents.
This ensures that the text version uses latex2html's -split 1 option, without
affecting HTML produced in the same run, and also minimizes the number of
l2h runs needed if --split 1 was used for an HTML run.
1998-08-06 20:15:20 +00:00
Fred Drake 11300cc71e build_html(): Simplify, so there's only one version of the latex2html
command line.

l2hoption():  Convenience function, to write out an option to the aux. init.
	file only if set.

Added --iconserver option to set the $ICONSERVER variable in latex2html; this
requires the use of an auxillary init. file since this can't be initialized
using a standard latex2html command-line option.  So the aux. init. file is
used for just about all the special options since it has to be written anyway
when $ICONSERVER needs to be set.
1998-08-05 04:48:18 +00:00
Fred Drake 8cab549c0a use_latex(): Hack to pass .syn files though uniq, so that the last module
in a HOWTO document isn't listed in the synopsis table twice.  This
	will do until the real bug is found (low priority!).
1998-07-23 19:13:52 +00:00
Fred Drake e87ab1fbf2 Fix definition of release_version (global). 1998-05-19 19:37:55 +00:00
Fred Drake a4565b0796 Update to use latex2html 98.1p5. 1998-05-15 17:14:17 +00:00
Fred Drake 8dbf46a79e Update to use latex2html 98.1p5.
Cleanup temporary files produced by latex2html in the output directory.
1998-05-15 17:13:08 +00:00
Fred Drake 8d1b3384c3 Remove debugging echo. 1998-05-15 13:38:21 +00:00
Fred Drake df825a10fc Fix the fix to allow the .tex document sources not live in ".". 1998-05-14 20:36:49 +00:00
Fred Drake 25d4e2873c Mostly spurious change to ensure that everyone's version of this picks up the
execute bit.... problem discovered by Guido.
1998-05-14 20:07:10 +00:00
Fred Drake f4fc476885 Don't run tools/toc2bkm.py unless we're building PDF.
Change the way TEXINPUTS gets defined to ensure that the directory containing
the main document file comes before any other dir, to allow documents to have
files that "override" like-named files elsewhere on the search path.  Guido
discovered we needed this.
1998-05-14 20:03:14 +00:00
Fred Drake 72dd58d90e Use .tgz instead of .tar.gz for the output file name. 1998-05-11 21:08:39 +00:00
Fred Drake d5d473fd5c Add --letter option, similar to --a4. This is a no-op, but can be used from
a Makefile:  mkhowto.sh --$(PAPER).
1998-05-11 20:40:24 +00:00
Fred Drake 58ff112e7f Don't be so ugly as to use "set -x" to get the executed commands printed. 1998-05-11 19:06:26 +00:00
Fred Drake 1a3541c29c Oops, better add it to the usage message! 1998-05-11 19:04:56 +00:00
Fred Drake 3504952781 Add easy-to-use support for A4 paper. 1998-05-11 19:04:06 +00:00
Fred Drake f2fa1e2afe Accept the release number on the command line instead of hardcoding it. 1998-05-11 18:52:24 +00:00
Fred Drake 323dc70de5 Don't be so ugly as to use "set -x" to get the executed commands printed. 1998-05-11 18:41:16 +00:00
Fred Drake 8ffa21c7aa Adjust to new file layout. 1998-05-08 15:37:13 +00:00
Fred Drake f4166a478a Some versions of latex2html don't automatically append the .tex extension to
the name of the main .tex source file if it's not in the current directory.
1998-05-08 04:00:56 +00:00
Fred Drake 4a9129c7e8 /bin/sed works on both Solaris and RedHat Linux; /usr/bin/sed does not. 1998-05-08 03:42:23 +00:00
Fred Drake 19c7c84db8 Be a little more robust handling filenames. 1998-05-07 21:20:39 +00:00
Fred Drake bf332696a1 Add support for a --pdf option to cause a PDF file to be created instead;
most of the processing is the same and has to be done anyway.
1998-05-07 17:28:42 +00:00
Fred Drake 8920156d04 New script to drive HTML generation. 1998-05-07 14:53:55 +00:00
Fred Drake 5360879740 New helper script to build the .dvi for a Python manual; usable for the
api, ext, ref, and tut manuals.  The Library Reference requires too much
special index processing to make it beneficial to extend this to support
it.
1998-05-07 01:38:16 +00:00
Fred Drake c9b8a57040 cleanup(): Remove *all* the temp files related to index generation! 1998-04-29 21:28:25 +00:00
Fred Drake 8805354bbc Simplify how some options get propogated. 1998-04-24 21:57:12 +00:00
Barry Warsaw dc1c970b0f This script appears to no longer be in the toolchain for Python
documentation, so it has been moved to ../../Tools/scripts

Fred, please verify.
1998-04-23 22:57:16 +00:00
Fred Drake 476412a918 cleanup(): Get rid of module index turds. 1998-04-17 20:25:55 +00:00
Fred Drake 7984256f4d build_ps(): Fix flags to dvips.
build_html():  Deal with node2label.pl a little better.
1998-04-17 20:06:16 +00:00
Fred Drake 4f6d6e487c Fix things. Blame Andy Eskilsson <andy.eskilsson@telelogic.se>.
But I'm not giving this or the info files out until Andy (or anyone else)
agrees to take over the maintenance of this script!  Hah!
1998-04-17 15:28:09 +00:00
Fred Drake 12f842e33e Adjust to allow both general and module indexes.
PDF output properly supports the outline.
1998-04-17 02:52:12 +00:00
Fred Drake bf88c3830e Fix the broken PDF links, really this time!
Appending a junk char to the end doesn't quite do it, or doesn't seem to at
any rate.  Instead, pad the page numbers to always be 3 charaters wide, with
leading zeros.
1998-04-15 17:50:22 +00:00
Fred Drake a88d681255 Change the form of the name given to each page of the PDF from "page.%d" to
"page.%dx"; this works around an acroread bug that causes targets not to be
recognized if their name is a prefix of another target in the file.
1998-04-15 14:53:28 +00:00
Fred Drake e3ae5198a3 Update to use the new release number. Will generalize in the next round. 1998-04-13 21:55:56 +00:00
Fred Drake 2b8c95e4ed Minor housing cleaning in HTML that gets generated. 1998-04-11 16:26:02 +00:00
Fred Drake 058068d992 Nearly a complete re-write.
Basically, it now works and produces a nice-looking HTML index.

Shows some promise for extensibility, but still young.  Needs useful comments.
1998-04-08 23:12:51 +00:00
Fred Drake a8e262b0b2 Use the new index style when running makeindex. 1998-04-04 04:20:21 +00:00
Fred Drake ac8f91ada4 Added --split for AMK; control split level of the HTML output. Use --split 1
to create a single HTML file.

Added --help.
1998-04-02 15:37:13 +00:00
Fred Drake ec56109a0a First (rough) cut at HTML index generation in Python. Not very pretty, but
easier to work with than the Perl code.
1998-03-27 05:25:43 +00:00
Fred Drake 19e2ce58bf Add support for mapping internal labels used from the index. 1998-03-27 05:24:53 +00:00
Fred Drake f558e3188e Make $MYDIR absolute -- bug reported by AMK. 1998-03-24 17:48:20 +00:00
Fred Drake 2543769ca5 Use "/usr/bin/env perl" for the #! line, and change the -i option to:
use English;
	$INPLACE_EDIT = '';

to get the inplace-editing behavior.
1998-03-19 05:17:49 +00:00
Fred Drake 1125488b24 build_dvi(): Make sure we run latex enough times; this now matches the #
of times pdflatex would be run, which is correct.
1998-03-18 22:06:13 +00:00
Fred Drake e603cb1073 Revive newind.py. -sigh- 1998-03-16 16:15:49 +00:00
Fred Drake 664b36ff59 *Sigh*
Add a -q option for "quiet" operation.  Nothing gets out (not even stderr,
since that's tossed to stdout for capture in the .how file).  It's a good
idea to use -l to get the log in case there are problems.  Maybe this should
be the default and add a --verbose option to get the stdout?  There's way
too much junk output.
1998-03-11 15:41:21 +00:00
Fred Drake dbc879e949 Allow the user to operate the script in debugging mode (-D), which just does
a "set -x".

Allow keeping a transcript, using -l, in $FILE.how.

Allow keeping of all the temp files created by the process, using -k.
1998-03-11 15:33:44 +00:00
Fred Drake e2e904f303 Script to format HOWTO documents. Currently only tested on the "Using
Kerberos from Python" HOWTO (this will change shortly, I hope).

This needs to be run from it's location in the Doc/tools directory, and
not via a symlink.  I'll try and fix this in the future.

The help message needs work.
1998-03-10 23:23:05 +00:00
Fred Drake eff1f7622a clean_title(): Remove debugging prints. 1998-03-10 14:33:27 +00:00
Fred Drake ac77b79df6 clean_title(): Clean a little more carefully. Still does funny things with
underscores.  Might this be a fundamental PDF limitation?  Hm, could
	still be a TeX thing.
1998-03-10 14:02:35 +00:00
Fred Drake 45e564dd78 In the source dist., don't include:
- the .cvsignore files; these are only useful in the CVS tree

	- ref/ref.pdf

	- ref/ref.ps

After compression, these last two account for about one-half MB, and half
the tarball.  They can be picked up from the appropriate format dist if
needed.
1998-03-10 14:00:55 +00:00
Fred Drake 568113a75b Obsolete. 1998-03-09 16:38:32 +00:00
Fred Drake 8fcad7beb1 Don't generate a \label{} here. 1998-03-09 14:48:00 +00:00
Fred Drake 473a90e831 Allow the user to specify the "biggest" section type from the command line;
default is "chapter".  Use 'python toc2bkm.py -c section' to use with
Python HOWTO documents.
1998-03-07 15:34:50 +00:00
Fred Drake 361ee6582a Utility to help create outline information for PDF. 1998-03-06 21:29:00 +00:00
Fred Drake 2888bf6cb9 Build a tarball that extracts to Python-$VERSION/Doc/ instead of Doc/,
at Guido's suggestion.
1998-03-05 16:31:22 +00:00
Fred Drake cefcb33d4e Oops, remove some debugging prints. 1998-03-04 06:34:21 +00:00
Fred Drake b98cd39e20 changeit(): Added support for \deprecated{}.
Chunk.__repr__(), main():  Allow Chunk objects to get the buffer, to make the
representation contain text instead of a pair of indexes.  This makes debugging
a little easier.
1998-03-04 06:33:43 +00:00
Fred Drake fcf275e0be Script to create a source distribution. See comments at top. 1998-03-03 17:22:44 +00:00
Fred Drake 4f4e920889 Use a Python script to create "empty" indexes. This solves Guido's
corrupted file problem and avoids the shell escape interpretation
portability problem.  ;-(  See comments at top of newind.py for an
explanation.
1998-02-27 05:18:28 +00:00
Fred Drake e817930a7b Adjusted to work with the newer version of LaTeX2HTML as well. 1998-02-26 18:49:58 +00:00
Fred Drake 74a11e59a2 Do a little bit more work on a table-driven basis. A little cleanup.
Seems to work at the moment.
1998-02-26 05:52:37 +00:00
Fred Drake 9c7c6bec98 Clean up name->name conversion a little, *make sure it happens in all the
right places*!
1998-02-19 21:40:22 +00:00
Fred Drake 526ebb4d97 Work on a temporary file, not the input file. 1998-02-19 16:01:41 +00:00
Fred Drake ef058037a5 Support environments {fulllineitems} and {classdesc}, more of the new logical
markup.

The info generation now works, yet again.
1998-02-19 15:20:30 +00:00
Fred Drake c02fbe52b2 breakable_re: Fix the RE so that module definition entries don't prevent
combining.
1998-02-19 06:05:29 +00:00
Jeremy Hylton 9caa110141 assure a consistent assignment for nodes with multiple labels 1998-02-18 16:10:22 +00:00
Fred Drake 9acafa8bb5 Don't make backups.
Use "mv" instead of "ln -s" to install the new names.
1998-02-18 14:52:24 +00:00
Jeremy Hylton daa2d5d4ea Patch HREFs in html files, replacing nodeXXX.html with label.html. 1998-02-18 13:53:48 +00:00
Fred Drake a219e7976f main(): Include a \label{modindex} in the output so latex won't let us re-use
the name elsewhere.  This is useful for the logical filenames project,
	since the "modindex" label is hardcoded into .latex2html-init.
1998-02-17 23:13:19 +00:00
Fred Drake e8b46132e2 Massive changes. Fewer warnings from the Python Library Reference. Still
messy, but the thing seems to be working without bombing completely today.
Formatting lib.texi with TeX doesn't seem to do too badly, either!

Info formatting isn't quite there; that might just have to disappear this
time.
1998-02-17 05:54:46 +00:00
Fred Drake cffaebb621 parse_line(): Strip whitespace from the module name.
main():  Include a comma between the module name and page number, to make
	 the generated index more like the "standard" generated index.
1998-02-13 05:11:05 +00:00
Fred Drake a94d21f44e Minor performance nits. 1998-02-10 21:35:49 +00:00
Fred Drake dd244a0b9e Script to fix up the Library Reference index so it's less ugly. The docstring:
"""Combine similar index entries into an entry and subentries.

For example:

  \item {foobar} (in module flotz), 23
  \item {foobar} (in module whackit), 4323

becomes

  \item {foobar}
    \subitem in module flotz, 23
    \subitem in module whackit, 4323

Note that an item which matches the format of a collapsable item but which
isn't part of a group of similar items is not modified.
"""

This results in a much more readable index, with less repitition of text;
especially for common method names.
1998-02-09 22:17:52 +00:00
Fred Drake c1ce320a4f Script to convert module index data to module index. 1998-01-02 03:00:27 +00:00
Fred Drake 43c9350f7a Getting uglier. But it doesn't completely bomb except for some table stuff.
I'll get to it when I can.
1997-12-29 21:40:35 +00:00
Fred Drake a4541af0ba A bunch of minor stuff.
Lots of support for new macros defined in myformat.sty; including the new
indexing macros, seealso environment & friends, and the byte code instruction
support.
1997-12-29 17:19:22 +00:00
Fred Drake 6ccaaf1a08 Change name of temporary file to avoid possible filesystem issues; matches
similar renaming of the @buildno file elsewhere in the Python tree.
1997-12-29 16:58:46 +00:00
Fred Drake cb91e7bbd3 Added the "italic correction" command ("\/") to the list of ignored commands.
There is at least one of there in the library reference, and this reduces
the warning count.  We *do* know what to do with it!
1997-11-25 04:06:21 +00:00
Guido van Rossum 6cb2ac226e A nicety (author lost). 1997-06-02 17:57:10 +00:00
Fred Drake 4b3f0312c9 (lib<all sorts of stuff>.tex):
Merged in many typo corrections and fixes to support GNU info
	processing; submitted by Tamito Kajiyama.
1996-12-13 22:04:31 +00:00
Fred Drake b33021b572 (fix_libaux.sed): Hackish little sed script to modify lib.aux to get section
numbers right for latex2html for section titles which include
	"\sectcode{__.*__}" in the name.  Perhaps less general than it should
	be, but sufficient.
1996-11-11 20:49:27 +00:00
Fred Drake abcb38250b (texi2html.py): Minor improvement to HTML 3.0 output for code examples. 1996-10-25 22:13:59 +00:00
Fred Drake 893e5e0a15 (partparse.py): Fix nasty bug where \e got translated to @e only within
the optional arg of an \item[].
1996-10-25 22:13:10 +00:00
Fred Drake acc8754031 (partparse.py): Small change by Sjoerd to improve handle of X11 extension
documentation.
1996-10-14 16:20:42 +00:00
Fred Drake 22f7f9e671 (texi2html.py): Added CLASS=Navigation attribute to DIV around top/bottom
navigation links for HTML 3 version.

	Forced a blank line above the footnotes separator for HTML 2; at
	least one page did not get this spaced correctly.
1996-10-11 16:54:00 +00:00
Fred Drake 11b6d24da0 (partparse.py): Small fix to do_datadesc(): in some odd cases the name of
data item was omitted, which also affected the indentation of the
	description.
1996-10-10 20:09:56 +00:00
Fred Drake 0282726643 (texi2html.py): Tightened the generated HTML slightly. Added -p option to
print section titles even when the debugging output is not enabled.
	Added -3 option to generate HTML 3.0 constructs where meaningful.

	Removed repititive garbage generation:  the old version added simple
	descriptive comments after every datadesc/funcdesc/*desc entry:

	function(args) -- function of module xxxx
	    Description....

	These comments are no longer generated:

	function(args)
	    Description....
1996-10-09 19:05:12 +00:00
Fred Drake 7edd8d3c58 (partparse.py): Rationalize some behavior around unexpected conditions. 1996-10-09 16:11:26 +00:00
Fred Drake a39a25e5ec (texi2html.py): Use "if __name__ == '__main__':" test. Adjust indentation
to 4 spaces per level (no longer 8).

(Makefile):  Use .pyc versions of partparse.py and texi2html.py to generate
	converted documentation formats.  This reduces the startup costs;
	probably doesn't affect anyone but me in reality, but helps when
	working on the docs.
1996-09-13 14:44:34 +00:00
Guido van Rossum 36f219dff8 More performance and layout improvements by Fred 1996-09-11 21:30:40 +00:00
Guido van Rossum 5f18d6c7a0 Reformatted with 4 spaces indent.
Got rid of most redundant \ continuation signs.
1996-09-10 22:34:20 +00:00
Guido van Rossum 49604d3182 20% speedup by Fred 1996-09-10 22:19:51 +00:00
Guido van Rossum 29901ff528 Some improvements by Fred Drake. 1996-08-09 21:46:34 +00:00
Guido van Rossum 06f4289d3f many fixes by anonymous contributor 1995-08-28 03:01:00 +00:00
Guido van Rossum a12bbff857 mods by Gregor Schmid -- very nice! 1995-05-03 14:17:36 +00:00
Guido van Rossum 557ed94ebb don't print PLAINTEXT = ... 1995-03-28 13:33:45 +00:00
Guido van Rossum 7760cdea81 recognize more latex commands; add obindex 1995-03-17 16:03:11 +00:00
Guido van Rossum b819bdfe83 handle a few new things 1995-03-15 11:26:26 +00:00
Guido van Rossum 26a9d37e5c new, from ../Demo/www 1995-03-15 11:26:05 +00:00
Sjoerd Mullender 1cfb6b8992 Can't remember the reason for the change, but it was necessary. :-) 1994-12-14 15:28:22 +00:00
Guido van Rossum 16d6e7109d Lots of small corrections by Andrew Kuchling (plus all new rotor docs) 1994-08-08 12:30:22 +00:00
Guido van Rossum 6938f06047 Merge alpha100 branch back to main trunk 1994-08-01 12:22:53 +00:00