summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/latex/ydoc/ydoc-doc.sty
blob: 9164dbd36aa09f806e325d3c556d14126448d22d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
%%
%% This is file `ydoc-doc.sty',
%% generated with the docstrip utility.
%%
%% The original source files were:
%%
%% ydoc.dtx  (with options: `ydoc-doc.sty')
%% 
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{ydoc-doc}[%
    2011/08/11
    v0.5alpha
    ydoc package to provide 'doc' macros]
\newcount\ydoc@bslashcnt
\def\ydoc@countbslashes{%
  \begingroup
    \let\firstlinemacro\empty
    \let\lastlinemacro\empty
    \let\newlinemacro\empty
    \let\spacemacro\empty
    \def\bslashmacro{\global\advance\ydoc@bslashcnt by\@ne}%
    \setbox\@tempboxa\hbox{\themacrocode}%
  \endgroup
}
\def\CheckSum#1{%
  \gdef\ydoc@checksum{#1}%
}
\let\ydoc@checksum\m@ne
\def\AlsoImplementation{%
  \gdef\StopEventually##1{%
    \@bsphack
    \gdef\Finale{##1\ydoc@checkchecksum}%
    \@esphack
  }%
}
\AlsoImplementation
\def\OnlyDescription{%
  \@bsphack
  \long\gdef\StopEventually##1{##1\endinput}%
  \@esphack
}
\let\Finale\relax
\def\MakePercentIgnore{\catcode`\%9\relax}
\def\MakePercentComment{\catcode`\%14\relax}
\def\DocInput#1{\MakePercentIgnore\input{#1}\MakePercentComment}
\providecommand*\CharacterTable{%
    \begingroup
    \CharTableChanges
    \@CharacterTable
}
\def\@CharacterTable#1{%
    \def\ydoc@used@CharacterTable{#1}%
    \@onelevel@sanitize\ydoc@used@CharacterTable
    \ifx\ydoc@used@CharacterTable\ydoc@correct@CharacterTable
           \typeout{***************************}%
           \typeout{* Character table correct *}%
           \typeout{***************************}%
    \else
         \PackageError{ydoc}{Character table corrupted}
                           {\the\wrong@table}
         \show\ydoc@used@CharacterTable
         \show\ydoc@correct@CharacterTable
    \fi
    \endgroup
}
\newhelp\wrong@table{Some of the ASCII characters are corrupted.^^J
            I now \string\show\space you both tables for comparison.}
\newcommand*\CharTableChanges{}
\def\ydoc@correct@CharacterTable
  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
   Digits        \0\1\2\3\4\5\6\7\8\9
   Exclamation   \!     Double quote  \"     Hash (number) \#
   Dollar        \$     Percent       \%     Ampersand     \&
   Acute accent  \'     Left paren    \(     Right paren   \)
   Asterisk      \*     Plus          \+     Comma         \,
   Minus         \-     Point         \.     Solidus       \/
   Colon         \:     Semicolon     \;     Less than     \<
   Equals        \=     Greater than  \>     Question mark \?
   Commercial at \@     Left bracket  \[     Backslash     \\
   Right bracket \]     Circumflex    \^     Underscore    \_
   Grave accent  \`     Left brace    \{     Vertical bar  \|
   Right brace   \}     Tilde         \~}
\@onelevel@sanitize\ydoc@correct@CharacterTable
\providecommand*\DoNotIndex[1]{%
  \PackageWarning{ydoc}{Ignoring DoNotIndex - not implemented yet!}{}{}%
}
\providecommand*\changes[3]{%
  \PackageWarning{ydoc}{Ignoring changes - not implemented yet!}{}{}%
}
\providecommand*\RecordChanges{%
  \PackageWarning{ydoc}{List of changes not implemented yet!}{}{}%
}
\providecommand*\PrintChanges{%
  \PackageWarning{ydoc}{List of changes not implemented yet!}{}{}%
}
\providecommand*\PrintIndex{%
  \PackageWarning{ydoc}{Code index not implemented yet!}{}{}%
}
\providecommand*\CodelineIndex{%
  \PackageWarning{ydoc}{Code line index not implemented yet!}{}{}%
}
\providecommand*\EnableCrossrefs{%
  \PackageWarning{ydoc}{Cross references not implemented yet!}{}{}%
}
\providecommand*\GetFileInfo[1]{%
  \def\filename{#1}%
  \def\@tempb##1 ##2 ##3\relax##4\relax{%
    \def\filedate{##1}%
    \def\fileversion{##2}%
    \def\fileinfo{##3}}%
  \edef\@tempa{\csname ver@#1\endcsname}%
  \expandafter\@tempb\@tempa\relax? ? \relax\relax
}
\def\ydoc@checkchecksum{%
  \ifnum\ydoc@checksum=\m@ne
    \message{^^J}%
    \message{**********************^^J}%
    \message{* No checksum found! *^^J}%
    \message{**********************^^J}%
    \GenericWarning{No checksum found}{Correct checksum is \the\ydoc@bslashcnt^^J}{}{}%
  \else
  \ifnum\ydoc@checksum=\z@
    \message{^^J}%
    \message{*********************^^J}%
    \message{* Checksum disabled *^^J}%
    \message{*********************^^J}%
    \GenericWarning{Checksum disabled}{Correct checksum is \the\ydoc@bslashcnt^^J}{}{}%
  \else
  \ifnum\ydoc@checksum=\ydoc@bslashcnt
    \message{^^J}%
    \message{*******************^^J}%
    \message{* Checksum passed *^^J}%
    \message{*******************^^J}%
  \else
    \message{^^J}%
    \message{****************************^^J}%
    \message{* Checksum wrong (\ydoc@checksum<>\the\ydoc@bslashcnt) ^^J}%
    \message{****************************^^J}%
    \GenericError{Checksum wrong}{Correct checksum is \the\ydoc@bslashcnt^^J}{}{}%
  \fi
  \fi
  \fi
}
\RequirePackage{shortvrb}
\AtBeginDocument{\MakeShortVerb{\|}}
\RequirePackage{url}

\def\package{\def\@package}
\package{\jobname}

\def\ctanlocation{\def\@ctanlocation##1}
\ctanlocation{http://www.ctan.org/pkg/#1}

\date{Version \fileversion\space -- \filedate}

\def\@homepage{%
    \begingroup
    \edef\@tempa{%
        \endgroup
        \noexpand\url
        {\@ctanlocation{\@package}}%
    }%
    \@tempa
}

\protected\def\homepage{\urldef\@homepage\url}
\protected\def\email{\hyper@normalise\email@}
\def\email@#1{\def\@plainemail{#1}\def\@email{\hyper@linkurl{\Hurl{#1}}{mailto:#1}}}

\let\@email\empty

\let\@plainemail\empty
\title{The \texorpdfstring{\pkgtitle{\@package}}{\@package} Package}

\protected\def\pkgtitle#1{%
    \texorpdfstring{\textsf{#1}}{#1}%
}

\def\@maketitle{%
    \newpage
    \null\vskip 2em
    \begin{center}%
        \let\footnote\thanks
        {\LARGE \@title \par }\vskip 1.5em%
        {\large \lineskip .5em%
        \begin{tabular}[t]{c}%
            \@author
        \end{tabular}%
        \par}%
        \ifx\@plainemail\empty\else
            {\large \lineskip .5em%
            \begin{tabular}[t]{c}%
                \@email
            \end{tabular}%
            \par}%
        \fi
        \vskip 1em
        {\large \lineskip .5em%
        \begin{tabular}[t]{c}%
            \@homepage
        \end{tabular}%
        \par}%
        \vskip 1em
        {\large \@date }%
    \end{center}%
    \par\vskip 1.5em
    \aftergroup\ydocpdfsettings
}

\ifpdf
\def\ydocpdfsettings{%
    \hypersetup{%
        pdfauthor   = {\@author\space<\@plainemail>},
        pdftitle    = {\@title},
        pdfsubject  = {Documentation of LaTeX package \@package},
        pdfkeywords = {\@package, LaTeX, TeX}
    }%
}
\else
\let\ydocpdfsettings\empty
\fi

\let\orig@maketitle\maketitle
\def\maketitle{%
    \ydocpdfsettings
    \orig@maketitle
    \let\orig@maketitle\relax
}
\endinput
%%
%% End of file `ydoc-doc.sty'.