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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
|
%\iffalse
% makedtx.dtx generated using makedtx version 0.9b (c) Nicola Talbot
% Command line args:
% -dir "source"
% -v "1"
% -src "creatdtx.(.*)=>creatdtx.\1"
% -src "makedtx=>makedtx.pl"
% -author "Nicola Talbot"
% -macrocode ".*\.p.*l"
% -setambles ".*\.p.*l=>\nopreamble\nopostamble"
% -doc "source/manual.tex"
% makedtx
% Created on 2005/2/13 21:58
%\fi
%\iffalse
%<*package>
%% \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 \~}
%</package>
%\fi
% \iffalse
% Doc-Source file to use with LaTeX2e
% Copyright (C) 2005 Nicola Talbot, all rights reserved.
% \fi
% \iffalse
%<*driver>
\documentclass[a4paper]{ltxdoc}
\usepackage[colorlinks,
bookmarks,
bookmarksopen,
pdfauthor={Nicola Talbot},
pdftitle={makedtx : a Perl script to help create a DTX file from source code}]{hyperref}
\OnlyDescription\newcommand{\switch}[1]{\textsf{-#1}}
\newcommand{\latextohtml}{\LaTeX2HTML}
\newcommand{\cmdname}[1]{\texttt{\symbol{92}#1}}
\begin{document}
\DocInput{makedtx.dtx}
\end{document}
%</driver>
%\fi
%
%
%\title{makedtx : a Perl script to help create a DTX file from source code}
%\author{Nicola Talbot}
%\date{11th February 2005}
%\maketitle
%
%\tableofcontents
%
%\begin{abstract}
%The \texttt{makedtx} bundle is provided to help developers to write the code and
%documentation in separate files, and then combine them into a single DTX
%file for distribution. It automatically generates the character table, and also
%writes the associated installation (.ins) script.
%\end{abstract}
%
%\section{Introduction}
%
%\changes{0.9}{2005/02/11}{Initial beta release}%
%Authors of \LaTeXe\ class files or packages are encouraged to bundle their
%source and documentation together into a single DTX file. This makes
%distribution much easier, as users need only download the DTX file
%and possibly a corresponding installation script (INS file) instead of
%a multitude of \texttt{.sty}, \texttt{.cls}, \texttt{.def} etc files.
%However, having the documentation and code bundled together can cause
%problems if a developer wants to, say, use \texttt{ispell} to spell check
%the documentation, or convert the documentation to a format other than DVI,
%PostScript or PDF (such as HTML).
%
%Why should I want to convert my documentation to HTML when I can just use PDF\LaTeX?
%The more general purpose packages that I write (such as \texttt{datetime} and \texttt{glossary})
%I upload to CTAN, however most of the packages I write are specific to the School
%of Computing Sciences at the University of East Anglia, so these I keep on my web site,
%and as some of the faculty either don't have a PDF plug in or prefer to view HTML rather
%the PDF documents, I have taken to writing both PDF and HTML versions of my package documentation.
%However, \latextohtml\ doesn't work on a \texttt{.dtx} file so I used to convert them manually
%which is fine for one or two small documents, but becomes rather cumbersome as soon as I have large
%documents or a lot of packages. Therefore I decided to write the documentation separately, and
%use a Perl script to bundle everything together. It also has the added convenience in that I don't
%have to keep copying and pasting the character table every time I write a new package, and it saves
%the laborious task of writing the installation script\footnote{or at least, it's laborious if there
%are rather a lot of files associated with a package}.
%
%This document is structured as follows: Section~\ref{sec:install} describes how to install the
%\texttt{makedtx} bundle, Section~\ref{sec:makedtx} gives an overview of the \texttt{makedtx.pl}
%Perl script, Section~\ref{sec:creatdtx} describes the \texttt{creatdtx} package, Section~\ref{sec:examples}
%illustrates the use of the \texttt{makedtx} bundle with examples and Section~\ref{sec:problems}
%gives a list of possible errors and their solutions.
%
%\section{Installation}\label{sec:install}
%
%You need to download both \texttt{makedtx.dtx} and \texttt{makedtx.ins}, and
%run the installation script through \LaTeX:\par
%\texttt{latex makedtx.ins}
%
%The following files will be created:
%\begin{description}
%\item[\texttt{makedtx.pl}] Perl script
%\item[\texttt{creatdtx.sty}] \LaTeX\ package for use with \texttt{makedtx.pl}
%\item[\texttt{creatdtx.perl}] Corresponding Perl script for use with LaTeX2HTML
%\end{description}
%
%If you are using UNIX/Linux etc you will need to make \texttt{makedtx.pl} executable using
%\texttt{chmod}:\par\vspace{6pt}\noindent\texttt{chmod a+x makedtx.pl}\par\vspace{6pt}\noindent and place it somewhere on your path. If \texttt{perl} is located somewhere other than \texttt{/usr/bin/}
%you will need to edit the first line of \texttt{makedtx.pl}. (If you don't know where \texttt{perl} is
%located, you can use the command: \texttt{which perl}.) The package \texttt{creatdtx.sty} needs to be placed somewhere
%on the \LaTeX\ path and \texttt{creatdtx.perl} should be placed in a directory searched by \latextohtml.
%(See the \latextohtml\ documentation for details.)
%
%\section{makedtx.pl}\label{sec:makedtx}
%
%The Perl script \texttt{makedtx.pl} has the following syntax:\par
%\texttt{makedtx.pl [\meta{options}] -src "\meta{expr1}=>\meta{expr2}" -doc \meta{filename} \meta{basename}}
%
%\subsection{Compulsory Arguments}
%
%The very last argument \meta{basename} is the basename of the \texttt{.dtx} and \texttt{.ins} files you want
%to create. The \switch{doc} \meta{filename} switch indicates the file containing the documentation and
%\switch{src} \verb!"!\meta{expr1}\verb+=>+\meta{expr2}\verb'"' indicates the original source file(s),
%given by \meta{expr1}, and the corresponding file name when it has been extracted from the \texttt{.dtx} file,
%given by \meta{expr2}. This switch is a little complicated, so
%it's best described using examples.
%
%Suppose you have your documentation in the file \texttt{foodoc.tex}, and the original source code is in the
%file \texttt{foosrc.sty}. You want to create the files \texttt{foo.dtx} and \texttt{foo.ins}. When you
%\LaTeX\ \texttt{foo.dtx} you want the documentation as specified in \texttt{foodoc.tex} and when
%you \LaTeX\ \texttt{foo.ins} you want the file \texttt{foo.sty} to be created, using the code specified
%in \texttt{foosrc.sty}. You will need to do:
%\begin{verbatim}
%makedtx.pl -src "foosrc\.sty=>foo.sty" -doc foodoc.tex foo
%\end{verbatim}
%
%You may have multiple invocations of the \switch{src} switch. For example, suppose you also have the
%file \texttt{barsrc.sty} which you want to be extracted from the \texttt{.dtx} file as \texttt{bar.sty},
%you can do:
%\begin{verbatim}
%makedtx.pl -src "foosrc\.sty=>foo.sty" -src "barsrc\.sty=>bar.sty" -doc foodoc.tex foo
%\end{verbatim}
%Alternatively, you can use Perl-type regular expressions:
%\begin{verbatim}
%makedtx.pl -src "(.*)src\.sty=>\1.sty" -doc foodoc.tex foo
%\end{verbatim}
%(Note the use of double quotes to prevent shell expansion.) Appendix~\ref{sec:prex} gives a brief
%overview of Perl regular expressions for the uninitiated.
%
%\subsection{Options}
%
%\begin{description}
%\item[\switch{h} or \switch{help}] Prints on-line help, and exits.
%
%\item[\switch{v}] Uses verbose mode.
%
%\item[\switch{dir} \meta{name}] Specifies directory containing source files, as specified by the \switch{src} switch.
%For example, suppose you have source files
%\texttt{foo.sty}, \texttt{bar.sty} in the subdirectory \texttt{sourcefiles}
%you can do:
%\begin{verbatim}
%makedtx.pl -dir sourcefiles -src "(.*)\.sty=>\1.sty" -doc foodoc.tex foo
%\end{verbatim}
%
%\item[\switch{op} \meta{character}] sets the Perl pattern matching operator (the default is set to \texttt{=} symbol since the
%\texttt{/} character is used as the directory divider).
%
%\item[\switch{askforoverwrite}] uses \cmdname{askforoverwritetrue} in the installation script.
%
%\item[\switch{noaskforoverwrite}] uses \cmdname{askforoverwritefalse} in the installation script (default).
%
%\item[\switch{noins}] Don't create the installation script (\texttt{.ins} file). This is useful if you want to tweak the
%file manually and you don't want your modifications overwritten.
%
%\item[\switch{preamble} \meta{text}] Set the preamble to \texttt{text}. The default preamble is:\par
%\begin{ttfamily}
%Copyright (C) \meta{date} \meta{author}, all rights reserved.
%If you modify this file, you must change its name first.
%You are NOT ALLOWED to distribute this file alone. You are NOT
%ALLOWED to take money for the distribution or use of either this
%file or a changed version, except for a nominal charge for copying
%etc.
%\end{ttfamily}
%
%where \meta{date} is the copyright date, and \meta{author} is the author's name (see below).
%
%\item[\switch{postamble} \meta{text}] Set the postamble to \texttt{text}. If this is omitted the \cmdname{postamble}
%command is omitted from the installation script.
%
%\item[\switch{author} \meta{name}] The author's name (as used in the default preamble). If omitted the user's name is used.
%
%\item[\switch{date} \meta{text}] The copyright date (as used in the default preamble). If omitted the current
%year is used.
%
%\item[\switch{stopeventually} \meta{text}] Insert \meta{text} into the argument of \cmdname{StopEventually}.
%For example: \verb+-stopeventually "\\PrintIndex"+ will result in the
%line: \cmdname{StopEventually}\verb"{\PrintIndex}".
%If \texttt{makedtx.pl} encounters a \cmdname{StopEventually} command within the document, this will be used instead.
%If there is no \cmdname{StopEventually} command in the document and the \switch{stopeventually} switch is absent
%\cmdname{StopEventually}\verb"{}" will be inserted in the DTX file.
%
%\item[\switch{setambles} \texttt{"}\meta{expr}\texttt{=\symbol{62}}\meta{text}\texttt{"}]
%Sets the pre- and postambles for files matching \meta{expr} within
%the \cmdname{file} command in the installation script. To illustrate this, let's suppose you have source files
%\texttt{foo.sty}, \texttt{bar.sty} and \texttt{foobar.pl} in the subdirectory \texttt{sourcefiles}. Since
%\texttt{foo.sty} and \texttt{bar.sty} are \LaTeX\ files, they should have pre- and postambles, but \texttt{foobar.pl}
%is a Perl file, and since the percent symbol (\%) is not a comment character in Perl, there should be no pre- and
%postambles for this file. Therefore you would need to do something like:
%\begin{verbatim}
%makedtx.pl -dir sourcefiles -src "(.*)\.sty=>\1.sty" -src "foobar.pl=>foobar.pl"
%-setambles "foobar\.pl=>\\nopreamble\\nopostamble" -doc foodoc.tex foo
%\end{verbatim}
%(Note that the line is only broken to fit it onto the page, and there should be no line break when entering
%at the command prompt.)
%
%If the argument to \switch{setambles} contains the string \verb"\\nopreamble", the character table will be
%excluded from the corresponding files. So, in the above example, when you do: \verb"latex foo.ins" the
%resulting files \texttt{foo.sty} and \texttt{bar.sty} will contain the character table, but \texttt{foobar.pl}
%won't. (If for some reason you don't want a preamble but you do want the character table included
%use \verb"\\usepreamble\\empty" instead of \verb'\\nopreamble'. Conversely, if you want a preamble but don't
%want the character table do something like \verb"\\nopreamble\\usepreamble\\defaultpreamble", although I can't think
%of a good reason for wanting either of these situations.)
%
%Note that the \verb"=>"\meta{text} part is optional. If it is omitted, \meta{text} is assumed to be empty.
%
%\item[\switch{macrocode} \texttt{"}\meta{expr}\texttt{"}] If source file matches the Perl regular expression given by \meta{expr},
%the source code is inserted into a \texttt{macrocode} environment in the DTX file.
%\end{description}
%
%\section{The creatdtx Package}
%\label{sec:creatdtx}
%
%The documentation source code, as specified using the \switch{doc} switch will typically be a standard
%\LaTeX\ document using the \texttt{ltxdoc} class file. Unlike the DTX file, there is no \cmdname{DocInput} command,
%and the lines do not begin with a percent symbol, which means that the document can be, say, passed to the
%\latextohtml\ converter, or some other application that would otherwise be confused by a DTX file. The \texttt{creatdtx}
%package can be used in this document using
%\begin{verbatim}
%\usepackage{creatdtx}
%\end{verbatim}
%although this package will be not be included in the DTX file by \texttt{makedtx.pl}.
%There is only one command defined in this package:
%\cmdname{ifmakedtx}\texttt{\{\meta{dtx text}\}\{\meta{non dtx text}\}}.
%The first argument \meta{dtx text} will be copied to the DTX file by \texttt{makedtx.pl}, but the second argument
%\meta{non dtx text} won't.
%However, if you \LaTeX\ the document, the first argument will be ignored, and the second argument will be used.
%
%For example, if your code (in \texttt{foodoc.tex}) contains the line:\par\vspace{6pt}\noindent\texttt{\cmdname{ifmakedtx}\{\}\{\cmdname{usepackage}\{html\}\}}
%\par\vspace{6pt}\noindent the \texttt{html} package will only be loaded if you \LaTeX\ \texttt{foodoc.tex}, but not when you \LaTeX\
%\texttt{foo.dtx}.
%
%The Perl script \texttt{creatdtx.perl} ignores the following commands (and any associated arguments):
%\cmdname{OnlyDescription}, \cmdname{RecordChanges}, \cmdname{MakeShortVerb}, \cmdname{DeleteShortVerb}, \cmdname{DoNotIndex},
%\cmdname{EnableCrossrefs}, \cmdname{CodelineIndex}, \cmdname{GetFileInfo},
%\cmdname{PrintChanges}, \cmdname{changes}, \cmdname{CheckSum}, \cmdname{DescribeMacro} and \cmdname{DescribeEnvironment}.
%So even if you don't use the \cmdname{ifmakedtx} command, using the \texttt{creatdtx} package will help ensure that
%extraneous text does not appear in the HTML document when using \latextohtml.
%
%\section{Examples}
%\label{sec:examples}
%
%Let's first consider a very simple example. Suppose you want to create a package that redefines \cmdname{today}
%so that the date is displayed in the form: yyyy-m-d. Let's call this package \texttt{dashdate}. The file
%\texttt{dashdate.sty} should look something like:
%\begin{verbatim}
% % First define package:
% % \begin{macrocode}
% \NeedsTeXFormat{LaTeX2e}
% \ProvidesPackage{dashdate}
% % \end{macrocode}
% % Redefine |\today| command:
% % \begin{macrocode}
% \renewcommand{\today}{\the\year-\the\month-\the\day}
% % \end{macrocode}
%\end{verbatim}
%Now let's make some (very brief) documentation. Let's call the file, say \texttt{manual.tex}\footnote{Note: if you
%want to use \latextohtml\ on this document, you will need to use, e.g., \cmdname{verb}\texttt{!\cmdname{today}!} instead of
%\texttt{\symbol{124}\cmdname{today}\symbol{124}} since it doesn't recognise \cmdname{MakeShortVerb}.}:
%\begin{verbatim}
%\documentclass{ltxdoc}
%\usepackage{creatdtx}
%
%\begin{document}
%\title{A Sample Package}
%\author{AN Other}
%\maketitle
%
%The \texttt{dashdate} package redefines |\today|
%to produce the current date in the form: yyyy-m-d.
%\end{document}
%\end{verbatim}
%Suppose you have saved \texttt{dashdate.sty} and \texttt{manual.tex} in the subdirectory \texttt{source}. You
%can now create the \texttt{.dtx} and \texttt{.ins} file using the command:
%\begin{verbatim}
%makedtx.pl -author "AN Other" -dir source -src "dashdate\.sty=>dashdate.sty"
%-doc source/manual.tex dashdate
%\end{verbatim}
%The file \texttt{dashdate.dtx} is created, and contains the following code:
%\begin{verbatim}
% %\iffalse
% % dashdate.dtx generated using makedtx.pl version 0.9b (c) Nicola Talbot
% % Command line args:
% % -dir "source"
% % -src "dashdate\.sty=>dashdate.sty"
% % -author "AN Other"
% % -doc "source/manual.tex"
% % dashdate
% % Created on 2005/2/10 22:22
% %\fi
% %\iffalse
% %<*package>
% %% \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 \~}
% %</package>
% %\fi
% % \iffalse
% % Doc-Source file to use with LaTeX2e
% % Copyright (C) 2005 AN Other, all rights reserved.
% % \fi
% % \iffalse
% %<*driver>
% \documentclass{ltxdoc}
%
% \begin{document}
% \DocInput{dashdate.dtx}
% \end{document}
% %</driver>
% %\fi
% %\title{A Sample Package}
% %\author{AN Other}
% %\maketitle
% %
% %The \texttt{dashdate} package redefines "\today"
% %to produce the current date in the form: yyyy-m-d.
% %\end{document}
% %
% %\StopEventually{}
% %\section{The Code}
% % \begin{macrocode}
% %<*dashdate.sty>
% % \end{macrocode}
% % First define package:
% % \begin{macrocode}
% \NeedsTeXFormat{LaTeX2e}
% \ProvidesPackage{dashdate}
% % \end{macrocode}
% % Redefine |\today| command:
% % \begin{macrocode}
% \renewcommand{\today}{\the\year-\the\month-\the\day}
% % \end{macrocode}
% % \begin{macrocode}
% %</dashdate.sty>
% % \end{macrocode}
% %\Finale
% \endinput
%\end{verbatim}
%The installation file \texttt{dashdate.ins} looks like:
%\begin{verbatim}
% % dashdate.ins generated using makedtx.pl version 0.9b 2005/2/10 22:22
% \input docstrip
%
% \preamble
% Copyright (C) 2005 AN Other, all rights reserved.
% If you modify this file, you must change its name first.
% You are NOT ALLOWED to distribute this file alone. You are NOT
% ALLOWED to take money for the distribution or use of either this
% file or a changed version, except for a nominal charge for copying
% etc.
% \endpreamble
%
% \askforoverwritefalse
%
% \generate{\file{dashdate.sty}{\usepreamble\defaultpreamble
% \usepostamble\defaultpostamble\from{dashdate.dtx}{dashdate.sty,package}}
% }
%
% \endbatchfile
%\end{verbatim}
%Note that the command \verb"\usepackage{creatdtx}" has not been transcribed to \texttt{dashdate.dtx}
%(although in this simple example it's not really needed).
%
%Now let's extend the example:
%suppose you want to create an analogous Perl script for use with \latextohtml.
%This will need to be called \texttt{dashdate.perl} and will look something like:
%\begin{verbatim}
%package main;
%
%sub do_cmd_today{
% local($today) = &get_date();
% $today =~ s|(\d+)/(\d+)/(\d+)|$3-$1-$2|;
% $_ = $today;
%}
%
%1;
%\end{verbatim}
%You will now need to call \texttt{makedtx.pl} as follows:
%\begin{verbatim}
%makedtx.pl -author "AN Other" -dir source -src "dashdate\.sty=>dashdate.sty"
%-src "dashdate\.perl=>dashdate.perl"
%-setambles "dashdate\.perl=>\\nopreamble\\nopostamble"
%-macrocode "dashdate\.perl" -doc source/manual.tex dashdate
%\end{verbatim}
%(Note that the line is only broken to allow it to fit onto the page, there should be no line break
%when you enter it on the command line.) Alternatively, you could save typing and do:
%\begin{verbatim}
%makedtx.pl -author "AN Other" -dir source -src "dashdate\.(.*)=>dashdate.\1"
%-setambles "dashdate\.perl=>\\nopreamble\\nopostamble" -macrocode "dashdate\.perl"
%-doc source/manual.tex dashdate
%\end{verbatim}
%Note the use of the \switch{setambles} switch which suppresses the insertion of text at the start and
%end of the Perl script which would only confuse Perl. Note also the use of the \switch{macrocode}
%switch. This is not needed for \texttt{dashdate.sty} since it has already been included in the source
%code, but since \% is not a comment character in Perl, the \texttt{macrocode} environment
%is not included in the source code, and needs to be added.
%(If you are unfamiliar with DocStrip and the use of the \texttt{macrocode} environment,
%I suggest you read either \emph{A guide to \LaTeX}~\cite[Appendix~D]{Kopka98}
%or \emph{The \LaTeX\ companion}~\cite[Chapter~14]{Goossens93})
%
%As another example, consider the \texttt{datetime} package. Version 2.42 of this package has 2 \texttt{.sty} files
%and 42 \texttt{.def} files. The documentation is written in the file \texttt{manual.tex}, and the \texttt{.sty}
%and \texttt{.def} files are saved in a subdirectory called \texttt{source}. Since these are the only files in this
%directory, they can easily be merged into one \texttt{.dtx} file using:
%\begin{verbatim}
%makedtx.pl -author "Nicola Talbot" -dir source -src "(.+)\.(.+)=>\1.\2"
%-doc manual.tex datetime
%\end{verbatim}
%This creates the files \texttt{datetime.dtx} and \texttt{datetime.ins} which can then be distributed. The PDF version
%of the documentation is obtained by doing:
%\begin{verbatim}
%pdflatex datetime.dtx
%\end{verbatim}
%and the HTML version (\texttt{manual.html}) is obtained by doing:
%\begin{verbatim}
%latex2html -split 0 -nonavigation -nofootnode -numbered_footnotes -noinfo manual
%\end{verbatim}
%Any minor differences between the HTML and PDF versions are dealt by using \cmdname{ifmakedtx} in
%the original file \texttt{manual.tex}.
%
%\section{Troubleshooting}
%\label{sec:problems}
%
%The \texttt{makedtx} bundle has only been tested under Linux using Perl v5.6.0. There are no guarantees whether
%or not it will work on other operating systems or on different versions (in fact, there are no guarantees or
%warranties at all).
%
%\subsection{Known Bugs}
%
%It's possible to confuse \texttt{makedtx.pl} by placing either the command \cmdname{end}\verb"{document}"
%or the command \cmdname{ifmakedtx} in a \cmdname{verb} command, or by having the \cmdname{ifmakedtx} command
%on the same line as \cmdname{begin}\verb"{document}". You will also need to take care about lines beginning
%with a percent symbol (\%) in the documentation, as this will get converted into a line beginning with \verb"%%"
%in the \texttt{.dtx} file, which has a special meaning. Either place a space immediately prior the percent symbol,
%or do \verb"\relax%" if you really don't want the extra space (or place your comment in an \cmdname{iffalse} \ldots\ \cmdname{fi}
%conditional).
%
%\subsection{Possible errors encountered using \texttt{makedtx.pl}}
%
%Note: be careful to use double quotes around arguments that contain characters that the shell might
%try interpreting, e.g.\ \verb"*" or \verb'>'.
%
%Syntax error messages:
%\begin{enumerate}
%\item \texttt{No document source specified (missing -doc)}
%
%You must use the \switch{doc} switch.
%
%\item \texttt{No source code specified (missing -src)}
%
%You must specify at least one \switch{src} switch.
%
%\item \texttt{No basename specified}
%
%You must specify the basename of the \texttt{.dtx} and \texttt{.ins} files. This should
%be the last argument passed to \texttt{makedtx.pl}.
%
%\item \texttt{-src \ldots\ argument invalid (no output file specified)}
%
%You have omitted the \verb"=>" separator in the argument of the \switch{src} switch.
%
%\item \texttt{-src argument \ldots\ invalid (too many => specified)}
%
%You have used too many \verb"=>" separators in the argument of the \switch{src} switch.
%(Similarly for the \switch{setambles} switch.)
%\end{enumerate}
%
%\appendix
%
%\section{Perl Regular Expressions}
%\label{sec:prex}
%
%This section gives a very brief overview of Perl regular expressions. For more detail, look at the Perl
%documentation (use \verb"man perlre" for the man page.)
%
%\begin{tabular}{ll}
%\verb'\' & Quote the next character\\
%\verb"." & Match any character\\
%\verb"|" & Alternation\\
%\verb"()" & Grouping\\
%\verb"[]" & Character class\\
%\verb"*" & Match 0 or more times\\
%\verb"+" & Match 1 or more times\\
%\verb"?" & Match 1 or 0 times\\
%\verb"{n}" & Match exactly \texttt{n} times\\
%\verb"{n,}" & Match at least \texttt{n} times\\
%\verb"{n,m}" & Match at least \texttt{n} but no more than \texttt{m} times.
%\end{tabular}
%
%In the replacement text, a backslash followed by a number \meta{n} indicates the text from the \meta{n}th group.
%
%For example, suppose you have the following files:
%\begin{verbatim}
%abcsrc.sty
%abcsrc.bst
%abcsrc.perl
%foosrc.sty
%foobarsrc.sty
%\end{verbatim}
%then if you pass the following switch to \texttt{makedtx.pl}:
%\begin{itemize}
%\item \verb'-src "abcsrc\.([styb]+)=>abc.\1"'
%will be equivalent to:
%\begin{verbatim}
%-src "abcsrc.sty=>abc.sty" -src "abcsrc.bst=>abc.bst"
%\end{verbatim}
%since \verb'[styb]+' will match one or more of the letters \texttt{styb} (so it will match \texttt{sty} and \texttt{bst}).
%\verb'\1' indicates the text found in the first group, which in this example will either be \texttt{sty} or \texttt{bst}.
%
%\item \verb'-src "abcsrc\.(.+)=>abc.\1"'
%will be equivalent to:
%\begin{verbatim}
%-src "abcsrc.sty=>abc.sty" -src "abcsrc.bst=>abc.bst" -src "abcsrc.perl=>abc.perl"
%\end{verbatim}
%Note that a full stop represents any character so \texttt{.+} means any string of length 1 or more, whereas
%\verb"\." means an actual full stop character.
%
%\item \verb'-src "foo(.*)src\.sty=>foo\1.sty"'
%will be equivalent to:
%\begin{verbatim}
%-src "foosrc.sty=>foo.sty" -src "foobarsrc.sty=>foobar.sty"
%\end{verbatim}
%
%\item \verb'-src "(.+)src\.(.+)=>\1.\2"'
%will be equivalent to
%\begin{verbatim}
%-src "abcsrc.sty=>abc.sty"
%-src "abcsrc.bst=>abc.bst"
%-src "abcsrc.perl=>abc.perl"
%-src "foosrc.sty=>foo.sty"
%-src "foobarsrc.sty=>foobar.sty"
%\end{verbatim}
%
%\end{itemize}
%
%\begin{thebibliography}{1}
%\bibitem{Goossens93} The \LaTeX\ companion. Michel~Goossens, Frank~Mittelbach and Alexander~Samarin.
%Addison-Wesley 1993.
%
%\bibitem{Kopka98} A guide to \LaTeX. Helmut~Kopka and Patrick~W.~Daly. Addison-Wesley 1998.
%\end{thebibliography}
%
%\section*{Contact Details}
%\addcontentsline{toc}{section}{Contact Details}
%
%\begin{tabular}{l}
%Dr Nicola Talbot\\
%School of Computing Sciences\\
%University of East Anglia\\
%Norwich. NR4 7TJ\\
%United Kingdom\\
%\url{http://theoval.cmp.uea.ac.uk/~nlct/}
%\end{tabular}
%
%
%
%\StopEventually{}
%\section{The Code}
% \begin{macrocode}
%<*creatdtx.perl>
% \end{macrocode}
% \begin{macrocode}
# creatdtx.perl LaTeX2HTML file corresponding to creatdtx.sty package
# author : Nicola Talbot
# date : 8th Feb 2005
package main;
print " [creatdtx v0.9b (N.L.C. Talbot)]";
sub do_cmd_meta
{
&do_cmd_emph(@_);
}
&ignore_commands( <<_IGNORED_CMDS_);
ifmakedtx # {}
StopEventually # {}
OnlyDescription
RecordChanges
PrintChanges
EnableCrossRefs
CodelineIndex
GetFileInfo # {}
CheckSum # {}
DescribeMacro # {}
DescribeEnvironment # {}
MakeShortVerb # {}
DeleteShortVerb # {}
DoNotIndex # {}
changes # {} # {} # {}
_IGNORED_CMDS_
1;
% \end{macrocode}
% \begin{macrocode}
%</creatdtx.perl>
% \end{macrocode}
% \begin{macrocode}
%<*creatdtx.sty>
% \end{macrocode}
% This is the code for the \texttt{creatdtx} package. This package should not be
% used in a .dtx file. First define the
% package:
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{creatdtx}[2005/02/11 v0.9b (N.L.C. Talbot)]
% \end{macrocode}
% Define \cmd{ifmakedtx}. The first argument will always be ignored by \LaTeX:
% \begin{macrocode}
\newcommand{\ifmakedtx}[2]{#2}
% \end{macrocode}
% Redefine |\StopEventually| so that it simply prints its argument
% \begin{macrocode}
\providecommand{\StopEventually}{}
\renewcommand{\StopEventually}[1]{#1}
% \end{macrocode}
% \begin{macrocode}
%</creatdtx.sty>
% \end{macrocode}
% \begin{macrocode}
%<*makedtx.pl>
% \end{macrocode}
% \begin{macrocode}
#!/usr/bin/perl
# File : makedtx
# Author : Dr Nicola Talbot
# Date : 29 Oct 2004
# Last Modified : 11 Feb 2005
# Version : 0.9b
# usage : makedtx [options] -src <expr>=><expr> -doc <filename> <basename>
#
# -h : help message
# -src <expr>=><expr> : e.g. -src "(foo)src\.(bar)=>$1.$2" will add foosrc.bar to <basename>.dtx to be extracted to foo.bar
# -doc <filename> : file containing documentation.
# <basename> : create <basename>.dtx and <basename>.ins
use Getopt::Long;
$version = "0.9b";
# process command line options
%optctl = ();
&GetOptions(\%optctl, "h", "help", "v", "src=s@", "doc=s", "dir=s", "op=s", "askforoverwrite!", "ins!",
"preamble=s", "postamble=s", "setambles=s@", "macrocode=s@",
"author=s", "date=s", "stopeventually=s") or syntaxerror();
$srcdir = ".";
$patternop = "=";
$verbose = 0;
$noins = 0;
$askforoverwrite = 0;
$preamble = "";
$postamble = "";
$author = ($ENV{'USER'} || "Unknown");
$stopeventually = "";
($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) = localtime(time);
$year = $year + 1900;
foreach $setting (keys %optctl)
{
if (($setting eq "h") || ($setting eq "help"))
{
help();
}
elsif ($setting eq "doc")
{
$docsrc = $optctl{$setting};
}
elsif ($setting eq "src")
{
@source = @{ $optctl{$setting} };
}
elsif ($setting eq "dir")
{
$srcdir = $optctl{$setting};
}
elsif ($setting eq "op")
{
$patternop = $optctl{$setting};
}
elsif ($setting eq "v")
{
$verbose = 1;
}
elsif ($setting eq "ins")
{
$noins = 1-$optctl{$setting};
}
elsif ($setting eq "askforoverwrite")
{
$askforoverwrite = $optctl{$setting};
}
elsif ($setting eq "preamble")
{
$preamble = $optctl{$setting};
}
elsif ($setting eq "postamble")
{
$postamble = $optctl{$setting};
}
elsif ($setting eq "setambles")
{
@setambles = @{ $optctl{$setting} };
}
elsif ($setting eq "macrocode")
{
@macrocode = @{ $optctl{$setting} };
}
elsif ($setting eq "author")
{
$author = $optctl{$setting};
}
elsif ($setting eq "date")
{
$year = $optctl{$setting};
}
elsif ($setting eq "stopeventually")
{
$stopeventually = $optctl{$setting};
}
}
if ($preamble eq "")
{
$preamble = "Copyright (C) $year $author, all rights reserved.\n";
$preamble = $preamble . "If you modify this file, you must change its name first.\n";
$preamble = $preamble . "You are NOT ALLOWED to distribute this file alone. You are NOT\n";
$preamble = $preamble . "ALLOWED to take money for the distribution or use of either this\n";
$preamble = $preamble . "file or a changed version, except for a nominal charge for copying\n";
$preamble = $preamble . "etc.";
}
if ($docsrc eq "")
{
print "No document source specified (missing -doc)\n";
syntaxerror();
}
if ($#ARGV != 0)
{
print "No basename specified\n";
syntaxerror();
}
if ($#source == -1)
{
print "No source code specified (missing -src)\n";
syntaxerror();
}
$basename = $ARGV[0];
open DTX, ">$basename.dtx" or die "Can't open '$basename.dtx'\n";
if ($verbose)
{
print "Documentation source : " . $docsrc . "\n";
}
open DOC, $docsrc or die "Can't open '$docsrc'\n";
print DTX "\%\\iffalse\n";
print DTX "\% $basename.dtx generated using $0 version $version (c) Nicola Talbot\n";
print DTX "\% Command line args:\n";
foreach $setting (keys %optctl)
{
if ($setting eq "src")
{
foreach $source (@source)
{
print DTX "\% -src \"$source\"\n";
}
}
elsif ($setting eq "setambles")
{
foreach $setamble (@setambles)
{
print DTX "\% -setambles \"$setamble\"\n";
}
}
elsif ($setting eq "macrocode")
{
foreach $macrocode (@macrocode)
{
print DTX "\% -macrocode \"$macrocode\"\n";
}
}
else
{
print DTX "\% -", $setting, " \"", $optctl{$setting}, "\"\n";
}
}
print DTX "\% $basename\n";
print DTX "\% Created on $year/", $mon+1, "/$mday $hour:", $min<10?"0$min" : $min,"\n";
print DTX "\%\\fi\n";
print DTX "\%\\iffalse\n";
print DTX "\%<*package>\n";
print DTX "\%\% \\CharacterTable\n";
print DTX "\%\% {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\n";
print DTX "\%\% 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\n";
print DTX "\%\% Digits \\0\\1\\2\\3\\4\\5\\6\\7\\8\\9\n";
print DTX "\%\% Exclamation \\! Double quote \\\" Hash (number) \\#\n";
print DTX "\%\% Dollar \\\$ Percent \\\% Ampersand \\&\n";
print DTX "\%\% Acute accent \\\' Left paren \\( Right paren \\)\n";
print DTX "\%\% Asterisk \\* Plus \\+ Comma \\,\n";
print DTX "\%\% Minus \\- Point \\. Solidus \\/\n";
print DTX "\%\% Colon \\: Semicolon \\; Less than \\<\n";
print DTX "\%\% Equals \\= Greater than \\> Question mark \\?\n";
print DTX "\%\% Commercial at \\\@ Left bracket \\[ Backslash \\\\\n";
print DTX "\%\% Right bracket \\] Circumflex \\^ Underscore \\_\n";
print DTX "\%\% Grave accent \\\` Left brace \\{ Vertical bar \\|\n";
print DTX "\%\% Right brace \\} Tilde \\~}\n";
print DTX "\%</package>\n";
print DTX "\%\\fi\n";
print DTX "\% \\iffalse\n";
print DTX "\% Doc-Source file to use with LaTeX2e\n";
print DTX "\% Copyright (C) $year $author, all rights reserved.\n";
print DTX "\% \\fi\n";
# driver
print DTX "\% \\iffalse\n";
print DTX "\%<*driver>\n";
$indoc=0;
while (<DOC>)
{
s/\\usepackage{creatdtx}//;
$restofline = $_;
$beginline = "";
$line = $restofline;
while ($restofline =~ /(.*)\\ifmakedtx(.*)/)
{
$beginline = $1;
($group,$restofline,$done) = getnextgroup($2);
$startline = $.;
while (!$done)
{
if ($nextline = <DOC>)
{
$line = $line . $nextline;
$restofline = $restofline . $nextline;
($group,$restofline,$done) = getnextgroup($restofline);
}
else
{
die "EOF found whilst scanning first argument to \\ifmakedtx on line $startline\n";
}
}
# print first arg, ignore second
$beginline = $beginline . $group;
($group,$restofline,$done) = getnextgroup($restofline);
while (!$done)
{
if ($nextline = <DOC>)
{
$line = $line . $nextline;
$restofline = $restofline . $nextline;
($group,$restofline,$done) = getnextgroup($restofline);
}
else
{
die "EOF found whilst scanning second argument to \\ifmakedtx on line $startline\n";
}
}
$line = $restofline;
}
$line = $beginline . $restofline;
print DTX $line;
if ($line=~/\\begin{document}/)
{
$indoc = 1;
last;
}
}
print DTX "\\DocInput{$basename.dtx}\n";
print DTX "\\end{document}\n";
print DTX "\%</driver>\n";
print DTX "\%\\fi\n";
$inverb=0;
$stopfound=0;
print DTX "\%";
while (<DOC>)
{
if (/\\begin{verbatim}/)
{
$inverb=1;
}
if (/\\end{verbatim}/)
{
$inverb=0;
}
if (/\\StopEventually/ && ($inverb==0))
{
$stopfound=1;
}
$restofline = $_;
$beginline = "";
$line = $restofline;
while ($restofline =~ /(.*)\\ifmakedtx(.*)/)
{
$beginline = $1;
($group,$restofline,$done) = getnextgroup($2);
$startline = $.;
while (!$done)
{
if ($nextline = <DOC>)
{
$line = $line . $nextline;
$restofline = $restofline . $nextline;
($group,$restofline,$done) = getnextgroup($restofline);
}
else
{
die "EOF found whilst scanning first argument to \\ifmakedtx on line $startline\n";
}
}
# print first arg, ignore second
$beginline = $beginline . $group;
($group,$restofline,$done) = getnextgroup($restofline);
while (!$done)
{
if ($nextline = <DOC>)
{
$line = $line . $nextline;
$restofline = $restofline . $nextline;
($group,$restofline,$done) = getnextgroup($restofline);
}
else
{
die "EOF found whilst scanning second argument to \\ifmakedtx on line $startline\n";
}
}
$line = $restofline;
}
$line = $beginline . $restofline;
if (($line=~/\\end{document}/) and not $inverb)
{
$indoc=0;
$line=~s/\\end{document}//;
}
$line=~s/\n/\n\%/mg;
print DTX "$line";
}
close DOC;
print DTX "\n";
if ($stopfound==0)
{
print DTX "\%\\StopEventually{$stopeventually}\n";
}
print DTX "\%\\section{The Code}\n";
@srcdirfile = glob("$srcdir/*");
%file = ();
foreach $source (@source)
{
($infile, $outfile, $remainder) = split /=>/, $source;
if ($outfile eq "")
{
print "-src $source argument invalid (no output file specified)\n";
syntaxerror();
}
if (not ($remainder eq ""))
{
print "-src $source argument invalid (too many => specified)\n";
syntaxerror();
}
foreach $srcdirfile (@srcdirfile)
{
$fileexp = $srcdir . "/" . $infile;
$_ = $srcdirfile;
$expr = "s$patternop$fileexp$patternop$outfile$patternop";
if (eval($expr))
{
if ($verbose)
{
print "$srcdirfile -> $_ \n";
}
$thisoutfile = $_;
$thisinfile = $srcdirfile;
open SRC, $thisinfile or die "Can't open $thisinfile\n";
print DTX "\% \\begin{macrocode}\n";
print DTX "\%<*$thisoutfile>\n";
print DTX "\% \\end{macrocode}\n";
$macrocode = 0;
foreach $expr (@macrocode)
{
if ($thisoutfile =~ m/$expr/)
{
print DTX "\% \\begin{macrocode}\n";
$macrocode = 1;
}
}
while (<SRC>)
{
print DTX "$_";
}
if ($macrocode == 1)
{
print DTX "\% \\end{macrocode}\n";
}
print DTX "\% \\begin{macrocode}\n";
print DTX "\%</$thisoutfile>\n";
print DTX "\% \\end{macrocode}\n";
close SRC;
$file{$thisinfile} = $thisoutfile;
}
}
}
print DTX "\%\\Finale\n";
print DTX "\\endinput\n";
close DTX;
if (!$noins)
{
open INS, ">$basename.ins" or die "Can't open '$basename.ins'\n";
print INS "\% $basename.ins generated using $0 version $version $year/",$mon+1,"/$mday $hour:", $min<10?"0$min":$min,"\n";
print INS "\\input docstrip\n\n";
print INS "\\preamble\n";
print INS "$preamble\n";
print INS "\\endpreamble\n\n";
if ($postamble ne "")
{
print INS "\\postamble\n";
print INS "$postamble\n";
print INS "\\endpostamble\n\n";
}
if ($askforoverwrite)
{
print INS "\\askforoverwritetrue\n\n";
}
else
{
print INS "\\askforoverwritefalse\n\n";
}
print INS "\\generate{";
foreach $file (keys %file)
{
$outfile = $file{$file};
print INS "\\file{$outfile}{";
$ambleset = 0;
$noamble = 0;
foreach $setamble (@setambles)
{
($fileexp, $amble, $remainder) = split /=>/, $setamble;
if (not ($remainder eq ""))
{
die "-setambles $setamble argument invalid (too many => specified)\n";
}
if ($outfile =~ m/$fileexp/)
{
if ($verbose)
{
print "$fileexp matches $outfile -> setting \"$amble\"\n";
}
print INS $amble;
$ambleset = 1;
if ($amble =~ m/\\nopreamble/)
{
$noamble = 1;
}
}
}
if (!$ambleset)
{
print INS "\\usepreamble\\defaultpreamble\n\\usepostamble\\defaultpostamble";
}
print INS "\\from{$basename.dtx}{$outfile";
if ($noamble == 0)
{
# this will add the character table to all files except those that use \nopreamble
print INS ",package";
}
print INS "}}\n";
}
print INS "}\n\n";
print INS "\\endbatchfile\n";
close INS;
}
sub syntaxerror
{
die "Syntax : $0 [options] <basename>\nUse -h for help\n";
}
sub help
{
print "$0 Help\n\n";
print "Current Version : $version\n\n";
print "usage : $0 [options] -src \"<expr>=><expr>\" -doc <filename> <basename>\n\n";
print "$0 can be used to construct a LaTeX2e dtx and ins file from\n";
print "the specified source code. The final command line argument\n";
print "<basename> should be used to specify the basename of the dtx\n";
print "and ins files.\n\n";
print "-src \"<expr1>=><expr2>\"\n";
print "The command line switch -src identifies the original source code and the name\n";
print "of the file to which it will utimately be extracted on latexing the ins file\n";
print "<expr1> can be a Perl expression, such as (foo)src.(sty), and <expr2> can\n";
print "a Perl substitution style expression, such as $1.$2\n";
print "Note that double quotes must be used to prevent shell expansion\n";
print "Multiple invocations of -src are permitted\n";
print "See examples below.\n\n";
print "-doc <filename>\n";
print "The name of the documentation source code. This should be a LaTeX2e document\n\n";
print "Optional Arguments:\n\n";
print "-dir <directory> : search for source files in <directory>\n";
print "-op <character> : set the pattern matching operator (default '$patternop')\n";
print "-askforoverwrite : set askforoverwrite switch in INS file to true\n";
print "-noaskforoverwrite : set askforoverwrite switch in INS file to false (default)\n";
print "-preamble <text> : set the preamble. Standard one inserted if omitted\n";
print "-postamble <text> : set the postamble.\n";
print "-setambles \"<pattern>=><text>\" : set pre- and postambles to <text> if file matches pattern\n";
print "-author <text> : name of author (inserted into standard preamble. User name inserted if omitted)\n";
print "-date <text> : copyright date\n";
print "-ins : create the ins file (default)\n";
print "-noins : don't create the ins file\n";
print "-h : help message\n";
print "-v : verbose\n\n";
print "Examples:\n\n";
print "Example 1:\n";
print "Documenation is in foodoc.tex\n";
print "Source code is in foosrc.sty. The final extracted version should be \n";
print "called foo.sty. The dtx file should be called foo.dtx and the ins file\n";
print " should be called foo.ins\n\n";
print "$0 -src \"foosrc\\.sty=>foo.sty\" -doc foodoc.tex foo\n\n";
print "Example 2:\n";
print "Documenation is in bardoc.tex\n";
print "Source code is in barsrc.sty. The final extracted version should be\n";
print "called bar.sty. Source code is also in barsrc.bst. The final extracted\n";
print "version should be called bar.bst. The dtx file should be called bar.dtx and\n";
print "the ins file should be called bar.ins\n\n";
print "$0 -src \"barsrc\\.sty=>bar.sty\" -src \"barsrc\\.bst=>bar.bst\" -doc bardoc.tex bar\n\n";
print "Or\n\n";
print "$0 -src \"barsrc\\.(bst|sty)=>bar.\$1\" -doc bardoc.tex bar\n\n";
die;
}
sub eatinitialspaces
{
my ($STR) = @_;
while (substr($STR,0,1) eq "\s")
{
$STR = substr($STR,1);
}
return $STR;
}
sub getnextgroup
{
my($curline) = @_;
$curline = eatinitialspaces($curline);
# check to see if current string is blank
if ($curline!~/[^\s]+/m)
{
return ("","",0);
}
if (($group = substr($curline,0,1)) ne "{")
{
# next group hasn't been delimited with braces
# return first non-whitespace character
$curline = substr($curline,1);
# unless it's a backslash, in which case get command name
if ($group eq "\\")
{
if ($curline=~/([a-zA-Z]+)(^[a-zA-Z].*)/m)
{
$group = $1;
$curline = $2;
}
else
{
# command is made up of backslash followed by symbol
$curline=~/([\W_0-9\s\\])(.*)/m;
$group = $1;
$curline = $2;
}
}
return ($group,$curline,1);
}
my $pos=index($curline, "{");
my $startpos=$pos;
my $posopen=0;
my $posclose=0;
my $bracelevel = 1;
my $done=0;
while (!$done)
{
$pos++;
$posopen = index($curline, "{", $pos);
# check to make sure it's not a \{
while ((substr($curline, $posopen-1,1) eq "\\") and ($posopen > 0))
{
# count how many backlashes come before it.
$i = $posopen-1;
$numbs = 1;
while ((substr($curline, $i-1,1) eq "\\") and ($i > 0))
{
$numbs++;
$i--;
}
# is $numbs is odd, we have a \{, otherwise we have \\{
if ($numbs%2 == 0)
{
last;
}
else
{
$posopen = index($curline, "{", $posopen+1);
}
}
$posclose= index($curline, "}", $pos);
# check to make sure it's not a \}
while ((substr($curline, $posclose-1,1) eq "\\") and ($posclose > 0))
{
# count how many backlashes come before it.
$i = $posclose-1;
$numbs = 1;
while ((substr($curline, $i-1,1) eq "\\") and ($i > 0))
{
$numbs++;
$i--;
}
# is $numbs is odd, we have a \}, otherwise we have \\}
if ($numbs%2 == 0)
{
last;
}
else
{
$posclose = index($curline, "}", $posclose+1);
}
}
if (($posopen==-1) and ($posclose==-1))
{
$done=1;
}
elsif ($posopen==-1)
{
$pos=$posclose;
$bracelevel--;
if ($bracelevel==0)
{
$group = substr($curline, $startpos+1, $pos-$startpos-1);
$curline = substr($curline, $pos+1);
return ($group,$curline,1);
}
}
elsif ($posclose==-1)
{
$pos=$posopen;
$bracelevel++;
}
elsif ($posopen<$posclose)
{
$pos=$posopen;
$bracelevel++;
}
elsif ($posclose<$posopen)
{
$pos=$posclose;
$bracelevel--;
if ($bracelevel==0)
{
$group = substr($curline, $startpos+1, $pos-$startpos-1);
$curline = substr($curline, $pos+1);
return ($group,$curline,1);
}
}
}
# closing brace must be on another line
return ("", $curline, 0);
}
1;
% \end{macrocode}
% \begin{macrocode}
%</makedtx.pl>
% \end{macrocode}
%\Finale
\endinput
|