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
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
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
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
2e1094e4ef
Use #!/usr/bin/env python instead of #!/usr/local/bin/python.
1999-04-09 14:53:35 +00:00
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
87a42cd61b
Add support for <platform>, some cleanup of module section after
...
creating the <moduleinfo>.
1999-03-11 17:35:12 +00:00
1acb8740eb
Oops, missed a couple of substitutions in the templates.
1999-03-04 21:33:55 +00:00
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
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
b1d839866c
Obsolete; use the Python version instead.
1999-03-03 20:28:17 +00:00
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
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
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
7f492ad7b8
Be more flexible to support platform annotations.
1999-03-02 16:22:56 +00:00
75ab7a6fa4
Clean up *.pla files -- platform annotation information.
1999-03-02 16:22:26 +00:00
093c97a36f
ignore_from_idx(): Fixed bug in regular expression.
1999-02-24 18:39:47 +00:00
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
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
b6cf9a4fc4
Script to help identify undocumented modules. Use -h or --help for
...
usage information.
1999-02-23 23:07:48 +00:00
93d762fc7a
Mark <verbatim> elements that represent interactive sessions; these
...
become <interpreter-session> elements.
1999-02-18 16:32:21 +00:00
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
607aed7a2c
Some adjustments, mostly to make it more general.
1999-02-18 16:30:16 +00:00
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
f6838c0f5e
Copy in the stylesheet after latex2html is done.
1999-02-16 20:43:53 +00:00
fcf57ad959
Copy in the stylesheet after latex2html is done.
1999-02-16 20:28:25 +00:00
f43ce00531
Make sure errors get propogated.
1999-02-16 20:05:43 +00:00
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
3618c14f72
Use a common definition for $(SUBMAKE) instead of repeating everything
...
all over the place.
1999-02-15 16:50:28 +00:00
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
ec5c0b41ae
Revert previous change; there's a better way to do it.
1999-02-10 17:08:00 +00:00
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
bb79438d26
This seems to fix a problem with targeting from the indexes.
1999-02-02 18:57:12 +00:00
7281b3b779
Updated comments on version of XML package needed.
1999-01-29 22:35:23 +00:00
1dd152d036
Added support to handle \versionadded in a reasonable way.
1999-01-29 22:12:29 +00:00
279ca75a5b
Be a little smarter on some attribute values, making an assumption about
...
the DTD.
1999-01-29 21:35:50 +00:00
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
666e60095b
Added the Doc/sgml/ directory to the tarball.
1999-01-29 21:22:55 +00:00
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
75930b31e2
Added table entries for \funcline and \funclineni.
1999-01-29 20:09:27 +00:00
fdfd50f815
Convert <version> to &version;.
1999-01-29 16:29:25 +00:00
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
3f3b09657f
Added table entries for \methodline, \methodlineni.
1999-01-28 23:49:37 +00:00
1453a8caf9
Constructor arguments for classes should be called <args>.
1999-01-28 23:10:48 +00:00
ffc4811a40
Simplify slightly.
1999-01-27 18:40:36 +00:00
a49a4eabbf
Add "term" to AUTOCLOSE.
1999-01-22 22:48:24 +00:00
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
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
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
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
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
d6ced7d199
convert(): Change the element name remapping to convert <refmodule>
...
to <module link>.
1999-01-19 17:11:23 +00:00
f82e4ab617
format_attrs(): Attempt a bit more minimization for SGML output.
1999-01-19 17:10:31 +00:00
589bc63e84
Add a "tarball" target.
1999-01-14 22:35:05 +00:00
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
3effeedad3
Shorten the name of the <rfc> "number" attribute to "num".
1999-01-14 21:18:52 +00:00
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
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
a50a1df588
Added clean and clobber targets.
1999-01-14 18:26:23 +00:00
54bad44f25
Update to the latest version of Michael Ernst's script.
1999-01-14 18:17:07 +00:00
3a7a3d745d
"Driver" makefile to convert all documents to SGML or XML at once.
1999-01-14 18:13:59 +00:00
7727416686
Add usage of the "driver" Makefile.
1999-01-14 18:12:33 +00:00
9d1c3b565f
Elaborate a comment on the format of the table that drives the
...
conversion.
1999-01-14 18:10:09 +00:00
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
79ad1f19dc
Escape special characters on output.
1999-01-14 17:06:09 +00:00
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
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
ed94dde4b9
No longer useful.
1999-01-08 15:48:47 +00:00
dd21c32169
It's finally gone!
1999-01-08 15:40:16 +00:00
c4e9263010
Add a few comments.
1999-01-08 15:32:27 +00:00
c58f346374
New support scripts for HTML->info conversion that use Michael Ernst's new
...
conversion tools.
1999-01-08 15:27:17 +00:00
3fe1d32693
New conversion tools for HTML->info from Michael Ernst
...
<mernst@cs.washington.edu>.
Thanks!
1999-01-08 15:25:29 +00:00
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
fcc5910090
Preliminary code to mark paragraphs. Seems to work, but very slow.
1999-01-06 22:50:52 +00:00
26f0f65653
Remove obsolete comment.
1999-01-05 20:53:43 +00:00
3b07480a17
trim_ignored_letters(): Simplify a little.
1999-01-04 22:00:56 +00:00
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
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
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
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
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
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
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
aeea9810cd
Use esistools.
...
Lots of changes to the conversion table.
1998-12-01 19:04:12 +00:00
4db5b4636c
Use esistools.
...
Generate ESIS data instead of XML.
Misc. changes to some transforms.
1998-12-01 19:03:01 +00:00
f077b9d61f
Use esistools, getopt.
1998-12-01 19:01:53 +00:00
3843bae969
Utility functions and misc. classes used in handling ESIS data.
1998-12-01 19:00:58 +00:00
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
3d5e2c032d
Move nasty cruft from make.rules' $(CUTCRUFT) here, mostly to clean up
...
make.rules.
1998-11-30 22:30:29 +00:00
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
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
42f5298ab5
Several small adjustments.
1998-11-30 14:45:24 +00:00
87dfd3cfbf
Handle output of \geq and \leq.
1998-11-30 14:36:26 +00:00
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
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
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
1cb330c383
The & character is also escaped using \.
1998-11-23 23:11:12 +00:00
1ff6db484f
Add some additional cleanup transformations.
1998-11-23 23:10:35 +00:00
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
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
30a68c7a2b
Moved into tools/sgmlconv/.
1998-11-23 16:59:39 +00:00
63de8f6d55
Moving to sgmlconv/ subdir.
1998-11-23 16:58:48 +00:00
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
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
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
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
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
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
d29cf379b9
Added --tools option, to package only the framework (no documents).
1998-10-21 14:26:26 +00:00
fbddddee49
Reflect new name of index style file.
1998-10-19 21:48:05 +00:00
9dcc9f7764
No longer needed since we have nice, contributed navigation buttons.
1998-10-19 21:40:45 +00:00
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
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
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
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
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
47f69067d5
Script to generate page counts of the PostScript files.
1998-08-28 21:16:28 +00:00
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
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
78b8c3d0d6
Oops, the --text option wasn't documented!
1998-08-12 17:52:16 +00:00
c794c38187
Added a comment about not using a symbolic link to access the script.
1998-08-12 17:50:07 +00:00
15c417eb77
Helper script used in creating navigation buttons.
1998-08-11 19:35:03 +00:00
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
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
077fffa874
The letter headings must be requested explicitly with --letters.
1998-08-07 20:49:54 +00:00
7cbf462acf
Allow multi-column indexes to be produced.
1998-08-07 19:50:13 +00:00
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
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
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
e87ab1fbf2
Fix definition of release_version (global).
1998-05-19 19:37:55 +00:00
a4565b0796
Update to use latex2html 98.1p5.
1998-05-15 17:14:17 +00:00
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
8d1b3384c3
Remove debugging echo.
1998-05-15 13:38:21 +00:00
df825a10fc
Fix the fix to allow the .tex document sources not live in ".".
1998-05-14 20:36:49 +00:00
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
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
72dd58d90e
Use .tgz instead of .tar.gz for the output file name.
1998-05-11 21:08:39 +00:00
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
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
1a3541c29c
Oops, better add it to the usage message!
1998-05-11 19:04:56 +00:00
3504952781
Add easy-to-use support for A4 paper.
1998-05-11 19:04:06 +00:00
f2fa1e2afe
Accept the release number on the command line instead of hardcoding it.
1998-05-11 18:52:24 +00:00
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
8ffa21c7aa
Adjust to new file layout.
1998-05-08 15:37:13 +00:00
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
4a9129c7e8
/bin/sed works on both Solaris and RedHat Linux; /usr/bin/sed does not.
1998-05-08 03:42:23 +00:00
19c7c84db8
Be a little more robust handling filenames.
1998-05-07 21:20:39 +00:00
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
8920156d04
New script to drive HTML generation.
1998-05-07 14:53:55 +00:00
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