summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/endfloat/README
blob: 395f19957f92f60120167db3358355cda521cc5e (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
This is the readme file for the endfloat package v2.7

This readme was modified on October 2, 1997 but without
updated endfloat itself, instead to fix errors in this file
and in endfloat.ins

It was again modified on March 31, 2006, by Frank K\"uster
<frank@kuesterei.ch> to indicate the license clarification (see below).

It was again modified on December 4, 2011, by Axel Sommerfeldt
<axel.sommerfeldt@f-m.fm> to reflect the changes introduced
with version 2.5 of the endfloat package.

It was again modified on March 24, 2018, by Axel Sommerfeldt
<axel.sommerfeldt@f-m.fm> to reflect the changes introduced
with version 2.6 of the endfloat package.

It was again modified on April 15, 2019, by Axel Sommerfeldt
<axel.sommerfeldt@f-m.fm> to reflect the changes introduced
with version 2.7 of the endfloat package.

Endfloat is a LaTeX package.  Versions 2.1 and above require
LaTeX2e.

Accompanying files should be:

	README				This file
	endfloat.dtx			Docstrip archive  (essential)
	endfloat.ins			(La)TeX batch file (if you
					    don't know what it is
					    then you DO need it)

===============================================================================
Overview:
  the package places figures and tables at the end of the document,
  as often requested by journals for non-camera ready submission.

===============================================================================
Installation:

Run

  latex endfloat.ins

This will produce three files, endfloat.sty, endfloat.drv and efxmpl.cfg .
You can run LaTeX on endfloat.drv for the documentation.
  
You should copy the file endfloat.sty to where you keep
your (La)TeX inputs.  You should read the documentation to find out
more about the example configuration file, efxmpl.cfg.

To produce the documentation, run LaTeX on endfloat.drv (or endfloat.dtx)
a couple of times, and then use the makeindex program (which might be
called makeindx on your system) to generate the index

 makeindex -g -s gind.ist endfloat

Then run LaTeX (at least) two more times to get the index in the table
of contents.

===============================================================================
Major changes in version 2.7 since 2.6:
  New package option 'disable' has been added.
  New command \addtodelayedfloat has beed added.
  New macros \efloatbegin, \efloatend, \efloatbeginlist,
  and \efloatendlist for customization have been added.
  The bugfix regarding the usage of UTF-8 characters in floating environments
  has been revised.

Major changes in version 2.6 since 2.5:
  New package options 'notables' and 'nofigures' have been added.
  New macros \efloattype, \efloatheading, \efloatpreamble, and \efloatpostamble
  have been added.
  A percent sign (%) is now allowed at the end of \end{<environment>}, too.
  Two bugs have been fixed regarding the usage of UTF-8 characters in floating
  environments.

Major changes in version 2.5 since 2.4:
  New commands \DeclareDelayedFloat, \DeclareDelayedFloatFlavor,
  and \SetupDelayedFloat added.
  New package options `tablesonly' and `figuresonly' added.

Major changes in version 2.4 since 2.3:
  Configuration file (with example of getting sidewaystable to work),
  Many new hooks for more user control.  Internal changes.

Major changes in version 2.3 and 2.2 since 2.1:
  Documentation and many internal changes.
  Added options for suppressing "Tables" and "Figures" section heads, for
  switching order of tables and figures.  Use of package options
  generally.

===============================================================================
Maintainer: -none-
Original authors: James Darrell McCauley, Jeff Goldberg (jeffrey@goldmark.org),
                  and Axel Sommerfeldt <axel.sommerfeldt@f-m.fm>

Obtaining endfloat:  The necessary files are kept on the Comprehensive
TeX Archive Network (CTAN): http://mirror.ctan.org/macros/latex/contrib/endfloat

Code repository: https://gitlab.com/axelsommerfeldt/endfloat
Bug tracker: https://gitlab.com/axelsommerfeldt/endfloat/issues

===============================================================================
License and copying:
    endfloat for LaTeX
    Copyright (C) 1992 Darrel McCauley
    Copyright (C) 1994-2011 Jeffrey Goldberg <jeffrey@goldmark.org>
    Copyright (C) 2011-2019 Axel Sommerfeldt <axel.sommerfeldt@f-m.fm>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA

This distribution currently comprises the following files:

README
COPYING
endfloat.dtx
endfloat.ins
endfloat.pdf

The license has been clarified by Jeffrey Goldberg in March 06

===============================================================================
No Warranty:
There is no warranty.  If it doesn't work right, none of the authors
may be held liable for any direct or indirect damage.  There are
some known bugs (see the documentation), there may very well be
some unknown bugs.

===============================================================================