summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/ednotes/README4U.txt
blob: 93d3552a42a14209881bea57c4ddeace0c47c356 (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
README4U: 

******************************************************************
***                                                            ***
***           Changes from ednotes.sty v0.64 to v1.0           *** 
***                                                            ***
***                  (Uwe Lueck, 2004/10/21)                   *** 
***                                                            ***
******************************************************************



* SUMMARY: *

  Since August 2004, the number of bundle files has been reduced. 
  Many of the remaining files have changed, some essentially, 
  others with respect to usage instructions. We explain how to 
  update your Ednotes installation accordingly. Optional 
  "patches", enhancements etc. that earlier had to be called by 
  loading separate files explicitly (mandatory arguments of 
  \usepackage) are now called by ednotes.sty package options 
  (optional arguments in \usepackage[<opt>]{ednotes}). New PDF 
  documentations/instructions have appeared. 


* Contents of this file: * 

  LN/MF_edn.zip -- ednotes/lineno/manyfoot/further changes -- 
  updating procedure -- new documentations 


* Some files you may have received: * 

  You may have received (by e-mail from us, e.g.) a distribution 
  containing files 

    LN_edn.zip 
    MF_edn.zip 

  They serve two purposes: 

  1. They contain the files README and CHANGES that reside in the 
     CTAN directories `[...]/lineno' and `[...]/ncctools' (from 
     which manyfoot.sty stems). In order to avoid that README and 
     CHANGES files overwrite each other, unzip them into separate 
     directories, and into another one than the README file (for 
     ednotes.sty) that you should have received as a plain text 
     file. 

  2. LEGAL, IMPORTANT: 

     The files README, manyfoot.dtx, and nccfoots.dtx contained in 
     MF_edn.zip are, by their copyright holder Alexander Rozhenko, 
     demanded to ACCOMPANY any (re)DISTRIBUTION of manyfoot.sty 
     and nccfoots.sty! 


* ednotes.sty changes: * 

  1. ednotes.sty version 1.0 has new package options `edtable', 
     `longtable', `nolongtablepatch', `edmacpara', 
     `countoccurrences', and `mathnotes' for handling "patch" or 
     enhancement etc. files. None of these files should be loaded 
     through the mandatory argument of \usepackage any more. E.g., 
     instead of \usepackage{edtable}, you now type 

       \usepackage[edtable,<further options>]{ednotes} .

     (So -- one advantage aimed at -- you must no longer worry 
     about the correct order of loading extension packages.)

  2. The above-mentioned option `nolongtablepatch' changes earlier 
     behaviour with respect to our longtable.sty patch file 
     ltabptch.sty, in avoiding an error message that otherwise 
     appears when ltabptch.sty is not present. This is convenient 
     when you deliberately want to avoid the patch. The error 
     message ensures that vertical spacing around a "longtable" 
     does not depend on the local TeX installation -- e.g., when 
     you send your source to a journal. 

  3. ednotes.sty has a new option `perpage' for making use of the 
     manyfoot.sty option `perpage' -- just see the Manyfoot 
     documentation for what it does. It requires perpage.sty, 
     which is available from [CTAN]/macros/latex/contrib/misc. 
 

* lineno.sty changes: * 

  1. The new version 4.1 of lineno.sty makes former extension 
     files linenox0.sty, linenox1.sty, and lnopatch.sty obsolete. 
     Don't load them any more! (We have installed a reminder for 
     the case that you don't obey this rule.)

  2. \firstlinenumber has slightly changed from its earlier 
     behaviour given by lnopatch.sty. See lineno.sty/tex/pdf. 


* manyfoot.sty changes: * 

  The new version 1.7 of manyfoot.sty provides a command 
  \ExtraParaSkip to replace our earlier \MFparaxbuffer. 
  (See the new ednotes.sty documentation to recall 
  \MFparaxbuffer -- search for `\ExtraParaSkip', e.g.) 
  This makes former extension file mfparxsp.sty obsolete. 
  Please replace \MFparaxbuffer by \ExtraParaSkip and don't 
  load mfparxsp.sty any more! For your earlier documents that 
  contain \usepackage{mfparxsp}, we offer a new version of 
  mfparxsp.sty which just reminds you of the change and 
  ("for this time") redirects your \MFparaxbuffer to 
  \ExtraParaSkip. You may as well just delete your copy of 
  mfparxsp.sty, if you are sure, e.g., that you won't anymore 
  compile a .tex containing \MFparaxbuffer and 
  \usepackage{mfparaxbuffer}. 


* Further corresponding changes: * 

  Extension files that still are used -- now required by the new 
  ednotes.sty package options -- have been changed at least with 
  respect to explanations that they contain. 


* UPDATING: * 

  1. (Mandatory:) overwrite your copies of 

       edcntwd0.sty 
       ednmath0.sty 
       ednotes.sty 
       edtable.sty
       lineno.sty 
       manyfoot.sty 
       mfparptc.sty 

     with the new versions. 

  2. Overwrite

       mfparxsp.sty 

     by our new "reminder" version, or just remove it from TeX's 
     searching scope -- as you like, recall `manyfoot.sty changes' 
     avove. 

  3. You may remove (from TeX's searching scope) linenox0.sty, 
     linenox1.sty, lnopatch.sty -- but they won't harm otherwise; 
     you will get an error message if you load one of them 
     inadvertently. 


* New documentation/instructions: * 
 
  1. An article on ednotes.sty is appearing in TUGboat vol. 24. 
     It describes the main commands and functions of Ednotes. 
     Moreover, it compares Ednotes to EDMAC and LEDMAC, two other 
     TeX macro packages for critical edition typesetting. 
     We provide a version of the article very near to the final 
     one as 

       tb77lueck.pdf . 

     (it is definitively not the final version.)

  2. The README for ednotes.sty has been rewritten very much and 
     may yield new insights. Detailed explanations addressing 
     non-TeXperts have been added. 

  3. lineno.tex has been updated according to the changes of 
     lineno.sty, of course. A pdflatex outcome 

       lineno.pdf 
 
     is available ([CTAN]/macros/latex/contrib/lineno/lineno.pdf). 
 
     A pdflatex outcome 
 
       ulineno.pdf 
 
     of the user's guide ulineno.tex is available as well. 
     It only deals with lineno.sty version 3.1, but will though 
     be helpful (I think). 
 
     Recall that lineno.sty offers many commands to control the 
     style of the marginal line numbers, so its documentation is 
     an essential contribution to ednotes.sty documentation. 

  4. Version 1.7 of manyfoot.sty is generated from the 
     corresponding version of 

       manyfoot.dtx 

     which is the TeX source for the documentation of 
     manyfoot.sty. Recently, the pdflatex output 

       manyfoot.pdf 

     has been added to CTAN directory ncctools. These two files 
     may be less essential for ednotes.sty users than 
     (u)lineno.tex/pdf. However, manyfoot.sty offers features 
     that you may find interesting: (i) customize rules between 
     footnote layers; (ii) \SplitNote (for paragraphed footnotes 
     at page breaks). (For nccfoots.sty, which manyfoot.sty 
     requires, there are nccfoots.dtx/pdf as well.)
 

Good Luck! 


[End of README4U]