/ Celestin Apprentice 2 / Apprentice-Release2.iso / Tools / Languages / Python 1.1 / Doc / libtemplate.tex

< prev

next >

MacOS 8.1

Win98

DOS

view JSON data

view as text

+--------+-------------------------+-------------------------+--------+--------+
|00000000| 25 20 54 65 6d 70 6c 61 | 74 65 20 66 6f 72 20 6c |% Templa|te for l|
|00000010| 69 62 72 61 72 79 20 73 | 65 63 74 69 6f 6e 73 2e |ibrary s|ections.|
|00000020| 0d 25 20 52 65 70 6c 61 | 63 65 20 74 65 78 74 20 |.% Repla|ce text |
|00000030| 69 6e 20 41 4c 4c 20 43 | 41 50 53 20 62 79 20 79 |in ALL C|APS by y|
|00000040| 6f 75 72 20 6f 77 6e 20 | 74 65 78 74 2e 0d 25 20 |our own |text..% |
|00000050| 43 6f 6d 6d 65 6e 74 73 | 20 73 74 61 72 74 69 6e |Comments| startin|
|00000060| 67 20 77 69 74 68 20 25 | 2a 2a 20 67 69 76 65 20 |g with %|** give |
|00000070| 61 64 64 69 74 69 6f 6e | 61 6c 20 64 69 72 65 63 |addition|al direc|
|00000080| 74 69 6f 6e 73 2e 0d 0d | 25 2a 2a 20 43 68 6f 6f |tions...|%** Choo|
|00000090| 73 65 20 6f 6e 65 20 6f | 66 20 74 68 65 20 66 6f |se one o|f the fo|
|000000a0| 6c 6c 6f 77 69 6e 67 20 | 74 77 6f 20 73 65 63 74 |llowing |two sect|
|000000b0| 69 6f 6e 20 68 65 61 64 | 69 6e 67 73 3a 0d 5c 73 |ion head|ings:.\s|
|000000c0| 65 63 74 69 6f 6e 7b 42 | 75 69 6c 74 2d 69 6e 20 |ection{B|uilt-in |
|000000d0| 6d 6f 64 75 6c 65 20 7b | 5c 74 74 20 59 4f 55 52 |module {|\tt YOUR|
|000000e0| 2d 4d 4f 44 55 4c 45 2d | 4e 41 4d 45 7d 7d 20 25 |-MODULE-|NAME}} %|
|000000f0| 20 49 66 20 77 72 69 74 | 74 65 6e 20 69 6e 20 43 | If writ|ten in C|
|00000100| 0d 5c 73 65 63 74 69 6f | 6e 7b 53 74 61 6e 64 61 |.\sectio|n{Standa|
|00000110| 72 64 20 6d 6f 64 75 6c | 65 20 7b 5c 74 74 20 59 |rd modul|e {\tt Y|
|00000120| 4f 55 52 2d 4d 4f 44 55 | 4c 45 2d 4e 41 4d 45 7d |OUR-MODU|LE-NAME}|
|00000130| 7d 20 25 20 49 66 20 77 | 72 69 74 74 65 6e 20 69 |} % If w|ritten i|
|00000140| 6e 20 50 79 74 68 6f 6e | 0d 0d 50 55 54 20 41 20 |n Python|..PUT A |
|00000150| 53 48 4f 52 54 20 49 4e | 54 52 4f 44 55 43 54 49 |SHORT IN|TRODUCTI|
|00000160| 4f 4e 20 41 4e 44 20 44 | 45 53 43 52 49 50 54 49 |ON AND D|ESCRIPTI|
|00000170| 4f 4e 20 4f 46 20 54 48 | 45 20 4d 4f 44 55 4c 45 |ON OF TH|E MODULE|
|00000180| 20 48 45 52 45 2e 0d 0d | 25 2a 2a 20 63 68 61 6e | HERE...|%** chan|
|00000190| 67 65 20 74 68 69 73 20 | 73 65 6e 74 65 6e 63 65 |ge this |sentence|
|000001a0| 20 74 6f 20 74 61 73 74 | 65 3a 0d 54 68 65 20 6d | to tast|e:.The m|
|000001b0| 6f 64 75 6c 65 20 64 65 | 66 69 6e 65 73 20 74 68 |odule de|fines th|
|000001c0| 65 20 66 6f 6c 6c 6f 77 | 69 6e 67 20 76 61 72 69 |e follow|ing vari|
|000001d0| 61 62 6c 65 73 20 61 6e | 64 20 66 75 6e 63 74 69 |ables an|d functi|
|000001e0| 6f 6e 73 3a 0d 0d 5c 62 | 65 67 69 6e 7b 64 65 73 |ons:..\b|egin{des|
|000001f0| 63 72 69 70 74 69 6f 6e | 7d 0d 0d 5c 72 65 6e 65 |cription|}..\rene|
|00000200| 77 63 6f 6d 6d 61 6e 64 | 7b 5c 69 6e 64 65 78 73 |wcommand|{\indexs|
|00000210| 75 62 69 74 65 6d 7d 7b | 28 69 6e 20 6d 6f 64 75 |ubitem}{|(in modu|
|00000220| 6c 65 20 59 4f 55 52 2d | 4d 4f 44 55 4c 45 2d 4e |le YOUR-|MODULE-N|
|00000230| 41 4d 45 29 7d 0d 0d 0d | 25 2a 2a 20 59 6f 75 20 |AME)}...|%** You |
|00000240| 63 61 6e 20 6d 69 78 20 | 65 78 63 65 70 74 69 6f |can mix |exceptio|
|00000250| 6e 73 2c 20 76 61 72 69 | 61 62 6c 65 73 20 61 6e |ns, vari|ables an|
|00000260| 64 20 66 75 6e 63 74 69 | 6f 6e 73 20 62 65 6c 6f |d functi|ons belo|
|00000270| 77 3b 20 6f 66 74 65 6e | 20 69 74 20 69 73 20 61 |w; often| it is a|
|00000280| 0d 25 2a 2a 20 67 6f 6f | 64 20 69 64 65 61 20 74 |.%** goo|d idea t|
|00000290| 6f 20 61 6c 70 68 61 62 | 65 74 69 7a 65 20 74 68 |o alphab|etize th|
|000002a0| 65 6d 20 61 6c 6c 2e 0d | 0d 0d 25 2a 2a 20 72 65 |em all..|..%** re|
|000002b0| 70 65 61 74 20 74 68 65 | 20 66 6f 6c 6c 6f 77 69 |peat the| followi|
|000002c0| 6e 67 20 66 6f 72 20 65 | 61 63 68 20 65 78 63 65 |ng for e|ach exce|
|000002d0| 70 74 69 6f 6e 3a 0d 5c | 65 78 63 69 74 65 6d 7b |ption:.\|excitem{|
|000002e0| 4e 41 4d 45 7d 0d 44 45 | 53 43 52 49 50 54 49 4f |NAME}.DE|SCRIPTIO|
|000002f0| 4e 20 4f 46 20 54 48 45 | 20 45 58 43 45 50 54 49 |N OF THE| EXCEPTI|
|00000300| 4f 4e 20 47 4f 45 53 20 | 48 45 52 45 2e 0d 0d 0d |ON GOES |HERE....|
|00000310| 25 2a 2a 20 72 65 70 65 | 61 74 20 74 68 65 20 66 |%** repe|at the f|
|00000320| 6f 6c 6c 6f 77 69 6e 67 | 20 66 6f 72 20 65 61 63 |ollowing| for eac|
|00000330| 68 20 76 61 72 69 61 62 | 6c 65 20 28 6f 72 20 63 |h variab|le (or c|
|00000340| 6f 6e 73 74 61 6e 74 29 | 3a 0d 5c 64 61 74 61 69 |onstant)|:.\datai|
|00000350| 74 65 6d 7b 4e 41 4d 45 | 7d 0d 44 45 53 43 52 49 |tem{NAME|}.DESCRI|
|00000360| 50 54 49 4f 4e 20 4f 46 | 20 54 48 45 20 56 41 52 |PTION OF| THE VAR|
|00000370| 49 41 42 4c 45 2f 43 4f | 4e 53 54 41 4e 54 20 47 |IABLE/CO|NSTANT G|
|00000380| 4f 45 53 20 48 45 52 45 | 2e 0d 0d 0d 25 2a 2a 20 |OES HERE|....%** |
|00000390| 72 65 70 65 61 74 20 74 | 68 65 20 66 6f 6c 6c 6f |repeat t|he follo|
|000003a0| 77 69 6e 67 20 66 6f 72 | 20 65 61 63 68 20 66 75 |wing for| each fu|
|000003b0| 6e 63 74 69 6f 6e 3a 0d | 5c 66 75 6e 63 69 74 65 |nction:.|\funcite|
|000003c0| 6d 7b 4e 41 4d 45 7d 7b | 50 41 52 41 4d 45 54 45 |m{NAME}{|PARAMETE|
|000003d0| 52 53 7d 20 25 20 44 6f | 6e 27 74 20 69 6e 63 6c |RS} % Do|n't incl|
|000003e0| 75 64 65 20 74 68 65 20 | 70 61 72 65 6e 74 68 65 |ude the |parenthe|
|000003f0| 73 65 73 0d 44 45 53 43 | 52 49 50 54 49 4f 4e 20 |ses.DESC|RIPTION |
|00000400| 4f 46 20 54 48 45 20 46 | 55 4e 43 54 49 4f 4e 20 |OF THE F|UNCTION |
|00000410| 47 4f 45 53 20 48 45 52 | 45 2e 0d 0d 0d 5c 65 6e |GOES HER|E....\en|
|00000420| 64 7b 64 65 73 63 72 69 | 70 74 69 6f 6e 7d 0d 0d |d{descri|ption}..|
|00000430| 41 44 44 49 54 49 4f 4e | 41 4c 20 48 49 4e 54 53 |ADDITION|AL HINTS|
|00000440| 20 46 4f 52 20 55 53 49 | 4e 47 20 54 48 45 20 4d | FOR USI|NG THE M|
|00000450| 4f 44 55 4c 45 20 4d 41 | 59 20 47 4f 20 48 45 52 |ODULE MA|Y GO HER|
|00000460| 45 2e 0d                |                         |E..     |        |
+--------+-------------------------+-------------------------+--------+--------+