summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/cdpbundl/00readme.txt
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-02-11 00:11:40 +0000
committerKarl Berry <karl@freefriends.org>2015-02-11 00:11:40 +0000
commit13e3251ec8da9abe378dd662a288d2261ae9b8c0 (patch)
treeb89235b38a35350bc55dd9fff1d8b0107a7cb08c /Master/texmf-dist/doc/latex/cdpbundl/00readme.txt
parent06035cd2a957fc5063b466c181f360a743fc9d0a (diff)
cdpbundl (9feb15)
git-svn-id: svn://tug.org/texlive/trunk@36255 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/cdpbundl/00readme.txt')
-rw-r--r--Master/texmf-dist/doc/latex/cdpbundl/00readme.txt88
1 files changed, 64 insertions, 24 deletions
diff --git a/Master/texmf-dist/doc/latex/cdpbundl/00readme.txt b/Master/texmf-dist/doc/latex/cdpbundl/00readme.txt
index a6e828117d0..3ed84fdec7f 100644
--- a/Master/texmf-dist/doc/latex/cdpbundl/00readme.txt
+++ b/Master/texmf-dist/doc/latex/cdpbundl/00readme.txt
@@ -4,7 +4,8 @@ This is file `00readme.txt'.
This file is part of a work named "C.D.P. Bundle".
-Copyright (C) 1999-2006 by Gustavo MEZZETTI <mezzetti@math.unipd.it>.
+Copyright (C) 1999-2015 by Gustavo MEZZETTI
+ <gustavo.mezzetti@istruzione.it>.
The C.D.P. Bundle may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
@@ -12,7 +13,7 @@ of this license or (at your option) any later version.
The latest version of this license is in
http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX
-version 2003/12/01 or later.
+version 2005/12/01 or later.
The C.D.P. Bundle has the LPPL maintenance status
"author-maintained".
@@ -26,7 +27,7 @@ This file, after giving a brief description of the C.D.P. Bundle,
explains how to install it and how to generate its--alas, still
incomplete!--documentation.
-January 1, 2006 (vers. 0.34)
+February 8, 2015 (vers. 0.36)
@@ -39,6 +40,7 @@ CONTENTS
- Checking the contents of the distribution
- How to install the C.D.P. Bundle
- How to generate the documentation
+- The makefile
@@ -57,7 +59,7 @@ sections and paragraphs, to include floating figures and tables, and to use
the commands "\tableofcontents", "\listoffigures", and "\listoftables" to
compile the relevant indexes. A single input file can contain several
letters, and each letter will have its own table of contents, etc.,
-independent from the other ones.
+independent of the other ones.
@@ -66,11 +68,11 @@ DRAWBACKS
The documentation included in this distribution is absolutely minimal. For
meaningful instructions on how to use the macros, the reader is referred to
-other documents available at the web site of the author's department,
+other documents available at the web site of the past author's department,
which, however, are written in Italian. Since the main purpose of these
macros is to typeset letters according to Italian conventions, this should
not be a problem. I will consider translating the documentation in English
-only if at least 5 persons ask me to.
+only if at least 5 persons ask me to. Nobody has asked yet.
@@ -107,7 +109,11 @@ under the title "MEANING OF THE TERM `Work'", but not those listed under
HOW TO INSTALL THE C.D.P. BUNDLE
================================
-To install the C.D.P. Bundle, follow these steps:
+Note that in many pre-packaged TeX distributions, like MiKTeX and TeX Live,
+the C.D.P. Bundle is already installed, and you can use it straight away.
+
+If, for some reason, you need to install the C.D.P. Bundle yourself, follow
+these steps (but also see the section titled "The makefile", below):
1) Make sure that the files `cdpbundl.dtx' and `cdpbundl.ins' are placed in
the same directory; below, we shall indicate this directory as "the current
@@ -116,14 +122,15 @@ directory".
2) Run LaTeX (or Plain TeX) once on the file `cdpbundl.ins'. This will
generate, in the current directory, the following LaTeX input files:
- adiseal.sty
articoletteracdp.cls
cdpaddon.sty
+ cdpbabel.sty
+ cdpnamesenglish.ldf
+ cdpnamesitalian.ldf
cdpshues-example.def
cdpshues.cfg
epson-stylus-740.def
hp-laserjet-4500.def
- lettcdpadi.cls
letteracdp.cls
3) Move all the files listed in 2) from the current directory to a LaTeX
@@ -138,10 +145,7 @@ the terminal at the end of the run of the file `cdpbundl.ins'.
b) The documentation of your TeX installation should tell you how to find
the LaTeX input directory/ies, and probably also how to create new LaTeX
-input directories reserved to hold your private classes and packages. If
-your TeX installation offers you the chance of defining your private LaTeX
-input directories, I recommend you exploit this possibility and place the
-generated files into such a directory.
+input directories reserved to hold your private classes and packages.
c) If you are not able to find the LaTeX input directories, or you are not
allowed to modify them and cannot create your personal LaTeX input
@@ -160,11 +164,11 @@ directory devoted to private classes and packages). In this case, note
that the TDS-compliant location for the C.D.P. Bundle, that is, the
directory inside which you should put all the files listed in 2), is
- $TEXMF/tex/latex/cdpbundl/
+ tex/latex/cdpbundl/
The documentation, on the other hand, should be stored inside
- $TEXMF/doc/latex/cdpbundl/
+ doc/latex/cdpbundl/
Of course, in order to do so you must have appropriate access priviledges
to the texmf tree of your site.
@@ -174,27 +178,29 @@ to the texmf tree of your site.
HOW TO GENERATE THE DOCUMENTATION
=================================
-A shortened form of the documentation, already typeset and packaged in PDF
-format, is given in the file `overview.pdf' that you might have found on
+A shortened form of the documentation, already typeset and packaged in PDF,
+is provided in the file `cdpbundl-doc.pdf' that you might have found on
some sites (e.g., the CTAN sites). This file, however, is not part of the
C.D.P. Bundle and distributors are not requested to include it among the
distributed files. Moreover, it does not contain any implementation notes
-(in which most users are not at all interested).
+(in which most users, though, are not at all interested).
If the distributor from whom you obtained the C.D.P. Bundle did not provide
-the file `overview.pdf', or if you want the full documentation, complete
-with all the available implementation notes (but, alas, still incomplete
-for many respects), you can generate it by following these steps:
+the file `cdpbundl-doc.pdf', or if you want the full documentation,
+complete with all the available implementation notes (but, alas, still
+unfinished for many respects), you can generate it following these steps
+(but also see the section titled "The makefile", below):
1) Run LaTeX (_not_ Plain TeX) _twice_ on the file `cdpbundl.dtx'.
This, among other things, will generate the files `cdpbundl.idx' and
`cdpbundl.glo' in the same directory as the file `cdpbundl.dtx'.
2) Run MakeIndex on the file `cdpbundl.idx' obtained in 1), using the style
-file `gind.sty', which is part of the standard LaTeX distribution.
+file `gind.ist', which is part of the standard LaTeX distribution.
3) Run MakeIndex on the file `cdpbundl.glo' obtained in 1), using the style
-file `gglo.sty', which is part of the standard LaTeX distribution.
+file `gglo.ist', which is part of the standard LaTeX distribution, and
+specifying the file `cdpbundl.gls' as the output file.
4) Run LaTeX _two_ more times on the file `cdpbundl.dtx'.
@@ -208,6 +214,7 @@ file `gglo.sty', which is part of the standard LaTeX distribution.
cdpbundl.ind
cdpbundl.lof
cdpbundl.log
+ cdpbundl.out
cdpbundl.toc
After step 4), you should get the documentation in DVI format in the file
@@ -219,8 +226,41 @@ run LaTeX three or four times, instead of two, in step 1)... :-)
Other LaTeX typesetting engines should work in the same way, perhaps
producing the output in a different format; for example, you may use
-pdflatex in place of LaTeX to obtain the documentation in PDF format.
+pdflatex in place of LaTeX to obtain the documentation in PDF.
+
+
+
+THE MAKEFILE
+============
+
+Starting with version 0.36 of the C.D.P. Bundle, a (quite trivial!)
+makefile that "knows" how to produce the documentation is offered along
+with the Bundle itself. Although it is not a required part of the
+distribution (as per LPPL), you may find that some distributors supply it
+all the same (I hope the CTAN sites will do so). With this makefile in
+the same directory as `cdpbundl.dtx', the shell command
+
+ make doc
+
+will take all the necessary actions to produce the full documentation
+(in PDF; the modifications you need to introduce into the makefile
+in order to obtain DVI output should be quite obvious, however).
+
+The same makefile can also be used to extract the various class, package,
+and ancillary (definition and configuration) files: simply issue the
+command
+
+ make code
+
+at the shell prompt; whereas
+
+ make
+
+will _both_ extract the code _and_ typeset the documentation. Type
+
+ make help
+for more information.
Have fun with the C.D.P. Bundle!