summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ednotes/READMORE.txt
blob: 340c8b216861052666aa51e28414fed4fb63cf24 (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
====================+=====+=======++=======+=====+====================

                          FIRST INSTRUCTIONS 
                                 for 
                               EDNOTES 
                          Distribution 2006
                     (this file October 5, 2006) 

                    Uwe Lueck, dir. Christian Tapp
                 http://www.contact-ednotes.sty.de.vu

====================+=====+=======++=======+=====+====================

CONTENTs of the present file: 

  Purpose -- recent (future) changes -- RIGHTS -- installing `ednotes' 
  -- learning about `ednotes' -- standalone packages -- contact us -- 
  newsletter -- glossary 

PURPOSE of the macros: 

  Here are macros for typesetting CRITICAL EDITIONS with LaTeX. 
  Packages `lineno' by Stephan I. B"ottcher, `manyfoot' by Alexander 
  I. Rozhenko, and `longtable' by David Carlisle are enhanced and 
  combined. -- For a few first informations, you may have a look at 
  http://ednotes.sty.de.vu. 

** RECENT (FUTURE) CHANGES: **

  If you have used `ednotes' earlier than September 2004, we urge you 
  to read the `CHANGES' file in the `ednotes' directory, especially 
  concerning the changes of September/October 2004. `ednotes', 
  `lineno', and `manyfoot' have been changed at one time and interact 
  differently than before. Some files have been removed, and former 
  extension packages are now automatically loaded on `ednotes' package 
  options. -- Other changes have happened more recently, most notably 
  in `manyfoot' and `nccfoots'. In general, you should find a LaTeX 
  warning on screen or in your job.log like 

    You have requested ... version ... of ... 
    but only version ... is available
 
  telling what other packages need to be updated. 
 
  `CHANGING.txt' deals with the possibility that you haven't got the 
  most recent version of `ednotes' and friends. 

RIGHTs: 

  For COPYRIGHTs as well as conditions of use (NO WARRANTY), 
  MODIFYING, and (RE)DISTRIBUTION, please see inside the files 
  mentioned in the present `README' file, as well as 
  `README-lineno.txt' and `README-ncctools.txt'. Usually, the LaTeX 
  Project Public License applies, a recent version of which can be 
  found on 
 
    http://www.latex-project.org/lppl.txt

  Any REDISTRIBUTION of `ednotes.sty' must contain the file `README'. 
 
  If you DISTRIBUTE `manyfoot.sty' and `nccfoots.sty', they must be 
  accompanied by `manyfoot.dtx', `nccfoots.dtx', and 
  `README-ncctools.txt'. 

INSTALLATION of `ednotes': 

  For enabling yourself to make use of all the options that 
  `ednotes' provides, download 

       edcntwd0.sty
       ednmath0.sty
       ednotes.sty 
       edtable.sty 
       lineno.sty 
       ltabptch.sty 
       manyfoot.sty 
       mfparptc.sty 
       perpage.sty 
       nccfoots.sty 
       vplref.sty 

  from 

       http://www.ctan.org/tex-archive/macros/latex/contrib/ednotes 

  (e.g., cf. `CTAN' in the glossary). Note that clicking on 
  "entire directory" suffices. 

  You then have to make the .sty files listed above "visible" 
  (see the glossary below) to (La)TeX when it runs your job. 

  (You may find out through reading documentations that it partially 
  depends on your intentions which .sty files actually must be there. 
  E.g., `ednotes.sty' works already when it is accompanied by 
  `lineno.sty', `manyfoot.sty', and `nccfoots.sty'.) 

USAGE of `ednotes': 

  We recommend not to load (by \usepackage) .sty files other than 
  `ednotes.sty' (except for "standalone uses" as explained below). 
  They are handled through `ednotes' package options as explained 
  in the documentation. 

  Sorry, the "user guide" and documentation for `ednotes' is, at 
  present, scattered over the listed .sty files and over the listed 
  CTAN folders. Here is just a guide through files and folders to 
  increase your knowledge step by step: 

    0. Oh, recently some of these explanations have been collected 
       in ednotes.pdf -- .txt input with .pdf output. 

    1. An overview of `ednotes' has appeared in TUGboat vol. 24. 
       no. 2; the above `ednotes' directory of CTAN contains an 
       updated .pdf version `ednotugb.pdf' of it. It demonstrates 
       through some examples what output certain commands produce. 
       It also compares `ednotes' with two other (La)TeX packages 
       for critical edition typesetting. 

    2. Next (or even first) we recommend reading the explanations at 
       the beginning of `ednotes.sty'. 

    3. You may find references to .sty files from the `ednotes' and 
       the `lineno' folder for reading about additional details of 
       usage. 

    4. `lineno.sty' provides commands and options that are very useful 
       to know for creating critical editions by `ednotes'. You can 
       read about these commands and options in `lineno.sty'. 
       Moreover, the explanations from `lineno.sty' can be printed 
       through `lineno.tex' or `lineno.pdf' obtainable from the above 
       `ednotes' directory. You find there as well an attempt at a 
       user's guide for `lineno' -- `ulineno.tex' and `ulineno.pdf'. 
       The latter is not quite up to date, but it may be helpful 
       though. -- When you use `ednotes', don't believe what the 
       `lineno' documentation tells about, e.g., 
 
         \usepackage[edtable]{lineno}

       (such statements address usage of `lineno' without `ednotes'). 
       Many package options of `ednotes.sty' are just passed to 
       `lineno.sty', so the `lineno' documentation is `ednotes' 
       documentation in this respect. 

    5. `manyfoot' is another essential module for making `ednotes' 
       work, though you may hardly need to know about it, `ednotes' 
       is a kind of user interface for `manyfoot'. However, you may 
       inform yourself about offers of `manyfoot' for certain fine 
       points of critical edition typesetting through `manyfoot.dtx' 
       or `manyfoot.pdf' -- which you find in 
 
         http://www.ctan.org/tex-archive/macros/latex/contrib/ncctools 

       (e.g., cf. `CTAN' in the glossary). There are `nccfoots.dtx' 
       and `nccfoots.pdf' as well. Indeed you may find functions of 
       `manyfoot' useful just for your commentary passages. 

    6. `perpage.sty' is mentioned here mainly to allow use of 
       `manyfoot's `perpage' option. It contains brief explanations. 

    7. `longtable', of course, is explained in `longtable.dtx' and 
       various guides for LaTeX. 

    8. We have prepared something for listing line numbers for index 
       terms. We don't take the time to integrate it here -- please 
       contact us (see below) if you are interested. 

Standalone files:

  Some of the listed .sty files which are our work may be useful 
  without using `ednotes': 

    1. Whenever you use `manyfoot', you can load `mfparptc.sty' after 
       `manyfoot.sty' just to modify the behaviour of `manyfoot' in 
       the way that is explained in `mfparptc.sty'. 

       Moreover, there is a file `mfparxsp.sty', made for the 
       possibility that some `manyfoot' user has used an earlier 
       version of `mfparxsp.sty' which has become obsolete. 

    2. For extending lineno.sty by packages from here, see 

         http://www.ctan.org/tex-archive/macros/latex/contrib/lineno 

       (e.g., cf. `CTAN' in the glossary). 
       
    3. `ltabptch.sty', a patch for `longtable', can be used whenever 
       `longtable' is used. 

    4. An additional file `lblchng1.sty' deals with page break 
       oscillations, by code as well as by explanations and 
       discussion. It can be used entirely independently from 
       any of the packages mentioned before. 

Contact us: 

   We would be happy about your suggestions and (in a way) about your 
   bug reports. Since documentation is so poor at present, please feel 
   free to ask us for help if needed. Please contact us via 
   
       http://www.contact-ednotes.sty.de.vu 
   
Newsletter: 

   E.g., you may ask us to take your e-mail address into a mailing 
   list for reporting `ednotes' changes.

Lucky typesetting! 

______________________________________________________________________

GLOSSARY: 

* `CTAN' 
    abbreviates `Comprehensive TeX Archive Network', cf., e.g., 
  
      http://www.ctan.org 
      http://tug.org/ctan.html
 
    and read about "mirrors" there. You will understand that you 
    may replace `www.ctan.org/tex-archive' by `www.dante.de/CTAN' 
    (e.g.) in the above-mentioned URL. (But dante doesn't offer 
    the "entire directory" function.)
  

* visible to (La)TeX 
 
    -- see the file `visible.txt' in the above `ednotes' directory. 

[END of READMORE.txt]_________________________________________________