%!PS-Adobe-2.0
%%Creator: dvips(k) 5.96.1 Copyright 2007 Radical Eye Software
%%Title: paper-letter/doc.dvi
%%CreationDate: Fri Dec 19 16:19:45 2008
%%Pages: 28
%%PageOrder: Ascend
%%BoundingBox: 0 0 612 792
%%DocumentFonts: Helvetica Helvetica-Oblique Times-Roman Times-Bold
%%+ Times-Italic Courier CMMI10 Courier-Bold CMSY10
%%DocumentPaperSizes: Letter
%%EndComments
%DVIPSWebPage: (www.radicaleye.com)
%DVIPSCommandLine: dvips -N0 -t letter -o paper-letter/doc.ps
%+ paper-letter/doc.dvi
%DVIPSParameters: dpi=600
%DVIPSSource: TeX output 2008.12.19:1619
%%BeginProcSet: tex.pro 0 0
%!
/TeXDict 300 dict def TeXDict begin/N{def}def/B{bind def}N/S{exch}N/X{S
N}B/A{dup}B/TR{translate}N/isls false N/vsize 11 72 mul N/hsize 8.5 72
mul N/landplus90{false}def/@rigin{isls{[0 landplus90{1 -1}{-1 1}ifelse 0
0 0]concat}if 72 Resolution div 72 VResolution div neg scale isls{
landplus90{VResolution 72 div vsize mul 0 exch}{Resolution -72 div hsize
mul 0}ifelse TR}if Resolution VResolution vsize -72 div 1 add mul TR[
matrix currentmatrix{A A round sub abs 0.00001 lt{round}if}forall round
exch round exch]setmatrix}N/@landscape{/isls true N}B/@manualfeed{
statusdict/manualfeed true put}B/@copies{/#copies X}B/FMat[1 0 0 -1 0 0]
N/FBB[0 0 0 0]N/nn 0 N/IEn 0 N/ctr 0 N/df-tail{/nn 8 dict N nn begin
/FontType 3 N/FontMatrix fntrx N/FontBBox FBB N string/base X array
/BitMaps X/BuildChar{CharBuilder}N/Encoding IEn N end A{/foo setfont}2
array copy cvx N load 0 nn put/ctr 0 N[}B/sf 0 N/df{/sf 1 N/fntrx FMat N
df-tail}B/dfs{div/sf X/fntrx[sf 0 0 sf neg 0 0]N df-tail}B/E{pop nn A
definefont setfont}B/Cw{Cd A length 5 sub get}B/Ch{Cd A length 4 sub get
}B/Cx{128 Cd A length 3 sub get sub}B/Cy{Cd A length 2 sub get 127 sub}
B/Cdx{Cd A length 1 sub get}B/Ci{Cd A type/stringtype ne{ctr get/ctr ctr
1 add N}if}B/CharBuilder{save 3 1 roll S A/base get 2 index get S
/BitMaps get S get/Cd X pop/ctr 0 N Cdx 0 Cx Cy Ch sub Cx Cw add Cy
setcachedevice Cw Ch true[1 0 0 -1 -.1 Cx sub Cy .1 sub]{Ci}imagemask
restore}B/D{/cc X A type/stringtype ne{]}if nn/base get cc ctr put nn
/BitMaps get S ctr S sf 1 ne{A A length 1 sub A 2 index S get sf div put
}if put/ctr ctr 1 add N}B/I{cc 1 add D}B/bop{userdict/bop-hook known{
bop-hook}if/SI save N @rigin 0 0 moveto/V matrix currentmatrix A 1 get A
mul exch 0 get A mul add .99 lt{/QV}{/RV}ifelse load def pop pop}N/eop{
SI restore userdict/eop-hook known{eop-hook}if showpage}N/@start{
userdict/start-hook known{start-hook}if pop/VResolution X/Resolution X
1000 div/DVImag X/IEn 256 array N 2 string 0 1 255{IEn S A 360 add 36 4
index cvrs cvn put}for pop 65781.76 div/vsize X 65781.76 div/hsize X}N
/p{show}N/RMat[1 0 0 -1 0 0]N/BDot 260 string N/Rx 0 N/Ry 0 N/V{}B/RV/v{
/Ry X/Rx X V}B statusdict begin/product where{pop false[(Display)(NeXT)
(LaserWriter 16/600)]{A length product length le{A length product exch 0
exch getinterval eq{pop true exit}if}{pop}ifelse}forall}{false}ifelse
end{{gsave TR -.1 .1 TR 1 1 scale Rx Ry false RMat{BDot}imagemask
grestore}}{{gsave TR -.1 .1 TR Rx Ry scale 1 1 false RMat{BDot}
imagemask grestore}}ifelse B/QV{gsave newpath transform round exch round
exch itransform moveto Rx 0 rlineto 0 Ry neg rlineto Rx neg 0 rlineto
fill grestore}B/a{moveto}B/delta 0 N/tail{A/delta X 0 rmoveto}B/M{S p
delta add tail}B/b{S p tail}B/c{-4 M}B/d{-3 M}B/e{-2 M}B/f{-1 M}B/g{0 M}
B/h{1 M}B/i{2 M}B/j{3 M}B/k{4 M}B/w{0 rmoveto}B/l{p -4 w}B/m{p -3 w}B/n{
p -2 w}B/o{p -1 w}B/q{p 1 w}B/r{p 2 w}B/s{p 3 w}B/t{p 4 w}B/x{0 S
rmoveto}B/y{3 2 roll p a}B/bos{/SS save N}B/eos{SS restore}B end
%%EndProcSet
%%BeginProcSet: 8r.enc 0 0
% File 8r.enc TeX Base 1 Encoding Revision 2.0 2002-10-30
%
% @@psencodingfile@{
% author = "S. Rahtz, P. MacKay, Alan Jeffrey, B. Horn, K. Berry,
% W. Schmidt, P. Lehman",
% version = "2.0",
% date = "27nov06",
% filename = "8r.enc",
% email = "tex-fonts@@tug.org",
% docstring = "This is the encoding vector for Type1 and TrueType
% fonts to be used with TeX. This file is part of the
% PSNFSS bundle, version 9"
% @}
%
% The idea is to have all the characters normally included in Type 1 fonts
% available for typesetting. This is effectively the characters in Adobe
% Standard encoding, ISO Latin 1, Windows ANSI including the euro symbol,
% MacRoman, and some extra characters from Lucida.
%
% Character code assignments were made as follows:
%
% (1) the Windows ANSI characters are almost all in their Windows ANSI
% positions, because some Windows users cannot easily reencode the
% fonts, and it makes no difference on other systems. The only Windows
% ANSI characters not available are those that make no sense for
% typesetting -- rubout (127 decimal), nobreakspace (160), softhyphen
% (173). quotesingle and grave are moved just because it's such an
% irritation not having them in TeX positions.
%
% (2) Remaining characters are assigned arbitrarily to the lower part
% of the range, avoiding 0, 10 and 13 in case we meet dumb software.
%
% (3) Y&Y Lucida Bright includes some extra text characters; in the
% hopes that other PostScript fonts, perhaps created for public
% consumption, will include them, they are included starting at 0x12.
% These are /dotlessj /ff /ffi /ffl.
%
% (4) hyphen appears twice for compatibility with both ASCII and Windows.
%
% (5) /Euro was assigned to 128, as in Windows ANSI
%
% (6) Missing characters from MacRoman encoding incorporated as follows:
%
% PostScript MacRoman TeXBase1
% -------------- -------------- --------------
% /notequal 173 0x16
% /infinity 176 0x17
% /lessequal 178 0x18
% /greaterequal 179 0x19
% /partialdiff 182 0x1A
% /summation 183 0x1B
% /product 184 0x1C
% /pi 185 0x1D
% /integral 186 0x81
% /Omega 189 0x8D
% /radical 195 0x8E
% /approxequal 197 0x8F
% /Delta 198 0x9D
% /lozenge 215 0x9E
%
/TeXBase1Encoding [
% 0x00
/.notdef /dotaccent /fi /fl
/fraction /hungarumlaut /Lslash /lslash
/ogonek /ring /.notdef /breve
/minus /.notdef /Zcaron /zcaron
% 0x10
/caron /dotlessi /dotlessj /ff
/ffi /ffl /notequal /infinity
/lessequal /greaterequal /partialdiff /summation
/product /pi /grave /quotesingle
% 0x20
/space /exclam /quotedbl /numbersign
/dollar /percent /ampersand /quoteright
/parenleft /parenright /asterisk /plus
/comma /hyphen /period /slash
% 0x30
/zero /one /two /three
/four /five /six /seven
/eight /nine /colon /semicolon
/less /equal /greater /question
% 0x40
/at /A /B /C
/D /E /F /G
/H /I /J /K
/L /M /N /O
% 0x50
/P /Q /R /S
/T /U /V /W
/X /Y /Z /bracketleft
/backslash /bracketright /asciicircum /underscore
% 0x60
/quoteleft /a /b /c
/d /e /f /g
/h /i /j /k
/l /m /n /o
% 0x70
/p /q /r /s
/t /u /v /w
/x /y /z /braceleft
/bar /braceright /asciitilde /.notdef
% 0x80
/Euro /integral /quotesinglbase /florin
/quotedblbase /ellipsis /dagger /daggerdbl
/circumflex /perthousand /Scaron /guilsinglleft
/OE /Omega /radical /approxequal
% 0x90
/.notdef /.notdef /.notdef /quotedblleft
/quotedblright /bullet /endash /emdash
/tilde /trademark /scaron /guilsinglright
/oe /Delta /lozenge /Ydieresis
% 0xA0
/.notdef /exclamdown /cent /sterling
/currency /yen /brokenbar /section
/dieresis /copyright /ordfeminine /guillemotleft
/logicalnot /hyphen /registered /macron
% 0xB0
/degree /plusminus /twosuperior /threesuperior
/acute /mu /paragraph /periodcentered
/cedilla /onesuperior /ordmasculine /guillemotright
/onequarter /onehalf /threequarters /questiondown
% 0xC0
/Agrave /Aacute /Acircumflex /Atilde
/Adieresis /Aring /AE /Ccedilla
/Egrave /Eacute /Ecircumflex /Edieresis
/Igrave /Iacute /Icircumflex /Idieresis
% 0xD0
/Eth /Ntilde /Ograve /Oacute
/Ocircumflex /Otilde /Odieresis /multiply
/Oslash /Ugrave /Uacute /Ucircumflex
/Udieresis /Yacute /Thorn /germandbls
% 0xE0
/agrave /aacute /acircumflex /atilde
/adieresis /aring /ae /ccedilla
/egrave /eacute /ecircumflex /edieresis
/igrave /iacute /icircumflex /idieresis
% 0xF0
/eth /ntilde /ograve /oacute
/ocircumflex /otilde /odieresis /divide
/oslash /ugrave /uacute /ucircumflex
/udieresis /yacute /thorn /ydieresis
] def
%%EndProcSet
%%BeginProcSet: texps.pro 0 0
%!
TeXDict begin/rf{findfont dup length 1 add dict begin{1 index/FID ne 2
index/UniqueID ne and{def}{pop pop}ifelse}forall[1 index 0 6 -1 roll
exec 0 exch 5 -1 roll VResolution Resolution div mul neg 0 0]FontType 0
ne{/Metrics exch def dict begin Encoding{exch dup type/integertype ne{
pop pop 1 sub dup 0 le{pop}{[}ifelse}{FontMatrix 0 get div Metrics 0 get
div def}ifelse}forall Metrics/Metrics currentdict end def}{{1 index type
/nametype eq{exit}if exch pop}loop}ifelse[2 index currentdict end
definefont 3 -1 roll makefont/setfont cvx]cvx def}def/ObliqueSlant{dup
sin S cos div neg}B/SlantFont{4 index mul add}def/ExtendFont{3 -1 roll
mul exch}def/ReEncodeFont{CharStrings rcheck{/Encoding false def dup[
exch{dup CharStrings exch known not{pop/.notdef/Encoding true def}if}
forall Encoding{]exch pop}{cleartomark}ifelse}if/Encoding exch def}def
end
%%EndProcSet
%%BeginFont: CMSY10
%!PS-AdobeFont-1.1: CMSY10 1.0
%%CreationDate: 1991 Aug 15 07:20:57
% Copyright (C) 1997 American Mathematical Society. All Rights Reserved.
11 dict begin
/FontInfo 7 dict dup begin
/version (1.0) readonly def
/Notice (Copyright (C) 1997 American Mathematical Society. All Rights Reserved) readonly def
/FullName (CMSY10) readonly def
/FamilyName (Computer Modern) readonly def
/Weight (Medium) readonly def
/ItalicAngle -14.035 def
/isFixedPitch false def
end readonly def
/FontName /CMSY10 def
/PaintType 0 def
/FontType 1 def
/FontMatrix [0.001 0 0 0.001 0 0] readonly def
/Encoding 256 array
0 1 255 {1 index exch /.notdef put} for
dup 49 /infinity put
readonly def
/FontBBox{-29 -960 1116 775}readonly def
currentdict end
currentfile eexec
D9D66F633B846A97B686A97E45A3D0AA052F09F9C8ADE9D907C058B87E9B6964
7D53359E51216774A4EAA1E2B58EC3176BD1184A633B951372B4198D4E8C5EF4
A213ACB58AA0A658908035BF2ED8531779838A960DFE2B27EA49C37156989C85
E21B3ABF72E39A89232CD9F4237FC80C9E64E8425AA3BEF7DED60B122A52922A
221A37D9A807DD01161779DDE7D31FF2B87F97C73D63EECDDA4C49501773468A
27D1663E0B62F461F6E40A5D6676D1D12B51E641C1D4E8E2771864FC104F8CBF
5B78EC1D88228725F1C453A678F58A7E1B7BD7CA700717D288EB8DA1F57C4F09
0ABF1D42C5DDD0C384C7E22F8F8047BE1D4C1CC8E33368FB1AC82B4E96146730
DE3302B2E6B819CB6AE455B1AF3187FFE8071AA57EF8A6616B9CB7941D44EC7A
71A7BB3DF755178D7D2E4BB69859EFA4BBC30BD6BB1531133FD4D9438FF99F09
4ECC068A324D75B5F696B8688EEB2F17E5ED34CCD6D047A4E3806D000C199D7C
515DB70A8D4F6146FE068DC1E5DE8BC5703711DA090312BA3FC00A08C453C609
C627A8B518C4140F0C0212E1C6EAC73B9B3029E0B1EB94AB6921DFD12A542808
7B005344D6744684E93F16CED1D11148AFD2F2696B50FBADDD8D83DEBDB58902
90B93AD039EE5F636481C7FBFBB679996F3E39916AE1085D8F0479B55FE6B787
098346EA8686AADF0E1F6A3AEEBD74BB69C6A6B9EF769D79E92BD00B449FAB4B
0911B555B06401A07CCBD231D9225462203F42EE627BEF718BCA9FE8959AF0A4
B1DDA92E6550C5A671141CB39DFB19341FF4D3DB06374CC05685E9F816FC5894
54E661345EE2F3A2B2DB82DFFF8A0EA594090A47835C5A786B3D14A02ABAB331
D6C4DC4E385A214B9D9A5FED0014AB08ACBA5B0DBD7A6B645C18A26E312B5BDB
154DE31744BC4847382CFBF30F68CEDD959DFA9AE364536ADCC2CE52B3D61FA2
1D7FAAAD16914457DA12D716B5B5DDD78428A96B4BC86B5AB2C9BF76CFFD4436
E607C98C95AD
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
cleartomark
%%EndFont
%%BeginFont: CMMI10
%!PS-AdobeFont-1.1: CMMI10 1.100
%%CreationDate: 1996 Jul 23 07:53:57
% Copyright (C) 1997 American Mathematical Society. All Rights Reserved.
11 dict begin
/FontInfo 7 dict dup begin
/version (1.100) readonly def
/Notice (Copyright (C) 1997 American Mathematical Society. All Rights Reserved) readonly def
/FullName (CMMI10) readonly def
/FamilyName (Computer Modern) readonly def
/Weight (Medium) readonly def
/ItalicAngle -14.04 def
/isFixedPitch false def
end readonly def
/FontName /CMMI10 def
/PaintType 0 def
/FontType 1 def
/FontMatrix [0.001 0 0 0.001 0 0] readonly def
/Encoding 256 array
0 1 255 {1 index exch /.notdef put} for
dup 60 /less put
dup 62 /greater put
readonly def
/FontBBox{-32 -250 1048 750}readonly def
currentdict end
currentfile eexec
D9D66F633B846A97B686A97E45A3D0AA0529731C99A784CCBE85B4993B2EEBDE
3B12D472B7CF54651EF21185116A69AB1096ED4BAD2F646635E019B6417CC77B
532F85D811C70D1429A19A5307EF63EB5C5E02C89FC6C20F6D9D89E7D91FE470
B72BEFDA23F5DF76BE05AF4CE93137A219ED8A04A9D7D6FDF37E6B7FCDE0D90B
986423E5960A5D9FBB4C956556E8DF90CBFAEC476FA36FD9A5C8175C9AF513FE
D919C2DDD26BDC0D99398B9F4D03D5993DFC0930297866E1CD0A319B6B1FD958
9E394A533A081C36D456A09920001A3D2199583EB9B84B4DEE08E3D12939E321
990CD249827D9648574955F61BAAA11263A91B6C3D47A5190165B0C25ABF6D3E
6EC187E4B05182126BB0D0323D943170B795255260F9FD25F2248D04F45DFBFB
DEF7FF8B19BFEF637B210018AE02572B389B3F76282BEB29CC301905D388C721
59616893E774413F48DE0B408BC66DCE3FE17CB9F84D205839D58014D6A88823
D9320AE93AF96D97A02C4D5A2BB2B8C7925C4578003959C46E3CE1A2F0EAC4BF
8B9B325E46435BDE60BC54D72BC8ACB5C0A34413AC87045DC7B84646A324B808
6FD8E34217213E131C3B1510415CE45420688ED9C1D27890EC68BD7C1235FAF9
1DAB3A369DD2FC3BE5CF9655C7B7EDA7361D7E05E5831B6B8E2EEC542A7B38EE
03BE4BAC6079D038ACB3C7C916279764547C2D51976BABA94BA9866D79F13909
95AA39B0F03103A07CBDF441B8C5669F729020AF284B7FF52A29C6255FCAACF1
74109050FBA2602E72593FBCBFC26E726EE4AEF97B7632BC4F5F353B5C67FED2
3EA752A4A57B8F7FEFF1D7341D895F0A3A0BE1D8E3391970457A967EFF84F6D8
47750B1145B8CC5BD96EE7AA99DDC9E06939E383BDA41175233D58AD263EBF19
AFC0E2F840512D321166547B306C592B8A01E1FA2564B9A26DAC14256414E4C8
42616728D918C74D13C349F4186EC7B9708B86467425A6FDB3A396562F7EE4D8
40B43621744CF8A23A6E532649B66C2A0002DD04F8F39618E4F572819DD34837
B5A08E643FDCA1505AF6A1FA3DDFD1FA758013CAED8ACDDBBB334D664DFF5B53
95601766777978D01677B8D19E1B10A078432D2884BB4F7B8C3293B68BB78100
16724E495064BA0168CC86D413CB48560D6D318357397832F7A858CD82030C7D
8A4A1919716E8B26AFF8789AAF489EE4E0A88DC477551A87C7DF2856189E4596
FE015956AFE5CC019F5CA6323A12B763B7B08B92C1A2940D3C566C43729E5482
63C6DC5E834AEB4DAFB5AE8F0B8931A4687C94D11587B9071C8D81DA14F12776
53A1985A3EBE37827656BD4635E03F09C3231F906874645E7DB3E59045A59D67
E745D8487CF73FC50F64060544F624F357BC998A87FBE468DEBB38A09449EBCA
D041D7C29225ACD16CB8A59E87924D15A9125F064710A6CCCA3AD3103D8FCC94
CC3571C6F9192774FCFE5BB42A14B27960903144D28BF047BF4C77646EA7BF6F
440D4EDEB712C63F2E8080419E42D1D58EED685EB5CDD49F80DB6E5553B519FA
C6A39A093155802F3EC607721F390307E91ECB597ABA60A537E3F8C045BF5DD3
D88CF6518D37FCD95D2F295D902D617440D23516D962F47750A682A319ACE1
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
0000000000000000000000000000000000000000000000000000000000000000
cleartomark
%%EndFont
TeXDict begin 40258431 52099146 1000 600 600 (paper-letter/doc.dvi)
@start /Fa 206[83 49[{}1 83.022 /CMSY10 rf /Fb 134[50
50 50 50 50 50 50 50 50 50 50 50 50 50 50 1[50 50 50
50 50 50 50 50 50 54[50 42[{TeXBase1Encoding ReEncodeFont}25
83.022 /Courier-Bold rf /Fc 193[65 1[65 60[{}2 83.022
/CMMI10 rf /Fd 134[50 50 72 50 55 28 50 33 1[55 55 55
83 22 50 1[22 55 55 28 55 55 50 55 55 9[94 1[72 61 66
72 1[66 2[83 55 2[28 72 78 61 66 72 72 9[55 55 55 55
55 55 55 55 55 55 1[28 33 42[50 2[{TeXBase1Encoding ReEncodeFont}51
99.6264 /Helvetica rf /Fe 190[39 65[{TeXBase1Encoding ReEncodeFont}1
58.1154 /Helvetica rf /Ff 137[33 33 18 26 22 1[33 1[33
52 18 2[18 33 33 1[29 33 1[33 29 8[48 3[41 37 4[48 4[22
5[44 1[48 18[17 46[{TeXBase1Encoding ReEncodeFont}24
66.4176 /Times-Roman rf /Fg 103[50 15[50 10[50 1[50 1[50
50 50 50 50 50 50 50 50 50 50 50 50 50 50 50 50 50 50
50 50 50 50 50 50 1[50 1[50 50 50 2[50 50 1[50 50 50
50 1[50 50 50 50 50 1[50 50 50 50 50 50 50 50 50 50 9[50
3[50 1[50 2[50 50 50 50 50 50 50 50 1[50 50 50 50 50
33[{TeXBase1Encoding ReEncodeFont}70 83.022 /Courier
rf /Fh 130[45 45 45 45 45 45 45 45 45 45 45 45 45 45
45 45 45 45 45 45 45 45 45 45 45 45 45 45 45 1[45 1[45
45 45 45 1[45 45 1[45 45 45 45 1[45 1[45 45 45 1[45 45
2[45 45 45 45 45 45 45 1[45 45 45 1[45 45 3[45 1[45 45
45 45 45 45 45 45 45 45 45 45 1[45 45 45 1[45 45 33[{
TeXBase1Encoding ReEncodeFont}76 74.7198 /Courier rf
/Fi 134[37 37 55 37 42 23 32 32 42 42 42 42 60 23 37
23 23 42 42 23 37 42 37 42 42 9[69 1[60 46 42 51 1[51
1[55 69 46 55 1[28 1[60 1[51 60 55 1[51 11[42 42 42 42
42 1[23 21 28 5[28 36[42 2[{TeXBase1Encoding ReEncodeFont}51
83.022 /Times-Italic rf /Fj 134[42 42 60 1[46 23 42 28
1[46 46 46 69 18 42 1[18 46 46 23 46 46 42 46 46 8[55
3[51 55 60 1[55 2[69 46 2[23 60 65 51 55 60 60 1[55 7[46
46 46 46 46 46 46 46 46 46 1[23 28 45[{TeXBase1Encoding ReEncodeFont}49
83.022 /Helvetica rf /Fk 190[42 15[29 49[{TeXBase1Encoding ReEncodeFont}
2 58.1154 /Times-Roman rf /Fl 190[42 65[{TeXBase1Encoding ReEncodeFont}
1 58.1154 /Times-Bold rf /Fm 134[42 42 60 42 46 28 32
37 1[46 42 46 69 23 46 1[23 46 42 28 37 46 37 1[42 8[60
83 1[60 55 46 2[51 65 60 78 55 2[32 1[65 51 55 60 60
1[60 6[28 42 42 42 42 42 42 42 42 42 3[28 3[28 28 36[46
46 2[{TeXBase1Encoding ReEncodeFont}54 83.022 /Times-Bold
rf /Fn 190[36 15[25 49[{TeXBase1Encoding ReEncodeFont}2
49.8132 /Times-Roman rf /Fo 134[37 37 54 37 37 21 29
25 37 37 37 37 58 21 37 21 21 37 37 25 33 37 33 37 33
8[54 3[46 3[42 3[46 2[25 3[46 3[54 5[21 12[19 1[19 4[25
36[42 2[{TeXBase1Encoding ReEncodeFont}37 74.7198 /Times-Roman
rf /Fp 139[25 29 33 14[33 42 37 31[54 65[{TeXBase1Encoding ReEncodeFont}
7 74.7198 /Times-Bold rf /Fq 134[37 37 54 37 42 21 37
25 1[42 42 42 62 17 37 1[17 42 42 21 42 42 37 42 42 14[54
4[62 42 6[50 54 2[50 76 5[21 5[42 1[42 2[21 21 25 42[37
2[{TeXBase1Encoding ReEncodeFont}37 74.7198 /Helvetica
rf /Fr 7[42 63[28 15[28 15[28 83 2[37 37 10[28 13[37
42 42 60 42 42 23 32 28 42 42 42 42 65 23 42 23 23 42
42 28 37 42 37 42 37 28 6[60 60 78 60 60 51 46 55 1[46
60 60 74 51 60 32 28 60 60 46 51 60 55 55 60 1[37 3[23
23 42 42 42 42 42 42 42 42 42 42 23 21 28 21 2[28 28
28 65 4[28 29[46 46 2[{TeXBase1Encoding ReEncodeFont}83
83.022 /Times-Roman rf /Fs 134[60 60 2[66 33 60 40 1[66
66 66 100 27 60 1[27 66 66 1[66 66 60 1[66 8[80 113 80
86 73 80 86 1[80 93 86 100 66 80 60 33 1[93 73 80 86
86 80 8[66 66 66 66 66 66 66 66 66 2[33 1[33 44[{
TeXBase1Encoding ReEncodeFont}51 119.552 /Helvetica rf
/Ft 140[50 6[22 6[55 3[55 14[72 28[55 1[55 55 3[28 46[{
TeXBase1Encoding ReEncodeFont}9 99.6264 /Helvetica-Oblique
rf /Fu 134[103 3[115 57 4[115 115 172 3[46 115 115 1[115
1[103 18[138 11[149 68[{TeXBase1Encoding ReEncodeFont}13
206.559 /Helvetica rf end
%%EndProlog
%%BeginSetup
%%Feature: *Resolution 600dpi
TeXDict begin
%%BeginPaperSize: Letter
/setpagedevice where
{ pop << /PageSize [612 792] >> setpagedevice }
{ /letter where { pop letter } if }
ifelse
%%EndPaperSize
end
%%EndSetup
%%Page: 1 1
TeXDict begin 1 0 bop 0 83 3901 9 v 1983 354 a Fu(Documenting)57
b(Python)3285 528 y Ft(Release)29 b(2.5.3)2987 882 y
Fs(F)-5 b(red)33 b(L.)h(Dr)o(ak)n(e)n(,)g(Jr)-6 b(.)3186
1237 y Fr(19th)20 b(December)m(,)e(2008)3503 1383 y(PythonLabs)3102
1483 y(Email:)25 b Fq(fdr)o(ak)o(
[email protected])1811 1705
y Fp(Abstract)208 1856 y Fo(The)16 b(Python)g(language)i(has)e(a)g
(substantial)h(body)g(of)f(documentation,)i(much)f(of)f(it)f(contrib)o
(uted)i(by)f(v)n(arious)h(authors.)23 b(The)16 b(markup)208
1947 y(used)k(for)g(the)h(Python)f(documentation)i(is)e(based)h(on)g(L)
1652 1930 y Fn(A)1677 1947 y Fo(T)1711 1964 y(E)1746
1947 y(X)f(and)h(requires)f(a)g(signi\002cant)h(set)f(of)g(macros)g
(written)g(speci\002cally)g(for)208 2038 y(documenting)e(Python.)23
b(This)16 b(document)h(describes)g(the)g(macros)g(introduced)g(to)g
(support)g(Python)g(documentation)h(and)f(ho)n(w)g(the)o(y)208
2130 y(should)j(be)f(used)g(to)g(support)h(a)f(wide)g(range)g(of)g
(output)h(formats.)320 2221 y(This)i(document)i(describes)g(the)f
(document)h(classes)f(and)h(special)f(markup)h(used)f(in)g(the)g
(Python)g(documentation.)37 b(Authors)208 2312 y(may)20
b(use)g(this)g(guide,)g(in)g(conjunction)h(with)f(the)g(template)g
(\002les)f(pro)o(vided)i(with)f(the)f(distrib)o(ution,)h(to)g(create)g
(or)g(maintain)g(whole)208 2404 y(documents)g(or)f(sections.)320
2495 y(If)26 b(you')l(re)h(interested)g(in)f(contrib)o(uting)h(to)g
(Python')l(s)g(documentation,)j(there')l(s)c(no)h(need)h(to)e(learn)h
(L)3041 2478 y Fn(A)3066 2495 y Fo(T)3100 2512 y(E)3135
2495 y(X)f(if)g(you')l(re)h(not)g(so)208 2586 y(inclined;)19
b(plain)g(te)o(xt)g(contrib)o(utions)g(are)g(more)g(than)h(welcome)f
(as)g(well.)0 2866 y Fs(Contents)0 3052 y Fm(1)83 b(Intr)o(oduction)
3281 b(2)0 3235 y(2)83 b(Dir)o(ectory)18 b(Structur)o(e)3032
b(2)0 3417 y(3)83 b(Style)20 b(Guide)3320 b(3)0 3600
y(4)83 b(L)150 3584 y Fl(A)180 3600 y Fm(T)221 3619 y(E)266
3600 y(X)21 b(Primer)3257 b(4)125 3700 y Fr(4.1)85 b(Syntax)96
b(.)42 b(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)
f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g
(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143
b(5)125 3799 y(4.2)85 b(Hierarchical)20 b(Structure)89
b(.)41 b(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)
g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h
(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143 b(7)125 3899 y(4.3)85
b(Common)19 b(En)m(vironments)93 b(.)41 b(.)g(.)h(.)f(.)g(.)g(.)h(.)f
(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)
h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143
b(7)0 4081 y Fm(5)83 b(Document)20 b(Classes)3090 b(8)0
4264 y(6)83 b(Special)20 b(Markup)h(Constructs)2755 b(8)125
4364 y Fr(6.1)85 b(Markup)19 b(for)h(the)g(Preamble)50
b(.)41 b(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)
g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f
(.)g(.)g(.)h(.)f(.)g(.)g(.)143 b(8)125 4463 y(6.2)85
b(Meta-information)18 b(Markup)74 b(.)41 b(.)h(.)f(.)g(.)g(.)h(.)f(.)g
(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)
f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)143
b(9)125 4563 y(6.3)85 b(Information)18 b(Units)42 b(.)f(.)g(.)h(.)f(.)g
(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)
f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g
(.)h(.)f(.)g(.)g(.)143 b(9)125 4663 y(6.4)85 b(Sho)n(wing)19
b(Code)h(Examples)50 b(.)41 b(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h
(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)
g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(11)125
4762 y(6.5)85 b(Inline)20 b(Markup)97 b(.)42 b(.)f(.)g(.)h(.)f(.)g(.)g
(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)
g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h
(.)f(.)g(.)g(.)102 b(11)125 4862 y(6.6)85 b(Miscellaneous)20
b(T)-6 b(e)o(xt)20 b(Markup)81 b(.)42 b(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h
(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)
g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(15)125
4962 y(6.7)85 b(Module-speci\002c)19 b(Markup)63 b(.)41
b(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h
(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)
g(.)h(.)f(.)g(.)g(.)102 b(15)125 5061 y(6.8)85 b(Library-le)n(v)o(el)18
b(Markup)43 b(.)f(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f
(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)
h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(16)125
5161 y(6.9)85 b(T)-7 b(able)21 b(Markup)46 b(.)41 b(.)h(.)f(.)g(.)h(.)f
(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)
h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g
(.)g(.)h(.)f(.)g(.)g(.)102 b(16)125 5260 y(6.10)43 b(Reference)20
b(List)h(Markup)54 b(.)41 b(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h
(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)
g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(19)125
5360 y(6.11)43 b(Inde)o(x-generating)16 b(Markup)99 b(.)41
b(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f
(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)
h(.)f(.)g(.)g(.)102 b(20)p eop end
%%Page: 2 2
TeXDict begin 2 1 bop 125 83 a Fr(6.12)43 b(Grammar)19
b(Production)g(Displays)60 b(.)41 b(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g
(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)
f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(21)125
183 y(6.13)43 b(Graphical)20 b(Interf)o(ace)e(Components)53
b(.)41 b(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)
g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f
(.)g(.)g(.)102 b(22)0 365 y Fm(7)83 b(Pr)o(ocessing)19
b(T)-8 b(ools)3109 b(23)125 465 y Fr(7.1)85 b(External)20
b(T)-7 b(ools)91 b(.)42 b(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h
(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)
g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102
b(23)125 565 y(7.2)85 b(Internal)19 b(T)-7 b(ools)53
b(.)41 b(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)
h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g
(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102
b(23)125 664 y(7.3)85 b(W)-7 b(orking)20 b(on)g(Cygwin)86
b(.)42 b(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)
f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g
(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(24)0 847 y Fm(8)83
b(Including)21 b(Graphics)3002 b(24)0 1029 y(9)83 b(Futur)o(e)19
b(Dir)o(ections)3065 b(25)125 1129 y Fr(9.1)85 b(Structured)19
b(Documentation)69 b(.)41 b(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g
(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)
f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)102 b(26)125
1229 y(9.2)85 b(Discussion)21 b(F)o(orums)62 b(.)41 b(.)h(.)f(.)g(.)g
(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)
g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)g(.)h(.)f(.)g(.)h(.)f(.)g(.)g(.)h
(.)f(.)g(.)g(.)102 b(26)0 1411 y Fm(Index)3614 b(27)p
0 1558 3901 9 v 0 1985 a Fs(1)120 b(Introduction)0 2218
y Fr(Python')-5 b(s)17 b(documentation)e(has)k(long)e(been)h
(considered)e(to)i(be)g(good)f(for)g(a)i(free)f(programming)c
(language.)23 b(There)17 b(are)h(a)h(number)d(of)0 2318
y(reasons)j(for)h(this,)g(the)g(most)g(important)e(being)h(the)h(early)
g(commitment)e(of)i(Python')-5 b(s)19 b(creator)m(,)f(Guido)h(v)n(an)g
(Rossum,)h(to)g(pro)o(viding)0 2417 y(documentation)g(on)i(the)h
(language)e(and)h(its)h(libraries,)g(and)f(the)h(continuing)d(in)m(v)n
(olv)o(ement)g(of)j(the)g(user)f(community)f(in)h(pro)o(viding)0
2517 y(assistance)f(for)e(creating)g(and)h(maintaining)f
(documentation.)0 2664 y(The)k(in)m(v)n(olv)o(ement)d(of)j(the)g
(community)e(tak)o(es)i(man)o(y)f(forms,)h(from)f(authoring)f(to)i(b)n
(ug)g(reports)f(to)h(just)h(plain)e(complaining)f(when)0
2763 y(the)27 b(documentation)c(could)j(be)g(more)g(complete)g(or)g
(easier)h(to)g(use.)44 b(All)27 b(of)g(these)f(forms)g(of)h(input)f
(from)f(the)i(community)d(ha)n(v)o(e)0 2863 y(pro)o(v)o(ed)18
b(useful)h(during)g(the)h(time)h(I')l(v)o(e)e(been)g(in)m(v)n(olv)o(ed)
f(in)j(maintaining)d(the)i(documentation.)0 3010 y(This)29
b(document)d(is)k(aimed)e(at)h(authors)f(and)g(potential)g(authors)f
(of)i(documentation)c(for)j(Python.)49 b(More)28 b(speci\002cally)-5
b(,)30 b(it)g(is)f(for)0 3110 y(people)23 b(contrib)n(uting)f(to)j(the)
f(standard)f(documentation)e(and)j(de)n(v)o(eloping)d(additional)i
(documents)g(using)h(the)g(same)g(tools)h(as)g(the)0
3209 y(standard)c(documents.)29 b(This)22 b(guide)f(will)i(be)f(less)h
(useful)e(for)h(authors)f(using)g(the)h(Python)f(documentation)e(tools)
j(for)f(topics)h(other)0 3309 y(than)e(Python,)f(and)g(less)i(useful)f
(still)h(for)f(authors)f(not)h(using)g(the)g(tools)g(at)h(all.)0
3456 y(The)g(material)h(in)g(this)g(guide)f(is)i(intended)d(to)i
(assist)h(authors)e(using)g(the)h(Python)e(documentation)f(tools.)30
b(It)22 b(includes)f(information)0 3555 y(on)c(the)h(source)f(distrib)n
(ution)f(of)h(the)h(standard)e(documentation,)f(a)j(discussion)f(of)g
(the)h(document)e(types,)h(reference)f(material)h(on)h(the)0
3655 y(markup)k(de\002ned)i(in)g(the)g(document)f(classes,)j(a)f(list)g
(of)f(the)g(e)o(xternal)f(tools)i(needed)e(for)g(processing)g
(documents,)h(and)f(reference)0 3755 y(material)f(on)f(the)h(tools)g
(pro)o(vided)e(with)i(the)g(documentation)d(resources.)29
b(At)23 b(the)f(end,)f(there)h(is)h(also)f(a)h(section)e(discussing)h
(future)0 3854 y(directions)d(for)h(the)g(Python)f(documentation)e(and)
j(where)f(to)i(turn)e(for)h(more)f(information.)0 4001
y(If)e(your)f(interest)i(is)g(in)g(contrib)n(uting)d(to)j(the)f(Python)
f(documentation,)f(b)n(ut)j(you)e(don')o(t)g(ha)n(v)o(e)h(the)g(time)h
(or)f(inclination)f(to)i(learn)e(L)3733 3984 y Fk(A)3763
4001 y Fr(T)3800 4020 y(E)3840 4001 y(X)0 4101 y(and)h(the)h(markup)e
(structures)i(documented)d(here,)i(there')-5 b(s)18 b(a)g(welcoming)f
(place)g(for)h(you)f(among)f(the)i(Python)f(contrib)n(utors)f(as)i
(well.)0 4200 y(An)o(y)23 b(time)h(you)f(feel)g(that)h(you)f(can)g
(clarify)g(e)o(xisting)g(documentation)e(or)i(pro)o(vide)f
(documentation)e(that')-5 b(s)24 b(missing,)h(the)e(e)o(xisting)0
4300 y(documentation)d(team)k(will)g(gladly)e(w)o(ork)h(with)g(you)g
(to)g(inte)o(grate)f(your)g(te)o(xt,)i(dealing)e(with)h(the)h(markup)d
(for)i(you.)33 b(Please)24 b(don')o(t)0 4400 y(let)d(the)f(material)g
(in)g(this)h(document)d(stand)i(between)f(the)i(documentation)c(and)j
(your)e(desire)i(to)h(help)f(out!)0 4727 y Fs(2)120 b(Director)t(y)33
b(Str)r(ucture)0 4960 y Fr(The)25 b(source)g(distrib)n(ution)f(for)h
(the)g(standard)f(Python)h(documentation)d(contains)j(a)h(lar)o(ge)e
(number)g(of)h(directories.)40 b(While)26 b(third-)0
5059 y(party)c(documents)e(do)j(not)f(need)g(to)g(be)h(placed)e(into)i
(this)g(structure)e(or)i(need)e(to)i(be)f(placed)g(within)h(a)f
(similar)h(structure,)f(it)h(can)g(be)0 5159 y(helpful)d(to)g(kno)n(w)g
(where)g(to)h(look)f(for)g(e)o(xamples)g(and)g(tools)h(when)f(de)n(v)o
(eloping)e(ne)n(w)i(documents)f(using)i(the)f(Python)g(documenta-)0
5259 y(tion)g(tools.)25 b(This)20 b(section)g(describes)g(this)h
(directory)d(structure.)p 0 5549 3901 4 v 0 5649 a Fj(2)3006
b(2)83 b(Director)r(y)23 b(Str)q(ucture)p eop end
%%Page: 3 3
TeXDict begin 3 2 bop 0 83 a Fr(The)21 b(documentation)e(sources)i(are)
g(usually)g(placed)g(within)h(the)f(Python)g(source)f(distrib)n(ution)h
(as)h(the)g(top-le)n(v)o(el)d(directory)h(`)p Fq(Doc/)p
Fr(',)0 183 y(b)n(ut)g(are)g(not)g(dependent)e(on)i(the)g(Python)f
(source)h(distrib)n(ution)f(in)h(an)o(y)f(w)o(ay)-5 b(.)0
330 y(The)21 b(`)p Fq(Doc/)p Fr(')f(directory)f(contains)h(a)i(fe)n(w)f
(\002les)h(and)e(se)n(v)o(eral)g(subdirectories.)26 b(The)20
b(\002les)i(are)f(mostly)g(self-e)o(xplanatory)-5 b(,)17
b(including)i(a)0 429 y(`)p Fq(README)p Fr(')h(and)f(a)i(`)p
Fq(Mak)o(e\002le)p Fr('.)i(The)d(directories)f(f)o(all)i(into)f(three)g
(cate)o(gories:)0 659 y Fm(Document)g(Sour)o(ces)208
759 y Fr(The)e(L)377 742 y Fk(A)407 759 y Fr(T)444 777
y(E)484 759 y(X)h(sources)f(for)g(each)h(document)d(are)j(placed)f(in)h
(a)g(separate)g(directory)-5 b(.)22 b(These)d(directories)e(are)i(gi)n
(v)o(en)f(short)g(names)208 858 y(which)h(v)n(aguely)g(indicate)g(the)i
(document)d(in)i(each:)879 1071 y Fm(Dir)o(ectory)p 1377
1100 4 100 v 208 w(Document)g(T)o(itle)p 829 1104 2450
4 v 879 1173 a Fq(api/)p 1377 1203 4 100 v 428 w Fi(The)g(Python/C)f
(API)879 1273 y Fq(dist/)p 1377 1303 V 412 w Fi(Distrib)n(uting)h
(Python)f(Modules)879 1373 y Fq(doc/)p 1377 1403 V 408
w Fi(Documenting)f(Python)879 1472 y Fq(e)n(xt/)p 1377
1502 V 431 w Fi(Extending)g(and)h(Embedding)f(the)i(Python)f(Interpr)m
(eter)879 1572 y Fq(inst/)p 1377 1602 V 412 w Fi(Installing)g(Python)g
(Modules)879 1672 y Fq(lib/)p 1377 1702 V 453 w Fi(Python)g(Libr)o(ary)
h(Refer)m(ence)879 1771 y Fq(mac/)p 1377 1801 V 388 w
Fi(Macintosh)f(Module)g(Refer)m(ence)879 1871 y Fq(ref/)p
1377 1901 V 441 w Fi(Python)g(Refer)m(ence)g(Manual)879
1970 y Fq(tut/)p 1377 2000 V 445 w Fi(Python)g(T)-5 b(utorial)879
2070 y Fq(whatsne)o(w/)p 1377 2100 V 196 w Fi(What')m(s)19
b(Ne)o(w)i(in)g(Python)e(2.5)0 2282 y Fm(F)n(ormat-Speci\002c)g(Output)
208 2381 y Fr(Most)k(output)f(formats)g(ha)n(v)o(e)h(a)g(directory)f
(which)h(contains)f(a)i(`)p Fq(Mak)o(e\002le)p Fr(')d(which)i(controls)
f(the)h(generation)f(of)g(that)i(format)208 2481 y(and)j(pro)o(vides)f
(storage)h(for)h(the)g(formatted)e(documents.)47 b(The)27
b(only)g(v)n(ariations)g(within)h(this)g(cate)o(gory)e(are)i(the)g
(Portable)208 2581 y(Document)e(F)o(ormat)i(\(PDF\))g(and)g(PostScript)
g(v)o(ersions)g(are)g(placed)g(in)g(the)h(directories)e(`)p
Fq(paper-a4/)p Fr(')e(and)j(`)p Fq(paper-letter/)p Fr(')208
2680 y(\(this)20 b(causes)g(all)g(the)g(temporary)e(\002les)j(created)e
(by)g(L)1743 2664 y Fk(A)1773 2680 y Fr(T)1810 2699 y(E)1850
2680 y(X)h(to)g(be)g(k)o(ept)f(in)i(the)e(same)h(place)g(for)f(each)h
(paper)f(size,)h(where)f(the)o(y)208 2780 y(can)h(be)g(more)f(easily)h
(ignored\).)879 2992 y Fm(Dir)o(ectory)p 1377 3022 V
208 w(Output)g(F)n(ormats)p 829 3025 2450 4 v 879 3095
a Fq(html/)p 1377 3125 4 100 v 387 w Fr(HTML)g(output)879
3195 y Fq(inf)n(o/)p 1377 3225 V 409 w Fr(GNU)g(info)g(output)879
3294 y Fq(isilo/)p 1377 3324 V 399 w Fr(iSilo)g(documents)f(\(for)g(P)o
(alm)h(OS)h(de)n(vices\))879 3394 y Fq(paper-a4/)p 1377
3424 V 227 w Fr(PDF)g(and)e(PostScript,)h(A4)g(paper)879
3494 y Fq(paper-letter/)p 1377 3523 V 143 w Fr(PDF)h(and)e(PostScript,)
h(US-Letter)g(paper)0 3705 y Fm(Supplemental)h(Files)208
3805 y Fr(Some)h(additional)f(directories)h(are)g(used)h(to)g(store)f
(supplemental)f(\002les)j(used)e(for)g(the)h(v)n(arious)f(processes.)32
b(Directories)22 b(are)208 3904 y(included)d(for)h(the)h(shared)f(L)
1015 3888 y Fk(A)1045 3904 y Fr(T)1082 3923 y(E)1121
3904 y(X)i(document)c(classes,)k(the)f(L)1968 3888 y
Fk(A)1998 3904 y Fr(T)2035 3923 y(E)2075 3904 y(X2HTML)e(support,)h
(template)g(\002les)i(for)e(v)n(arious)g(document)208
4004 y(components,)d(and)j(the)g(scripts)h(used)f(to)g(perform)e(v)n
(arious)h(steps)i(in)f(the)h(formatting)d(processes.)879
4216 y Fm(Dir)o(ectory)p 1377 4246 V 208 w(Contents)p
829 4250 2450 4 v 879 4319 a Fq(commonte)n(x/)p 1377
4349 4 100 v 144 w Fr(Document)g(content)h(shared)h(among)f(documents)
879 4419 y Fq(per)q(l/)p 1377 4449 V 402 w Fr(Support)f(for)i(L)1851
4402 y Fk(A)1881 4419 y Fr(T)1918 4438 y(E)1957 4419
y(X2HTML)g(processing)879 4519 y Fq(templates/)p 1377
4548 V 203 w Fr(Example)e(\002les)k(for)d(source)h(documents)879
4618 y Fq(te)n(xinputs/)p 1377 4648 V 230 w Fr(Style)g(implementation)e
(for)i(L)2301 4602 y Fk(A)2331 4618 y Fr(T)2368 4637
y(E)2407 4618 y(X)879 4718 y Fq(tools/)p 1377 4748 V
370 w Fr(Custom)g(processing)f(scripts)0 5022 y Fs(3)120
b(Style)33 b(Guide)0 5255 y Fr(The)20 b(Python)g(documentation)e
(should)i(follo)n(w)g(the)h Fi(Apple)f(Publications)f(Style)i(Guide)f
Fr(where)n(v)o(er)f(possible.)27 b(This)21 b(particular)e(style)0
5354 y(guide)g(w)o(as)i(selected)f(mostly)g(because)g(it)h(seems)f
(reasonable)f(and)h(is)h(easy)f(to)g(get)h(online.)p
0 5549 3901 4 v 3854 5649 a Fj(3)p eop end
%%Page: 4 4
TeXDict begin 4 3 bop 0 83 a Fr(T)-7 b(opics)20 b(which)g(are)g(not)g
(co)o(v)o(ered)e(in)i(the)g(Apple')-5 b(s)20 b(style)h(guide)e(will)i
(be)f(discussed)g(in)h(this)f(document)e(if)j(necessary)-5
b(.)0 230 y(F)o(ootnotes)21 b(are)g(generally)f(discouraged)g(due)h(to)
h(the)f(pain)h(of)f(using)g(footnotes)f(in)i(the)g(HTML)f(con)m(v)o
(ersion)e(of)j(documents.)27 b(F)o(oot-)0 330 y(notes)21
b(may)h(be)f(used)g(when)g(the)o(y)g(are)h(the)f(best)h(w)o(ay)g(to)g
(present)e(speci\002c)i(information.)27 b(When)21 b(a)h(footnote)e
(reference)g(is)j(added)d(at)0 429 y(the)e(end)g(of)g(the)g(sentence,)g
(it)h(should)e(follo)n(w)g(the)h(sentence-ending)e(punctuation.)21
b(The)d(L)2616 413 y Fk(A)2646 429 y Fr(T)2683 448 y(E)2723
429 y(X)h(markup)d(should)h(appear)g(something)0 529
y(lik)o(e)j(this:)236 767 y Fh(This)44 b(sentence)g(has)g(a)h(footnote)
e(reference.\045)326 858 y(\\footnote{This)f(is)j(the)f(footnote)g
(text.})0 1145 y Fr(F)o(ootnotes)19 b(may)h(appear)f(in)h(the)g(middle)
g(of)g(sentences)f(where)h(appropriate.)0 1292 y(Man)o(y)i(special)h
(names)f(are)h(used)f(in)h(the)g(Python)e(documentation,)f(including)h
(the)i(names)f(of)h(operating)d(systems,)k(programming)0
1391 y(languages,)17 b(standards)h(bodies,)h(and)f(the)h(lik)o(e.)25
b(Man)o(y)18 b(of)g(these)h(were)g(assigned)f(L)2390
1375 y Fk(A)2420 1391 y Fr(T)2457 1410 y(E)2497 1391
y(X)h(macros)f(at)i(some)f(point)f(in)h(the)g(distant)f(past,)0
1491 y(and)g(these)h(macros)f(li)n(v)o(ed)g(on)g(long)g(past)h(their)f
(usefulness.)24 b(In)18 b(the)h(current)e(markup,)g(most)i(of)f(these)h
(entities)g(are)g(not)f(assigned)g(an)o(y)0 1591 y(special)h(markup,)e
(b)n(ut)i(the)g(preferred)d(spellings)j(are)g(gi)n(v)o(en)e(here)i(to)g
(aid)f(authors)g(in)h(maintaining)e(the)i(consistenc)o(y)f(of)g
(presentation)0 1690 y(in)i(the)h(Python)e(documentation.)0
1837 y(Other)32 b(terms)g(and)f(w)o(ords)h(deserv)o(e)f(special)h
(mention)f(as)h(well;)39 b(these)32 b(con)m(v)o(entions)e(should)h(be)h
(used)f(to)i(ensure)e(consistenc)o(y)0 1937 y(throughout)17
b(the)j(documentation:)0 2157 y Fm(CPU)41 b Fr(F)o(or)20
b(\223central)g(processing)f(unit.)-6 b(\224)26 b(Man)o(y)20
b(style)h(guides)f(say)h(this)g(should)e(be)i(spelled)f(out)g(on)h(the)
f(\002rst)h(use)g(\(and)f(if)h(you)f(must)208 2257 y(use)j(it,)i(do)e
(so!\).)34 b(F)o(or)22 b(the)i(Python)e(documentation,)f(this)j(abbre)n
(viation)c(should)j(be)g(a)n(v)n(oided)f(since)i(there')-5
b(s)23 b(no)g(reasonable)208 2357 y(w)o(ay)j(to)h(predict)f(which)h
(occurrence)d(will)k(be)e(the)h(\002rst)h(seen)f(by)f(the)h(reader)-5
b(.)44 b(It)27 b(is)h(better)e(to)h(use)g(the)g(w)o(ord)f
(\223processor\224)208 2456 y(instead.)0 2619 y Fm(POSIX)41
b Fr(The)22 b(name)g(assigned)g(to)g(a)h(particular)e(group)f(of)i
(standards.)31 b(This)22 b(is)i(al)o(w)o(ays)e(uppercase.)30
b(Use)23 b(the)f(macro)g Fg(\\POSIX)f Fr(to)208 2718
y(represent)e(this)h(name.)0 2881 y Fm(Python)40 b Fr(The)20
b(name)g(of)g(our)f(f)o(a)n(v)n(orite)h(programming)d(language)h(is)j
(al)o(w)o(ays)g(capitalized.)0 3043 y Fm(Unicode)41 b
Fr(The)20 b(name)g(of)f(a)i(character)e(set)i(and)f(matching)e
(encoding.)23 b(This)e(is)g(al)o(w)o(ays)f(written)g(capitalized.)2
3205 y(U)t Ff(N)t(I)t(X)44 b Fr(The)21 b(name)g(of)g(the)g(operating)e
(system)j(de)n(v)o(eloped)d(at)j(A)-9 b(T&T)20 b(Bell)j(Labs)e(in)g
(the)h(early)f(1970s.)27 b(Use)22 b(the)f(macro)f Fg(\\UNIX)h
Fr(to)208 3305 y(use)f(this)h(name.)0 3631 y Fs(4)120
b(L)209 3604 y Fj(A)246 3631 y Fs(T)299 3662 y(E)365
3631 y(X)33 b(Pr)r(imer)0 3863 y Fr(This)28 b(section)g(is)h(a)f(brief)
g(introduction)d(to)j(L)1323 3847 y Fk(A)1353 3863 y
Fr(T)1390 3882 y(E)1430 3863 y(X)g(concepts)f(and)h(syntax,)h(to)f(pro)
o(vide)e(authors)h(enough)f(information)g(to)i(author)0
3963 y(documents)g(producti)n(v)o(ely)f(without)h(ha)n(ving)h(to)h
(become)e(\223T)1832 3982 y(E)1872 3963 y(Xnicians.)-6
b(\224)53 b(This)30 b(does)g(not)f(teach)g(e)n(v)o(erything)e(needed)i
(to)h(kno)n(w)0 4063 y(about)22 b(writing)h(L)493 4046
y Fk(A)523 4063 y Fr(T)560 4081 y(E)599 4063 y(X)h(for)e(Python)g
(documentation;)f(man)o(y)h(of)h(the)g(standard)f(\223en)m
(vironments\224)e(are)j(not)g(described)e(here)i(\(though)0
4162 y(you)c(will)i(learn)f(ho)n(w)g(to)g(mark)f(something)g(as)i(an)f
(en)m(vironment\).)0 4309 y(Perhaps)27 b(the)h(most)f(important)f
(concept)h(to)h(k)o(eep)f(in)g(mind)g(while)h(marking)e(up)h(Python)g
(documentation)d(is)29 b(that)f(while)f(T)3716 4328 y(E)3756
4309 y(X)i(is)0 4409 y(unstructured,)16 b(L)476 4392
y Fk(A)506 4409 y Fr(T)543 4428 y(E)582 4409 y(X)j(w)o(as)g(designed)e
(as)i(a)f(layer)g(on)g(top)g(of)g(T)1802 4428 y(E)1842
4409 y(X)g(which)g(speci\002cally)g(supports)f(structured)g(markup.)22
b(The)c(Python-)0 4509 y(speci\002c)i(markup)e(is)j(intended)d(to)i(e)o
(xtend)e(the)i(structure)f(pro)o(vided)e(by)i(standard)g(L)2428
4492 y Fk(A)2458 4509 y Fr(T)2495 4527 y(E)2535 4509
y(X)h(document)e(classes)j(to)f(support)e(additional)0
4608 y(information)g(speci\002c)i(to)h(Python.)0 4755
y(L)21 4738 y Fk(A)51 4755 y Fr(T)88 4774 y(E)128 4755
y(X)c(documents)e(contain)h(tw)o(o)h(parts:)23 b(the)17
b(preamble)f(and)g(the)h(body)-5 b(.)22 b(The)16 b(preamble)g(is)h
(used)g(to)g(specify)f(certain)g(metadata)h(about)0 4855
y(the)24 b(document)d(itself,)k(such)e(as)i(the)e(title,)i(the)f(list)h
(of)e(authors,)g(the)h(date,)g(and)f(the)h Fi(class)g
Fr(the)f(document)f(belongs)g(to.)36 b(Additional)0 4954
y(information)15 b(used)i(to)g(control)f(inde)o(x)g(generation)g(and)g
(the)h(use)h(of)f(bibliographic)d(databases)j(can)g(also)h(be)f(placed)
g(in)g(the)g(preamble.)0 5054 y(F)o(or)22 b(most)g(authors,)g(the)g
(preamble)e(can)i(be)h(most)f(easily)g(created)g(by)f(cop)o(ying)g(it)i
(from)e(an)h(e)o(xisting)g(document)e(and)h(modifying)f(a)0
5154 y(fe)n(w)g(k)o(e)o(y)g(pieces)g(of)g(information.)0
5300 y(The)f Fi(class)i Fr(of)e(a)h(document)e(is)j(used)e(to)h(place)g
(a)g(document)d(within)j(a)g(broad)e(cate)o(gory)g(of)i(documents)e
(and)h(set)h(some)g(fundamental)0 5400 y(formatting)14
b(properties.)22 b(F)o(or)16 b(Python)f(documentation,)f(tw)o(o)i
(classes)h(are)f(used:)23 b(the)16 b Fg(manual)g Fr(class)h(and)e(the)i
Fg(howto)e Fr(class.)25 b(These)p 0 5549 3901 4 v 0 5649
a Fj(4)3253 b(4)83 b(L)3444 5631 y Fe(A)3470 5649 y Fj(T)3507
5671 y(E)3553 5649 y(X)23 b(Pr)q(imer)p eop end
%%Page: 5 5
TeXDict begin 5 4 bop 0 83 a Fr(classes)18 b(also)f(de\002ne)f(the)h
(additional)f(markup)f(used)h(to)h(document)e(Python)h(concepts)g(and)g
(structures.)23 b(Speci\002c)17 b(information)e(about)0
183 y(these)20 b(classes)h(is)f(pro)o(vided)d(in)j(section)f(5,)h
(\223Document)e(Classes,)-6 b(\224)21 b(belo)n(w)-5 b(.)24
b(The)19 b(\002rst)h(thing)f(in)h(the)g(preamble)e(is)i(the)g
(declaration)e(of)0 282 y(the)i(document')-5 b(s)19 b(class.)0
429 y(After)h(the)g(class)i(declaration,)c(a)j(number)d(of)i
Fi(macr)l(os)h Fr(are)f(used)g(to)g(pro)o(vide)f(further)f(information)
g(about)h(the)i(document)d(and)i(setup)0 529 y(an)o(y)i(additional)g
(markup)f(that)i(is)h(needed.)32 b(No)23 b(output)f(is)i(generated)d
(from)h(the)h(preamble;)g(it)g(is)h(an)f(error)f(to)h(include)f(free)h
(te)o(xt)f(in)0 628 y(the)e(preamble)f(because)g(it)i(w)o(ould)f(cause)
g(output.)0 775 y(The)30 b(document)f(body)g(follo)n(ws)h(the)h
(preamble.)55 b(This)30 b(contains)g(all)i(the)e(printed)g(components)e
(of)i(the)h(document)e(mark)o(ed)g(up)0 875 y(structurally)-5
b(.)23 b(Generic)18 b(L)722 858 y Fk(A)752 875 y Fr(T)789
894 y(E)829 875 y(X)i(structures)e(include)h(hierarchical)e(sections,)j
(numbered)c(and)j(b)n(ulleted)g(lists,)h(and)f(special)g(structures)0
975 y(for)h(the)g(document)e(abstract)i(and)g(inde)o(x)o(es.)0
1259 y Fd(4.1)100 b(Syntax)0 1462 y Fr(There)19 b(are)h(some)g(things)g
(that)h(an)f(author)f(of)g(Python)g(documentation)f(needs)i(to)g(kno)n
(w)f(about)g(L)2818 1446 y Fk(A)2848 1462 y Fr(T)2885
1481 y(E)2925 1462 y(X)i(syntax.)0 1609 y(A)33 b Fi(comment)e
Fr(is)i(started)f(by)g(the)g(\223percent\224)f(character)g(\(`)p
Fg(\045)p Fr('\))g(and)h(continues)f(through)f(the)i(end)g(of)g(the)g
(line)g Fi(and)g(all)g(leading)0 1709 y(whitespace)22
b(on)g(the)h(following)e(line)p Fr(.)32 b(This)23 b(is)g(a)g(little)g
(dif)n(ferent)e(from)h(an)o(y)f(programming)e(language)i(I)i(kno)n(w)e
(of,)i(so)g(an)f(e)o(xample)0 1808 y(is)f(in)f(order:)236
2047 y Fh(This)44 b(is)h(text.\045)f(comment)416 2138
y(This)g(is)g(more)g(text.)89 b(\045)45 b(another)f(comment)236
2229 y(Still)g(more)g(text.)0 2516 y Fr(The)16 b(\002rst)h(non-comment)
c(character)i(follo)n(wing)g(the)h(\002rst)i(comment)d(is)i(the)f
(letter)h(`)p Fg(T)p Fr(')f(on)g(the)g(second)g(line;)h(the)g(leading)e
(whitespace)0 2615 y(on)22 b(that)h(line)f(is)i(consumed)d(as)i(part)f
(of)g(the)h(\002rst)g(comment.)30 b(This)23 b(means)f(that)h(there)f
(is)h(no)g(space)f(between)g(the)g(\002rst)h(and)f(second)0
2715 y(sentences,)e(so)g(the)g(period)f(and)h(letter)g(`)p
Fg(T)p Fr(')g(will)h(be)f(directly)g(adjacent)f(in)h(the)h(typeset)e
(document.)0 2862 y(Note)k(also)f(that)h(though)e(the)i(\002rst)g
(non-comment)c(character)j(after)g(the)h(second)e(comment)g(is)j(the)f
(letter)f(`)p Fg(S)p Fr(',)g(there)h(is)g(whitespace)0
2962 y(preceding)18 b(the)i(comment,)f(so)h(the)h(tw)o(o)f(sentences)g
(are)g(separated)f(as)i(e)o(xpected.)0 3108 y(A)j Fi(gr)l(oup)e
Fr(is)i(an)f(enclosure)e(for)i(a)g(collection)f(of)h(te)o(xt)g(and)f
(commands)g(which)g(encloses)h(the)g(formatting)e(conte)o(xt)h(and)g
(constrains)0 3208 y(the)i(scope)f(of)h(an)o(y)e(changes)h(to)h(that)g
(conte)o(xt)e(made)h(by)h(commands)e(within)h(the)h(group.)34
b(Groups)23 b(can)g(be)h(nested)f(hierarchically)-5 b(.)0
3308 y(The)26 b(formatting)f(conte)o(xt)h(includes)g(the)g(font)g(and)g
(the)h(de\002nition)f(of)g(additional)f(macros)i(\(or)f(o)o(v)o
(errides)e(of)j(macros)f(de\002ned)f(in)0 3407 y(outer)19
b(groups\).)k(Syntactically)-5 b(,)19 b(groups)g(are)h(enclosed)f(in)i
(braces:)236 3645 y Fh({text)44 b(in)h(a)f(group})0 3932
y Fr(An)23 b(alternate)g(syntax)g(for)g(a)h(group)d(using)i(brack)o
(ets,)h Fg([...])p Fr(,)f(is)i(used)e(by)g(macros)g(and)f(en)m
(vironment)f(constructors)h(which)h(tak)o(e)0 4032 y(optional)g
(parameters;)i(brack)o(ets)f(do)g(not)g(normally)f(hold)g(syntactic)h
(signi\002cance.)37 b(A)25 b(de)o(generate)d(group,)h(containing)g
(only)g(one)0 4131 y(atomic)f(bit)h(of)f(content,)g(does)h(not)f(need)g
(to)h(ha)n(v)o(e)f(an)g(e)o(xplicit)g(group,)f(unless)i(it)h(is)f
(required)e(to)i(a)n(v)n(oid)f(ambiguity)-5 b(.)30 b(Since)23
b(Python)0 4231 y(tends)d(to)n(w)o(ard)f(the)i(e)o(xplicit,)e(groups)g
(are)h(also)g(made)g(e)o(xplicit)f(in)i(the)f(documentation)d(markup.)0
4378 y(Groups)25 b(are)g(used)g(only)g(sparingly)f(in)i(the)f(Python)g
(documentation,)e(e)o(xcept)i(for)g(their)g(use)h(in)f(marking)f
(parameters)h(to)g(macros)0 4477 y(and)20 b(en)m(vironments.)0
4624 y(A)f Fi(macr)l(o)f Fr(is)h(usually)e(a)i(simple)f(construct)f
(which)g(is)i(identi\002ed)e(by)h(name)g(and)f(can)h(tak)o(e)g(some)g
(number)e(of)i(parameters.)23 b(In)18 b(normal)0 4724
y(L)21 4707 y Fk(A)51 4724 y Fr(T)88 4743 y(E)128 4724
y(X)h(usage,)f(one)g(of)h(these)g(can)f(be)h(optional.)k(The)18
b(markup)f(is)j(introduced)c(using)i(the)h(backslash)f(character)g(\(`)
p Fg(\\)p Fr('\),)f(and)h(the)h(name)0 4824 y(is)27 b(gi)n(v)o(en)f(by)
g(alphabetic)f(characters)g(\(no)h(digits,)i(hyphens,)e(or)g
(underscores\).)41 b(Required)26 b(parameters)f(should)g(be)i(mark)o
(ed)e(as)i(a)0 4923 y(group,)18 b(and)i(optional)f(parameters)g(should)
g(be)h(mark)o(ed)f(using)h(the)g(alternate)f(syntax)h(for)f(a)i(group.)
0 5070 y(F)o(or)f(e)o(xample,)e(a)j(macro)e(which)h(tak)o(es)g(a)h
(single)f(parameter)f(w)o(ould)g(appear)g(lik)o(e)i(this:)p
0 5549 3901 4 v 0 5649 a Fj(4.1)83 b(Syntax)3402 b(5)p
eop end
%%Page: 6 6
TeXDict begin 6 5 bop 236 174 a Fh(\\name{parameter})0
461 y Fr(A)21 b(macro)e(which)h(tak)o(es)g(an)g(optional)f(parameter)g
(w)o(ould)g(be)h(typed)g(lik)o(e)g(this)h(when)e(the)i(optional)e
(parameter)f(is)j(gi)n(v)o(en:)236 699 y Fh(\\name[optional])0
986 y Fr(If)f(both)f(optional)g(and)h(required)e(parameters)h(are)h(to)
h(be)f(required,)e(it)j(looks)f(lik)o(e)g(this:)236 1224
y Fh(\\name[optional]{required})0 1510 y Fr(A)j(macro)e(name)h(may)g
(be)h(follo)n(wed)e(by)h(a)h(space)f(or)g(ne)n(wline;)h(a)g(space)f
(between)g(the)g(macro)g(name)g(and)g(an)o(y)f(parameters)g(will)j(be)0
1610 y(consumed,)i(b)n(ut)g(this)g(usage)g(is)h(not)f(practiced)f(in)h
(the)h(Python)e(documentation.)39 b(Such)26 b(a)h(space)f(is)h(still)g
(consumed)e(if)h(there)g(are)0 1710 y(no)d(parameters)f(to)h(the)g
(macro,)g(in)g(which)f(case)i(inserting)e(an)h(empty)f(group)g(\()p
Fg({})p Fr(\))g(or)h(e)o(xplicit)g(w)o(ord)f(space)h(\(`)p
Fg(\\)49 b Fr('\))23 b(immediately)0 1809 y(after)c(the)g(macro)f(name)
g(helps)h(to)g(a)n(v)n(oid)g(running)e(the)i(e)o(xpansion)e(of)h(the)h
(macro)f(into)h(the)g(follo)n(wing)f(te)o(xt.)24 b(Macros)18
b(which)h(tak)o(e)g(no)0 1909 y(parameters)g(b)n(ut)h(which)f(should)g
(not)g(be)h(follo)n(wed)f(by)g(a)h(w)o(ord)g(space)f(do)h(not)f(need)h
(special)g(treatment)f(if)h(the)g(follo)n(wing)e(character)0
2008 y(in)i(the)h(document)d(source)h(if)i(not)f(a)g(name)g(character)f
(\(such)g(as)i(punctuation\).)0 2155 y(Each)f(line)g(of)g(this)h(e)o
(xample)d(sho)n(ws)j(an)f(appropriate)e(w)o(ay)i(to)g(write)h(te)o(xt)f
(which)f(includes)h(a)g(macro)g(which)f(tak)o(es)i(no)f(parameters:)236
2393 y Fh(This)44 b(\\UNIX{})g(is)h(followed)e(by)i(a)f(space.)236
2485 y(This)g(\\UNIX\\)g(is)h(also)f(followed)f(by)i(a)g(space.)236
2576 y(\\UNIX,)f(followed)g(by)g(a)h(comma,)f(needs)g(no)g(additional)f
(markup.)0 2863 y Fr(An)24 b Fi(en)m(vir)l(onment)f Fr(is)i(a)f(lar)o
(ger)f(construct)g(than)h(a)g(macro,)g(and)g(can)g(be)g(used)g(for)f
(things)h(with)g(more)g(content)f(than)g(w)o(ould)h(con)m(v)o(e-)0
2962 y(niently)d(\002t)h(in)g(a)g(macro)f(parameter)-5
b(.)28 b(The)o(y)21 b(are)h(primarily)e(used)h(when)g(formatting)f
(parameters)h(need)g(to)g(be)h(changed)e(before)g(and)0
3062 y(after)i(a)g(lar)o(ge)f(chunk)f(of)i(content,)f(b)n(ut)h(the)g
(content)f(itself)i(needs)e(to)h(be)g(highly)f(\003e)o(xible.)30
b(Code)22 b(samples)g(are)g(presented)e(using)i(an)0
3162 y(en)m(vironment,)17 b(and)j(descriptions)e(of)i(functions,)f
(methods,)g(and)g(classes)j(are)e(also)g(mark)o(ed)f(using)h(en)m
(vironments.)0 3308 y(Since)f(the)f(content)g(of)g(an)h(en)m(vironment)
d(is)j(free-form)e(and)h(can)g(consist)h(of)f(se)n(v)o(eral)h
(paragraphs,)d(the)o(y)i(are)h(actually)f(mark)o(ed)f(using)0
3408 y(a)29 b(pair)g(of)f(macros:)42 b Fg(\\begin)28
b Fr(and)h Fg(\\end)p Fr(.)50 b(These)29 b(macros)f(both)g(tak)o(e)h
(the)g(name)f(of)g(the)h(en)m(vironment)d(as)k(a)f(parameter)-5
b(.)50 b(An)0 3508 y(e)o(xample)19 b(is)i(the)f(en)m(vironment)d(used)j
(to)h(mark)e(the)h(abstract)g(of)g(a)h(document:)236
3655 y Fh(\\begin{abstract})326 3746 y(This)44 b(is)h(the)f(text)g(of)h
(the)f(abstract.)88 b(It)44 b(concisely)g(explains)f(what)326
3837 y(information)g(is)h(found)g(in)h(the)f(document.)326
4020 y(It)g(can)h(consist)e(of)i(multiple)e(paragraphs.)236
4111 y(\\end{abstract})0 4398 y Fr(An)17 b(en)m(vironment)d(can)i(also)
i(ha)n(v)o(e)e(required)f(and)h(optional)g(parameters)g(of)g(its)i(o)n
(wn.)23 b(These)17 b(follo)n(w)f(the)h(parameter)f(of)g(the)h
Fg(\\begin)0 4497 y Fr(macro.)24 b(This)c(e)o(xample)f(sho)n(ws)h(an)g
(en)m(vironment)e(which)h(tak)o(es)i(a)f(single)g(required)f
(parameter:)236 4735 y Fh(\\begin{datadesc}{controlnames})326
4827 y(A)45 b(33-element)e(string)h(array)g(that)g(contains)f(the)h
(\\ASCII{})g(mnemonics)f(for)326 4918 y(the)h(thirty-two)f(\\ASCII{})h
(control)g(characters)f(from)h(0)g(\(NUL\))g(to)h(0x1f)326
5009 y(\(US\),)f(in)g(order,)g(plus)g(the)h(mnemonic)e(\\samp{SP})g
(for)i(the)f(space)g(character.)236 5101 y(\\end{datadesc})0
5387 y Fr(There)24 b(are)h(a)g(number)e(of)h(less-used)h(marks)f(in)h
(L)1450 5371 y Fk(A)1480 5387 y Fr(T)1517 5406 y(E)1556
5387 y(X)g(which)g(are)f(used)h(to)g(enter)f(characters)g(which)g(are)g
(not)h(found)e(in)k Ff(A)t(S)t(C)t(I)t(I)h Fr(or)p 0
5549 3901 4 v 0 5649 a Fj(6)3253 b(4)83 b(L)3444 5631
y Fe(A)3470 5649 y Fj(T)3507 5671 y(E)3553 5649 y(X)23
b(Pr)q(imer)p eop end
%%Page: 7 7
TeXDict begin 7 6 bop 0 83 a Fr(which)25 b(a)h(considered)e(special,)j
(or)e Fi(active)h Fr(in)f(T)1404 102 y(E)1445 83 y(X)h(or)f(L)1647
66 y Fk(A)1677 83 y Fr(T)1714 102 y(E)1754 83 y(X.)41
b(Gi)n(v)o(en)25 b(that)h(these)g(are)f(often)g(used)g(adjacent)g(to)h
(other)f(characters,)0 183 y(the)g(markup)e(required)g(to)i(produce)e
(the)h(proper)f(character)h(may)g(need)g(to)h(be)g(follo)n(wed)f(by)g
(a)h(space)g(or)f(an)h(empty)f(group,)g(or)h(the)0 282
y(markup)18 b(can)i(be)h(enclosed)e(in)h(a)h(group.)i(Some)d(which)f
(are)i(found)d(in)i(Python)f(documentation)f(are:)1320
509 y Fm(Character)p 1732 538 4 100 v 97 w(Markup)p 1270
542 1361 4 v 1488 612 a Fr(\210)p 1732 641 4 100 v 267
w Fg(\\textasciicircum)1488 711 y Fr(\230)p 1732 741
V 267 w Fg(\\textasciitilde)1469 811 y Fc(>)p 1732 841
V 249 w Fg(\\textgreater)1469 910 y Fc(<)p 1732 940 V
249 w Fg(\\textless)1483 1010 y Fr(c)-32 b(\270)p 1732
1040 V 267 w Fg(\\c)50 b(c)1488 1110 y Fr(\250)-35 b(o)p
1732 1140 V 260 w Fg(\\"o)1481 1209 y Fr(\370)p 1732
1239 V 260 w Fg(\\o)0 1490 y Fd(4.2)100 b(Hier)o(archical)30
b(Str)q(ucture)0 1692 y Fr(L)21 1676 y Fk(A)51 1692 y
Fr(T)88 1711 y(E)128 1692 y(X)f(e)o(xpects)e(documents)g(to)i(be)g
(arranged)d(in)j(a)g(con)m(v)o(entional,)e(hierarchical)g(w)o(ay)-5
b(,)30 b(with)f(chapters,)g(sections,)i(sub-sections,)0
1792 y(appendix)o(es,)26 b(and)g(the)g(lik)o(e.)45 b(These)26
b(are)h(mark)o(ed)e(using)h(macros)g(rather)g(than)g(en)m(vironments,)f
(probably)f(because)i(the)h(end)f(of)g(a)0 1892 y(section)20
b(can)g(be)g(safely)g(inferred)f(when)g(a)i(section)f(of)g(equal)f(or)h
(higher)f(le)n(v)o(el)h(starts.)0 2039 y(There)29 b(are)h(six)g(\223le)
n(v)o(els\224)f(of)g(sectioning)g(in)h(the)g(document)d(classes)k(used)
f(for)f(Python)f(documentation,)h(and)g(the)h(deepest)f(tw)o(o)0
2138 y(le)n(v)o(els)191 2108 y Fk(1)244 2138 y Fr(are)20
b(not)g(used.)25 b(The)20 b(le)n(v)o(els)g(are:)1307
2348 y Fm(Le)o(v)o(el)p 1547 2378 V 99 w(Macr)o(o)f(Name)p
2344 2378 V 335 w(Notes)p 1257 2381 1387 4 v 1382 2451
a Fr(1)p 1547 2481 4 100 v 174 w Fg(\\chapter)p 2344
2481 V 448 w Fr(\(1\))1382 2550 y(2)p 1547 2580 V 174
w Fg(\\section)p 2344 2580 V 1382 2650 a Fr(3)p 1547
2680 V 174 w Fg(\\subsection)p 2344 2680 V 1382 2749
a Fr(4)p 1547 2779 V 174 w Fg(\\subsubsection)p 2344
2779 V 1382 2849 a Fr(5)p 1547 2879 V 174 w Fg(\\paragraph)p
2344 2879 V 348 w Fr(\(2\))1382 2949 y(6)p 1547 2979
V 174 w Fg(\\subparagraph)p 2344 2979 V 0 3173 a Fr(Notes:)0
3403 y Fm(\(1\))40 b Fr(Only)20 b(used)g(for)g(the)g
Fg(manual)f Fr(documents,)g(as)i(described)d(in)j(section)f(5,)g
(\223Document)e(Classes.)-6 b(\224)0 3569 y Fm(\(2\))40
b Fr(Not)21 b(the)f(same)g(as)h(a)g(paragraph)c(of)j(te)o(xt;)g(nobody)
e(seems)j(to)f(use)h(this.)0 3853 y Fd(4.3)100 b(Common)29
b(En)n(vironments)0 4056 y Fr(L)21 4040 y Fk(A)51 4056
y Fr(T)88 4075 y(E)128 4056 y(X)24 b(pro)o(vides)e(a)i(v)n(ariety)f(of)
h(en)m(vironments)d(e)n(v)o(en)i(without)g(the)h(additional)e(markup)g
(pro)o(vided)g(by)h(the)h(Python-speci\002c)e(docu-)0
4156 y(ment)i(classes)h(introduced)d(in)i(the)h(ne)o(xt)e(section.)37
b(The)24 b(follo)n(wing)f(en)m(vironments)e(are)j(pro)o(vided)e(as)j
(part)f(of)g(standard)f(L)3589 4139 y Fk(A)3619 4156
y Fr(T)3656 4175 y(E)3695 4156 y(X)i(and)0 4256 y(are)20
b(being)f(used)h(in)h(the)f(standard)f(Python)g(documentation;)e
(descriptions)i(will)i(be)f(added)f(here)h(as)h(time)f(allo)n(ws.)p
0 4327 1560 4 v 90 4382 a Fn(1)120 4406 y Ff(The)c(deepest)j(le)n(v)o
(els)g(ha)o(v)o(e)f(the)g(highest)g(numbers)f(in)h(the)f(table.)p
0 5549 3901 4 v 0 5649 a Fj(4.2)83 b(Hier)o(archical)24
b(Str)q(ucture)2857 b(7)p eop end
%%Page: 8 8
TeXDict begin 8 7 bop 236 174 a Fh(abstract)236 266 y(alltt)236
357 y(description)236 448 y(displaymath)236 540 y(document)236
631 y(enumerate)236 722 y(figure)236 814 y(flushleft)236
905 y(itemize)236 996 y(list)236 1088 y(math)236 1179
y(quotation)236 1270 y(quote)236 1362 y(sloppypar)236
1453 y(verbatim)0 1902 y Fs(5)120 b(Document)35 b(Classes)0
2134 y Fr(T)-7 b(w)o(o)19 b(L)185 2118 y Fk(A)215 2134
y Fr(T)252 2153 y(E)292 2134 y(X)g(document)e(classes)j(are)f
(de\002ned)f(speci\002cally)h(for)f(use)i(with)f(the)g(Python)f
(documentation.)j(The)e Fg(manual)f Fr(class)i(is)g(for)0
2234 y(lar)o(ge)f(documents)g(which)g(are)h(sectioned)g(into)g
(chapters,)f(and)h(the)g Fg(howto)g Fr(class)h(is)g(for)e(smaller)i
(documents.)0 2381 y(The)k Fg(manual)f Fr(documents)f(are)i(lar)o(ger)f
(and)g(are)h(used)g(for)f(most)h(of)g(the)g(standard)f(documents.)37
b(This)25 b(document)e(class)j(is)g(based)0 2481 y(on)d(the)g(standard)
f(L)558 2464 y Fk(A)588 2481 y Fr(T)625 2499 y(E)664
2481 y(X)i Fg(report)f Fr(class)h(and)e(is)i(formatted)e(v)o(ery)g
(much)g(lik)o(e)i(a)f(long)f(technical)h(report.)32 b(The)23
b Fi(Python)f(Refer)m(ence)0 2580 y(Manual)d Fr(is)i(a)g(good)e(e)o
(xample)f(of)i(a)h Fg(manual)f Fr(document,)d(and)j(the)g
Fi(Python)f(Libr)o(ary)i(Refer)m(ence)e Fr(is)i(a)g(lar)o(ge)e(e)o
(xample.)0 2727 y(The)i Fg(howto)g Fr(documents)f(are)i(shorter)m(,)e
(and)h(don')o(t)f(ha)n(v)o(e)h(the)g(lar)o(ge)g(structure)f(of)i(the)f
Fg(manual)g Fr(documents.)27 b(This)22 b(class)h(is)f(based)0
2827 y(on)d(the)g(standard)g(L)547 2810 y Fk(A)577 2827
y Fr(T)614 2845 y(E)653 2827 y(X)h Fg(article)f Fr(class)h(and)f(is)i
(formatted)c(some)n(what)i(lik)o(e)h(the)f(Linux)f(Documentation)f
(Project')-5 b(s)20 b(\223HO)m(WT)o(O\224)0 2926 y(series)k(as)g(done)e
(originally)f(using)i(the)g(LinuxDoc)e(softw)o(are.)33
b(The)23 b(original)f(intent)h(for)f(the)h(document)f(class)i(w)o(as)g
(that)f(it)h(serv)o(e)e(a)0 3026 y(similar)k(role)g(as)h(the)f(LDP')-5
b(s)26 b(HO)m(WT)o(O)h(series,)g(b)n(ut)f(the)g(applicability)f(of)h
(the)g(class)h(turns)e(out)h(to)g(be)g(some)n(what)f(broader)-5
b(.)41 b(This)0 3126 y(class)19 b(is)h(used)e(for)g(\223ho)n(w-to\224)f
(documents)f(\(this)j(document)d(is)k(an)e(e)o(xample\))f(and)g(for)h
(shorter)g(reference)f(manuals)g(for)h(small,)h(f)o(airly)0
3225 y(cohesi)n(v)o(e)j(module)g(libraries.)34 b(Examples)23
b(of)g(the)h(later)f(use)h(include)e Fi(Using)h(K)m(erber)l(os)i(fr)l
(om)f(Python)p Fr(,)f(which)g(contains)f(reference)0
3325 y(material)e(for)f(an)h(e)o(xtension)f(package.)24
b(These)c(documents)e(are)i(roughly)e(equi)n(v)n(alent)h(to)h(a)h
(single)f(chapter)f(from)g(a)i(lar)o(ger)e(w)o(ork.)0
3652 y Fs(6)120 b(Special)33 b(Mar)r(kup)h(Constr)r(ucts)0
3885 y Fr(The)d(Python)g(document)f(classes)j(de\002ne)e(a)h(lot)g(of)g
(ne)n(w)f(en)m(vironments)e(and)j(macros.)59 b(This)32
b(section)f(contains)g(the)h(reference)0 3985 y(material)19
b(for)g(these)h(f)o(acilities.)26 b(Documentation)17
b(for)i(\223standard\224)f(L)1977 3968 y Fk(A)2007 3985
y Fr(T)2044 4003 y(E)2084 3985 y(X)i(constructs)f(is)i(not)e(included)f
(here,)h(though)f(the)o(y)h(are)h(used)0 4084 y(in)g(the)h(Python)e
(documentation.)0 4369 y Fd(6.1)100 b(Mar)q(kup)29 b(f)m(or)f(the)h
(Preamb)n(le)0 4558 y Fg(\\)p Fb(release)p Fg({)p Fi(ver)r
Fg(})208 4658 y Fr(Set)20 b(the)h(v)o(ersion)e(number)f(for)h(the)i
(softw)o(are)e(described)g(in)i(the)f(document.)0 4805
y Fg(\\)p Fb(setshortversion)p Fg({)p Fi(sver)r Fg(})208
4904 y Fr(Specify)f(the)h(\223short\224)g(v)o(ersion)f(number)f(of)i
(the)g(documented)e(softw)o(are)h(to)i(be)f Fi(sver)r
Fr(.)p 0 5549 3901 4 v 0 5649 a Fj(8)2707 b(6)83 b(Special)25
b(Mar)q(kup)e(Constr)q(ucts)p eop end
%%Page: 9 9
TeXDict begin 9 8 bop 0 83 a Fd(6.2)100 b(Meta-inf)m(or)r(mation)31
b(Mar)q(kup)0 272 y Fg(\\)p Fb(sectionauthor)p Fg({)p
Fi(author)r Fg(}{)p Fi(email)p Fg(})208 372 y Fr(Identi\002es)c(the)i
(author)e(of)h(the)g(current)f(section.)50 b Fi(author)29
b Fr(should)e(be)h(the)h(author')-5 b(s)27 b(name)h(such)g(that)h(it)g
(can)f(be)g(used)g(for)208 471 y(presentation)20 b(\(though)g(it)i
(isn')o(t\),)g(and)f Fi(email)h Fr(should)f(be)h(the)g(author')-5
b(s)21 b(email)h(address.)30 b(The)22 b(domain)e(name)h(portion)g(of)h
(the)208 571 y(address)d(should)g(be)i(lo)n(wer)e(case.)208
704 y(No)h(presentation)e(is)j(generated)e(from)g(this)i(markup,)d(b)n
(ut)i(it)h(is)g(used)f(to)g(help)g(k)o(eep)g(track)g(of)f(contrib)n
(utions.)0 989 y Fd(6.3)100 b(Inf)m(or)r(mation)30 b(Units)0
1191 y Fr(XXX)21 b(Explain)e(terminology)-5 b(,)17 b(or)j(come)f(up)h
(with)g(something)f(more)g(\223lay)-5 b(.)f(\224)0 1338
y(There)32 b(are)g(a)h(number)e(of)h(en)m(vironments)e(used)i(to)h
(describe)e(speci\002c)i(features)f(pro)o(vided)e(by)i(modules.)61
b(Each)32 b(en)m(vironment)0 1438 y(requires)22 b(parameters)f(needed)g
(to)i(pro)o(vide)d(basic)j(information)d(about)i(what)g(is)h(being)f
(described,)g(and)g(the)g(en)m(vironment)e(content)0
1538 y(should)g(be)h(the)f(description.)26 b(Most)21
b(of)f(these)h(en)m(vironments)d(mak)o(e)j(entries)f(in)h(the)g
(general)f(inde)o(x)f(\(if)i(one)f(is)i(being)e(produced)e(for)0
1637 y(the)k(document\);)f(if)i(no)f(inde)o(x)f(entry)g(is)i(desired,)f
(non-inde)o(xing)d(v)n(ariants)i(are)i(a)n(v)n(ailable)e(for)h(man)o(y)
f(of)h(these)h(en)m(vironments.)28 b(The)0 1737 y(en)m(vironments)22
b(ha)n(v)o(e)j(names)f(of)h(the)g(form)f Fi(featur)m(e)p
Fg(desc)p Fr(,)h(and)g(the)g(non-inde)o(xing)c(v)n(ariants)j(are)h
(named)f Fi(featur)m(e)p Fg(descni)p Fr(.)38 b(The)0
1836 y(a)n(v)n(ailable)20 b(v)n(ariants)f(are)h(e)o(xplicitly)g
(included)e(in)j(the)f(list)h(belo)n(w)-5 b(.)0 1983
y(F)o(or)20 b(each)g(of)g(these)g(en)m(vironments,)d(the)j(\002rst)h
(parameter)m(,)d Fi(name)p Fr(,)i(pro)o(vides)e(the)i(name)g(by)g
(which)f(the)i(feature)e(is)i(accessed.)0 2130 y(En)m(vironments)d
(which)j(describe)f(features)h(of)g(objects)g(within)g(a)g(module,)f
(such)h(as)h(object)e(methods)g(or)h(data)g(attrib)n(utes,)g(allo)n(w)h
(an)0 2230 y(optional)e Fi(type)h(name)f Fr(parameter)-5
b(.)26 b(When)21 b(the)g(feature)f(is)i(an)f(attrib)n(ute)f(of)h(class)
h(instances,)f Fi(type)f(name)h Fr(only)f(needs)h(to)g(be)g(gi)n(v)o
(en)e(if)0 2329 y(the)j(class)g(w)o(as)g(not)g(the)f(most)h(recently)e
(described)g(class)j(in)f(the)f(module;)g(the)g Fi(name)g
Fr(v)n(alue)g(from)g(the)g(most)h(recent)f Fg(classdesc)0
2429 y Fr(is)e(implied.)24 b(F)o(or)18 b(features)g(of)g(b)n(uilt-in)g
(or)g(e)o(xtension)g(types,)g(the)g Fi(type)h(name)f
Fr(v)n(alue)g(should)f(al)o(w)o(ays)i(be)f(pro)o(vided.)k(Another)17
b(special)0 2529 y(case)24 b(includes)f(methods)g(and)g(members)g(of)g
(general)g(\223protocols,)-6 b(\224)23 b(such)g(as)i(the)e(formatter)g
(and)g(writer)g(protocols)g(described)f(for)0 2628 y(the)27
b Fg(formatter)f Fr(module:)39 b(these)27 b(may)g(be)g(documented)e
(without)h(an)o(y)h(speci\002c)g(implementation)e(classes,)30
b(and)d(will)h(al)o(w)o(ays)0 2728 y(require)19 b(the)h
Fi(type)g(name)g Fr(parameter)e(to)j(be)f(pro)o(vided.)0
2875 y Fg(\\begin{)p Fb(cfuncdesc)p Fg(}{)p Fi(type)p
Fg(}{)p Fi(name)p Fg(}{)p Fi(ar)m(g)o(s)p Fg(})0 2974
y(\\end{)p Fb(cfuncdesc)p Fg(})208 3074 y Fr(En)m(vironment)d(used)j
(to)h(described)e(a)j(C)f(function.)k(The)20 b Fi(type)h
Fr(should)e(be)i(speci\002ed)f(as)h(a)g Fg(typedef)f
Fr(name,)g Fg(struct)49 b Fi(ta)o(g)p Fr(,)208 3174 y(or)23
b(the)h(name)g(of)f(a)i(primiti)n(v)o(e)d(type.)36 b(If)24
b(it)h(is)f(a)h(pointer)e(type,)h(the)g(trailing)f(asterisk)h(should)f
(not)h(be)g(preceded)e(by)h(a)i(space.)208 3273 y Fi(name)19
b Fr(should)g(be)h(the)g(name)f(of)h(the)g(function)e(\(or)i
(function-lik)o(e)d(pre-processor)h(macro\),)g(and)h
Fi(ar)m(gs)i Fr(should)e(gi)n(v)o(e)g(the)h(types)208
3373 y(and)f(names)h(of)g(the)g(parameters.)k(The)c(names)g(need)f(to)h
(be)h(gi)n(v)o(en)e(so)h(the)o(y)g(may)f(be)h(used)g(in)h(the)f
(description.)0 3520 y Fg(\\begin{)p Fb(cmemberdesc)p
Fg(}{)p Fi(container)r Fg(}{)p Fi(typ)o(e)p Fg(}{)p Fi(n)o(ame)p
Fg(})0 3619 y(\\end{)p Fb(cmemberdesc)p Fg(})208 3719
y Fr(Description)c(for)h(a)h(structure)e(member)-5 b(.)23
b Fi(container)18 b Fr(should)f(be)g(the)h Fg(typedef)e
Fr(name,)i(if)f(there)g(is)i(one,)e(otherwise)g(if)h(should)208
3819 y(be)k(`)p Fg(struct)48 b Fi(ta)o(g)p Fr('.)32 b(The)22
b(type)g(of)g(the)g(member)g(should)f(gi)n(v)o(en)g(as)i
Fi(type)p Fr(,)g(and)f(the)h(name)e(should)h(be)g(gi)n(v)o(en)g(as)h
Fi(name)p Fr(.)31 b(The)208 3918 y(te)o(xt)d(of)g(the)g(description)f
(should)h(include)f(the)i(range)e(of)h(v)n(alues)g(allo)n(wed,)i(ho)n
(w)e(the)g(v)n(alue)g(should)f(be)i(interpreted,)f(and)208
4018 y(whether)19 b(the)h(v)n(alue)f(can)h(be)h(changed.)i(References)c
(to)i(structure)e(members)g(in)h(te)o(xt)g(should)f(use)i(the)f
Fg(\\member)g Fr(macro.)0 4165 y Fg(\\begin{)p Fb(csimplemacrodesc)p
Fg(}{)p Fi(name)p Fg(})0 4264 y(\\end{)p Fb(csimplemacrodesc)p
Fg(})208 4364 y Fr(Documentation)d(for)i(a)i(\223simple\224)e(macro.)24
b(Simple)c(macros)f(are)h(macros)g(which)f(are)h(used)g(for)f(code)g(e)
o(xpansion,)f(b)n(ut)i(which)208 4464 y(do)25 b(not)g(tak)o(e)h(ar)o
(guments)e(so)i(cannot)e(be)i(described)e(as)j(functions.)40
b(This)26 b(is)g(not)g(to)f(be)h(used)g(for)f(simple)g(constant)g
(de\002ni-)208 4563 y(tions.)f(Examples)16 b(of)h(its)h(use)g(in)f(the)
g(Python)f(documentation)f(include)h Fg(PyObject_HEAD)f
Fr(and)i Fg(Py_BEGIN_ALLOW_-)208 4663 y(THREADS)p Fr(.)0
4810 y Fg(\\begin{)p Fb(ctypedesc)p Fg(}[)p Fi(ta)o(g)p
Fg(]{)p Fi(name)p Fg(})0 4909 y(\\end{)p Fb(ctypedesc)p
Fg(})208 5009 y Fr(En)m(vironment)23 b(used)j(to)h(described)e(a)i(C)h
(type.)44 b(The)26 b Fi(name)g Fr(parameter)f(should)h(be)g(the)h
Fg(typedef)f Fr(name.)43 b(If)27 b(the)f(type)h(is)208
5109 y(de\002ned)c(as)i(a)g Fg(struct)f Fr(without)g(a)h
Fg(typedef)p Fr(,)f Fi(name)g Fr(should)g(ha)n(v)o(e)f(the)i(form)e
Fg(struct)49 b Fi(ta)o(g)p Fr(.)38 b Fi(name)23 b Fr(will)j(be)e(added)
f(to)208 5208 y(the)d(inde)o(x)f(unless)i Fi(ta)o(g)f
Fr(is)i(pro)o(vided,)c(in)i(which)g(case)h Fi(ta)o(g)f
Fr(will)i(be)e(used)g(instead.)26 b Fi(ta)o(g)20 b Fr(should)g(not)g
(be)g(used)h(for)e(a)i Fg(typedef)208 5308 y Fr(name.)p
0 5549 3901 4 v 0 5649 a Fj(6.2)83 b(Meta-inf)n(or)r(mation)25
b(Mar)q(kup)2732 b(9)p eop end
%%Page: 10 10
TeXDict begin 10 9 bop 0 83 a Fg(\\begin{)p Fb(cvardesc)p
Fg(}{)p Fi(type)p Fg(}{)p Fi(name)p Fg(})0 183 y(\\end{)p
Fb(cvardesc)p Fg(})208 282 y Fr(Description)16 b(of)h(a)g(global)g(C)h
(v)n(ariable.)23 b Fi(type)17 b Fr(should)f(be)h(the)h
Fg(typedef)e Fr(name,)h Fg(struct)49 b Fi(ta)o(g)p Fr(,)17
b(or)g(the)h(name)e(of)h(a)h(primiti)n(v)o(e)208 382
y(type.)24 b(If)c(v)n(ariable)f(has)i(a)f(pointer)f(type,)h(the)g
(trailing)f(asterisk)i(should)e Fi(not)h Fr(be)g(preceded)e(by)i(a)h
(space.)0 529 y Fg(\\begin{)p Fb(datadesc)p Fg(}{)p Fi(name)p
Fg(})0 628 y(\\end{)p Fb(datadesc)p Fg(})208 728 y Fr(This)29
b(en)m(vironment)c(is)30 b(used)f(to)g(document)d(global)i(data)h(in)g
(a)g(module,)h(including)d(both)h(v)n(ariables)g(and)g(v)n(alues)g
(used)h(as)208 828 y(\223de\002ned)19 b(constants.)-6
b(\224)24 b(Class)e(and)d(object)h(attrib)n(utes)g(are)g(not)g
(documented)e(using)h(this)i(en)m(vironment.)0 975 y
Fg(\\begin{)p Fb(datadescni)p Fg(}{)p Fi(name)p Fg(})0
1074 y(\\end{)p Fb(datadescni)p Fg(})208 1174 y Fr(Lik)o(e)f
Fg(datadesc)p Fr(,)f(b)n(ut)h(without)f(creating)h(an)o(y)f(inde)o(x)g
(entries.)0 1321 y Fg(\\begin{)p Fb(excclassdesc)p Fg(}{)p
Fi(name)p Fg(}{)p Fi(con)o(structor)c(par)o(ameter)o(s)p
Fg(})0 1420 y(\\end{)p Fb(excclassdesc)p Fg(})208 1520
y Fr(Describe)22 b(an)h(e)o(xception)e(de\002ned)h(by)h(a)h(class.)34
b Fi(constructor)23 b(par)o(ameter)o(s)f Fr(should)g(not)h(include)f
(the)h Fi(self)36 b Fr(parameter)22 b(or)h(the)208 1620
y(parentheses)28 b(used)g(in)i(the)f(call)g(syntax.)51
b(T)-7 b(o)30 b(describe)e(an)h(e)o(xception)e(class)j(without)f
(describing)e(the)i(parameters)f(to)i(its)208 1719 y(constructor)m(,)17
b(use)k(the)f Fg(excdesc)f Fr(en)m(vironment.)0 1866
y Fg(\\begin{)p Fb(excdesc)p Fg(}{)p Fi(name)p Fg(})0
1966 y(\\end{)p Fb(excdesc)p Fg(})208 2065 y Fr(Describe)33
b(an)h(e)o(xception.)64 b(In)34 b(the)g(case)g(of)g(class)g(e)o
(xceptions,)i(the)e(constructor)e(parameters)g(are)i(not)g(described;)
39 b(use)208 2165 y Fg(excclassdesc)18 b Fr(to)i(describe)g(an)g(e)o
(xception)e(class)j(and)f(its)h(constructor)-5 b(.)0
2312 y Fg(\\begin{)p Fb(funcdesc)p Fg(}{)p Fi(name)p
Fg(}{)p Fi(par)o(ameter)o(s)p Fg(})0 2411 y(\\end{)p
Fb(funcdesc)p Fg(})208 2511 y Fr(Describe)17 b(a)i(module-le)n(v)o(el)d
(function.)22 b Fi(par)o(ameter)o(s)c Fr(should)f(not)h(include)f(the)i
(parentheses)e(used)h(in)g(the)g(call)h(syntax.)24 b(Object)208
2611 y(methods)17 b(are)h(not)g(documented)e(using)i(this)h(en)m
(vironment.)i(Bound)c(object)h(methods)f(placed)h(in)g(the)h(module)e
(namespace)g(as)208 2710 y(part)j(of)h(the)f(public)g(interf)o(ace)g
(of)h(the)g(module)e(are)i(documented)d(using)j(this,)g(as)g(the)o(y)g
(are)f(equi)n(v)n(alent)f(to)i(normal)f(functions)208
2810 y(for)f(most)h(purposes.)208 2943 y(The)27 b(description)f(should)
g(include)h(information)e(about)i(the)g(parameters)g(required)f(and)h
(ho)n(w)g(the)o(y)g(are)g(used)g(\(especially)208 3042
y(whether)h(mutable)g(objects)h(passed)g(as)g(parameters)f(are)h
(modi\002ed\),)h(side)f(ef)n(fects,)i(and)e(possible)f(e)o(xceptions.)
51 b(A)29 b(small)208 3142 y(e)o(xample)18 b(may)i(be)g(pro)o(vided.)0
3289 y Fg(\\begin{)p Fb(funcdescni)p Fg(}{)p Fi(name)p
Fg(}{)p Fi(par)o(a)o(meter)o(s)p Fg(})0 3388 y(\\end{)p
Fb(funcdescni)p Fg(})208 3488 y Fr(Lik)o(e)g Fg(funcdesc)p
Fr(,)f(b)n(ut)h(without)f(creating)h(an)o(y)f(inde)o(x)g(entries.)0
3635 y Fg(\\begin{)p Fb(classdesc)p Fg(}{)p Fi(name)p
Fg(}{)p Fi(constructor)c(par)o(ameter)o(s)p Fg(})0 3735
y(\\end{)p Fb(classdesc)p Fg(})208 3834 y Fr(Describe)k(a)i(class)g
(and)f(its)h(constructor)-5 b(.)23 b Fi(constructor)d(par)o(ameter)o(s)
g Fr(should)f(not)h(include)f(the)h Fi(self)33 b Fr(parameter)19
b(or)h(the)g(paren-)208 3934 y(theses)g(used)g(in)g(the)h(call)f
(syntax.)0 4081 y Fg(\\begin{)p Fb(classdesc)800 4094
y(*)850 4081 y Fg(}{)p Fi(name)p Fg(})0 4180 y(\\end{)p
Fb(classdesc)700 4193 y(*)750 4180 y Fg(})208 4280 y
Fr(Describe)k(a)h(class)g(without)f(describing)f(the)h(constructor)-5
b(.)36 b(This)25 b(can)f(be)h(used)f(to)h(describe)e(classes)j(that)e
(are)h(merely)e(con-)208 4380 y(tainers)d(for)f(attrib)n(utes)h(or)g
(which)g(should)f(ne)n(v)o(er)g(be)h(instantiated)g(or)f(subclassed)h
(by)g(user)g(code.)0 4526 y Fg(\\begin{)p Fb(memberdesc)p
Fg(}[)p Fi(type)d(name)p Fg(]{)p Fi(name)p Fg(})0 4626
y(\\end{)p Fb(memberdesc)p Fg(})208 4726 y Fr(Describe)24
b(an)h(object)f(data)h(attrib)n(ute.)38 b(The)24 b(description)g
(should)g(include)f(information)g(about)h(the)g(type)h(of)f(the)h(data)
g(to)g(be)208 4825 y(e)o(xpected)18 b(and)i(whether)f(it)i(may)f(be)g
(changed)e(directly)-5 b(.)0 4972 y Fg(\\begin{)p Fb(memberdescni)p
Fg(}[)p Fi(type)16 b(name)p Fg(]{)p Fi(name)p Fg(})0
5072 y(\\end{)p Fb(memberdescni)p Fg(})208 5171 y Fr(Lik)o(e)k
Fg(memberdesc)p Fr(,)e(b)n(ut)i(without)g(creating)f(an)o(y)h(inde)o(x)
f(entries.)0 5318 y Fg(\\begin{)p Fb(methoddesc)p Fg(}[)p
Fi(type)e(name)p Fg(]{)p Fi(name)p Fg(}{)p Fi(par)o(ameter)o(s)p
Fg(})p 0 5549 3901 4 v 0 5649 a Fj(10)2661 b(6)83 b(Special)25
b(Mar)q(kup)e(Constr)q(ucts)p eop end
%%Page: 11 11
TeXDict begin 11 10 bop 0 83 a Fg(\\end{)p Fb(methoddesc)p
Fg(})208 183 y Fr(Describe)18 b(an)h(object)g(method.)k
Fi(par)o(ameter)o(s)c Fr(should)f(not)h(include)f(the)i
Fi(self)32 b Fr(parameter)17 b(or)i(the)h(parentheses)e(used)h(in)g
(the)g(call)208 282 y(syntax.)24 b(The)c(description)e(should)i
(include)f(similar)h(information)e(to)i(that)h(described)d(for)i
Fg(funcdesc)p Fr(.)0 429 y Fg(\\begin{)p Fb(methoddescni)p
Fg(}[)p Fi(type)c(name)p Fg(]{)p Fi(name)p Fg(}{)p Fi(par)o(ameter)o(s)
p Fg(})0 529 y(\\end{)p Fb(methoddescni)p Fg(})208 628
y Fr(Lik)o(e)k Fg(methoddesc)p Fr(,)e(b)n(ut)i(without)g(creating)f(an)
o(y)h(inde)o(x)f(entries.)0 913 y Fd(6.4)100 b(Sho)o(wing)29
b(Code)g(Examples)0 1116 y Fr(Examples)23 b(of)h(Python)f(source)h
(code)f(or)h(interacti)n(v)o(e)f(sessions)i(are)f(represented)e(as)j
Fg(verbatim)f Fr(en)m(vironments.)34 b(This)24 b(en)m(viron-)0
1216 y(ment)e(is)h(a)g(standard)e(part)h(of)g(L)896 1199
y Fk(A)926 1216 y Fr(T)963 1235 y(E)1003 1216 y(X.)31
b(It)23 b(is)g(important)e(to)h(only)g(use)g(spaces)h(for)e
(indentation)g(in)h(code)g(e)o(xamples)f(since)h(T)3592
1235 y(E)3633 1216 y(X)h(drops)0 1315 y(tabs)e(instead)e(of)h(con)m(v)o
(erting)e(them)h(to)i(spaces.)0 1462 y(Representing)d(an)i(interacti)n
(v)o(e)f(session)h(requires)f(including)f(the)i(prompts)e(and)i(output)
e(along)h(with)h(the)g(Python)e(code.)25 b(No)19 b(special)0
1562 y(markup)26 b(is)i(required)d(for)i(interacti)n(v)o(e)f(sessions.)
47 b(After)27 b(the)g(last)i(line)e(of)g(input)g(or)g(output)f
(presented,)h(there)g(should)f(not)h(be)h(an)0 1662 y(\223unused\224)19
b(primary)f(prompt;)h(this)i(is)g(an)f(e)o(xample)f(of)h(what)g
Fi(not)g Fr(to)g(do:)236 1900 y Fh(>>>)45 b(1)f(+)h(1)236
1991 y(2)236 2082 y(>>>)0 2369 y Fr(W)m(ithin)22 b(the)g
Fg(verbatim)g Fr(en)m(vironment,)d(characters)i(special)h(to)h(L)1977
2352 y Fk(A)2007 2369 y Fr(T)2044 2388 y(E)2083 2369
y(X)g(do)f(not)g(need)f(to)i(be)f(specially)g(mark)o(ed)f(in)h(an)o(y)f
(w)o(ay)-5 b(.)31 b(The)0 2469 y(entire)25 b(e)o(xample)e(will)j(be)f
(presented)f(in)h(a)g(monospaced)e(font;)k(no)e(attempt)f(at)i
(\223pretty-printing\224)21 b(is)26 b(made,)g(as)g(the)f(en)m
(vironment)0 2568 y(must)g(w)o(ork)g(for)f(non-Python)e(code)j(and)f
(non-code)f(displays.)39 b(There)25 b(should)f(be)h(no)f(blank)h(lines)
g(at)h(the)f(top)g(or)g(bottom)f(of)g(an)o(y)0 2668 y
Fg(verbatim)19 b Fr(display)-5 b(.)0 2815 y(Longer)19
b(displays)h(of)g(v)o(erbatim)e(te)o(xt)j(may)e(be)i(included)e(by)g
(storing)h(the)g(e)o(xample)f(te)o(xt)h(in)h(an)f(e)o(xternal)f(\002le)
i(containing)d(only)i(plain)0 2914 y(te)o(xt.)48 b(The)27
b(\002le)i(may)e(be)h(included)e(using)h(the)h(standard)f
Fg(\\verbatiminput)f Fr(macro;)31 b(this)d(macro)f(tak)o(es)h(a)g
(single)g(ar)o(gument)0 3014 y(naming)19 b(the)h(\002le)h(containing)d
(the)i(te)o(xt.)25 b(F)o(or)20 b(e)o(xample,)f(to)h(include)f(the)h
(Python)f(source)h(\002le)h(`)p Fq(e)n(xample)o(.p)n(y)p
Fr(',)c(use:)236 3252 y Fh(\\verbatiminput{example.py})0
3539 y Fr(Use)k(of)e Fg(\\verbatiminput)f Fr(allo)n(ws)j(easier)f(use)g
(of)g(special)g(editing)f(modes)h(for)f(the)h(included)e(\002le.)26
b(The)20 b(\002le)g(should)f(be)h(placed)0 3638 y(in)g(the)h(same)f
(directory)e(as)j(the)f(L)952 3622 y Fk(A)982 3638 y
Fr(T)1019 3657 y(E)1059 3638 y(X)h(\002les)g(for)e(the)i(document.)0
3785 y(The)k(Python)g(Documentation)e(Special)j(Interest)f(Group)f(has)
i(discussed)g(a)g(number)e(of)h(approaches)f(to)i(creating)e
(pretty-printed)0 3885 y(code)j(displays)h(and)f(interacti)n(v)o(e)g
(sessions;)32 b(see)d(the)f(Doc-SIG)f(area)g(on)h(the)g(Python)e(W)-7
b(eb)29 b(site)g(for)e(more)g(information)f(on)h(this)0
3984 y(topic.)0 4269 y Fd(6.5)100 b(Inline)29 b(Mar)q(kup)0
4472 y Fr(The)20 b(macros)g(described)g(in)h(this)g(section)f(are)h
(used)g(to)f(mark)g(just)i(about)d(an)o(ything)g(interesting)h(in)h
(the)f(document)f(te)o(xt.)26 b(The)o(y)20 b(may)0 4572
y(be)g(used)g(in)g(headings)f(\(though)f(an)o(ything)g(in)m(v)n(olving)
h(hyperlinks)e(should)j(be)g(a)n(v)n(oided)f(there\))g(as)i(well)g(as)g
(in)f(the)g(body)f(te)o(xt.)0 4719 y Fg(\\)p Fb(bfcode)p
Fg({)p Fi(te)n(xt)q Fg(})208 4818 y Fr(Lik)o(e)h Fg(\\code)p
Fr(,)f(b)n(ut)h(also)h(mak)o(es)f(the)g(font)g(bold-f)o(ace.)0
4965 y Fg(\\)p Fb(cdata)p Fg({)p Fi(name)p Fg(})208 5065
y Fr(The)f(name)h(of)g(a)h(C-language)d(v)n(ariable.)0
5212 y Fg(\\)p Fb(cfunction)p Fg({)p Fi(name)p Fg(})208
5311 y Fr(The)h(name)h(of)g(a)h(C-language)d(function.)23
b Fi(name)d Fr(should)f(include)g(the)h(function)f(name)g(and)h(the)g
(trailing)g(parentheses.)p 0 5549 3901 4 v 0 5649 a Fj(6.4)83
b(Sho)o(wing)25 b(Code)e(Examples)2684 b(11)p eop end
%%Page: 12 12
TeXDict begin 12 11 bop 0 83 a Fg(\\)p Fb(character)p
Fg({)p Fi(c)o(har)r Fg(})208 183 y Fr(A)22 b(character)g(when)f
(discussing)h(the)h(character)e(rather)h(than)g(a)g(one-byte)f(string)h
(v)n(alue.)31 b(The)22 b(character)f(will)i(be)g(typeset)f(as)208
282 y(with)e Fg(\\samp)p Fr(.)0 429 y Fg(\\)p Fb(citetitle)p
Fg([)p Fi(url)p Fg(]{)p Fi(title)p Fg(})208 529 y Fr(A)h(title)g(for)f
(a)h(referenced)d(publication.)24 b(If)d Fi(url)g Fr(is)g(speci\002ed,)
f(the)h(title)g(will)g(be)g(made)f(into)g(a)h(hyperlink)d(when)i
(formatted)f(as)208 628 y(HTML.)0 775 y Fg(\\)p Fb(class)p
Fg({)p Fi(name)p Fg(})208 875 y Fr(A)h(class)h(name;)f(a)h(dotted)e
(name)h(may)f(be)h(used.)0 1022 y Fg(\\)p Fb(code)p Fg({)p
Fi(te)n(xt)q Fg(})208 1121 y Fr(A)k(short)f(code)g(fragment)f(or)h
(literal)h(constant)f(v)n(alue.)35 b(T)-7 b(ypically)i(,)23
b(it)h(should)f(not)g(include)g(an)o(y)f(spaces)i(since)g(no)f
(quotation)208 1221 y(marks)c(are)h(added.)0 1368 y Fg(\\)p
Fb(constant)p Fg({)p Fi(name)p Fg(})208 1468 y Fr(The)d(name)f(of)h(a)h
(\223de\002ned\224)e(constant.)23 b(This)18 b(may)e(be)i(a)f
(C-language)f Fg(#define)g Fr(or)h(a)h(Python)e(v)n(ariable)h(that)g
(is)h(not)f(intended)208 1567 y(to)j(be)g(changed.)0
1714 y Fg(\\)p Fb(csimplemacro)p Fg({)p Fi(name)p Fg(})208
1814 y Fr(The)e(name)g(of)h(a)g(\223simple\224)g(macro.)k(Simple)c
(macros)f(are)h(macros)f(which)h(are)f(used)h(for)f(code)g(e)o
(xpansion,)f(b)n(ut)i(which)f(do)h(not)208 1913 y(tak)o(e)d(ar)o
(guments)f(so)j(cannot)d(be)i(described)f(as)h(functions.)23
b(This)17 b(is)g(not)g(to)g(be)g(used)f(for)h(simple)g(constant)f
(de\002nitions.)23 b(Exam-)208 2013 y(ples)d(of)g(its)h(use)g(in)f(the)
g(Python)f(documentation)e(include)j Fg(PyObject_HEAD)e
Fr(and)i Fg(Py_BEGIN_ALLOW_THREADS)p Fr(.)0 2160 y Fg(\\)p
Fb(ctype)p Fg({)p Fi(name)p Fg(})208 2259 y Fr(The)k(name)g(of)g(a)h(C)
h Fg(typedef)e Fr(or)g(structure.)38 b(F)o(or)24 b(structures)g
(de\002ned)g(without)g(a)h Fg(typedef)p Fr(,)g(use)f
Fg(\\ctype{struct)208 2359 y(struct_tag})18 b Fr(to)j(mak)o(e)e(it)i
(clear)f(that)h(the)f Fg(struct)f Fr(is)j(required.)0
2506 y Fg(\\)p Fb(deprecated)p Fg({)p Fi(ver)o(sion)p
Fg(}{)p Fi(what)17 b(to)k(do)p Fg(})208 2606 y Fr(Declare)d(whate)n(v)o
(er)g(is)i(being)f(described)f(as)h(being)g(deprecated)e(starting)i
(with)g(release)h Fi(ver)o(sion)p Fr(.)k(The)19 b(te)o(xt)g(gi)n(v)o
(en)f(as)i Fi(what)f(to)208 2705 y(do)g Fr(should)g(recommend)e
(something)i(to)h(use)g(instead.)k(It)c(should)f(be)h(complete)f
(sentences.)24 b(The)c(entire)f(deprecation)f(notice)208
2805 y(will)k(be)g(presented)f(as)i(a)g(separate)e(paragraph;)g(it)i
(should)e(either)h(precede)e(or)i(succeed)g(the)g(description)e(of)i
(the)g(deprecated)208 2904 y(feature.)0 3051 y Fg(\\)p
Fb(dfn)p Fg({)p Fi(term)p Fg(})208 3151 y Fr(Mark)d(the)h(de\002ning)f
(instance)h(of)g Fi(term)h Fr(in)f(the)g(te)o(xt.)25
b(\(No)20 b(inde)o(x)f(entries)h(are)g(generated.\))0
3298 y Fg(\\)p Fb(e)208 3397 y Fr(Produces)f(a)i(backslash.)k(This)c
(is)g(con)m(v)o(enient)d(in)j Fg(\\code)p Fr(,)f Fg(\\file)p
Fr(,)g(and)g(similar)h(macros,)e(and)h(the)h Fg(alltt)f
Fr(en)m(vironment,)208 3497 y(and)27 b(is)h(only)f(de\002ned)g(there.)
47 b(T)-7 b(o)28 b(create)g(a)g(backslash)f(in)h(ordinary)e(te)o(xt)h
(\(such)g(as)i(the)f(contents)f(of)g(the)h Fg(\\citetitle)208
3597 y Fr(macro\),)18 b(use)j(the)f(standard)f Fg(\\textbackslash)f
Fr(macro.)0 3744 y Fg(\\)p Fb(email)p Fg({)p Fi(addr)m(ess)p
Fg(})208 3843 y Fr(An)25 b(email)h(address.)41 b(Note)25
b(that)h(this)g(is)h Fi(not)e Fr(hyperlink)o(ed)e(in)i(an)o(y)g(of)h
(the)f(possible)h(output)e(formats.)41 b(The)25 b(domain)f(name)208
3943 y(portion)18 b(of)i(the)g(address)g(should)f(be)h(lo)n(wer)g
(case.)0 4090 y Fg(\\)p Fb(emph)p Fg({)p Fi(te)n(xt)q
Fg(})208 4189 y Fr(Emphasized)e(te)o(xt;)i(this)h(will)g(be)f
(presented)f(in)h(an)g(italic)h(font.)0 4336 y Fg(\\)p
Fb(envvar)p Fg({)p Fi(name)p Fg(})208 4436 y Fr(An)f(en)m(vironment)d
(v)n(ariable.)24 b(Inde)o(x)18 b(entries)i(are)g(generated.)0
4583 y Fg(\\)p Fb(exception)p Fg({)p Fi(name)p Fg(})208
4682 y Fr(The)f(name)h(of)g(an)g(e)o(xception.)j(A)e(dotted)e(name)h
(may)f(be)h(used.)0 4829 y Fg(\\)p Fb(file)p Fg({)p Fi(\002le)f(or)i
(dir)r Fg(})208 4929 y Fr(The)k(name)g(of)h(a)g(\002le)g(or)g
(directory)-5 b(.)39 b(In)25 b(the)h(PDF)h(and)e(PostScript)h(outputs,)
g(single)f(quotes)g(and)h(a)g(font)f(change)f(are)i(used)208
5028 y(to)c(indicate)f(the)h(\002le)g(name,)f(b)n(ut)h(no)g(quotes)f
(are)g(used)h(in)g(the)g(HTML)f(output.)29 b Fm(W)-5
b(ar)o(ning:)27 b Fr(The)22 b Fg(\\file)f Fr(macro)g(cannot)g(be)208
5128 y(used)e(in)i(the)f(content)f(of)h(a)h(section)f(title)h(due)e(to)
i(processing)d(limitations.)0 5275 y Fg(\\)p Fb(filenq)p
Fg({)p Fi(\002le)h(or)h(dir)r Fg(})208 5374 y Fr(Lik)o(e)e
Fg(\\file)p Fr(,)h(b)n(ut)f(single)h(quotes)f(are)h(ne)n(v)o(er)e
(used.)24 b(This)19 b(can)f(be)h(used)g(in)f(conjunction)f(with)i
(tables)f(if)h(a)h(column)d(will)i(only)p 0 5549 3901
4 v 0 5649 a Fj(12)2661 b(6)83 b(Special)25 b(Mar)q(kup)e(Constr)q
(ucts)p eop end
%%Page: 13 13
TeXDict begin 13 12 bop 208 83 a Fr(contain)19 b(\002le)i(or)e
(directory)g(names.)24 b Fm(W)-5 b(ar)o(ning:)24 b Fr(The)c
Fg(\\filenq)g Fr(macro)f(cannot)g(be)h(used)g(in)g(the)g(content)f(of)h
(a)h(section)f(title)208 183 y(due)f(to)i(processing)d(limitations.)0
330 y Fg(\\)p Fb(function)p Fg({)p Fi(name)p Fg(})208
429 y Fr(The)h(name)h(of)g(a)h(Python)e(function;)f(dotted)h(names)h
(may)g(be)g(used.)0 576 y Fg(\\)p Fb(infinity)208 676
y Fr(The)f(symbol)h(for)f(mathematical)g(in\002nity:)25
b Fa(1)p Fr(.)g(Some)20 b(W)-7 b(eb)21 b(bro)n(wsers)e(are)i(not)e
(able)h(to)h(render)e(the)h(HTML)g(representation)208
775 y(of)f(this)i(symbol)e(properly)-5 b(,)18 b(b)n(ut)i(support)f(is)i
(gro)n(wing.)0 922 y Fg(\\)p Fb(kbd)p Fg({)p Fi(k)o(e)n(y)e(sequence)p
Fg(})208 1022 y Fr(Mark)g(a)h(sequence)e(of)h(k)o(e)o(ystrok)o(es.)24
b(What)c(form)e Fi(k)o(e)n(y)i(sequence)e Fr(tak)o(es)i(may)g(depend)d
(on)j(platform-)d(or)j(application-speci\002c)208 1121
y(con)m(v)o(entions.)49 b(When)29 b(there)g(are)g(no)g(rele)n(v)n(ant)f
(con)m(v)o(entions,)h(the)g(names)g(of)g(modi\002er)f(k)o(e)o(ys)h
(should)f(be)h(spelled)g(out,)i(to)208 1221 y(impro)o(v)o(e)24
b(accessibility)j(for)f(ne)n(w)h(users)g(and)f(non-nati)n(v)o(e)f
(speak)o(ers.)44 b(F)o(or)27 b(e)o(xample,)g(an)g Fm(xemacs)f
Fr(k)o(e)o(y)g(sequence)g(may)h(be)208 1321 y(mark)o(ed)20
b(lik)o(e)h Fg(\\kbd{C-x)49 b(C-f})p Fr(,)21 b(b)n(ut)h(without)e
(reference)g(to)i(a)g(speci\002c)f(application)f(or)i(platform,)e(the)h
(same)h(sequence)208 1420 y(should)d(be)h(mark)o(ed)f(as)i
Fg(\\kbd{Control-x)47 b(Control-f})p Fr(.)0 1567 y Fg(\\)p
Fb(keyword)p Fg({)p Fi(name)p Fg(})208 1667 y Fr(The)19
b(name)h(of)g(a)h(k)o(e)o(yw)o(ord)d(in)i(a)h(programming)c(language.)0
1814 y Fg(\\)p Fb(mailheader)p Fg({)p Fi(name)p Fg(})208
1913 y Fr(The)30 b(name)h(of)g(an)g(RFC)h(822-style)e(mail)h(header)-5
b(.)57 b(This)31 b(markup)e(does)i(not)g(imply)f(that)h(the)h(header)d
(is)j(being)f(used)f(in)208 2013 y(an)e(email)g(message,)i(b)n(ut)e
(can)g(be)g(used)g(to)g(refer)f(to)i(an)o(y)e(header)g(of)h(the)g(same)
g(\223style.)-6 b(\224)49 b(This)29 b(is)g(also)f(used)g(for)f(headers)
208 2113 y(de\002ned)g(by)i(the)g(v)n(arious)e(MIME)i
(speci\002cations.)50 b(The)28 b(header)g(name)g(should)g(be)h(entered)
e(in)i(the)g(same)g(w)o(ay)g(it)g(w)o(ould)208 2212 y(normally)f(be)i
(found)e(in)j(practice,)g(with)g(the)f(camel-casing)e(con)m(v)o
(entions)g(being)h(preferred)f(where)h(there)h(is)h(more)e(than)208
2312 y(one)d(common)f(usage.)45 b(The)27 b(colon)f(which)g(follo)n(ws)h
(the)g(name)f(of)h(the)g(header)f(should)g(not)g(be)h(included.)44
b(F)o(or)27 b(e)o(xample:)208 2411 y Fg(\\mailheader{Content-Type})p
Fr(.)0 2558 y Fg(\\)p Fb(makevar)p Fg({)p Fi(name)p Fg(})208
2658 y Fr(The)19 b(name)h(of)g(a)h Fm(mak)o(e)f Fr(v)n(ariable.)0
2805 y Fg(\\)p Fb(manpage)p Fg({)p Fi(name)p Fg(}{)p
Fi(section)p Fg(})208 2904 y Fr(A)g(reference)f(to)h(a)j(U)t
Ff(N)t(I)t(X)g Fr(manual)c(page.)0 3051 y Fg(\\)p Fb(member)p
Fg({)p Fi(name)p Fg(})208 3151 y Fr(The)g(name)h(of)g(a)h(data)f
(attrib)n(ute)f(of)h(an)g(object.)0 3298 y Fg(\\)p Fb(method)p
Fg({)p Fi(name)p Fg(})208 3397 y Fr(The)27 b(name)g(of)h(a)g(method)f
(of)g(an)h(object.)47 b Fi(name)28 b Fr(should)e(include)h(the)h
(method)f(name)g(and)g(the)h(trailing)f(parentheses.)47
b(A)208 3497 y(dotted)19 b(name)g(may)h(be)g(used.)0
3644 y Fg(\\)p Fb(mimetype)p Fg({)p Fi(name)p Fg(})208
3744 y Fr(The)f(name)h(of)g(a)h(MIME)e(type,)h(or)g(a)g(component)e(of)
i(a)g(MIME)g(type)g(\(the)g(major)f(or)h(minor)f(portion,)g(tak)o(en)g
(alone\).)0 3890 y Fg(\\)p Fb(module)p Fg({)p Fi(name)p
Fg(})208 3990 y Fr(The)g(name)h(of)g(a)h(module;)d(a)j(dotted)e(name)h
(may)g(be)g(used.)k(This)d(should)e(also)h(be)h(used)f(for)f(package)g
(names.)0 4137 y Fg(\\)p Fb(newsgroup)p Fg({)p Fi(name)p
Fg(})208 4237 y Fr(The)g(name)h(of)g(a)h(Usenet)f(ne)n(wsgroup.)0
4383 y Fg(\\)p Fb(note)p Fg({)p Fi(te)n(xt)q Fg(})208
4483 y Fr(An)f(especially)g(important)e(bit)j(of)f(information)e(about)
h(an)i(API)f(that)h(a)f(user)g(should)g(be)g(a)o(w)o(are)g(of)g(when)g
(using)g(whate)n(v)o(er)e(bit)208 4583 y(of)22 b(API)g(the)h(note)e
(pertains)h(to.)32 b(This)22 b(should)f(be)i(the)f(last)h(thing)f(in)g
(the)h(paragraph)c(as)k(the)g(end)f(of)g(the)g(note)g(is)h(not)f
(visually)208 4682 y(mark)o(ed)k(in)i(an)o(y)e(w)o(ay)-5
b(.)47 b(The)27 b(content)g(of)g Fi(te)n(xt)j Fr(should)d(be)g(written)
h(in)f(complete)g(sentences)g(and)g(include)g(all)h(appropriate)208
4782 y(punctuation.)0 4929 y Fg(\\)p Fb(pep)p Fg({)p
Fi(number)r Fg(})208 5028 y Fr(A)21 b(reference)e(to)i(a)g(Python)e
(Enhancement)f(Proposal.)26 b(This)21 b(generates)f(appropriate)e(inde)
o(x)h(entries.)27 b(The)20 b(te)o(xt)g(`)p Fg(PEP)49
b Fi(num-)208 5128 y(ber)r Fr(')20 b(is)h(generated;)d(in)j(the)f(HTML)
g(output,)e(this)j(te)o(xt)f(is)h(a)g(hyperlink)c(to)k(an)f(online)f
(cop)o(y)h(of)g(the)g(speci\002ed)g(PEP)-9 b(.)0 5275
y Fg(\\)p Fb(plusminus)208 5374 y Fr(The)20 b(symbol)g(for)h
(indicating)e(a)j(v)n(alue)e(that)h(may)f(tak)o(e)h(a)h(positi)n(v)o(e)
e(or)h(ne)o(gati)n(v)o(e)d(v)n(alue)j(of)f(a)i(speci\002ed)e
(magnitude,)f(typically)p 0 5549 3901 4 v 0 5649 a Fj(6.5)83
b(Inline)25 b(Mar)q(kup)3110 b(13)p eop end
%%Page: 14 14
TeXDict begin 14 13 bop 208 83 a Fr(represented)18 b(by)i(a)g(plus)h
(sign)f(placed)f(o)o(v)o(er)g(a)i(minus)e(sign.)25 b(F)o(or)20
b(e)o(xample:)k Fg(\\plusminus)48 b(3\045)p Fr(.)0 230
y Fg(\\)p Fb(program)p Fg({)p Fi(name)p Fg(})208 330
y Fr(The)20 b(name)h(of)g(an)g(e)o(x)o(ecutable)e(program.)26
b(This)21 b(may)g(dif)n(fer)f(from)g(the)h(\002le)h(name)f(for)f(the)h
(e)o(x)o(ecutable)f(for)g(some)h(platforms.)208 429 y(In)e(particular)m
(,)g(the)h(`)p Fq(.e)n(x)n(e)p Fr(')f(\(or)g(other\))g(e)o(xtension)g
(should)g(be)h(omitted)g(for)f(W)m(indo)n(ws)h(programs.)0
576 y Fg(\\)p Fb(programopt)p Fg({)p Fi(option)p Fg(})208
676 y Fr(A)26 b(command-line)c(option)j(to)g(an)h(e)o(x)o(ecutable)d
(program.)39 b(Use)26 b(this)g(only)f(for)g(\223short\224)g(options,)h
(and)f(include)f(the)i(leading)208 775 y(hyphen.)0 922
y Fg(\\)p Fb(longprogramopt)p Fg({)p Fi(option)p Fg(})208
1022 y Fr(A)21 b(long)g(command-line)d(option)i(to)h(an)g(e)o(x)o
(ecutable)f(program.)25 b(This)d(should)e(only)g(be)h(used)g(for)g
(long)f(option)g(names)h(which)208 1121 y(will)f(be)h(pre\002x)o(ed)d
(by)i(tw)o(o)g(hyphens;)f(the)h(hyphens)e(should)h(not)h(be)g(pro)o
(vided)e(as)j(part)e(of)h Fi(option)p Fr(.)0 1268 y Fg(\\)p
Fb(refmodule)p Fg([)p Fi(k)o(e)n(y)p Fg(]{)p Fi(name)p
Fg(})208 1368 y Fr(Lik)o(e)d Fg(\\module)p Fr(,)h(b)n(ut)g(create)f(a)i
(hyperlink)c(to)j(the)g(documentation)d(for)j(the)f(named)g(module.)23
b(Note)18 b(that)g(the)g(corresponding)208 1468 y Fg(\\declaremodule)g
Fr(must)i(be)g(in)g(the)g(same)g(document.)j(If)d(the)g
Fg(\\declaremodule)e Fr(de\002nes)i(a)g(module)f(k)o(e)o(y)g(dif)n
(ferent)208 1567 y(from)g(the)h(module)f(name,)g(it)i(must)f(also)h(be)
f(pro)o(vided)d(as)k Fi(k)o(e)n(y)f Fr(to)h(the)f Fg(\\refmodule)f
Fr(macro.)0 1714 y Fg(\\)p Fb(regexp)p Fg({)p Fi(string)p
Fg(})208 1814 y Fr(Mark)g(a)i(re)o(gular)d(e)o(xpression.)0
1961 y Fg(\\)p Fb(rfc)p Fg({)p Fi(number)r Fg(})208 2060
y Fr(A)29 b(reference)e(to)i(an)f(Internet)g(Request)h(for)f(Comments.)
50 b(This)29 b(generates)f(appropriate)e(inde)o(x)h(entries.)51
b(The)28 b(te)o(xt)h(`)p Fg(RFC)208 2160 y Fi(number)r
Fr(')18 b(is)k(generated;)c(in)j(the)f(HTML)g(output,)e(this)j(te)o(xt)
f(is)h(a)g(hyperlink)c(to)k(an)f(online)f(cop)o(y)h(of)f(the)i
(speci\002ed)f(RFC.)0 2307 y Fg(\\)p Fb(samp)p Fg({)p
Fi(te)n(xt)q Fg(})208 2406 y Fr(A)h(short)g(code)g(sample,)g(b)n(ut)h
(possibly)e(longer)g(than)h(w)o(ould)g(be)g(gi)n(v)o(en)f(using)h
Fg(\\code)p Fr(.)28 b(Since)21 b(quotation)f(marks)h(are)g(added,)208
2506 y(spaces)f(are)g(acceptable.)0 2653 y Fg(\\)p Fb(shortversion)208
2752 y Fr(The)h(\223short\224)h(v)o(ersion)e(number)h(of)g(the)i
(documented)c(softw)o(are,)j(as)h(speci\002ed)e(using)h(the)g
Fg(\\setshortversion)e Fr(macro)208 2852 y(in)38 b(the)g(preamble.)77
b(F)o(or)37 b(Python,)k(the)d(short)g(v)o(ersion)f(number)f(for)h(a)i
(release)f(is)h(the)f(\002rst)g(three)g(characters)f(of)h(the)208
2952 y Fg(sys.version)29 b Fr(v)n(alue.)55 b(F)o(or)30
b(e)o(xample,)h(v)o(ersions)f(2.0b1)f(and)h(2.0.1)f(both)h(ha)n(v)o(e)g
(a)g(short)h(v)o(ersion)e(of)h(2.0.)55 b(This)31 b(may)208
3051 y(not)23 b(apply)f(for)h(all)h(packages;)g(if)f
Fg(\\setshortversion)e Fr(is)k(not)e(used,)g(this)h(produces)e(an)h
(empty)g(e)o(xpansion.)32 b(See)24 b(also)208 3151 y(the)c
Fg(\\version)f Fr(macro.)0 3298 y Fg(\\)p Fb(strong)p
Fg({)p Fi(te)n(xt)q Fg(})208 3397 y Fr(Strongly)f(emphasized)h(te)o
(xt;)h(this)h(will)g(be)f(presented)f(using)g(a)i(bold)e(font.)0
3544 y Fg(\\)p Fb(ulink)p Fg({)p Fi(te)n(xt)q Fg(}{)p
Fi(url)p Fg(})208 3644 y Fr(A)29 b(hyperte)o(xt)e(link)i(with)g(a)g
(tar)o(get)g(speci\002ed)f(by)h(a)h(URL,)f(b)n(ut)g(for)g(which)f(the)h
(link)g(te)o(xt)g(should)f(not)h(be)g(the)g(title)h(of)f(the)208
3744 y(resource.)40 b(F)o(or)25 b(resources)g(being)f(referenced)g(by)h
(name,)h(use)g(the)g Fg(\\citetitle)e Fr(macro.)41 b(Not)25
b(all)i(formatted)d(v)o(ersions)208 3843 y(support)17
b(arbitrary)h(hyperte)o(xt)e(links.)25 b(Note)19 b(that)g(man)o(y)f
(characters)g(are)h(special)g(to)g(L)2681 3826 y Fk(A)2711
3843 y Fr(T)2748 3862 y(E)2788 3843 y(X)g(and)g(this)h(macro)e(does)g
(not)h(al)o(w)o(ays)208 3943 y(do)26 b(the)h(right)g(thing.)44
b(In)27 b(particular)m(,)g(the)g(tilde)g(character)f(\(`)p
Fg(\230)p Fr('\))g(is)i(mis-handled;)h(encoding)c(it)i(as)h(a)g(he)o
(x-sequence)c(does)208 4042 y(w)o(ork,)19 b(use)h(`)p
Fg(\0457e)p Fr(')g(in)g(place)g(of)g(the)g(tilde)h(character)-5
b(.)0 4189 y Fg(\\)p Fb(url)p Fg({)p Fi(url)p Fg(})208
4289 y Fr(A)20 b(URL)h(\(or)e(URN\).)i(The)e(URL)i(will)g(be)f
(presented)f(as)i(te)o(xt.)j(In)c(the)g(HTML)g(and)g(PDF)h(formatted)d
(v)o(ersions,)h(the)h(URL)h(will)208 4389 y(also)h(be)g(a)h(hyperlink.)
29 b(This)22 b(can)h(be)f(used)g(when)g(referring)e(to)i(e)o(xternal)f
(resources)h(without)f(speci\002c)i(titles;)h(references)d(to)208
4488 y(resources)e(which)i(ha)n(v)o(e)f(titles)i(should)e(be)h(mark)o
(ed)e(using)h(the)h Fg(\\citetitle)f Fr(macro.)26 b(See)21
b(the)g(comments)f(about)f(special)208 4588 y(characters)g(in)h(the)g
(description)f(of)h(the)g Fg(\\ulink)g Fr(macro)f(for)h(special)g
(considerations.)0 4735 y Fg(\\)p Fb(var)p Fg({)p Fi(name)p
Fg(})208 4834 y Fr(The)f(name)h(of)g(a)h(v)n(ariable)e(or)h(formal)f
(parameter)f(in)j(running)d(te)o(xt.)0 4981 y Fg(\\)p
Fb(version)208 5081 y Fr(The)27 b(v)o(ersion)g(number)f(of)i(the)g
(described)e(softw)o(are,)j(as)g(speci\002ed)f(using)f
Fg(\\release)g Fr(in)h(the)g(preamble.)47 b(See)28 b(also)h(the)208
5180 y Fg(\\shortversion)18 b Fr(macro.)0 5327 y Fg(\\)p
Fb(warning)p Fg({)p Fi(te)n(xt)q Fg(})p 0 5549 3901 4
v 0 5649 a Fj(14)2661 b(6)83 b(Special)25 b(Mar)q(kup)e(Constr)q(ucts)p
eop end
%%Page: 15 15
TeXDict begin 15 14 bop 208 83 a Fr(An)29 b(important)e(bit)i(of)g
(information)e(about)h(an)h(API)g(that)h(a)f(user)g(should)f(be)h(v)o
(ery)f(a)o(w)o(are)h(of)g(when)f(using)h(whate)n(v)o(er)e(bit)208
183 y(of)h(API)i(the)f(w)o(arning)f(pertains)h(to.)52
b(This)29 b(should)g(be)g(the)g(last)h(thing)e(in)i(the)f(paragraph)e
(as)j(the)f(end)f(of)h(the)h(w)o(arning)e(is)208 282
y(not)e(visually)g(mark)o(ed)f(in)i(an)o(y)f(w)o(ay)-5
b(.)44 b(The)26 b(content)g(of)g Fi(te)n(xt)j Fr(should)d(be)g(written)
h(in)f(complete)g(sentences)g(and)g(include)g(all)208
382 y(appropriate)j(punctuation.)58 b(This)32 b(dif)n(fers)g(from)f
Fg(\\note)g Fr(in)i(that)f(it)g(is)h(recommended)c(o)o(v)o(er)i
Fg(\\note)h Fr(for)f(information)208 482 y(re)o(garding)17
b(security)-5 b(.)0 628 y(The)18 b(follo)n(wing)f(tw)o(o)h(macros)g
(are)g(used)h(to)f(describe)g(information)e(that')-5
b(s)19 b(associated)f(with)g(changes)g(from)f(one)h(release)g(to)h
(another)-5 b(.)0 728 y(F)o(or)24 b(features)g(which)f(are)h(described)
f(by)h(a)h(single)f(paragraph,)f(these)h(are)g(typically)g(added)f(as)i
(separate)f(source)f(lines)i(at)g(the)f(end)0 828 y(of)k(the)g
(paragraph.)45 b(When)28 b(adding)f(these)h(to)g(features)f(described)g
(by)g(multiple)h(paragraphs,)f(the)o(y)h(are)f(usually)h(collected)f
(in)h(a)0 927 y(single)d(separate)f(paragraph)f(after)h(the)h
(description.)38 b(When)24 b(both)g Fg(\\versionadded)f
Fr(and)i Fg(\\versionchanged)d Fr(are)j(used,)0 1027
y Fg(\\versionadded)18 b Fr(should)g(come)h(\002rst;)i(the)e(v)o
(ersions)g(should)f(be)i(listed)g(in)g(chronological)c(order)-5
b(.)24 b(Both)c(of)f(these)h(should)e(come)0 1127 y(before)d(a)n(v)n
(ailability)h(statements.)24 b(The)16 b(location)f(should)h(be)g
(selected)h(so)g(the)f(e)o(xplanation)e(mak)o(es)j(sense)f(and)g(may)g
(v)n(ary)g(as)h(needed.)0 1273 y Fg(\\)p Fb(versionadded)p
Fg([)p Fi(e)n(xplanation)p Fg(]{)p Fi(ver)o(sion)p Fg(})208
1373 y Fr(The)30 b(v)o(ersion)g(of)h(Python)f(which)h(added)f(the)h
(described)f(feature)g(to)h(the)h(library)e(or)g(C)j(API.)e
Fi(e)n(xplanation)e Fr(should)h(be)h(a)208 1473 y Fi(brief)21
b Fr(e)o(xplanation)e(of)i(the)h(change)e(consisting)h(of)g(a)h
(capitalized)e(sentence)h(fragment;)f(a)i(period)e(will)i(be)g
(appended)d(by)i(the)208 1572 y(formatting)e(process.)29
b(When)22 b(this)g(applies)g(to)g(an)f(entire)h(module,)e(it)j(should)d
(be)i(placed)f(at)h(the)g(top)f(of)h(the)f(module)g(section)208
1672 y(before)d(an)o(y)i(prose.)0 1819 y Fg(\\)p Fb(versionchanged)p
Fg([)p Fi(e)n(xplanation)p Fg(]{)p Fi(ver)o(sion)p Fg(})208
1918 y Fr(The)25 b(v)o(ersion)g(of)h(Python)f(in)h(which)f(the)h(named)
f(feature)g(w)o(as)i(changed)d(in)j(some)e(w)o(ay)i(\(ne)n(w)e
(parameters,)h(changed)e(side)208 2018 y(ef)n(fects,)34
b(etc.\).)61 b Fi(e)n(xplanation)30 b Fr(should)h(be)h(a)h
Fi(brief)f Fr(e)o(xplanation)e(of)i(the)g(change)f(consisting)g(of)h(a)
h(capitalized)e(sentence)208 2118 y(fragment;)16 b(a)i(period)f(will)h
(be)g(appended)d(by)i(the)h(formatting)e(process.)23
b(This)18 b(should)f(not)g(generally)f(be)i(applied)e(to)i(modules.)0
2403 y Fd(6.6)100 b(Miscellaneous)30 b(T)-12 b(e)m(xt)27
b(Mar)q(kup)0 2605 y Fr(In)g(addition)f(to)i(the)f(inline)g(markup,)g
(some)g(additional)f(\223block\224)g(markup)g(is)i(de\002ned)e(to)i
(mak)o(e)f(it)h(easier)f(to)h(bring)e(attention)g(to)0
2705 y(v)n(arious)21 b(bits)i(of)f(te)o(xt.)32 b(The)22
b(markup)e(described)h(here)h(serv)o(es)g(this)h(purpose,)e(and)h(is)i
(intended)d(to)h(be)g(used)h(when)e(marking)g(one)h(or)0
2805 y(more)d(paragraphs)f(or)i(other)g(block)f(constructs)g(\(such)h
(as)h Fg(verbatim)e Fr(en)m(vironments\).)0 2952 y Fg(\\begin{)p
Fb(notice)p Fg(}[)p Fi(type)p Fg(])0 3051 y(\\end{)p
Fb(notice)p Fg(})208 3151 y Fr(Label)k(some)h(paragraphs)e(as)i(being)f
(w)o(orthy)g(of)g(additional)g(attention)g(from)g(the)h(reader)-5
b(.)35 b(What)25 b(sort)f(of)f(attention)h(is)g(w)o(ar)n(-)208
3250 y(ranted)h(can)i(be)g(indicated)e(by)i(specifying)e(the)i
Fi(type)f Fr(of)h(the)g(notice.)44 b(The)26 b(only)g(v)n(alues)g
(de\002ned)g(for)g Fi(type)h Fr(are)g Fg(note)f Fr(and)208
3350 y Fg(warning)p Fr(;)i(these)e(are)g(equi)n(v)n(alent)e(in)i
(intent)g(to)g(the)g(inline)f(markup)g(of)g(the)h(same)g(name.)42
b(If)26 b Fi(type)g Fr(is)g(omitted,)h Fg(note)f Fr(is)208
3450 y(used.)e(Additional)19 b(v)n(alues)h(may)g(be)g(de\002ned)f(in)h
(the)h(future.)0 3735 y Fd(6.7)100 b(Module-speci\002c)30
b(Mar)q(kup)0 3938 y Fr(The)20 b(markup)f(described)g(in)i(this)g
(section)g(is)g(used)g(to)g(pro)o(vide)d(information)g(about)i(a)h
(module)e(being)h(documented.)k(Each)c(module)0 4037
y(should)d(be)g(documented)e(in)j(its)g(o)n(wn)g Fg(\\section)p
Fr(.)23 b(A)18 b(typical)f(use)h(of)f(this)h(markup)e(appears)h(at)h
(the)g(top)f(of)g(that)h(section)f(and)g(might)0 4137
y(look)i(lik)o(e)i(this:)236 4284 y Fh(\\section{\\module{spam})41
b(---)640 4375 y(Access)j(to)g(the)g(SPAM)h(facility})236
4558 y(\\declaremodule{extension}{spam})326 4649 y(\\platform{Unix})236
4740 y(\\modulesynopsis{Access)c(to)k(the)f(SPAM)g(facility)g(of)g
(\\UNIX.})236 4832 y(\\moduleauthor{Jane)e(Doe}{
[email protected]})
0 5118 y Fr(Python)19 b(packages)h(\227)h(collections)e(of)i(modules)e
(that)i(can)f(be)g(described)g(as)h(a)g(unit)f(\227)h(are)f(documented)
e(using)i(the)h(same)f(markup)0 5218 y(as)29 b(modules.)47
b(The)28 b(name)f(for)g(a)i(module)d(in)i(a)h(package)d(should)h(be)h
(typed)f(in)h(\223fully)f(quali\002ed\224)g(form)g(\(it)i(should)e
(include)g(the)0 5317 y(package)19 b(name\).)25 b(F)o(or)20
b(e)o(xample,)f(a)i(module)e(\223foo\224)g(in)i(package)e(\223bar\224)h
(should)f(be)h(mark)o(ed)g(as)h Fg(\\module{bar.foo})p
Fr(,)d(and)i(the)p 0 5549 3901 4 v 0 5649 a Fj(6.6)83
b(Miscellaneous)24 b(T)-10 b(e)n(xt)23 b(Mar)q(kup)2610
b(15)p eop end
%%Page: 16 16
TeXDict begin 16 15 bop 0 83 a Fr(be)o(ginning)18 b(of)i(the)g
(reference)e(section)i(w)o(ould)g(appear)f(as:)236 230
y Fh(\\section{\\module{bar.foo})41 b(---)640 321 y(Module)j(from)g
(the)g(\\module{bar})f(package})236 504 y
(\\declaremodule{extension}{bar.foo})236 595 y(\\modulesynopsis{Nifty)f
(module)h(from)i(the)f(\\module{bar})f(package.})236
687 y(\\moduleauthor{Jane)f(Doe}{
[email protected]})0
973 y Fr(Note)20 b(that)g(the)h(name)e(of)h(a)h(package)d(is)k(also)e
(mark)o(ed)f(using)h Fg(\\module)p Fr(.)0 1120 y Fg(\\)p
Fb(declaremodule)p Fg([)p Fi(k)o(e)n(y)p Fg(]{)p Fi(type)p
Fg(}{)p Fi(name)p Fg(})208 1220 y Fr(Requires)30 b(tw)o(o)h
(parameters:)45 b(module)29 b(type)h(\(`)p Fg(standard)p
Fr(',)h(`)p Fg(builtin)p Fr(',)g(`)p Fg(extension)p Fr(',)h(or)e(`'\),)
i(and)e(the)h(module)208 1319 y(name.)k(An)23 b(optional)g(parameter)f
(should)h(be)g(gi)n(v)o(en)g(as)h(the)g(basis)g(for)f(the)h(module')-5
b(s)23 b(\223k)o(e)o(y\224)g(used)g(for)g(linking)g(to)h(or)f(refer)n
(-)208 1419 y(encing)c(the)j(section.)27 b(The)20 b(\223k)o(e)o(y\224)h
(should)f(only)g(be)h(gi)n(v)o(en)f(if)h(the)g(module')-5
b(s)20 b(name)g(contains)h(an)o(y)f(underscores,)f(and)i(should)208
1518 y(be)g(the)g(name)g(with)h(the)f(underscores)f(stripped.)27
b(Note)22 b(that)f(the)h Fi(type)f Fr(parameter)f(must)h(be)h(one)f(of)
g(the)g(v)n(alues)g(listed)h(abo)o(v)o(e)208 1618 y(or)i(an)h(error)f
(will)i(be)f(printed.)39 b(F)o(or)24 b(modules)g(which)h(are)g
(contained)e(in)i(packages,)g(the)g(fully-quali\002ed)e(name)i(should)f
(be)208 1718 y(gi)n(v)o(en)18 b(as)j Fi(name)f Fr(parameter)-5
b(.)24 b(This)c(should)f(be)h(the)h(\002rst)g(thing)e(after)h(the)g
Fg(\\section)f Fr(used)h(to)h(introduce)d(the)i(module.)0
1865 y Fg(\\)p Fb(platform)p Fg({)p Fi(speci\002er)r
Fg(})208 1964 y Fr(Speci\002es)i(the)h(portability)e(of)h(the)h
(module.)30 b Fi(speci\002er)25 b Fr(is)e(a)g(comma-separated)d(list)j
(of)g(k)o(e)o(ys)f(that)g(specify)g(what)h(platforms)208
2064 y(the)28 b(module)g(is)i(a)n(v)n(ailable)e(on.)50
b(The)29 b(k)o(e)o(ys)f(are)h(short)g(identi\002ers;)k(e)o(xamples)27
b(that)i(are)g(in)g(use)g(include)f(`)p Fg(IRIX)p Fr(',)g(`)p
Fg(Mac)p Fr(',)208 2163 y(`)p Fg(Windows)p Fr(',)d(and)g(`)p
Fg(Unix)p Fr('.)40 b(It)25 b(is)i(important)d(to)i(use)f(a)h(k)o(e)o(y)
f(which)g(has)h(already)e(been)h(used)g(when)g(applicable.)40
b(This)26 b(is)208 2263 y(used)19 b(to)i(pro)o(vide)d(annotations)h(in)
h(the)g(Module)f(Inde)o(x)g(and)g(the)i(HTML)e(and)h(GNU)h(info)e
(output.)0 2410 y Fg(\\)p Fb(modulesynopsis)p Fg({)p
Fi(te)n(xt)q Fg(})208 2510 y Fr(The)e Fi(te)n(xt)k Fr(is)e(a)g(short,)e
(\223one)h(line\224)g(description)f(of)h(the)g(module)f(that)h(can)g
(be)g(used)g(as)h(part)f(of)f(the)i(chapter)e(introduction.)k(This)208
2609 y(is)h(must)f(be)g(placed)f(after)h Fg(\\declaremodule)p
Fr(.)k(The)c(synopsis)g(is)h(used)f(in)g(b)n(uilding)f(the)h(contents)f
(of)h(the)g(table)g(inserted)208 2709 y(as)f(the)h Fg
(\\localmoduletable)p Fr(.)h(No)e(te)o(xt)g(is)h(produced)d(at)j(the)f
(point)f(of)h(the)h(markup.)0 2856 y Fg(\\)p Fb(moduleauthor)p
Fg({)p Fi(name)p Fg(}{)p Fi(email)p Fg(})208 2955 y Fr(This)g(macro)g
(is)h(used)g(to)g(encode)e(information)f(about)i(who)g(authored)e(a)j
(module.)28 b(This)22 b(is)h(currently)c(not)j(used)f(to)h(generate)208
3055 y(output,)c(b)n(ut)i(can)g(be)h(used)f(to)g(help)g(determine)e
(the)j(origin)e(of)h(the)g(module.)0 3340 y Fd(6.8)100
b(Libr)o(ar)s(y-le)m(v)n(el)30 b(Mar)q(kup)0 3543 y Fr(This)20
b(markup)e(is)i(used)g(when)f(describing)f(a)i(selection)g(of)f
(modules.)24 b(F)o(or)19 b(e)o(xample,)f(the)i Fi(Macintosh)f(Libr)o
(ary)g(Modules)h Fr(document)0 3642 y(uses)31 b(this)g(to)g(help)f(pro)
o(vide)f(an)h(o)o(v)o(ervie)n(w)f(of)h(the)h(modules)e(in)i(the)g
(collection,)h(and)e(man)o(y)f(chapters)h(in)h(the)f
Fi(Python)g(Libr)o(ary)0 3742 y(Refer)m(ence)20 b Fr(use)g(it)h(for)e
(the)i(same)f(purpose.)0 3889 y Fg(\\)p Fb(localmoduletable)208
3988 y Fr(If)49 b(a)i(`)p Fq(.syn)p Fr(')f(\002le)g(e)o(xists)h(for)e
(the)h(current)e(chapter)h(\(or)h(for)f(the)h(entire)f(document)f(in)i
Fg(howto)g Fr(documents\),)55 b(a)208 4088 y Fg(synopsistable)18
b Fr(is)j(created)e(with)i(the)f(contents)f(loaded)h(from)f(the)h(`)p
Fq(.syn)p Fr(')g(\002le.)0 4373 y Fd(6.9)100 b(T)-12
b(ab)n(le)29 b(Mar)q(kup)0 4576 y Fr(There)20 b(are)h(three)f
(general-purpose)d(table)k(en)m(vironments)d(de\002ned)i(which)h
(should)e(be)i(used)g(whene)n(v)o(er)e(possible.)26 b(These)21
b(en)m(viron-)0 4676 y(ments)h(are)h(de\002ned)e(to)i(pro)o(vide)e
(tables)h(of)h(speci\002c)f(widths)h(and)f(some)g(con)m(v)o(enience)e
(for)i(formatting.)30 b(These)22 b(en)m(vironments)e(are)0
4775 y(not)27 b(meant)g(to)h(be)f(general)g(replacements)f(for)h(the)h
(standard)e(L)1888 4759 y Fk(A)1918 4775 y Fr(T)1955
4794 y(E)1994 4775 y(X)j(table)e(en)m(vironments,)f(b)n(ut)i(can)f(be)h
(used)f(for)g(an)h(adv)n(antage)0 4875 y(when)22 b(the)h(documents)d
(are)j(processed)e(using)h(the)h(tools)g(for)e(Python)h(documentation)d
(processing.)31 b(In)22 b(particular)m(,)g(the)g(generated)0
4974 y(HTML)e(looks)g(good!)j(There)c(is)i(also)g(an)f(adv)n(antage)e
(for)i(the)g(e)n(v)o(entual)e(con)m(v)o(ersion)g(of)i(the)g
(documentation)d(to)j(XML)g(\(see)h(section)0 5074 y(9,)f(\223Future)f
(Directions\224\).)0 5221 y(Each)28 b(en)m(vironment)e(is)j(named)e
Fg(table)p Fi(cols)p Fr(,)j(where)e Fi(cols)h Fr(is)g(the)g(number)e
(of)h(columns)f(in)i(the)g(table)f(speci\002ed)g(in)h(lo)n(wer)n(-case)
0 5321 y(Roman)17 b(numerals.)22 b(W)m(ithin)17 b(each)g(of)g(these)g
(en)m(vironments,)e(an)i(additional)f(macro,)h Fg(\\line)p
Fi(cols)p Fr(,)f(is)i(de\002ned,)f(where)f Fi(cols)i
Fr(matches)p 0 5549 3901 4 v 0 5649 a Fj(16)2661 b(6)83
b(Special)25 b(Mar)q(kup)e(Constr)q(ucts)p eop end
%%Page: 17 17
TeXDict begin 17 16 bop 0 83 a Fr(the)19 b Fi(cols)g
Fr(v)n(alue)e(of)i(the)f(corresponding)e(table)i(en)m(vironment.)j
(These)e(are)f(supported)f(for)h Fi(cols)h Fr(v)n(alues)f(of)h
Fg(ii)p Fr(,)f Fg(iii)p Fr(,)h(and)f Fg(iv)p Fr(.)25
b(These)0 183 y(en)m(vironments)19 b(are)i(all)h(b)n(uilt)g(on)f(top)g
(of)g(the)g Fg(tabular)g Fr(en)m(vironment.)k(V)-9 b(ariants)22
b(based)f(on)g(the)g Fg(longtable)f Fr(en)m(vironment)f(are)0
282 y(also)i(pro)o(vided.)0 429 y(Note)h(that)h(all)g(tables)f(in)h
(the)f(standard)f(Python)g(documentation)f(use)i(v)o(ertical)g(lines)h
(between)e(columns,)h(and)f(this)i(must)g(be)f(spec-)0
529 y(i\002ed)28 b(in)g(the)g(markup)f(for)g(each)h(table.)48
b(A)29 b(general)e(border)f(around)g(the)i(outside)f(of)h(the)g(table)g
(is)h(not)f(used,)h(b)n(ut)f(w)o(ould)g(be)g(the)0 628
y(responsibility)19 b(of)h(the)g(processor;)f(the)h(document)e(markup)h
(should)g(not)h(include)f(an)h(e)o(xterior)f(border)-5
b(.)0 775 y(The)21 b Fg(longtable)p Fr(-based)d(v)n(ariants)j(of)g(the)
g(table)g(en)m(vironments)d(are)j(formatted)f(with)h(e)o(xtra)f(space)h
(before)f(and)h(after)m(,)f(so)i(should)0 875 y(only)g(be)g(used)g(on)g
(tables)g(which)g(are)h(long)e(enough)f(that)j(splitting)f(o)o(v)o(er)f
(multiple)h(pages)g(is)h(reasonable;)f(tables)h(with)f(fe)n(wer)g(than)
0 975 y(twenty)27 b(ro)n(ws)f(should)g(ne)n(v)o(er)g(by)g(mark)o(ed)g
(using)h(the)g(long)f(\003a)n(v)n(ors)h(of)g(the)g(table)f(en)m
(vironments.)43 b(The)27 b(header)e(ro)n(w)i(is)h(repeated)0
1074 y(across)20 b(the)g(top)g(of)g(each)g(part)g(of)g(the)g(table.)0
1221 y Fg(\\begin{)p Fb(tableii)p Fg(}{)p Fi(colspec)p
Fg(}{)p Fi(col1font)q Fg(}{)p Fi(h)o(ead)o(ing)o(1)p
Fg(}{)p Fi(h)o(ea)o(din)o(g2)p Fg(})0 1321 y(\\end{)p
Fb(tableii)p Fg(})208 1420 y Fr(Create)31 b(a)g(tw)o(o-column)d(table)j
(using)f(the)h(L)1513 1404 y Fk(A)1543 1420 y Fr(T)1580
1439 y(E)1620 1420 y(X)g(column)e(speci\002er)i Fi(colspec)p
Fr(.)56 b(The)30 b(column)g(speci\002er)g(should)g(indicate)208
1520 y(v)o(ertical)23 b(bars)h(between)g(columns)f(as)i(appropriate)d
(for)i(the)h(speci\002c)f(table,)h(b)n(ut)g(should)e(not)h(specify)g(v)
o(ertical)f(bars)i(on)f(the)208 1620 y(outside)18 b(of)g(the)h(table)g
(\(that)f(is)i(considered)d(a)i(stylesheet)g(issue\).)25
b(The)18 b Fi(col1font)h Fr(parameter)f(is)h(used)g(as)g(a)h(stylistic)
f(treatment)208 1719 y(of)24 b(the)h(\002rst)g(column)e(of)i(the)f
(table:)34 b(the)25 b(\002rst)g(column)f(is)h(presented)f(as)h
Fg(\\)p Fi(col1font)q Fg({column1})p Fr(.)36 b(T)-7 b(o)24
b(a)n(v)n(oid)h(treating)f(the)208 1819 y(\002rst)h(column)f(specially)
-5 b(,)25 b Fi(col1font)g Fr(may)g(be)f(`)p Fg(textrm)p
Fr('.)38 b(The)25 b(column)f(headings)f(are)i(tak)o(en)g(from)e(the)i
(v)n(alues)g Fi(heading1)208 1918 y Fr(and)19 b Fi(heading2)p
Fr(.)0 2065 y Fg(\\begin{)p Fb(longtableii)p Fg(}...)0
2165 y(\\end{)p Fb(longtableii)p Fg(})208 2265 y Fr(Lik)o(e)27
b Fg(tableii)p Fr(,)h(b)n(ut)g(produces)d(a)j(table)g(which)f(may)g(be)
g(brok)o(en)f(across)h(page)g(boundaries.)45 b(The)27
b(parameters)f(are)i(the)208 2364 y(same)20 b(as)h(for)e
Fg(tableii)p Fr(.)0 2511 y Fg(\\)p Fb(lineii)p Fg({)p
Fi(column1)p Fg(}{)p Fi(column2)p Fg(})208 2611 y Fr(Create)g(a)h
(single)f(table)g(ro)n(w)g(within)g(a)g Fg(tableii)g
Fr(or)g Fg(longtableii)f Fr(en)m(vironment.)j(The)e(te)o(xt)g(for)g
(the)g(\002rst)h(column)e(will)208 2710 y(be)i(generated)e(by)i
(applying)e(the)i(macro)g(named)f(by)h(the)g Fi(col1font)g
Fr(v)n(alue)g(when)f(the)h Fg(tableii)g Fr(w)o(as)h(opened.)0
2857 y Fg(\\begin{)p Fb(tableiii)p Fg(}{)p Fi(colspec)p
Fg(}{)p Fi(col1fon)o(t)q Fg(}{)p Fi(head)o(ing)o(1)p
Fg(}{)o Fi(hea)o(din)o(g2)o Fg(}{)p Fi(h)o(ead)o(ing)o(3)p
Fg(})0 2957 y(\\end{)p Fb(tableiii)p Fg(})208 3056 y
Fr(Lik)o(e)h(the)h Fg(tableii)f Fr(en)m(vironment,)f(b)n(ut)i(with)g(a)
g(third)f(column.)32 b(The)23 b(heading)e(for)h(the)h(third)f(column)g
(is)i(gi)n(v)o(en)d(by)i Fi(head-)208 3156 y(ing3)p Fr(.)0
3303 y Fg(\\begin{)p Fb(longtableiii)p Fg(}...)0 3403
y(\\end{)p Fb(longtableiii)p Fg(})208 3502 y Fr(Lik)o(e)h
Fg(tableiii)p Fr(,)h(b)n(ut)g(produces)e(a)i(table)g(which)f(may)g(be)h
(brok)o(en)e(across)h(page)h(boundaries.)36 b(The)24
b(parameters)g(are)h(the)208 3602 y(same)20 b(as)h(for)e
Fg(tableiii)p Fr(.)0 3749 y Fg(\\)p Fb(lineiii)p Fg({)p
Fi(column1)p Fg(}{)p Fi(column2)p Fg(}{)o Fi(colu)o(mn3)o
Fg(})208 3848 y Fr(Lik)o(e)h(the)g Fg(\\lineii)f Fr(macro,)g(b)n(ut)h
(with)h(a)f(third)g(column.)k(The)19 b(te)o(xt)i(for)e(the)h(third)g
(column)f(is)i(gi)n(v)o(en)e(by)g Fi(column3)p Fr(.)0
3995 y Fg(\\begin{)p Fb(tableiv)p Fg(}{)p Fi(colspec)p
Fg(}{)p Fi(col1font)q Fg(}{)p Fi(h)o(ead)o(ing)o(1)p
Fg(}{)p Fi(h)o(ea)o(din)o(g2)p Fg(})o({)p Fi(hea)o(din)o(g3)o
Fg(}{)p Fi(h)o(ead)o(ing)o(4)p Fg(})0 4095 y(\\end{)p
Fb(tableiv)p Fg(})208 4194 y Fr(Lik)o(e)26 b(the)h Fg(tableiii)e
Fr(en)m(vironment,)g(b)n(ut)i(with)f(a)h(fourth)e(column.)43
b(The)26 b(heading)f(for)h(the)h(fourth)e(column)g(is)j(gi)n(v)o(en)d
(by)208 4294 y Fi(heading4)p Fr(.)0 4441 y Fg(\\begin{)p
Fb(longtableiv)p Fg(}...)0 4541 y(\\end{)p Fb(longtableiv)p
Fg(})208 4640 y Fr(Lik)o(e)i Fg(tableiv)p Fr(,)h(b)n(ut)g(produces)d(a)
j(table)g(which)f(may)g(be)g(brok)o(en)f(across)h(page)g(boundaries.)45
b(The)27 b(parameters)f(are)i(the)208 4740 y(same)20
b(as)h(for)e Fg(tableiv)p Fr(.)0 4887 y Fg(\\)p Fb(lineiv)p
Fg({)p Fi(column1)p Fg(}{)p Fi(column2)p Fg(}{)p Fi(c)o(olumn)o(3)p
Fg(})o({)p Fi(colu)o(mn4)o Fg(})208 4986 y Fr(Lik)o(e)h(the)g
Fg(\\lineiii)f Fr(macro,)g(b)n(ut)h(with)h(a)f(fourth)f(column.)24
b(The)19 b(te)o(xt)h(for)g(the)g(fourth)f(column)g(is)i(gi)n(v)o(en)e
(by)g Fi(column4)p Fr(.)0 5133 y Fg(\\begin{)p Fb(tablev)p
Fg(}{)p Fi(colspec)p Fg(}{)p Fi(col1font)q Fg(}{)p Fi(he)o(ad)o(ing1)o
Fg(}{)p Fi(h)o(ead)o(ing)o(2)p Fg(}{)o Fi(hea)o(din)o(g3)o
Fg(}{)p Fi(h)o(ead)o(ing)o(4)p Fg(}{)p Fi(h)o(ea)o(ding)o(5)p
Fg(})0 5233 y(\\end{)p Fb(tablev)p Fg(})208 5332 y Fr(Lik)o(e)e(the)g
Fg(tableiv)g Fr(en)m(vironment,)d(b)n(ut)k(with)f(a)h(\002fth)f
(column.)23 b(The)17 b(heading)f(for)g(the)i(\002fth)f(column)f(is)i
(gi)n(v)o(en)e(by)h Fi(heading5)p Fr(.)p 0 5549 3901
4 v 0 5649 a Fj(6.9)83 b(T)-10 b(ab)n(le)25 b(Mar)q(kup)3112
b(17)p eop end
%%Page: 18 18
TeXDict begin 18 17 bop 0 83 a Fg(\\begin{)p Fb(longtablev)p
Fg(}...)0 183 y(\\end{)p Fb(longtablev)p Fg(})208 282
y Fr(Lik)o(e)19 b Fg(tablev)p Fr(,)g(b)n(ut)h(produces)e(a)i(table)f
(which)g(may)h(be)f(brok)o(en)f(across)i(page)f(boundaries.)j(The)e
(parameters)e(are)i(the)f(same)208 382 y(as)h(for)g Fg(tablev)p
Fr(.)0 529 y Fg(\\)p Fb(linev)p Fg({)p Fi(column1)p Fg(}{)p
Fi(column2)p Fg(}{)p Fi(co)o(lumn)o(3)p Fg(}{)o Fi(colu)o(mn4)o
Fg(}{)p Fi(co)o(lumn)o(5)p Fg(})208 628 y Fr(Lik)o(e)g(the)g
Fg(\\lineiv)f Fr(macro,)g(b)n(ut)h(with)h(a)f(\002fth)h(column.)i(The)d
(te)o(xt)g(for)g(the)g(\002fth)g(column)f(is)i(gi)n(v)o(en)e(by)h
Fi(column5)p Fr(.)0 775 y(An)27 b(additional)f(table-lik)o(e)h(en)m
(vironment)d(is)k Fg(synopsistable)p Fr(.)44 b(The)27
b(table)g(generated)f(by)h(this)h(en)m(vironment)c(contains)i(tw)o(o)0
875 y(columns,)15 b(and)h(each)f(ro)n(w)h(is)g(de\002ned)f(by)h(an)f
(alternate)h(de\002nition)e(of)i Fg(\\modulesynopsis)p
Fr(.)21 b(This)16 b(en)m(vironment)d(is)k(not)e(normally)0
975 y(used)20 b(by)g(authors,)f(b)n(ut)h(is)h(created)e(by)h(the)g
Fg(\\localmoduletable)e Fr(macro.)0 1121 y(Here)25 b(is)h(a)g(small)g
(e)o(xample)e(of)h(a)h(table)f(gi)n(v)o(en)f(in)i(the)f(documentation)d
(for)j(the)g Fg(warnings)g Fr(module;)h(markup)e(inside)h(the)h(table)0
1221 y(cells)21 b(is)g(minimal)f(so)g(the)g(markup)f(for)g(the)i(table)
f(itself)g(is)i(readily)d(discernable.)k(Here)e(is)g(the)f(markup)e
(for)i(the)g(table:)236 1459 y Fh
(\\begin{tableii}{l|l}{exception}{Class}{D)o(escrip)o(tion})326
1551 y(\\lineii{Warning})640 1642 y({This)44 b(is)g(the)h(base)f(class)
g(of)g(all)g(warning)g(category)g(classes.)88 b(It)685
1733 y(is)44 b(a)h(subclass)e(of)i(\\exception{Exception}.})326
1825 y(\\lineii{UserWarning})640 1916 y({The)f(default)g(category)f
(for)h(\\function{warn\(\)}.})326 2007 y(\\lineii{DeprecationWarning})
640 2098 y({Base)g(category)f(for)i(warnings)e(about)h(deprecated)f
(features.})326 2190 y(\\lineii{SyntaxWarning})640 2281
y({Base)h(category)f(for)i(warnings)e(about)h(dubious)g(syntactic)685
2372 y(features.})326 2464 y(\\lineii{RuntimeWarning})640
2555 y({Base)g(category)f(for)i(warnings)e(about)h(dubious)g(runtime)f
(features.})326 2646 y(\\lineii{FutureWarning})640 2738
y({Base)h(category)f(for)i(warnings)e(about)h(constructs)f(that)h(will)
g(change)640 2829 y(semantically)f(in)h(the)g(future.})236
2920 y(\\end{tableii})0 3207 y Fr(Here)20 b(is)h(the)f(resulting)g
(table:)50 3515 y Fm(Class)p 995 3545 4 100 v 807 w(Description)p
0 3548 3943 4 v 50 3618 a Fg(Warning)p 995 3648 4 100
v 646 w Fr(This)g(is)i(the)e(base)g(class)h(of)f(all)h(w)o(arning)e
(cate)o(gory)f(classes.)26 b(It)21 b(is)g(a)g(subclass)f(of)g
Fg(Exception)p Fr(.)50 3717 y Fg(UserWarning)p 995 3747
V 446 w Fr(The)g(def)o(ault)f(cate)o(gory)g(for)g Fg(warn\(\))p
Fr(.)50 3817 y Fg(DeprecationWarning)p 995 3847 V 96
w Fr(Base)i(cate)o(gory)e(for)g(w)o(arnings)g(about)h(deprecated)e
(features.)50 3917 y Fg(SyntaxWarning)p 995 3947 V 346
w Fr(Base)j(cate)o(gory)e(for)g(w)o(arnings)g(about)h(dubious)e
(syntactic)i(features.)50 4016 y Fg(RuntimeWarning)p
995 4046 V 296 w Fr(Base)h(cate)o(gory)e(for)g(w)o(arnings)g(about)h
(dubious)e(runtime)h(features.)0 4242 y(Note)26 b(that)h(the)f(class)h
(names)f(are)g(implicitly)g(mark)o(ed)f(using)h(the)g
Fg(\\exception)f Fr(macro,)i(since)f(that)g(is)i(gi)n(v)o(en)d(as)i
(the)f Fi(col1font)0 4341 y Fr(v)n(alue)c(for)h(the)g
Fg(tableii)f Fr(en)m(vironment.)30 b(T)-7 b(o)23 b(create)g(a)g(table)g
(using)g(dif)n(ferent)e(markup)g(for)i(the)g(\002rst)g(column,)g(use)g
Fg(textrm)f Fr(for)0 4441 y(the)e Fi(col1font)h Fr(v)n(alue)e(and)h
(mark)f(each)h(entry)f(indi)n(vidually)-5 b(.)0 4588
y(T)e(o)19 b(add)g(a)h(horizontal)d(line)j(between)e(v)o(ertical)g
(sections)i(of)f(a)g(table,)h(use)f(the)g(standard)f
Fg(\\hline)h Fr(macro)f(between)h(the)g(ro)n(ws)g(which)0
4687 y(should)g(be)h(separated:)p 0 5549 3901 4 v 0 5649
a Fj(18)2661 b(6)83 b(Special)25 b(Mar)q(kup)e(Constr)q(ucts)p
eop end
%%Page: 19 19
TeXDict begin 19 18 bop 236 174 a Fh
(\\begin{tableii}{l|l}{constant}{Language})o({Audie)o(nce})326
266 y(\\lineii{APL}{Masochists.})326 357 y(\\lineii{BASIC}{First-time)
41 b(programmers)h(on)j(PC)f(hardware.})326 448 y(\\lineii{C}{\\UNIX{})
e(\\&\\)i(Linux)g(kernel)g(developers.})416 540 y(\\hline)326
631 y(\\lineii{Python}{Everyone!})236 722 y(\\end{tableii})0
1009 y Fr(Note)20 b(that)g(not)f(all)i(presentation)d(formats)h(are)h
(capable)f(of)g(displaying)g(a)h(horizontal)e(rule)h(in)h(this)h
(position.)j(This)c(is)g(ho)n(w)g(the)g(table)0 1108
y(looks)g(in)g(the)g(format)f(you')l(re)g(reading)f(no)n(w:)1089
1335 y Fm(Language)p 1635 1365 4 100 v 246 w(A)l(udience)p
1039 1368 1822 4 v 1089 1438 a Fg(APL)p 1635 1468 4 100
v 448 w Fr(Masochists.)1089 1537 y Fg(C)p 1635 1567 V
550 w Fr(U)t Ff(N)t(I)t(X)23 b Fr(&)d(Linux)f(k)o(ernel)h(de)n(v)o
(elopers.)1089 1637 y Fg(JavaScript)p 1635 1667 V 98
w Fr(W)-7 b(eb)21 b(de)n(v)o(elopers.)p 1039 1670 1822
4 v 1089 1740 a Fg(Python)p 1635 1770 4 100 v 298 w Fr(Ev)o(eryone!)0
2019 y Fd(6.10)100 b(Ref)m(erence)30 b(List)d(Mar)q(kup)0
2222 y Fr(Man)o(y)f(sections)g(include)g(a)h(list)g(of)f(references)g
(to)g(module)f(documentation)f(or)i(e)o(xternal)f(documents.)43
b(These)26 b(lists)i(are)e(created)0 2322 y(using)j(the)i
Fg(seealso)e Fr(or)h Fg(seealso)1172 2337 y(*)1251 2322
y Fr(en)m(vironments.)51 b(These)30 b(en)m(vironments)d(de\002ne)j
(some)g(additional)e(macros)i(to)g(support)0 2422 y(creating)19
b(reference)g(entries)h(in)g(a)h(reasonable)d(manner)-5
b(.)0 2569 y(The)24 b Fg(seealso)f Fr(en)m(vironment)e(is)k(typically)e
(placed)g(in)h(a)h(section)e(just)i(before)e(an)o(y)g(sub-sections.)35
b(This)24 b(is)h(done)e(to)h(ensure)f(that)0 2668 y(reference)14
b(links)h(related)f(to)i(the)f(section)g(are)g(not)g(hidden)f(in)h(a)h
(subsection)e(in)i(the)f(hyperte)o(xt)e(renditions)g(of)i(the)h
(documentation.)k(F)o(or)0 2768 y(the)h(HTML)f(output,)g(it)h(is)h(sho)
n(wn)e(as)h(a)g(\223side)g(bar)m(,)-6 b(\224)20 b(box)o(ed)f(of)n(f)h
(from)g(the)h(main)f(\003o)n(w)h(of)f(the)h(te)o(xt.)26
b(The)21 b Fg(seealso)3414 2783 y(*)3484 2768 y Fr(en)m(vironment)0
2867 y(is)f(dif)n(ferent)e(in)i(that)f(it)h(should)f(be)g(used)g(when)g
(a)h(list)h(of)e(references)f(is)i(being)f(presented)f(as)i(part)f(of)g
(the)h(primary)e(content;)g(it)j(is)f(not)0 2967 y(specially)g(set)h
(of)n(f)e(from)h(the)g(te)o(xt.)0 3114 y Fg(\\begin{)p
Fb(seealso)p Fg(})0 3214 y(\\end{)p Fb(seealso)p Fg(})208
3313 y Fr(This)g(en)m(vironment)d(creates)j(a)h(\223See)f(also:\224)26
b(heading)18 b(and)i(de\002nes)g(the)g(markup)f(used)h(to)g(describe)f
(indi)n(vidual)g(references.)0 3460 y Fg(\\begin{)p Fb(seealso)700
3473 y(*)750 3460 y Fg(})0 3560 y(\\end{)p Fb(seealso)600
3573 y(*)650 3560 y Fg(})208 3659 y Fr(This)26 b(en)m(vironment)d(is)28
b(used)e(to)h(create)f(a)h(list)g(of)f(references)f(which)h(form)g
(part)g(of)g(the)g(main)g(content.)43 b(It)27 b(is)g(not)f(gi)n(v)o(en)
f(a)208 3759 y(special)c(header)g(and)g(is)h(not)g(set)g(of)n(f)f(from)
f(the)i(main)f(\003o)n(w)h(of)f(the)h(te)o(xt.)29 b(It)22
b(pro)o(vides)e(the)h(same)h(additional)e(markup)g(used)h(to)208
3859 y(describe)e(indi)n(vidual)f(references.)0 4005
y(F)o(or)h(each)h(of)f(the)h(follo)n(wing)e(macros,)h
Fi(why)h Fr(should)e(be)i(one)f(or)g(more)g(complete)g(sentences,)g
(starting)g(with)h(a)g(capital)g(letter)g(\(unless)0
4105 y(it)h(starts)g(with)f(an)g(identi\002er)m(,)f(which)h(should)f
(not)h(be)g(modi\002ed\),)f(and)g(ending)g(with)h(the)h(appropriate)c
(punctuation.)0 4252 y(These)j(macros)g(are)g(only)f(de\002ned)g
(within)h(the)g(content)g(of)f(the)i Fg(seealso)e Fr(and)h
Fg(seealso)2728 4267 y(*)2797 4252 y Fr(en)m(vironments.)0
4399 y Fg(\\)p Fb(seelink)p Fg({)p Fi(url)p Fg(}{)p Fi(linkte)n(xt)q
Fg(}{)p Fi(why)p Fg(})208 4498 y Fr(References)32 b(to)g(speci\002c)h
(on-line)f(resources)f(should)h(be)h(gi)n(v)o(en)e(using)h(the)h
Fg(\\seelink)f Fr(macro)f(if)i(the)o(y)f(don')o(t)f(ha)n(v)o(e)h(a)208
4598 y(meaningful)22 b(title)k(b)n(ut)f(there)f(is)i(some)f(short)f
(description)g(of)g(what')-5 b(s)25 b(at)h(the)f(end)f(of)h(the)g
(link.)38 b(Online)25 b(documents)e(which)208 4698 y(ha)n(v)o(e)d
(identi\002able)g(titles)i(should)d(be)i(referenced)e(using)h(the)h
Fg(\\seetitle)f Fr(macro,)g(using)g(the)h(optional)e(parameter)g(to)i
(that)208 4797 y(macro)e(to)h(pro)o(vide)e(the)i(URL.)0
4944 y Fg(\\)p Fb(seemodule)p Fg([)p Fi(k)o(e)n(y)p Fg(]{)p
Fi(name)p Fg(}{)p Fi(why)p Fg(})208 5044 y Fr(Refer)29
b(to)i(another)d(module.)53 b Fi(why)30 b Fr(should)f(be)h(a)g(brief)g
(e)o(xplanation)d(of)j(why)f(the)h(reference)e(may)i(be)g(interesting.)
53 b(The)208 5143 y(module)19 b(name)h(is)i(gi)n(v)o(en)d(in)i
Fi(name)p Fr(,)f(with)h(the)g(link)g(k)o(e)o(y)f(gi)n(v)o(en)f(in)i
Fi(k)o(e)n(y)g Fr(if)g(necessary)-5 b(.)26 b(In)20 b(the)h(HTML)f(and)h
(PDF)g(con)m(v)o(ersions,)208 5243 y(the)h(module)f(name)g(will)i(be)f
(a)h(hyperlink)c(to)k(the)f(referred-to)e(module.)29
b Fm(Note:)g Fr(The)21 b(module)g(must)h(be)h(documented)c(in)k(the)208
5343 y(same)d(document)e(\(the)i(corresponding)d Fg(\\declaremodule)h
Fr(is)j(required\).)p 0 5549 3901 4 v 0 5649 a Fj(6.10)84
b(Ref)n(erence)22 b(List)h(Mar)q(kup)2730 b(19)p eop
end
%%Page: 20 20
TeXDict begin 20 19 bop 0 83 a Fg(\\)p Fb(seepep)p Fg({)p
Fi(number)r Fg(}{)p Fi(title)p Fg(}{)p Fi(why)p Fg(})208
183 y Fr(Refer)25 b(to)g(an)g(Python)f(Enhancement)f(Proposal)h
(\(PEP\).)h Fi(number)h Fr(should)e(be)h(the)g(of)n(\002cial)g(number)e
(assigned)i(by)g(the)g(PEP)208 282 y(Editor)m(,)16 b
Fi(title)j Fr(should)d(be)i(the)f(human-readable)d(title)19
b(of)e(the)h(PEP)g(as)g(found)e(in)i(the)f(of)n(\002cial)h(cop)o(y)e
(of)i(the)f(document,)f(and)h Fi(why)208 382 y Fr(should)k(e)o(xplain)f
(what')-5 b(s)23 b(interesting)e(about)g(the)h(PEP)-9
b(.)23 b(This)f(should)f(be)h(used)g(to)g(refer)f(the)h(reader)f(to)i
(PEPs)g(which)e(specify)208 482 y(interf)o(aces)e(or)h(language)f
(features)g(rele)n(v)n(ant)g(to)h(the)h(material)e(in)i(the)f
(annotated)f(section)h(of)f(the)i(documentation.)0 628
y Fg(\\)p Fb(seerfc)p Fg({)p Fi(number)r Fg(}{)p Fi(title)p
Fg(}{)p Fi(why)p Fg(})208 728 y Fr(Refer)i(to)g(an)g(IETF)h(Request)f
(for)f(Comments)h(\(RFC\).)h(Otherwise)f(v)o(ery)f(similar)i(to)f
Fg(\\seepep)p Fr(.)33 b(This)24 b(should)e(be)h(used)g(to)208
828 y(refer)18 b(the)g(reader)g(to)h(PEPs)h(which)e(specify)g
(protocols)g(or)g(data)h(formats)f(rele)n(v)n(ant)g(to)h(the)f
(material)h(in)g(the)g(annotated)e(section)208 927 y(of)i(the)i
(documentation.)0 1074 y Fg(\\)p Fb(seetext)p Fg({)p
Fi(te)n(xt)q Fg(})208 1174 y Fr(Add)f(arbitrary)f(te)o(xt)i
Fi(te)n(xt)i Fr(to)f(the)f(\223See)g(also:\224)27 b(list.)h(This)21
b(can)g(be)g(used)g(to)g(refer)f(to)h(of)n(f-line)e(materials)i(or)g
(on-line)f(materials)208 1273 y(using)f(the)h Fg(\\url)g
Fr(macro.)k(This)d(should)e(consist)h(of)g(one)g(or)g(more)f(complete)g
(sentences.)0 1420 y Fg(\\)p Fb(seetitle)p Fg([)p Fi(url)p
Fg(]{)p Fi(title)p Fg(}{)p Fi(why)p Fg(})208 1520 y Fr(Add)h(a)i
(reference)d(to)j(an)f(e)o(xternal)f(document)f(named)h
Fi(title)p Fr(.)29 b(If)21 b Fi(url)h Fr(is)g(gi)n(v)o(en,)e(the)h
(title)h(is)g(made)f(a)h(hyperlink)c(in)k(the)f(HTML)208
1620 y(v)o(ersion)d(of)i(the)h(documentation,)c(and)i(displayed)g(belo)
n(w)h(the)g(title)h(in)f(the)g(typeset)g(v)o(ersions)g(of)g(the)g
(documentation.)0 1766 y Fg(\\)p Fb(seeurl)p Fg({)p Fi(url)p
Fg(}{)p Fi(why)p Fg(})208 1866 y Fr(References)g(to)i(speci\002c)g
(on-line)e(resources)g(should)h(be)g(gi)n(v)o(en)f(using)h(the)g
Fg(\\seeurl)g Fr(macro)g(if)g(the)o(y)g(don')o(t)f(ha)n(v)o(e)h(a)h
(mean-)208 1966 y(ingful)16 b(title.)25 b(Online)17 b(documents)e
(which)i(ha)n(v)o(e)g(identi\002able)g(titles)h(should)f(be)g
(referenced)e(using)i(the)g Fg(\\seetitle)g Fr(macro,)208
2065 y(using)i(the)h(optional)f(parameter)g(to)h(that)h(macro)e(to)h
(pro)o(vide)e(the)j(URL.)0 2350 y Fd(6.11)100 b(Inde)m(x-gener)o(ating)
32 b(Mar)q(kup)0 2553 y Fr(Ef)n(fecti)n(v)o(e)16 b(inde)o(x)g
(generation)g(for)g(technical)h(documents)f(can)h(be)g(v)o(ery)g(dif)n
(\002cult,)g(especially)g(for)g(someone)f(f)o(amiliar)h(with)g(the)h
(topic)0 2653 y(b)n(ut)j(not)f(the)h(creation)f(of)g(inde)o(x)o(es.)25
b(Much)20 b(of)h(the)f(dif)n(\002culty)g(arises)h(in)g(the)g(area)f(of)
h(terminology:)j(including)19 b(the)h(terms)h(an)g(e)o(xpert)0
2752 y(w)o(ould)g(use)i(for)e(a)i(concept)d(is)j(not)f(suf)n
(\002cient.)30 b(Coming)21 b(up)h(with)g(the)g(terms)g(that)h(a)f(no)o
(vice)f(w)o(ould)g(look)g(up)h(is)h(f)o(airly)f(dif)n(\002cult)f(for)0
2852 y(an)f(author)f(who,)g(typically)-5 b(,)19 b(is)i(an)f(e)o(xpert)f
(in)i(the)f(area)g(she)g(is)h(writing)f(on.)0 2999 y(The)k(truly)f(dif)
n(\002cult)h(aspects)g(of)g(inde)o(x)e(generation)g(are)i(not)g(areas)g
(with)g(which)g(the)g(documentation)d(tools)j(can)g(help.)36
b(Ho)n(we)n(v)o(er)m(,)0 3098 y(ease)17 b(of)f(producing)e(the)j(inde)o
(x)e(once)h(content)f(decisions)h(are)h(made)f(is)h(within)f(the)h
(scope)f(of)g(the)h(tools.)24 b(Markup)15 b(is)i(pro)o(vided)d(which)0
3198 y(the)22 b(processing)f(softw)o(are)h(is)h(able)g(to)f(use)h(to)f
(generate)f(a)i(v)n(ariety)e(of)h(kinds)g(of)g(inde)o(x)f(entry)h(with)
g(minimal)g(ef)n(fort.)30 b(Additionally)-5 b(,)0 3298
y(man)o(y)28 b(of)h(the)g(en)m(vironments)d(described)i(in)h(section)g
(6.3,)i(\223Information)26 b(Units,)-6 b(\224)31 b(will)f(generate)e
(appropriate)f(entries)i(into)g(the)0 3397 y(general)19
b(and)h(module)f(inde)o(x)o(es.)0 3544 y(The)d(follo)n(wing)e(macro)i
(can)g(be)g(used)g(to)g(control)f(the)h(generation)f(of)h(inde)o(x)f
(data,)h(and)g(should)f(be)h(used)g(in)h(the)f(document)e(preamble:)0
3691 y Fg(\\)p Fb(makemodindex)208 3791 y Fr(This)38
b(should)f(be)h(used)f(in)h(the)g(document)e(preamble)h(if)h(a)g
(\223Module)f(Inde)o(x\224)f(is)j(desired)e(for)h(a)g(document)e
(contain-)208 3890 y(ing)29 b(reference)f(material)i(on)f(man)o(y)g
(modules.)53 b(This)30 b(causes)g(a)g(data)g(\002le)h
Fg(lib)p Fi(jobname)p Fg(.idx)c Fr(to)j(be)g(created)f(from)g(the)208
3990 y Fg(\\declaremodule)24 b Fr(macros.)41 b(This)27
b(\002le)f(can)g(be)g(processed)f(by)h(the)g Fm(mak)o(eindex)g
Fr(program)e(to)i(generate)f(a)h(\002le)h(which)208 4090
y(can)20 b(be)g Fg(\\input)f Fr(into)h(the)g(document)f(at)h(the)h
(desired)e(location)g(of)h(the)g(module)f(inde)o(x.)0
4236 y(There)28 b(are)h(a)h(number)d(of)i(macros)g(that)g(are)g(useful)
g(for)f(adding)g(inde)o(x)g(entries)h(for)f(particular)g(concepts,)i
(man)o(y)e(of)h(which)g(are)0 4336 y(speci\002c)20 b(to)h(programming)
16 b(languages)j(or)h(e)n(v)o(en)f(Python.)0 4483 y Fg(\\)p
Fb(bifuncindex)p Fg({)p Fi(name)p Fg(})208 4583 y Fr(Add)g(an)h(inde)o
(x)f(entry)g(referring)f(to)i(a)h(b)n(uilt-in)e(function)f(named)h
Fi(name)p Fr(;)h(parentheses)f(should)g(not)g(be)h(included)f(after)g
Fi(name)p Fr(.)0 4729 y Fg(\\)p Fb(exindex)p Fg({)p Fi(e)n(xception)p
Fg(})208 4829 y Fr(Add)g(a)i(reference)d(to)j(an)f(e)o(xception)e
(named)h Fi(e)n(xception)p Fr(.)24 b(The)c(e)o(xception)e(should)i(be)g
(class-based.)0 4976 y Fg(\\)p Fb(kwindex)p Fg({)p Fi(k)o(e)n(ywor)m(d)
r Fg(})208 5076 y Fr(Add)f(a)i(reference)d(to)j(a)f(language)f(k)o(e)o
(yw)o(ord)f(\(not)i(a)g(k)o(e)o(yw)o(ord)f(parameter)f(in)j(a)f
(function)f(or)h(method)e(call\).)0 5222 y Fg(\\)p Fb(obindex)p
Fg({)p Fi(object)g(type)p Fg(})208 5322 y Fr(Add)h(an)h(inde)o(x)f
(entry)h(for)f(a)i(b)n(uilt-in)f(object)f(type.)p 0 5549
3901 4 v 0 5649 a Fj(20)2661 b(6)83 b(Special)25 b(Mar)q(kup)e(Constr)q
(ucts)p eop end
%%Page: 21 21
TeXDict begin 21 20 bop 0 83 a Fg(\\)p Fb(opindex)p Fg({)p
Fi(oper)o(ator)r Fg(})208 183 y Fr(Add)19 b(a)i(reference)d(to)j(an)f
(operator)m(,)e(such)i(as)h(`)p Fg(+)p Fr('.)0 330 y
Fg(\\)p Fb(refmodindex)p Fg([)p Fi(k)o(e)n(y)p Fg(]{)p
Fi(module)p Fg(})208 429 y Fr(Add)e(an)i(inde)o(x)e(entry)g(for)h
(module)f Fi(module)p Fr(;)h(if)g Fi(module)g Fr(contains)f(an)i
(underscore,)d(the)i(optional)f(parameter)g Fi(k)o(e)n(y)h
Fr(should)g(be)208 529 y(pro)o(vided)h(as)k(the)g(same)f(string)g(with)
h(underscores)d(remo)o(v)o(ed.)35 b(An)24 b(inde)o(x)f(entry)h(\223)p
Fi(module)f Fr(\(module\)\224)f(will)j(be)g(generated.)208
628 y(This)20 b(is)h(intended)e(for)g(use)i(with)f(non-standard)d
(modules)i(implemented)g(in)h(Python.)0 775 y Fg(\\)p
Fb(refexmodindex)p Fg([)p Fi(k)o(e)n(y)p Fg(]{)p Fi(module)p
Fg(})208 875 y Fr(As)e(for)f Fg(\\refmodindex)p Fr(,)g(b)n(ut)g(the)h
(inde)o(x)f(entry)g(will)h(be)g(\223)p Fi(module)f Fr(\(e)o(xtension)f
(module\).)-6 b(\224)22 b(This)c(is)h(intended)d(for)h(use)h(with)208
975 y(non-standard)f(modules)i(not)h(implemented)e(in)i(Python.)0
1121 y Fg(\\)p Fb(refbimodindex)p Fg([)p Fi(k)o(e)n(y)p
Fg(]{)p Fi(module)p Fg(})208 1221 y Fr(As)i(for)g Fg(\\refmodindex)p
Fr(,)e(b)n(ut)i(the)g(inde)o(x)f(entry)h(will)g(be)g(\223)p
Fi(module)f Fr(\(b)n(uilt-in)g(module\).)-6 b(\224)29
b(This)22 b(is)h(intended)e(for)g(use)h(with)208 1321
y(standard)d(modules)g(not)h(implemented)e(in)i(Python.)0
1468 y Fg(\\)p Fb(refstmodindex)p Fg([)p Fi(k)o(e)n(y)p
Fg(]{)p Fi(module)p Fg(})208 1567 y Fr(As)g(for)g Fg(\\refmodindex)p
Fr(,)e(b)n(ut)i(the)g(inde)o(x)f(entry)g(will)i(be)f(\223)p
Fi(module)e Fr(\(standard)h(module\).)-6 b(\224)23 b(This)d(is)h
(intended)e(for)g(use)h(with)208 1667 y(standard)f(modules)g
(implemented)f(in)i(Python.)0 1814 y Fg(\\)p Fb(stindex)p
Fg({)p Fi(statement)q Fg(})208 1913 y Fr(Add)f(an)h(inde)o(x)f(entry)h
(for)f(a)i(statement)f(type,)f(such)h(as)h Fg(print)f
Fr(or)g Fg(try)p Fr(/)p Fg(finally)p Fr(.)208 2042 y(XXX)g(Need)g
(better)g(e)o(xamples)f(of)h(dif)n(ference)e(from)h Fg(\\kwindex)p
Fr(.)0 2189 y(Additional)g(macros)i(are)f(pro)o(vided)e(which)j(are)f
(useful)h(for)f(con)m(v)o(eniently)d(creating)j(general)g(inde)o(x)f
(entries)i(which)f(should)g(appear)0 2289 y(at)26 b(man)o(y)f(places)h
(in)g(the)g(inde)o(x)f(by)h(rotating)f(a)h(list)h(of)f(w)o(ords.)42
b(These)25 b(are)h(simple)g(macros)g(that)g(simply)f(use)h
Fg(\\index)g Fr(to)g(b)n(uild)0 2388 y(some)20 b(number)e(of)i(inde)o
(x)f(entries.)25 b(Inde)o(x)19 b(entries)h(b)n(uild)g(using)f(these)i
(macros)e(contain)g(both)h(primary)e(and)i(secondary)e(te)o(xt.)0
2535 y Fg(\\)p Fb(indexii)p Fg({)p Fi(wor)m(d1)p Fg(}{)p
Fi(wor)m(d2)p Fg(})208 2635 y Fr(Build)75 b(tw)o(o)g(inde)o(x)e
(entries.)189 b(This)76 b(is)f(e)o(xactly)f(equi)n(v)n(alent)g(to)h
(using)f Fg(\\index{)p Fi(wor)m(d1)p Fg(!)p Fi(wor)m(d2)p
Fg(})e Fr(and)208 2734 y Fg(\\index{)p Fi(wor)m(d2)p
Fg(!)p Fi(wor)m(d1)p Fg(})p Fr(.)0 2881 y Fg(\\)p Fb(indexiii)p
Fg({)p Fi(wor)m(d1)p Fg(}{)p Fi(wor)m(d2)p Fg(}{)p Fi(wor)m(d3)p
Fg(})208 2981 y Fr(Build)64 b(three)g(inde)o(x)f(entries.)157
b(This)65 b(is)g(e)o(xactly)f(equi)n(v)n(alent)e(to)j(using)f
Fg(\\index{)p Fi(wor)m(d1)p Fg(!)p Fi(wor)m(d2)46 b(wor)m(d3)p
Fg(})p Fr(,)208 3080 y Fg(\\index{)p Fi(wor)m(d2)p Fg(!)p
Fi(wor)m(d3)p Fg(,)g Fi(wor)m(d1)p Fg(})p Fr(,)19 b(and)h
Fg(\\index{)p Fi(wor)m(d3)p Fg(!)p Fi(wor)m(d1)47 b(wor)m(d2)p
Fg(})p Fr(.)0 3227 y Fg(\\)p Fb(indexiv)p Fg({)p Fi(wor)m(d1)p
Fg(}{)p Fi(wor)m(d2)p Fg(}{)p Fi(wor)m(d3)p Fg(}{)p Fi(wor)m(d4)p
Fg(})208 3327 y Fr(Build)72 b(four)g(inde)o(x)f(entries.)182
b(This)73 b(is)g(e)o(xactly)f(equi)n(v)n(alent)f(to)h(using)g
Fg(\\index{)p Fi(wor)m(d1)p Fg(!)p Fi(wor)m(d2)47 b(wor)m(d3)208
3427 y(wor)m(d4)p Fg(})p Fr(,)126 b Fg(\\index{)p Fi(wor)m(d2)p
Fg(!)p Fi(wor)m(d3)46 b(wor)m(d4)p Fg(,)j Fi(wor)m(d1)p
Fg(})p Fr(,)126 b Fg(\\index{)p Fi(wor)m(d3)p Fg(!)p
Fi(wor)m(d4)p Fg(,)47 b Fi(wor)m(d1)i(wor)m(d2)p Fg(})p
Fr(,)126 b(and)208 3526 y Fg(\\index{)p Fi(wor)m(d4)p
Fg(!)p Fi(wor)m(d1)46 b(wor)m(d2)j(wor)m(d3)p Fg(})p
Fr(.)0 3807 y Fd(6.12)100 b(Gr)o(ammar)29 b(Production)h(Displa)m(ys)0
4010 y Fr(Special)23 b(markup)e(is)j(a)n(v)n(ailable)e(for)h
(displaying)e(the)i(productions)e(of)h(a)i(formal)d(grammar)-5
b(.)32 b(The)23 b(markup)e(is)j(simple)f(and)f(does)h(not)0
4110 y(attempt)18 b(to)h(model)f(all)h(aspects)g(of)g(BNF)h(\(or)e(an)o
(y)g(deri)n(v)o(ed)f(forms\),)g(b)n(ut)i(pro)o(vides)e(enough)g(to)i
(allo)n(w)f(conte)o(xt-free)e(grammars)i(to)h(be)0 4210
y(displayed)h(in)h(a)h(w)o(ay)f(that)h(causes)f(uses)h(of)f(a)g(symbol)
g(to)g(be)g(rendered)e(as)j(hyperlinks)d(to)j(the)f(de\002nition)f(of)h
(the)g(symbol.)27 b(There)21 b(is)0 4309 y(one)f(en)m(vironment)d(and)i
(a)i(pair)f(of)g(macros:)0 4456 y Fg(\\begin{)p Fb(productionlist)p
Fg(}[)p Fi(langua)n(g)o(e)p Fg(])0 4556 y(\\end{)p Fb(productionlist)p
Fg(})208 4655 y Fr(This)31 b(en)m(vironment)e(is)k(used)e(to)h(enclose)
f(a)h(group)e(of)i(productions.)57 b(The)31 b(tw)o(o)h(macros)f(are)h
(only)f(de\002ned)g(within)g(this)208 4755 y(en)m(vironment.)21
b(If)f(a)g(document)d(describes)i(more)g(than)g(one)g(language,)f(the)i
(optional)e(parameter)g Fi(langua)o(g)o(e)g Fr(should)g(be)i(used)208
4855 y(to)k(distinguish)f(productions)f(between)h(languages.)35
b(The)24 b(v)n(alue)f(of)h(the)g(parameter)f(should)g(be)h(a)g(short)g
(name)g(that)g(can)g(be)208 4954 y(used)e(as)h(part)f(of)g(a)h
(\002lename;)g(colons)f(or)g(other)g(characters)f(that)i(can')o(t)e(be)
i(used)f(in)h(\002lename)e(across)i(platforms)e(should)h(be)208
5054 y(included.)0 5201 y Fg(\\)p Fb(production)p Fg({)p
Fi(name)p Fg(}{)p Fi(de\002nition)p Fg(})208 5300 y Fr(A)g(production)c
(rule)k(in)f(the)h(grammar)-5 b(.)28 b(The)21 b(rule)g(de\002nes)g(the)
h(symbol)f Fi(name)f Fr(to)i(be)g Fi(de\002nition)p Fr(.)27
b Fi(name)21 b Fr(should)f(not)i(contain)208 5400 y(an)o(y)g(markup,)g
(and)h(the)g(use)h(of)f(hyphens)e(in)j(a)g(document)d(which)i(supports)
f(more)h(than)g(one)f(grammar)g(is)i(unde\002ned.)33
b Fi(def-)p 0 5549 3901 4 v 0 5649 a Fj(6.12)84 b(Gr)o(ammar)22
b(Production)i(Displa)n(ys)2459 b(21)p eop end
%%Page: 22 22
TeXDict begin 22 21 bop 208 83 a Fi(inition)23 b Fr(may)g(contain)g
Fg(\\token)g Fr(macros)g(and)g(an)o(y)g(additional)g(content)f(needed)h
(to)h(describe)f(the)h(grammatical)e(model)h(of)208 183
y Fi(symbol)p Fr(.)h(Only)c(one)g Fg(\\production)e Fr(may)i(be)g(used)
g(to)h(de\002ne)e(a)i(symbol)e(\227)i(multiple)e(de\002nitions)h(are)g
(not)g(allo)n(wed.)0 330 y Fg(\\)p Fb(token)p Fg({)p
Fi(name)p Fg(})208 429 y Fr(The)f(name)h(of)f(a)i(symbol)e(de\002ned)g
(by)g(a)i Fg(\\production)d Fr(macro,)h(used)h(in)g(the)g
Fi(de\002nition)e Fr(of)i(a)g(symbol.)k(Where)c(possible,)208
529 y(this)g(will)h(be)f(rendered)f(as)h(a)h(hyperlink)d(to)i(the)g
(de\002nition)f(of)h(the)g(symbol)g Fi(name)p Fr(.)0
676 y(Note)k(that)f(the)h(entire)f(grammar)f(does)h(not)h(need)f(to)g
(be)h(de\002ned)e(in)i(a)g(single)g Fg(productionlist)d
Fr(en)m(vironment;)i(an)o(y)f(number)0 775 y(of)e(groupings)e(may)h(be)
i(used)f(to)g(describe)f(the)h(grammar)-5 b(.)24 b(Ev)o(ery)19
b(use)h(of)g(the)g Fg(\\token)g Fr(must)g(correspond)e(to)i(a)h
Fg(\\production)p Fr(.)0 922 y(The)f(follo)n(wing)e(is)k(an)e(e)o
(xample)e(tak)o(en)i(from)f(the)i Fi(Python)e(Refer)m(ence)g(Manual)p
Fr(:)236 1069 y Fh(\\begin{productionlist})326 1160 y
(\\production{identifier})819 1252 y({\(\\token{letter}|"_"\))41
b(\(\\token{letter})i(|)h(\\token{digit})f(|)i("_"\))3510
1265 y(*)3555 1252 y(})326 1343 y(\\production{letter})819
1434 y({\\token{lowercase})d(|)j(\\token{uppercase}})326
1526 y(\\production{lowercase})819 1617 y({"a"..."z"})326
1708 y(\\production{uppercase})819 1800 y({"A"..."Z"})326
1891 y(\\production{digit})819 1982 y({"0"..."9"})236
2074 y(\\end{productionlist})0 2498 y Fd(6.13)100 b(Gr)o(aphical)29
b(Interf)m(ace)g(Components)0 2701 y Fr(The)20 b(components)e(of)i
(graphical)e(interf)o(aces)i(will)h(be)f(assigned)g(markup,)e(b)n(ut)i
(most)g(of)g(the)g(speci\002cs)h(ha)n(v)o(e)f(not)g(been)f(determined.)
0 2848 y Fg(\\)p Fb(guilabel)p Fg({)p Fi(label)p Fg(})208
2948 y Fr(Labels)25 b(presented)g(as)h(part)g(of)f(an)h(interacti)n(v)o
(e)e(user)i(interf)o(ace)f(should)f(be)i(mark)o(ed)f(using)g
Fg(\\guilabel)p Fr(.)40 b(This)26 b(includes)208 3047
y(labels)e(from)f(te)o(xt-based)g(interf)o(aces)h(such)g(as)h(those)f
(created)f(using)h Fg(curses)f Fr(or)h(other)g(te)o(xt-based)e
(libraries.)37 b(An)o(y)24 b(label)208 3147 y(used)k(in)h(the)f(interf)
o(ace)g(should)g(be)h(mark)o(ed)e(with)i(this)g(macro,)h(including)c(b)
n(utton)i(labels,)j(windo)n(w)d(titles,)j(\002eld)e(names,)208
3247 y(menu)19 b(and)g(menu)h(selection)g(names,)f(and)h(e)n(v)o(en)f
(v)n(alues)h(in)g(selection)g(lists.)0 3393 y Fg(\\)p
Fb(menuselection)p Fg({)p Fi(menupath)p Fg(})208 3493
y Fr(Menu)30 b(selections)i(should)e(be)h(mark)o(ed)f(using)h(a)h
(combination)d(of)i Fg(\\menuselection)f Fr(and)g Fg(\\sub)p
Fr(.)59 b(This)31 b(macro)g(is)208 3593 y(used)26 b(to)g(mark)g(a)h
(complete)e(sequence)g(of)i(menu)e(selections,)j(including)d(selecting)
h(submenus)f(and)h(choosing)e(a)j(speci\002c)208 3692
y(operation,)22 b(or)h(an)o(y)g(subsequence)f(of)h(such)g(a)h
(sequence.)34 b(The)23 b(names)h(of)f(indi)n(vidual)f(selections)h
(should)g(be)g(separated)g(by)208 3792 y(occurrences)18
b(of)i Fg(\\sub)p Fr(.)208 3925 y(F)o(or)f(e)o(xample,)g(to)h(mark)g
(the)g(selection)g(\223)p Fj(Star)s(t)46 b Fc(>)23 b
Fj(Prog)o(r)o(ams)p Fr(\224,)e(use)f(this)h(markup:)444
4149 y Fh(\\menuselection{Start)41 b(\\sub)j(Programs})208
4338 y Fr(When)17 b(including)g(a)h(selection)g(that)g(includes)g(some)
g(trailing)f(indicator)m(,)g(such)h(as)h(the)f(ellipsis)h(some)e
(operating)g(systems)h(use)208 4438 y(to)i(indicate)f(that)i(the)f
(command)e(opens)i(a)g(dialog,)f(the)i(indicator)d(should)i(be)g
(omitted)f(from)g(the)i(selection)e(name.)208 4571 y(Indi)n(vidual)29
b(selection)i(names)g(within)g(the)g Fg(\\menuselection)e
Fr(should)h(not)h(be)h(mark)o(ed)d(using)i Fg(\\guilabel)f
Fr(since)208 4671 y(that')-5 b(s)20 b(implied)g(by)f(using)h
Fg(\\menuselection)p Fr(.)0 4817 y Fg(\\)p Fb(sub)208
4917 y Fr(Separator)g(for)g(menu)h(selections)g(that)g(include)g
(multiple)f(le)n(v)o(els.)28 b(This)22 b(macro)e(is)i(only)f(de\002ned)
f(within)h(the)h(conte)o(xt)e(of)h(the)208 5017 y Fg(\\menuselection)d
Fr(macro.)p 0 5549 3901 4 v 0 5649 a Fj(22)2661 b(6)83
b(Special)25 b(Mar)q(kup)e(Constr)q(ucts)p eop end
%%Page: 23 23
TeXDict begin 23 22 bop 0 86 a Fs(7)120 b(Processing)34
b(T)-14 b(ools)0 336 y Fd(7.1)100 b(Exter)r(nal)30 b(T)-12
b(ools)0 539 y Fr(Man)o(y)26 b(tools)i(are)f(needed)f(to)i(be)f(able)h
(to)f(process)g(the)h(Python)e(documentation)e(if)k(all)g(supported)e
(formats)g(are)i(required.)44 b(This)0 638 y(section)28
b(lists)i(the)f(tools)f(used)h(and)f(when)g(each)g(is)h(required.)48
b(Consult)29 b(the)f(`)p Fq(Doc/README)p Fr(')g(\002le)h(to)g(see)g(if)
g(there)f(are)g(speci\002c)0 738 y(v)o(ersion)19 b(requirements)f(for)i
(an)o(y)f(of)h(these.)0 968 y Fm(dvips)42 b Fr(This)22
b(program)e(is)j(a)f(typical)g(part)f(of)h(T)1371 987
y(E)1411 968 y(X)h(installations.)30 b(It)22 b(is)h(used)f(to)g
(generate)f(PostScript)h(from)e(the)i(\223de)n(vice)g(indepen-)208
1067 y(dent\224)d(`)p Fq(.dvi)p Fr(')g(\002les.)26 b(It)21
b(is)g(needed)e(for)g(the)i(con)m(v)o(ersion)c(to)j(PostScript.)0
1234 y Fm(emacs)41 b Fr(Emacs)19 b(is)i(the)e(kitchen)f(sink)i(of)f
(programmers')d(editors,)j(and)g(a)h(damn)e(\002ne)h(kitchen)g(sink)g
(it)h(is.)26 b(It)19 b(also)h(comes)f(with)h(some)208
1333 y(of)f(the)h(processing)f(needed)g(to)h(support)e(the)i(proper)e
(menu)h(structures)h(for)f(T)-6 b(e)o(xinfo)18 b(documents)h(when)g(an)
h(info)f(con)m(v)o(ersion)208 1433 y(is)k(desired.)31
b(This)22 b(is)i(needed)d(for)g(the)i(info)f(con)m(v)o(ersion.)28
b(Using)23 b Fm(xemacs)f Fr(instead)g(of)g(FSF)h Fm(emacs)g
Fr(may)f(lead)g(to)h(instability)208 1532 y(in)d(the)g(con)m(v)o
(ersion,)d(b)n(ut)k(that')-5 b(s)20 b(because)g(nobody)e(seems)i(to)h
(maintain)e(the)h(Emacs)g(T)-6 b(e)o(xinfo)19 b(code)g(in)i(a)f
(portable)f(manner)-5 b(.)0 1698 y Fm(latex)40 b Fr(L)233
1682 y Fk(A)263 1698 y Fr(T)300 1717 y(E)340 1698 y(X)27
b(is)g(a)g(lar)o(ge)e(and)h(e)o(xtensible)g(macro)f(package)g(by)h
(Leslie)h(Lamport,)f(based)g(on)g(T)2845 1717 y(E)2885
1698 y(X,)i(a)f(w)o(orld-class)f(typesetter)g(by)208
1798 y(Donald)i(Knuth.)51 b(It)29 b(is)h(used)f(for)g(the)g(con)m(v)o
(ersion)e(to)i(PostScript,)i(and)e(is)h(needed)e(for)g(the)i(HTML)f
(con)m(v)o(ersion)d(as)k(well)208 1898 y(\(L)257 1881
y Fk(A)287 1898 y Fr(T)324 1916 y(E)363 1898 y(X2HTML)19
b(requires)g(one)h(of)g(the)g(intermediate)f(\002les)i(it)g(creates\).)
0 2064 y Fm(latex2html)40 b Fr(Probably)25 b(the)i(longest)f(Perl)h
(script)g(an)o(yone)e(e)n(v)o(er)i(attempted)e(to)j(maintain.)44
b(This)27 b(con)m(v)o(erts)e(L)3254 2047 y Fk(A)3284
2064 y Fr(T)3321 2082 y(E)3361 2064 y(X)i(documents)e(to)208
2163 y(HTML)19 b(documents,)f(and)h(does)g(a)h(pretty)f(reasonable)f
(job)m(.)24 b(It)c(is)h(required)d(for)g(the)i(con)m(v)o(ersions)d(to)j
(HTML)f(and)g(GNU)h(info.)0 2329 y Fm(lynx)41 b Fr(This)27
b(is)i(a)f(te)o(xt-mode)d(W)-7 b(eb)28 b(bro)n(wser)f(which)g(includes)
g(an)g(HTML-to-plain)e(te)o(xt)i(con)m(v)o(ersion.)45
b(This)27 b(is)i(used)e(to)h(con)m(v)o(ert)208 2429 y
Fg(howto)19 b Fr(documents)g(to)h(te)o(xt.)0 2595 y Fm(mak)o(e)41
b Fr(Just)18 b(about)e(an)o(y)g(v)o(ersion)g(should)g(w)o(ork)g(for)h
(the)g(standard)f(documents,)f(b)n(ut)i(GNU)h Fm(mak)o(e)f
Fr(is)h(required)d(for)i(the)g(e)o(xperimental)208 2695
y(processes)29 b(in)g(`)p Fq(Doc/tools/sgmlcon)o(v/)p
Fr(',)g(at)g(least)i(while)e(the)o(y')l(re)f(e)o(xperimental.)50
b(This)30 b(is)g(not)f(required)f(for)g(running)g(the)208
2794 y Fm(mkho)o(wto)20 b Fr(script.)0 2960 y Fm(mak)o(eindex)41
b Fr(This)26 b(is)h(a)f(standard)f(program)e(for)i(con)m(v)o(erting)e
(L)1883 2944 y Fk(A)1913 2960 y Fr(T)1950 2979 y(E)1990
2960 y(X)j(inde)o(x)f(data)g(to)h(a)h(formatted)d(inde)o(x;)j(it)g
(should)d(be)i(included)208 3060 y(with)20 b(all)h(L)501
3043 y Fk(A)531 3060 y Fr(T)568 3079 y(E)607 3060 y(X)g(installations.)
k(It)20 b(is)h(needed)e(for)h(the)g(PDF)h(and)f(PostScript)g(con)m(v)o
(ersions.)0 3226 y Fm(mak)o(einf)n(o)41 b Fr(GNU)31 b
Fm(mak)o(einf)n(o)f Fr(is)i(used)e(to)h(con)m(v)o(ert)d(T)-6
b(e)o(xinfo)29 b(documents)g(to)i(GNU)g(info)f(\002les.)57
b(Since)30 b(T)-6 b(e)o(xinfo)29 b(is)j(used)e(as)i(an)208
3326 y(intermediate)18 b(format)h(in)i(the)f(info)f(con)m(v)o(ersion,)f
(this)i(program)e(is)k(needed)c(in)j(that)f(con)m(v)o(ersion.)0
3492 y Fm(pd\003atex)41 b Fr(pdfT)477 3510 y(E)515 3492
y(X)29 b(is)f(a)g(relati)n(v)o(ely)f(ne)n(w)g(v)n(ariant)g(of)g(T)1646
3510 y(E)1686 3492 y(X,)j(and)d(is)i(used)e(to)h(generate)f(the)g(PDF)i
(v)o(ersion)d(of)h(the)h(manuals.)47 b(It)28 b(is)208
3591 y(typically)19 b(installed)h(as)h(part)f(of)g(most)g(of)g(the)g
(lar)o(ge)f(T)1767 3610 y(E)1807 3591 y(X)i(distrib)n(utions.)j
Fm(pd\003atex)c Fr(is)h(pdfT)2880 3610 y(E)2919 3591
y(X)g(using)e(the)i(L)3344 3575 y Fk(A)3374 3591 y Fr(T)3411
3610 y(E)3450 3591 y(X)g(format.)0 3757 y Fm(perl)41
b Fr(Perl)20 b(is)f(required)e(for)i(L)846 3741 y Fk(A)876
3757 y Fr(T)913 3776 y(E)952 3757 y(X2HTML)f(and)h(one)f(of)h(the)f
(scripts)i(used)e(to)h(post-process)f(L)2744 3741 y Fk(A)2774
3757 y Fr(T)2811 3776 y(E)2850 3757 y(X2HTML)g(output,)g(as)i(well)f
(as)h(the)208 3857 y(HTML-to-T)-6 b(e)o(xinfo)16 b(con)m(v)o(ersion.)22
b(This)f(is)g(required)d(for)i(the)g(HTML)g(and)g(GNU)g(info)g(con)m(v)
o(ersions.)0 4023 y Fm(python)41 b Fr(Python)25 b(is)i(used)f(for)g
(man)o(y)f(of)h(the)g(scripts)h(in)g(the)f(`)p Fq(Doc/tools/)p
Fr(')e(directory;)k(it)f(is)g(required)e(for)h(all)g(con)m(v)o
(ersions.)41 b(This)208 4123 y(shouldn')o(t)17 b(be)k(a)f(problem)f(if)
h(you')l(re)e(interested)i(in)g(writing)g(documentation)d(for)j
(Python!)0 4408 y Fd(7.2)100 b(Inter)r(nal)30 b(T)-12
b(ools)0 4610 y Fr(This)30 b(section)g(describes)f(the)h(v)n(arious)f
(scripts)i(that)f(are)g(used)f(to)h(implement)f(v)n(arious)g(stages)h
(of)g(document)e(processing)h(or)g(to)0 4710 y(orchestrate)24
b(entire)g(b)n(uild)g(sequences.)38 b(Most)26 b(of)e(these)h(tools)g
(are)g(only)f(useful)g(in)h(the)g(conte)o(xt)e(of)i(b)n(uilding)e(the)i
(standard)f(docu-)0 4810 y(mentation,)19 b(b)n(ut)h(some)g(are)g(more)f
(general.)0 5040 y Fm(mkho)o(wto)41 b Fr(This)23 b(is)h(the)g(primary)d
(script)j(used)f(to)g(format)f(third-party)f(documents.)32
b(It)24 b(contains)e(all)i(the)g(logic)e(needed)g(to)i(\223get)f(it)208
5139 y(right.)-6 b(\224)31 b(The)22 b(proper)e(w)o(ay)j(to)f(use)h
(this)g(script)f(is)i(to)e(mak)o(e)g(a)h(symbolic)e(link)h(to)h(it)g
(or)f(run)g(it)h(in)g(place;)g(the)f(actual)g(script)h(\002le)208
5239 y(must)c(be)h(stored)g(as)g(part)g(of)f(the)h(documentation)d
(source)i(tree,)h(though)e(it)j(may)e(be)h(used)f(to)h(format)f
(documents)f(outside)i(the)208 5338 y(tree.)k(Use)d Fm(mkho)o(wto)f
(--help)h Fr(for)e(a)i(list)g(of)f(command)e(line)j(options.)p
0 5549 3901 4 v 3808 5649 a Fj(23)p eop end
%%Page: 24 24
TeXDict begin 24 23 bop 208 83 a Fm(mkho)o(wto)17 b Fr(can)g(be)h(used)
f(for)g(both)g Fg(howto)g Fr(and)g Fg(manual)g Fr(class)h(documents.)k
(It)c(is)h(usually)e(a)h(good)e(idea)h(to)h(al)o(w)o(ays)g(use)g(the)
208 183 y(latest)h(v)o(ersion)f(of)g(this)i(tool)e(rather)h(than)f(a)h
(v)o(ersion)f(from)g(an)g(older)h(source)f(release)h(of)f(Python.)24
b(It)19 b(can)f(be)h(used)g(to)g(generate)208 282 y(D)m(VI,)h(HTML,)f
(PDF)-7 b(,)22 b(PostScript,)e(and)g(plain)g(te)o(xt)g(documents.)k
(The)c(GNU)h(info)f(and)g(iSilo)g(formats)g(will)h(be)g(supported)d(by)
208 382 y(this)i(script)h(in)f(some)g(future)f(v)o(ersion.)208
515 y(Use)h(the)h Fm(--help)f Fr(option)f(on)h(this)g(script')-5
b(s)21 b(command)d(line)i(to)h(get)f(a)h(summary)d(of)i(options)g(for)f
(this)i(script.)208 648 y(XXX)f(Need)g(more)f(here.)0
932 y Fd(7.3)100 b(W)m(or)q(king)30 b(on)e(Cygwin)0 1135
y Fr(Installing)19 b(the)g(required)e(tools)j(under)e(Cygwin)h(under)f
(Cygwin)g(can)i(be)f(a)h(little)g(tedious.)k(Most)19
b(of)g(the)h(required)d(packages)h(can)i(be)0 1235 y(installed)g(using)
g(Cygwin')-5 b(s)20 b(graphical)f(installer)m(,)g(while)h(netpbm)f(and)
h(L)2114 1218 y Fk(A)2144 1235 y Fr(T)2181 1254 y(E)2220
1235 y(X2HTML)g(must)g(be)g(installed)g(from)f(source.)0
1382 y(Start)26 b(with)f(a)h(reasonably)e(modern)f(v)o(ersion)h(of)h
(Cygwin.)40 b(If)26 b(you)e(ha)n(v)o(en')o(t)g(upgraded)e(for)j(a)h(fe)
n(w)f(years,)h(no)n(w)f(w)o(ould)g(be)g(a)h(good)0 1481
y(time.)0 1628 y(Using)g(the)g(Cygwin)f(installer)m(,)i(mak)o(e)f(sure)
g(your)f(Cygwin)g(installation)h(includes)f(Perl,)j(Python,)e(and)f
(the)h(T)3271 1647 y(E)3311 1628 y(X)h(packages.)41 b(Perl)0
1728 y(and)32 b(Python)g(are)h(located)g(under)e(the)i
Fj(Inter)r(preters)h Fr(heading.)62 b(The)32 b(T)2196
1747 y(E)2237 1728 y(X)h(packages)f(are)h(located)f(under)g(the)h
Fj(T)-10 b(e)n(xt)32 b Fr(heading,)0 1828 y(and)25 b(are)h(named)e
Fg(tetex-)821 1843 y(*)871 1828 y Fr(.)41 b(T)-7 b(o)26
b(ensure)e(that)i(all)g(required)e(packages)h(are)g(a)n(v)n(ailable,)i
(install)f(e)n(v)o(ery)e Fg(tetex)h Fr(package,)h(e)o(xcept)0
1927 y Fg(tetex-x11)p Fr(.)e(\(There)19 b(may)h(be)g(a)g(more)g
(minimal)f(set,)i(b)n(ut)f(I')l(v)o(e)f(not)h(spent)g(time)g(trying)f
(to)i(minimize)e(the)h(installation.\))0 2074 y(The)15
b(netpbm)g(package)f(is)j(used)e(by)g(L)1059 2057 y Fk(A)1089
2074 y Fr(T)1126 2093 y(E)1166 2074 y(X2HTML,)f(and)i
Fi(must)g Fr(be)f(installed)h(before)e(L)2490 2057 y
Fk(A)2520 2074 y Fr(T)2557 2093 y(E)2597 2074 y(X2HTML)h(can)g(be)h
(successfully)f(installed,)0 2174 y(e)n(v)o(en)h(though)f(its)i
(features)f(will)i(not)e(be)h(used)g(for)f(most)g(Python)g
(documentation.)21 b(References)16 b(to)h(do)n(wnload)d(locations)j
(are)f(located)0 2273 y(in)27 b(the)g(netpbm)f(README.)h(Install)g
(from)f(the)h(latest)h(stable)g(source)e(distrib)n(ution)g(according)f
(to)i(the)g(instructions.)45 b(\(Note)26 b(that)0 2373
y(binary)19 b(packages)g(of)h(netpbm)f(are)h(sometimes)g(a)n(v)n
(ailable,)f(b)n(ut)h(these)h(may)e(not)h(w)o(ork)g(correctly)f(with)h
(L)3056 2356 y Fk(A)3086 2373 y Fr(T)3123 2392 y(E)3163
2373 y(X2HTML.\))0 2520 y(L)21 2503 y Fk(A)51 2520 y
Fr(T)88 2539 y(E)128 2520 y(X2HTML)27 b(can)h(be)h(installed)f(from)f
(the)i(source)e(archi)n(v)o(e,)i(b)n(ut)g(only)e(after)h(munging)e(one)
i(of)g(the)h(\002les)g(in)g(the)f(distrib)n(ution.)0
2619 y(Do)n(wnload)20 b(the)h(source)g(archi)n(v)o(e)f(from)g(the)h(L)
1318 2603 y Fk(A)1348 2619 y Fr(T)1385 2638 y(E)1425
2619 y(X2HTML)g(website)g Fq(
http://www)l(.late)n(x2html.org)o(/)16
b Fr(\(or)21 b(one)g(of)g(the)g(man)o(y)f(alternate)0
2719 y(sites\))j(and)e(unpack)f(it)i(to)g(a)h(b)n(uild)e(directory)-5
b(.)28 b(In)21 b(the)h(top)f(le)n(v)o(el)h(of)f(this)i(b)n(uild)e
(directory)f(there)h(will)i(be)f(a)g(\002le)g(named)f(`)p
Fq(L2hos)o(.pm)p Fr('.)0 2819 y(Open)k(`)p Fq(L2hos)o(.pm)p
Fr(')e(in)i(an)h(editor)m(,)f(and)g(near)f(the)i(bottom)e(of)h(the)g
(\002le)h(replace)f(the)g(te)o(xt)g Fg($\210O)h Fr(with)f(the)h(te)o
(xt)f Fg('unix')p Fr(.)40 b(Proceed)0 2918 y(using)20
b(this)g(command)f(to)h(b)n(uild)g(and)f(install)i(the)f(softw)o(are:)
236 3065 y Fh(\045)45 b(./configure)e(&&)h(make)h(install)0
3352 y Fr(Y)-9 b(ou)15 b(should)g(no)n(w)g(be)g(able)h(to)g(b)n(uild)f
(at)h(least)h(the)e(D)m(VI,)g(HTML,)h(PDF)-7 b(,)16 b(and)f(PostScript)
h(v)o(ersions)f(of)g(the)h(formatted)e(documentation.)0
3679 y Fs(8)120 b(Including)35 b(Gr)o(aphics)0 3912 y
Fr(The)c(standard)f(documentation)e(included)i(with)h(Python)f(mak)o
(es)h(no)g(use)h(of)f(diagrams)f(or)h(images;)36 b(this)c(is)g
(intentional.)57 b(The)0 4012 y(outside)24 b(tools)i(used)e(to)i
(format)e(the)h(documentation)d(ha)n(v)o(e)i(not)h(al)o(w)o(ays)h(been)
e(suited)h(to)g(w)o(orking)f(with)h(graphics.)39 b(As)25
b(the)h(tools)0 4111 y(ha)n(v)o(e)20 b(e)n(v)n(olv)o(ed)e(and)i(been)f
(impro)o(v)o(ed)f(by)i(their)g(maintainers,)e(support)h(for)h(graphics)
f(has)h(impro)o(v)o(ed.)0 4258 y(The)33 b(internal)g(tools,)k(starting)
c(with)h(the)g Fm(mkho)o(wto)g Fr(script,)i(do)e(not)f(pro)o(vide)f(an)
o(y)h(direct)g(support)f(for)h(graphics.)65 b(Ho)n(we)n(v)o(er)m(,)0
4358 y Fm(mkho)o(wto)20 b Fr(will)h(not)f(interfere)f(with)h(graphics)f
(support)g(in)h(the)h(e)o(xternal)d(tools.)0 4505 y(Experience)j(using)
h(graphics)g(together)f(with)j(these)f(tools)g(and)f(the)h
Fg(howto)f Fr(and)h Fg(manual)f Fr(document)f(classes)j(is)g(not)e(e)o
(xtensi)n(v)o(e,)0 4604 y(b)n(ut)e(has)h(been)e(kno)n(wn)g(to)h(w)o
(ork.)k(The)c(basic)h(approach)d(is)j(this:)104 4834
y(1.)41 b(Create)20 b(the)g(image)g(or)g(graphic)f(using)g(your)g(f)o
(a)n(v)n(orite)h(application.)104 5000 y(2.)41 b(Con)m(v)o(ert)30
b(the)i(image)g(to)g(a)g(format)f(supported)f(by)i(the)g(con)m(v)o
(ersion)d(to)j(your)f(desired)g(output)g(format.)59 b(If)32
b(you)f(w)o(ant)h(to)208 5100 y(generate)22 b(HTML)h(or)g(PostScript,)h
(you)f(can)g(con)m(v)o(ert)f(the)h(image)g(or)g(graphic)f(to)i
(encapsulated)e(PostScript)h(\(a)h(`)p Fq(.eps)p Fr(')e(\002le\);)208
5199 y(L)229 5183 y Fk(A)259 5199 y Fr(T)296 5218 y(E)335
5199 y(X2HTML)27 b(can)h(con)m(v)o(ert)e(that)i(to)g(a)g(`)p
Fq(.gif)p Fr(')f(\002le;)32 b(it)d(may)f(be)g(possible)f(to)h(pro)o
(vide)e(a)j(`)p Fq(.gif)p Fr(')d(\002le)j(directly)-5
b(.)47 b(If)27 b(you)g(w)o(ant)208 5299 y(to)g(generate)f(PDF)-7
b(,)29 b(you)d(need)h(to)h(pro)o(vide)d(an)j(\223encapsulated\224)d
(PDF)j(\002le.)48 b(This)27 b(can)h(be)f(generated)f(from)g
(encapsulated)208 5399 y(PostScript)20 b(using)f(the)i
Fm(epstopdf)f Fr(tool)g(pro)o(vided)d(with)k(the)f(teT)2070
5417 y(E)2110 5399 y(X)h(distrib)n(ution)e(on)h(Linux)f(and)i(U)t
Ff(N)t(I)t(X)r Fr(.)p 0 5549 3901 4 v 0 5649 a Fj(24)2969
b(8)83 b(Including)25 b(Gr)o(aphics)p eop end
%%Page: 25 25
TeXDict begin 25 24 bop 104 83 a Fr(3.)41 b(In)19 b(your)g(document,)f
(add)i(this)h(line)f(to)g(\223import\224)f(the)h(general)g(graphics)f
(support)f(package)h Fg(graphicx)p Fr(:)444 300 y Fh
(\\usepackage{graphicx})104 591 y Fr(4.)41 b(Where)20
b(you)f(w)o(ant)h(to)h(include)e(your)g(graphic)f(or)i(image,)g
(include)f(markup)f(similar)j(to)f(this:)444 807 y Fh(\\begin{figure})
533 899 y(\\centering)533 990 y(\\includegraphics[width=5in]{myimage})
533 1081 y(\\caption{Description)42 b(of)i(my)h(image})444
1173 y(\\end{figure})208 1438 y Fr(In)32 b(particular)m(,)h(note)f(for)
g(the)g Fg(\\includegraphics)e Fr(macro)h(that)i(no)f(\002le)h(e)o
(xtension)e(is)i(pro)o(vided.)59 b(If)32 b(you')l(re)e(only)208
1537 y(interested)21 b(in)h(one)f(tar)o(get)g(format,)g(you)h(can)f
(include)g(the)h(e)o(xtension)f(of)g(the)h(appropriate)e(input)h
(\002le,)i(b)n(ut)f(to)g(allo)n(w)g(support)208 1637
y(for)d(multiple)h(formats,)f(omitting)g(the)h(e)o(xtension)f(mak)o(es)
h(life)g(easier)-5 b(.)104 1788 y(5.)41 b(Run)20 b Fm(mkho)o(wto)g
Fr(normally)-5 b(.)0 1981 y(If)24 b(you')l(re)f(w)o(orking)f(on)i
(systems)h(which)f(support)f(some)h(sort)h(of)f Fm(mak)o(e)g
Fr(f)o(acility)-5 b(,)25 b(you)e(can)i(use)f(that)h(to)f(ensure)g(the)g
(intermediate)0 2081 y(graphic)18 b(formats)g(are)i(k)o(ept)f(up)g(to)g
(date.)25 b(This)19 b(e)o(xample)f(sho)n(ws)h(a)h(`)p
Fq(Mak)o(e\002le)p Fr(')e(used)h(to)g(format)g(a)g(document)f
(containing)f(a)j(diagram)0 2181 y(created)f(using)h(the)g
Fm(dia)h Fr(application:)236 2419 y Fh(default:)44 b(pdf)236
2510 y(all:)224 b(html)44 b(pdf)g(ps)236 2693 y(html:)134
b(mydoc/mydoc.html)236 2784 y(pdf:)179 b(mydoc.pdf)236
2875 y(ps:)224 b(mydoc.ps)236 3058 y(mydoc/mydoc.html:)87
b(mydoc.tex)43 b(mygraphic.eps)595 3149 y(mkhowto)h(--html)f($<)236
3332 y(mydoc.pdf:)88 b(mydoc.tex)44 b(mygraphic.pdf)595
3423 y(mkhowto)g(--pdf)g($<)236 3606 y(mydoc.ps:)133
b(mydoc.tex)44 b(mygraphic.eps)595 3697 y(mkhowto)g(--postscript)e($<)
236 3880 y(.SUFFIXES:)h(.dia)i(.eps)f(.pdf)236 4063 y(.dia.eps:)595
4154 y(dia)g(--nosplash)f(--export)h($@)g($<)236 4337
y(.eps.pdf:)595 4428 y(epstopdf)f($<)0 4868 y Fs(9)120
b(Future)35 b(Directions)0 5101 y Fr(The)25 b(history)f(of)g(the)h
(Python)f(documentation)e(is)j(full)g(of)g(changes,)f(most)h(of)g
(which)f(ha)n(v)o(e)h(been)f(f)o(airly)g(small)h(and)g(e)n(v)n
(olutionary)-5 b(.)0 5201 y(There)28 b(has)i(been)f(a)g(great)g(deal)g
(of)g(discussion)g(about)g(making)e(lar)o(ge)i(changes)f(in)i(the)f
(markup)e(languages)h(and)h(tools)g(used)g(to)0 5300
y(process)23 b(the)g(documentation.)30 b(This)23 b(section)g(deals)g
(with)g(the)g(nature)f(of)h(the)g(changes)f(and)g(what)h(appears)g(to)g
(be)g(the)g(most)g(lik)o(ely)0 5400 y(path)d(of)g(future)f(de)n(v)o
(elopment.)p 0 5549 3901 4 v 3808 5649 a Fj(25)p eop
end
%%Page: 26 26
TeXDict begin 26 25 bop 0 83 a Fd(9.1)100 b(Str)q(uctured)30
b(Documentation)0 286 y Fr(Most)c(of)f(the)g(small)h(changes)e(to)h
(the)h(L)1157 269 y Fk(A)1187 286 y Fr(T)1224 305 y(E)1263
286 y(X)g(markup)e(ha)n(v)o(e)g(been)h(made)g(with)g(an)g(e)o(ye)g(to)h
(di)n(v)n(orcing)d(the)i(markup)f(from)g(the)h(pre-)0
386 y(sentation,)20 b(making)g(both)g(a)i(bit)f(more)g(maintainable.)26
b(Ov)o(er)20 b(the)h(course)g(of)f(1998,)g(a)i(lar)o(ge)e(number)f(of)i
(changes)f(were)h(made)f(with)0 485 y(e)o(xactly)j(this)h(in)h(mind;)g
(pre)n(viously)-5 b(,)22 b(changes)h(had)g(been)g(made)h(b)n(ut)g(in)g
(a)g(less)h(systematic)f(manner)e(and)i(with)g(more)f(concern)f(for)0
585 y(not)i(needing)f(to)i(update)e(the)i(e)o(xisting)f(content.)36
b(The)25 b(result)f(has)h(been)f(a)h(highly)e(structured)g(and)h
(semantically)g(loaded)f(markup)0 684 y(language)h(implemented)f(in)j
(L)897 668 y Fk(A)927 684 y Fr(T)964 703 y(E)1004 684
y(X.)41 b(W)m(ith)26 b(almost)f(no)g(basic)h(T)1905 703
y(E)1945 684 y(X)g(or)g(L)2148 668 y Fk(A)2178 684 y
Fr(T)2215 703 y(E)2254 684 y(X)g(markup)e(in)h(use,)i(ho)n(we)n(v)o(er)
m(,)e(the)g(markup)f(syntax)h(is)0 784 y(about)19 b(the)h(only)g(e)n
(vidence)f(of)g(L)920 767 y Fk(A)950 784 y Fr(T)987 803
y(E)1027 784 y(X)i(in)f(the)g(actual)g(document)e(sources.)0
931 y(One)23 b(side)g(ef)n(fect)f(of)g(this)h(is)h(that)f(while)f(we')l
(v)o(e)g(been)g(able)h(to)f(use)h(standard)f(\223engines\224)f(for)h
(manipulating)f(the)h(documents,)g(such)0 1031 y(as)i(L)114
1014 y Fk(A)144 1031 y Fr(T)181 1049 y(E)220 1031 y(X)g(and)e(L)468
1014 y Fk(A)498 1031 y Fr(T)535 1049 y(E)575 1031 y(X2HTML,)g(most)h
(of)g(the)g(actual)g(transformations)e(ha)n(v)o(e)h(been)h(created)f
(speci\002cally)h(for)f(Python.)33 b(The)22 b(L)3733
1014 y Fk(A)3763 1031 y Fr(T)3800 1049 y(E)3840 1031
y(X)0 1130 y(document)f(classes)j(and)f(L)770 1114 y
Fk(A)800 1130 y Fr(T)837 1149 y(E)877 1130 y(X2HTML)f(support)g(are)h
(both)f(complete)g(implementations)g(of)g(the)i(speci\002c)f(markup)e
(designed)h(for)0 1230 y(these)e(documents.)0 1377 y(Combining)f
(highly)h(customized)f(markup)g(with)i(the)g(some)n(what)f(esoteric)g
(systems)i(used)e(to)h(process)f(the)h(documents)e(leads)i(us)g(to)0
1476 y(ask)k(some)f(questions:)33 b(Can)25 b(we)g(do)f(this)h(more)e
(easily?)39 b(and,)24 b(Can)h(we)g(do)f(this)h(better?)38
b(After)24 b(a)h(great)f(deal)g(of)g(discussion)g(with)0
1576 y(the)g(community)-5 b(,)21 b(we)k(ha)n(v)o(e)e(determined)e(that)
j(acti)n(v)o(ely)f(pursuing)f(modern)g(structured)g(documentation)f
(systems)j(is)h(w)o(orth)e(some)0 1676 y(in)m(v)o(estment)c(of)g(time.)
0 1822 y(There)k(appear)g(to)h(be)g(tw)o(o)g(real)g(contenders)e(in)i
(this)h(arena:)32 b(the)24 b(Standard)e(General)h(Markup)g(Language)f
(\(SGML\),)h(and)g(the)h(Ex-)0 1922 y(tensible)19 b(Markup)f(Language)g
(\(XML\).)g(Both)i(of)f(these)h(standards)f(ha)n(v)o(e)f(adv)n(antages)
g(and)h(disadv)n(antages,)f(and)h(man)o(y)f(adv)n(antages)0
2022 y(are)i(shared.)0 2169 y(SGML)25 b(of)n(fers)f(adv)n(antages)f
(which)i(may)f(appeal)h(most)g(to)g(authors,)g(especially)f(those)h
(using)f(ordinary)f(te)o(xt)i(editors.)39 b(There)24
b(are)0 2268 y(also)30 b(additional)e(abilities)h(to)h(de\002ne)f
(content)f(models.)51 b(A)30 b(number)e(of)h(high-quality)d(tools)k
(with)f(demonstrated)e(maturity)i(are)0 2368 y(a)n(v)n(ailable,)19
b(b)n(ut)i(most)f(are)g(not)g(free;)g(for)f(those)h(which)g(are,)g
(portability)f(issues)i(remain)e(a)i(problem.)0 2515
y(The)29 b(adv)n(antages)f(of)h(XML)h(include)e(the)i(a)n(v)n
(ailability)f(of)g(a)h(lar)o(ge)f(number)e(of)j(e)n(v)n(olving)d
(tools.)53 b(Unfortunately)-5 b(,)29 b(man)o(y)f(of)i(the)0
2614 y(associated)24 b(standards)g(are)h(still)h(e)n(v)n(olving,)d(and)
i(the)f(tools)h(will)g(ha)n(v)o(e)f(to)h(follo)n(w)f(along.)37
b(This)25 b(means)f(that)h(de)n(v)o(eloping)d(a)j(rob)n(ust)0
2714 y(tool)30 b(set)g(that)g(uses)h(more)e(than)g(the)h(basic)g(XML)g
(1.0)f(recommendation)d(is)31 b(not)f(possible)f(in)h(the)g(short)g
(term.)53 b(The)30 b(promised)0 2814 y(a)n(v)n(ailability)22
b(of)g(a)h(wide)f(v)n(ariety)g(of)g(high-quality)e(tools)j(which)e
(support)h(some)g(of)g(the)h(most)f(important)f(related)h(standards)f
(is)j(not)0 2913 y(immediate.)50 b(Man)o(y)28 b(tools)g(are)h(lik)o
(ely)g(to)g(be)f(free,)j(and)d(the)h(portability)e(issues)i(of)g(those)
g(which)f(are,)i(are)f(not)g(e)o(xpected)e(to)i(be)0
3013 y(signi\002cant.)0 3160 y(It)17 b(turns)f(out)g(that)g(con)m(v)o
(erting)e(to)i(an)g(XML)h(or)f(SGML)h(system)f(holds)g(promise)f(for)h
(translators)g(as)h(well;)h(ho)n(w)e(much)g(can)g(be)g(done)f(to)0
3259 y(ease)20 b(the)f(b)n(urden)f(on)h(translators)g(remains)g(to)g
(be)h(seen,)f(and)g(may)g(ha)n(v)o(e)f(some)i(impact)f(on)g(the)g
(schema)g(and)g(speci\002c)g(technologies)0 3359 y(used.)0
3506 y(XXX)i(Ev)o(entual)d(migration)h(to)h(XML.)0 3653
y(The)g(documentation)e(will)j(be)f(mo)o(v)o(ed)f(to)h(XML)h(in)g(the)f
(future,)f(and)h(tools)h(are)f(being)g(written)g(which)g(will)h(con)m
(v)o(ert)e(the)h(documen-)0 3752 y(tation)25 b(from)g(the)h(current)e
(format)h(to)h(something)e(close)i(to)g(a)g(\002nished)f(v)o(ersion,)h
(to)g(the)g(e)o(xtent)f(that)g(the)h(desired)f(information)f(is)0
3852 y(already)g(present)h(in)g(the)h(documentation.)37
b(Some)25 b(XSL)-8 b(T)26 b(stylesheets)f(ha)n(v)o(e)g(been)g(started)g
(for)g(presenting)f(a)h(preliminary)f(XML)0 3952 y(v)o(ersion)19
b(as)i(HTML,)f(b)n(ut)g(the)g(results)g(are)h(f)o(airly)e(rough.)0
4098 y(The)i(timeframe)g(for)g(the)g(con)m(v)o(ersion)e(is)k(not)e
(clear)g(since)h(there)f(doesn')o(t)f(seem)i(to)g(be)f(much)g(time)g(a)
n(v)n(ailable)h(to)f(w)o(ork)g(on)g(this,)i(b)n(ut)0
4198 y(the)d(apparent)f(bene\002ts)h(are)g(gro)n(wing)e(more)i
(substantial)g(at)g(a)h(moderately)d(rapid)i(pace.)0
4483 y Fd(9.2)100 b(Discussion)28 b(F)m(or)q(ums)0 4686
y Fr(Discussion)g(of)g(the)f(future)g(of)h(the)g(Python)f
(documentation)e(and)i(related)g(topics)h(tak)o(es)g(place)g(in)g(the)g
(Documentation)e(Special)0 4785 y(Interest)19 b(Group,)g(or)g
(\223Doc-SIG.)-6 b(\224)19 b(Information)e(on)i(the)h(group,)d
(including)h(mailing)h(list)i(archi)n(v)o(es)e(and)g(subscription)f
(information,)0 4885 y(is)j(a)n(v)n(ailable)f(at)h Fq(
http://www)l(.p)n
(ython.org)o(/sigs/d)o(oc-sig/)-7 b Fr(.)26 b(The)20
b(SIG)g(is)h(open)f(to)g(all)h(interested)e(parties.)0
5032 y(Comments)c(and)f(b)n(ug)h(reports)f(on)h(the)h(standard)e
(documents)f(should)i(be)g(sent)g(to)h Fq(docs@p)n(ython.org)p
Fr(.)k(This)c(may)e(include)h(comments)0 5132 y(about)25
b(formatting,)h(content,)g(grammatical)f(and)h(spelling)g(errors,)g(or)
g(this)h(document.)41 b(Y)-9 b(ou)26 b(can)g(also)g(send)g(comments)f
(on)h(this)0 5231 y(document)18 b(directly)i(to)g(the)g(author)f(at)i
Fq(fdr)o(ak)o(
[email protected])p Fr(.)p 0 5549 3901 4 v 0 5649
a Fj(26)3024 b(9)83 b(Future)23 b(Directions)p eop end
%%Page: 27 27
TeXDict begin 27 26 bop 0 217 a Fs(Inde)l(x)0 391 y(B)0
515 y Fg(bfcode)p Fr(,)19 b(11)0 614 y Fg(bifuncindex)p
Fr(,)f(20)0 805 y Fs(C)0 929 y Fg(cdata)p Fr(,)i(11)0
1028 y Fg(cfuncdesc)f Fr(en)m(vironment,)e(9)0 1128 y
Fg(cfunction)p Fr(,)i(11)0 1228 y Fg(character)p Fr(,)g(12)0
1327 y Fg(citetitle)p Fr(,)g(12)0 1427 y Fg(class)p Fr(,)h(12)0
1526 y Fg(classdesc)f Fr(en)m(vironment,)e(10)0 1626
y Fg(classdesc)450 1641 y(*)519 1626 y Fr(en)m(vironment,)g(10)0
1726 y Fg(cmemberdesc)i Fr(en)m(vironment,)e(9)0 1825
y Fg(code)p Fr(,)j(12)0 1925 y Fg(constant)p Fr(,)f(12)0
2025 y Fg(csimplemacro)p Fr(,)f(12)0 2124 y Fg(csimplemacrodesc)g
Fr(en)m(vironment,)f(9)0 2224 y Fg(ctype)p Fr(,)j(12)0
2323 y Fg(ctypedesc)f Fr(en)m(vironment,)e(9)0 2423 y
Fg(cvardesc)i Fr(en)m(vironment,)e(10)0 2606 y Fs(D)0
2729 y Fg(datadesc)i Fr(en)m(vironment,)e(10)0 2829 y
Fg(datadescni)i Fr(en)m(vironment,)e(10)0 2928 y Fg(declaremodule)p
Fr(,)h(16)0 3028 y Fg(deprecated)p Fr(,)h(12)0 3127 y
Fg(dfn)p Fr(,)h(12)0 3310 y Fs(E)0 3433 y Fg(e)p Fr(,)g(12)0
3533 y Fg(email)p Fr(,)g(12)0 3633 y Fg(emph)p Fr(,)g(12)0
3732 y(en)m(vironments)166 3832 y Fg(cfuncdesc)p Fr(,)f(9)166
3931 y Fg(classdesc)p Fr(,)g(10)166 4031 y Fg(classdesc)616
4046 y(*)666 4031 y Fr(,)g(10)166 4131 y Fg(cmemberdesc)p
Fr(,)g(9)166 4230 y Fg(csimplemacrodesc)p Fr(,)f(9)166
4330 y Fg(ctypedesc)p Fr(,)h(9)166 4430 y Fg(cvardesc)p
Fr(,)g(10)166 4529 y Fg(datadesc)p Fr(,)g(10)166 4629
y Fg(datadescni)p Fr(,)g(10)166 4729 y Fg(excclassdesc)p
Fr(,)f(10)166 4828 y Fg(excdesc)p Fr(,)h(10)166 4928
y Fg(funcdesc)p Fr(,)g(10)166 5027 y Fg(funcdescni)p
Fr(,)g(10)166 5127 y Fg(longtableii)p Fr(,)g(17)166 5227
y Fg(longtableiii)p Fr(,)f(17)166 5326 y Fg(longtableiv)p
Fr(,)h(17)2158 388 y Fg(longtablev)p Fr(,)f(18)2158 488
y Fg(memberdesc)p Fr(,)g(10)2158 587 y Fg(memberdescni)p
Fr(,)g(10)2158 687 y Fg(methoddesc)p Fr(,)g(10)2158 787
y Fg(methoddescni)p Fr(,)g(11)2158 886 y Fg(notice)p
Fr(,)h(15)2158 986 y Fg(productionlist)p Fr(,)e(21)2158
1085 y Fg(seealso)p Fr(,)i(19)2158 1185 y Fg(seealso)2508
1200 y(*)2558 1185 y Fr(,)g(19)2158 1285 y Fg(tableii)p
Fr(,)g(17)2158 1384 y Fg(tableiii)p Fr(,)g(17)2158 1484
y Fg(tableiv)p Fr(,)g(17)2158 1584 y Fg(tablev)p Fr(,)g(17)1992
1683 y Fg(envvar)p Fr(,)g(12)1992 1783 y Fg(excclassdesc)f
Fr(en)m(vironment,)f(10)1992 1882 y Fg(excdesc)i Fr(en)m(vironment,)e
(10)1992 1982 y Fg(exception)p Fr(,)h(12)1992 2082 y
Fg(exindex)p Fr(,)h(20)1992 2262 y Fs(F)1992 2385 y Fg(file)p
Fr(,)g(12)1992 2485 y Fg(filenq)p Fr(,)g(12)1992 2584
y Fg(funcdesc)g Fr(en)m(vironment,)e(10)1992 2684 y Fg(funcdescni)h
Fr(en)m(vironment,)f(10)1992 2784 y Fg(function)p Fr(,)i(13)1992
2972 y Fs(G)1992 3095 y Fg(guilabel)p Fr(,)g(22)1992
3275 y Fs(I)1992 3399 y Fg(indexii)p Fr(,)g(21)1992 3498
y Fg(indexiii)p Fr(,)g(21)1992 3598 y Fg(indexiv)p Fr(,)g(21)1992
3697 y Fg(infinity)p Fr(,)g(13)1992 3878 y Fs(K)1992
4001 y Fg(kbd)p Fr(,)g(13)1992 4100 y Fg(keyword)p Fr(,)g(13)1992
4200 y Fg(kwindex)p Fr(,)g(20)1992 4380 y Fs(L)1992 4503
y Fg(lineii)p Fr(,)g(17)1992 4603 y Fg(lineiii)p Fr(,)g(17)1992
4703 y Fg(lineiv)p Fr(,)g(17)1992 4802 y Fg(linev)p Fr(,)g(18)1992
4902 y Fg(localmoduletable)p Fr(,)e(16)1992 5001 y Fg(longprogramopt)p
Fr(,)g(14)1992 5101 y Fg(longtableii)h Fr(en)m(vironment,)f(17)1992
5201 y Fg(longtableiii)h Fr(en)m(vironment,)f(17)1992
5300 y Fg(longtableiv)h Fr(en)m(vironment,)f(17)1992
5400 y Fg(longtablev)h Fr(en)m(vironment,)f(18)p 0 5549
3901 4 v 3808 5649 a Fj(27)p eop end
%%Page: 28 28
TeXDict begin 28 27 bop 0 86 a Fs(M)0 210 y Fg(mailheader)p
Fr(,)19 b(13)0 309 y Fg(makemodindex)p Fr(,)f(20)0 409
y Fg(makevar)p Fr(,)h(13)0 509 y Fg(manpage)p Fr(,)g(13)0
608 y Fg(member)p Fr(,)g(13)0 708 y Fg(memberdesc)g Fr(en)m(vironment,)
e(10)0 807 y Fg(memberdescni)i Fr(en)m(vironment,)d(10)0
907 y Fg(menuselection)p Fr(,)i(22)0 1007 y Fg(method)p
Fr(,)h(13)0 1106 y Fg(methoddesc)g Fr(en)m(vironment,)e(10)0
1206 y Fg(methoddescni)i Fr(en)m(vironment,)d(11)0 1306
y Fg(mimetype)p Fr(,)j(13)0 1405 y Fg(module)p Fr(,)g(13)0
1505 y Fg(moduleauthor)p Fr(,)f(16)0 1604 y Fg(modulesynopsis)p
Fr(,)g(16)0 1787 y Fs(N)0 1910 y Fg(newsgroup)p Fr(,)h(13)0
2010 y Fg(note)p Fr(,)h(13)0 2110 y Fg(notice)g Fr(en)m(vironment,)c
(15)0 2301 y Fs(O)0 2424 y Fg(obindex)p Fr(,)j(20)0 2524
y Fg(opindex)p Fr(,)g(21)0 2706 y Fs(P)0 2829 y Fr(packages,)g(15)0
2929 y Fg(pep)p Fr(,)h(13)0 3029 y Fg(platform)p Fr(,)f(16)0
3128 y Fg(plusminus)p Fr(,)g(13)0 3228 y Fg(production)p
Fr(,)g(21)0 3328 y Fg(productionlist)f Fr(en)m(vironment,)f(21)0
3427 y Fg(program)p Fr(,)i(14)0 3527 y Fg(programopt)p
Fr(,)g(14)0 3709 y Fs(R)0 3833 y Fg(refbimodindex)p Fr(,)f(21)0
3932 y Fg(refexmodindex)p Fr(,)g(21)0 4032 y Fg(refmodindex)p
Fr(,)g(21)0 4132 y Fg(refmodule)p Fr(,)h(14)0 4231 y
Fg(refstmodindex)p Fr(,)f(21)0 4331 y Fg(regexp)p Fr(,)h(14)0
4430 y Fg(release)p Fr(,)g(8)0 4530 y(RFC)166 4630 y(RFC)j(822,)d(13)0
4729 y Fg(rfc)p Fr(,)h(14)0 4921 y Fs(S)0 5044 y Fg(samp)p
Fr(,)g(14)0 5143 y Fg(sectionauthor)p Fr(,)e(9)0 5243
y Fg(seealso)h Fr(en)m(vironment,)e(19)0 5343 y Fg(seealso)350
5358 y(*)419 5343 y Fr(en)m(vironment,)g(19)1992 83 y
Fg(seelink)p Fr(,)i(19)1992 183 y Fg(seemodule)p Fr(,)f(19)1992
282 y Fg(seepep)p Fr(,)h(20)1992 382 y Fg(seerfc)p Fr(,)g(20)1992
482 y Fg(seetext)p Fr(,)g(20)1992 581 y Fg(seetitle)p
Fr(,)g(20)1992 681 y Fg(seeurl)p Fr(,)g(20)1992 780 y
Fg(setshortversion)p Fr(,)e(8)1992 880 y Fg(shortversion)p
Fr(,)h(14)1992 980 y Fg(stindex)p Fr(,)h(21)1992 1079
y Fg(strong)p Fr(,)g(14)1992 1179 y Fg(sub)p Fr(,)g(22)1992
1362 y Fs(T)1992 1485 y Fg(tableii)g Fr(en)m(vironment,)e(17)1992
1584 y Fg(tableiii)i Fr(en)m(vironment,)e(17)1992 1684
y Fg(tableiv)i Fr(en)m(vironment,)e(17)1992 1784 y Fg(tablev)i
Fr(en)m(vironment,)e(17)1992 1883 y Fg(token)p Fr(,)i(22)1992
2066 y Fs(U)1992 2189 y Fg(ulink)p Fr(,)g(14)1992 2289
y Fg(url)p Fr(,)g(14)1992 2471 y Fs(V)1992 2595 y Fg(var)p
Fr(,)g(14)1992 2694 y Fg(version)p Fr(,)g(14)1992 2794
y Fg(versionadded)p Fr(,)f(15)1992 2894 y Fg(versionchanged)p
Fr(,)f(15)1992 3076 y Fs(W)1992 3200 y Fg(warning)p Fr(,)i(14)p
0 5549 3901 4 v 0 5649 a Fj(28)3607 b(Inde)n(x)p eop
end
%%Trailer
userdict /end-hook known{end-hook}if
%%EOF
