Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e15956b

Browse files
committed
Merged changes from the 1.5.2p2 release.
1 parent 20082d9 commit e15956b

14 files changed

Lines changed: 371 additions & 201 deletions

File tree

Doc/doc/doc.tex

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,19 @@ \section{Special Markup Constructs}
226226
macros. This section contains the reference material for these
227227
facilities.
228228

229+
\subsection{Meta-information Markup \label{meta-info}}
230+
231+
\begin{macrodesc}{sectionauthor}{\p{author}\p{email}}
232+
Identifies the author of the current section. \var{author}
233+
should be the author's name such that it can be used for
234+
presentation (though it isn't), and \var{email} should be the
235+
author's email address. The domain name portion of
236+
the address should be lower case.
237+
238+
No presentation is generated from this markup, but it is used to
239+
help keep track of contributions.
240+
\end{macrodesc}
241+
229242
\subsection{Information Units \label{info-units}}
230243

231244
XXX Explain terminology, or come up with something more ``lay.''
@@ -412,7 +425,8 @@ \section{Special Markup Constructs}
412425

413426
\begin{macrodesc}{email}{\p{address}}
414427
An email address. Note that this is \emph{not} hyperlinked in
415-
any of the possible output formats.
428+
any of the possible output formats. The domain name portion of
429+
the address should be lower case.
416430
\end{macrodesc}
417431

418432
\begin{macrodesc}{emph}{\p{text}}
@@ -689,8 +703,8 @@ \section{\module{spam} ---
689703
An additional table-like environment is \env{synopsistable}. The
690704
table generated by this environment contains two columns, and each
691705
row is defined by an alternate definition of
692-
\macro{modulesynopsis}. This environment is not normally use by
693-
the user, but is created by the \macro{localmoduletable} macro.
706+
\macro{modulesynopsis}. This environment is not normally used by
707+
authors, but is created by the \macro{localmoduletable} macro.
694708

695709

696710
\subsection{Reference List Markup \label{references}}
@@ -726,7 +740,7 @@ \section{\module{spam} ---
726740
\subsection{Index-generating Markup \label{indexing}}
727741

728742
Effective index generation for technical documents can be very
729-
difficult, especially for someone familliar with the topic but not
743+
difficult, especially for someone familiar with the topic but not
730744
the creation of indexes. Much of the difficulty arises in the
731745
area of terminology: including the terms an expert would use for a
732746
concept is not sufficient. Coming up with the terms that a novice
@@ -735,7 +749,7 @@ \section{\module{spam} ---
735749

736750
The truly difficult aspects of index generation are not areas with
737751
which the documentation tools can help. However, ease
738-
of producing the index once content decisions are make is within
752+
of producing the index once content decisions are made is within
739753
the scope of the tools. Markup is provided which the processing
740754
software is able to use to generate a variety of kinds of index
741755
entry with minimal effort. Additionally, many of the environments

Doc/html/Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ mac: mac/mac.html
5353
ref: ref/ref.html
5454
tut: tut/tut.html
5555

56-
$(INDEXFILES): $(COMMONPERL) $(TOPDIR)/html/about.dat
56+
$(INDEXFILES): $(COMMONPERL) \
57+
$(TOPDIR)/html/about.dat \
58+
$(TOPDIR)/tools/node2label.pl
5759

5860
# The index.html target is at the end since it screws up font-lock.
5961

Doc/html/index.html.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<html>
22
<head>
3-
<title>Python 1.5.2 Documentation</title>
3+
<title>Python @RELEASE@ Documentation - @DATE@</title>
44
<link rel=STYLESHEET href="lib/lib.css" type="text/css">
55
<style type="text/css">
66
a.title { font-weight: bold; font-size: 110%; }
@@ -38,7 +38,7 @@
3838
</p>
3939
</div>
4040

41-
<table>
41+
<table align="center">
4242
<tbody>
4343
<tr><td>
4444
<ul>

Doc/paper-letter/.cvsignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313
*.l2h
1414
*.how
1515
README
16+
api.tex

Doc/paper-letter/Makefile

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,17 +58,20 @@ pdf: $(PDFFILES)
5858
ps: $(PSFILES)
5959

6060

61-
README: $(PSFILES)
61+
README: $(PSFILES) $(TOOLSDIR)/getpagecounts
6262
$(TOOLSDIR)/getpagecounts >$@
6363

6464

6565
# Python/C API Reference Manual
66-
api.dvi: $(APIFILES)
66+
api.dvi: api.tex $(APIFILES)
6767
$(MKDVI) api
6868

69-
api.pdf: $(APIFILES)
69+
api.pdf: api.tex $(APIFILES)
7070
$(MKPDF) api
7171

72+
api.tex: ../api/api.tex ../api/refcounts.dat ../tools/anno-api.py
73+
$(PYTHON) ../tools/anno-api.py -o $@ ../api/api.tex
74+
7275
# Documenting Python
7376
doc.dvi: $(DOCFILES)
7477
$(MKHOWTO) --dvi ../doc/doc.tex
@@ -113,7 +116,7 @@ tut.pdf: $(TUTFILES)
113116

114117

115118
clean:
116-
rm -f *~ *.aux *.idx *.ilg *.ind *.log *.toc *.bkm *.syn *.pla
119+
rm -f *~ *.aux *.idx *.ilg *.ind *.log *.toc *.bkm *.syn *.pla api.tex
117120

118121
clobber: clean
119122
rm -f $(DVIFILES) $(PSFILES) $(PDFFILES)

Doc/perl/SynopsisTable.pm

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ sub show{
3838

3939
sub tohtml{
4040
my $self = shift;
41-
my $data = "<table class=\"synopsistable\">\n";
41+
my $data = "<table class='synopsistable'>\n";
4242
my $name;
4343
foreach $name (split /,/, $self->{names}) {
4444
my($key,$type,$synopsis) = $self->get($name);
45-
my $link = "<a href=\"module-$key.html\">";
46-
$data .= (" <tr>"
47-
. "<td><b><tt class=module>$link$name</a></tt></b></td>\n"
48-
. " <td class=synopsis>$synopsis</td></tr>\n");
45+
my $link = "<a href='module-$key.html'>";
46+
$data .= (' <tr>'
47+
. "<td><b><tt class='module'>$link$name</a></tt></b></td>\n"
48+
. " <td class='synopsis'>$synopsis</td></tr>\n");
4949
}
5050
$data .= "</table>\n";
5151
$data;

Doc/perl/l2hinit.perl

Lines changed: 58 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ package main;
1616
$HTML_VERSION = 4.0;
1717

1818
$MAX_LINK_DEPTH = 2;
19+
$MAX_SPLIT_DEPTH = 5; # split at subsections but not sub-subsections
1920
$ADDRESS = '';
2021

2122
$NO_FOOTNODE = 1;
@@ -143,22 +144,22 @@ sub adjust_icon_information{
143144
$BLANK_ICON =~ s/alt="blank"/alt=""/;
144145
$NAV_BGCOLOR = " bgcolor=\"#99CCFF\"";
145146
}
147+
146148
adjust_icon_information();
147149

148150

149151
sub make_nav_sectref{
150152
my($label,$title) = @_;
151153
if ($title) {
152-
$title =~ s/<A/<A class=sectref/;
153-
return ("<b class=navlabel>$label:</b> "
154-
. "$title\n");
154+
return ("<b class='navlabel'>$label:</b> "
155+
. "<span class='sectref'>$title</span>\n");
155156
}
156157
return '';
157158
}
158159

159160
sub make_nav_panel{
160161
my $s;
161-
$s = "<table align=center width=\"100%\" cellpadding=0 cellspacing=2>"
162+
$s = "<table align='center' width='100%' cellpadding='0' cellspacing='2'>"
162163
. "\n<tr>"
163164
. "\n<td>$NEXT</td>"
164165
. "\n<td>$UP</td>"
@@ -184,13 +185,13 @@ sub make_nav_panel{
184185
}
185186

186187
sub top_navigation_panel {
187-
"<div class=navigation>\n"
188+
"<div class='navigation'>\n"
188189
. make_nav_panel()
189190
. '<br><hr></div>';
190191
}
191192

192193
sub bot_navigation_panel {
193-
"<p>\n<div class=navigation><hr>"
194+
"<p>\n<div class='navigation'><hr>"
194195
. make_nav_panel()
195196
. '</div>';
196197
}
@@ -334,13 +335,11 @@ sub add_module_idx{
334335
my $plat = '';
335336
$key =~ s/<tt>([a-zA-Z0-9._]*)<\/tt>/\1/;
336337
if ($ModulePlatforms{$key} && !$allthesame) {
337-
$plat = (" <em>(<span class=platform>$ModulePlatforms{$key}"
338+
$plat = (" <em>(<span class='platform'>$ModulePlatforms{$key}"
338339
. '</span>)</em>');
339340
}
340-
print MODIDXFILE
341-
$moditem
342-
. $IDXFILE_FIELD_SEP
343-
. "<tt class=module>$key</tt>$plat###\n";
341+
print MODIDXFILE $moditem . $IDXFILE_FIELD_SEP
342+
. "<tt class='module'>$key</tt>$plat###\n";
344343
}
345344
close(MODIDXFILE);
346345
if (!$allthesame) {
@@ -556,9 +555,55 @@ sub protect_useritems {
556555
#
557556
# Note that this *must* be done in the init file, not the python.perl
558557
# style support file. The %declarations must be set before initialize()
559-
# is called in the main script.
558+
# is called in the main LaTeX2HTML script (which happens before style files
559+
# are loaded).
560560
#
561-
%declarations = ('preform' => '<dl><dd><pre class=verbatim></pre></dl>',
561+
%declarations = ('preform' => '<dl><dd><pre class="verbatim"></pre></dl>',
562562
%declarations);
563563

564+
565+
# This is added to get rid of the long comment that follows the doctype
566+
# declaration; MSIE5 on NT4 SP4 barfs on it and drops the content of the
567+
# page.
568+
sub make_head_and_body {
569+
local($title,$body) = @_;
570+
local($DTDcomment) = '';
571+
local($version,$isolanguage) = ($HTML_VERSION, 'EN');
572+
local(%isolanguages) = ( 'english', 'EN' , 'USenglish', 'EN.US'
573+
, 'original', 'EN' , 'german' , 'DE'
574+
, 'austrian', 'DE.AT', 'french' , 'FR'
575+
, 'spanish', 'ES'
576+
, %isolanguages );
577+
$isolanguage = $isolanguages{$default_language};
578+
$isolanguage = 'EN' unless $isolanguage;
579+
$title = &purify($title,1);
580+
eval("\$title = ". $default_title ) unless ($title);
581+
582+
# allow user-modification of the <TITLE> tag; thanks Dan Young
583+
if (defined &custom_TITLE_hook) {
584+
$title = &custom_TITLE_hook($title, $toc_sec_title);
585+
}
586+
587+
if ($DOCTYPE =~ /\/\/[\w\.]+\s*$/) { # language spec included
588+
$DTDcomment = "<!DOCTYPE html PUBLIC \"$DOCTYPE\">\n";
589+
} else {
590+
$DTDcomment = "<!DOCTYPE html PUBLIC \"$DOCTYPE//"
591+
. ($ISO_LANGUAGE ? $ISO_LANGUAGE : $isolanguage) . "\">\n";
592+
}
593+
594+
$STYLESHEET = $FILE.".css" unless $STYLESHEET;
595+
if (!$charset && $CHARSET) { $charset = $CHARSET; $charset =~ s/_/\-/go; }
596+
597+
join('', ($DOCTYPE ? $DTDcomment : '' )
598+
,"<html>\n<head>\n<title>", $title, "</title>\n"
599+
, &meta_information($title)
600+
, ($CHARSET && $HTML_VERSION ge "2.1" ?
601+
"<meta http-equiv=\"Content-Type\" content=\"text/html; charset=$charset\">\n"
602+
: "" )
603+
, ($BASE ? "<base href=\"$BASE\">\n" : "" )
604+
, "<link rel=\"STYLESHEET\" href=\"$STYLESHEET\">"
605+
, $more_links_mark
606+
, "\n</head>\n<body $body>\n");
607+
}
608+
564609
1; # This must be the last line

Doc/perl/ltxmarkup.perl

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ sub ltx_next_argument{
1515
sub do_cmd_macro{
1616
local($_) = @_;
1717
my $macro = ltx_next_argument();
18-
return "<tt class=macro>&#92;$macro</tt>" . $_;
18+
return "<tt class='macro'>&#92;$macro</tt>" . $_;
1919
}
2020

2121
sub do_cmd_env{
2222
local($_) = @_;
2323
my $env = ltx_next_argument();
24-
return "<tt class=environment>&#92;$env</tt>" . $_;
24+
return "<tt class='environment'>&#92;$env</tt>" . $_;
2525
}
2626

2727
sub ltx_process_params{
@@ -43,8 +43,8 @@ sub do_env_macrodesc{
4343
local($_) = @_;
4444
my $macro = ltx_next_argument();
4545
my $params = ltx_process_params(ltx_next_argument());
46-
return "\n<dl class=macrodesc>"
47-
. "\n<dt><b><tt class=macro>&#92;$macro</tt></b>"
46+
return "\n<dl class='macrodesc'>"
47+
. "\n<dt><b><tt class='macro'>&#92;$macro</tt></b>"
4848
. "\n $params"
4949
. "\n<dd>"
5050
. $_
@@ -55,9 +55,10 @@ sub do_env_envdesc{
5555
local($_) = @_;
5656
my $env = ltx_next_argument();
5757
my $params = ltx_process_params(ltx_next_argument());
58-
return "\n<dl class=envdesc>"
59-
. "\n<dt><tt>&#92;begin{<b class=environment>$env</b>}</tt>"
58+
return "\n<dl class='envdesc'>"
59+
. "\n<dt><tt>&#92;begin{<b class='environment'>$env</b>}</tt>"
6060
. "\n $params"
61+
. "\n<br /><tt>&#92;end{<b class='environment'>$env</b>}</tt>"
6162
. "\n<dd>"
6263
. $_
6364
. "</dl>";

0 commit comments

Comments
 (0)