summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/curve2e/README.txt
blob: 94b76a5f6860db30352e15dc4eaf4b5a20e702f6 (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
%%
%% This is file `README.txt',
%%
%%   Copyright (C)  2005--2020 Claudio Beccari  all rights reserved.
%%   License information appended
%% 
File README.txt for package curve2e
        [2020-12-20 v.2.2.13 Extension package for pict2e]
The package bundle curve2e is composed of the following files

curve2e.dtx
curve2e-manual.tex
README.txt

The derived files are

curve2e.sty
curve2e-v161.sty
curve2e.pdf
curve2e-manual.pdf

Compile curve2e.dtx and curve2e-manual.tex two or three times until
all labels and citation keys are completely resolved.

Move curve2e.dtx and curve2e-manual.tex to ROOT/source/latex/curve2e/
Move curve2e.pdf and curve2e-manual.pdf to ROOT/doc/latex/curve2e/
Move curve2e.sty and curve2e-v161.sty   to ROOT/tex/latex/curve2e/
Move README.txt                         to ROOT/doc/latex/curve2e/

curve2e.dtx is the documented TeX source file of the derived files
curve2e.sty, and curve2e-v161.sty.

You get curve2e.sty, curve2e.pdf, and curve2e-v161.sty by running 
pdflatex on curve2e.dtx.

The curve2e-manual file contains the user manual; in this way the long 
preliminary descriptive part has been transferred to a shorter dedicated 
file, and the “normal” user should have enough information to use the 
package. The curve2e.pdf file, extracted from the .dtx one, contains the 
code documentation and is intended for the developers, or for the curious 
advanced users. For what concerns curve2e-v161.sty, it is a previous 
roll back version of this package; see below why the older version might 
become necessary to the end user.

README.txt, this file, contains general information.

Curve2e.sty is an extension of the package pict2e.sty which initially 
extended the standard picture LaTeX environment according to what Leslie 
Lamport specified in the second edition of his LaTeX manual (1994); in 
time pict2e.sty  evolved to contain further enhancements to what Leslie 
Lamport announced in 1994.

This further extension curve2e.sty to pict2e.sty allows to draw lines
and vectors with any non integer slope parameters, to draw dashed and 
dotted lines of any slope, to draw arcs and curved vectors, to draw 
curves where just the interpolating nodes are specified together with 
the slopes at such nodes; closed paths of any shape can be filled with 
color; all coordinates are treated as ordered pairs, i.e. 'complex 
numbers'; coordinates may be expressed also in polar form. Coordinates 
may be specified with macros, so that editing any drawing is rendered 
much simpler: any point specified with a macro is modified only once in
its macro definition.
Some of these features have been incorporated in the 2009 version of
pict2e; therefore this package avoids any modification to the original
pict2e commands. In any case the version of curve2e is compatible with
later versions of pict2e; see below.

Curve2e now accepts polar coordinates in addition to the usual cartesian
ones; several macros have been upgraded; a new macro for tracing cubic
Bezier splines with their control nodes specified in polar form is
available. The same applies to quadratic Bezier splines. The \multiput
command has been completely modified in a backwards compatible way; the
new version allows to manipulate the increment components in a 
configurable way. A new xmultiput command has been defined that is more 
configurable than the original one; both commands multiput and xmultiput 
are backwards compatible with the original picture environment definition.

Curve2e solves a conflict with package eso-pic.

This version of curve2e is almost fully compatible with pict2e dated
2014/01/12 version 0.2z and later; as of today the last pct2e revision 
is version 0.4b dated 2020, and curve2e has been tested also with this 
revision confirming that it performs as expected.

If you specify:

\usepackage[<pict2e options>]{curve2e}

the package pict2e is automatically invoked with the specified options.

The -almost fully compatible- phrase is necessary to explain that this
version of curve2e uses some `functions' of the LaTeX3 language that were
made available to the LaTeX developers by mid October 2018. Should the 
user have an older or a basic/incomplete installation of the TeX system,
such L3 functions might not be available. This is why this
package checks the presence of the developer interface; in case
such interface is not available it rolls back to the previous version
renamed curve2e-v161.sty, which is part of this bundle; this roll-back
file name must not be modified in any way. The compatibility mentioned
above implies that the user macros remain the same, but their
implementation requires the L3 interface. Some macros and environments
rely totally on the xfp package functionalities, but legacy documents
source files should compile correctly.

The package has the LPPL status of maintained.

According to the LPPL licence, you are entitled to modify this package,
as long as you fulfil the few conditions set forth by the Licence.

Nevertheless this package is an extension to the standard LaTeX pict2e 
(2014 and 2020) package. Therefore any change must be controlled on the
parent package pict2e, so as to avoid redefining or interfering with
what is already contained in that package.

If you prefer sending me your modifications, as long as I will maintain
this package, I will possibly include every (documented) suggestion or
modification into this package and, of course, I will acknowledge your
contribution.

Claudio Beccari

claudio dot beccari at gmail dot com

%% 
%% Distributable under the LaTeX Project Public License,
%% version 1.3c or higher (your choice). The latest version of
%% this license is at: http://www.latex-project.org/lppl.txt
%% 
%% This work is "maintained"
%% 
%% This work consists of files curve2e.dtx and curve2e-manual.tex,
%% and the derived files curve2e.sty and curve2e.pdf, curve2e-manual.pdf,
%% plus the auxiliary  files README.txt and curve2e-v161.sty.
%% 
%%
%% End of file `README.txt'.