annotate doc/interpreter/preface.txi @ 20628:3af34e1ef330

Preliminary inclusion of uixx objects properties in the manual (bug #46076) * doc/interpreter/genpropdoc.m: add uixx objects to the list of supported graphics objects * doc/interpreter/genpropdoc.m (get_doc): add uixx objects and their specific properties (currently empty documentation) * doc/interpreter/plot.txi("Interacting with Plots"): add a note and a reference about ui* family of functions. * doc/interpreter/plot.txi("Interacting with Plots"): for consistency, remove "uimenu" reference. All the other uixx are already in the gui section * doc/interpreter/plot.txi("graphics data structure"): add uixx objects * doc/interpreter/gui.txi("UI Elements"): add "uimenu" function reference * doc/module.mk: add rules to build uixx properties texi files. * graphics.in.h: make uixx "__object__" property (Octave internal) hidden so that it does not appear in the documentation.
author Pantxo Diribarne <pantxo.diribarne@gmail.com>
date Fri, 09 Oct 2015 16:25:27 +0200
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19630
diff changeset
1 @c Copyright (C) 1996-2015 John W. Eaton
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
8 @c your option) any later version.
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
9 @c
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
13 @c for more details.
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
14 @c
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
17 @c <http://www.gnu.org/licenses/>.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
18
12154
22c99c8cfcb6 Add Makefile rules to auto-generate AUTHORS file from contributors.texi
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
19 @ifclear AUTHORSONLY
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3928
diff changeset
20 @node Preface
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
21 @unnumbered Preface
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
22 @cindex contributors
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
23 @cindex history
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
24
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
25 Octave was originally intended to be companion software for an
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
26 undergraduate-level textbook on chemical reactor design being written by
19074
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
27 @nospell{James B. Rawlings} of the University of Wisconsin-Madison and
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
28 @nospell{John G. Ekerdt} of the University of Texas.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
29
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
30 Clearly, Octave is now much more than just another `courseware' package
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
31 with limited utility beyond the classroom. Although our initial goals
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
32 were somewhat vague, we knew that we wanted to create something that
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
33 would enable students to solve realistic problems, and that they could
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
34 use for many things other than chemical reactor design problems.
14198
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
35 We find that most students pick up the basics of Octave quickly, and are
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
36 using it confidently in just a few hours.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
37
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
38 Although it was originally intended to be used to teach reactor design,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
39 it has been used in several other undergraduate and graduate
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
40 courses in the Chemical Engineering Department at the University of
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
41 Texas, and the math department at the University of Texas has been using
14198
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
42 it for teaching differential equations and linear algebra as well.
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
43 More recently, Octave has been used as the primary computational tool
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
44 for teaching Stanford's online Machine Learning class
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
45 (@url{ml-class.org}) taught by Andrew Ng. Tens of thousands of students
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
46 participated in the course.
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
47
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
48 If you find Octave useful, please let us know. We are always interested
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
49 to find out how Octave is being used.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
50
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
51 Virtually everyone thinks that the name Octave has something to do with
14198
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
52 music, but it is actually the name of one of John W. Eaton's former
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
53 professors who wrote a famous textbook on chemical reaction engineering,
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
54 and who was also well known for his ability to do quick `back of the
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
55 envelope' calculations. We hope that this software will make it
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
56 possible for many people to do more ambitious computations just as
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
57 easily.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
58
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
59 Everyone is encouraged to share this software with others under the
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
60 terms of the GNU General Public License (@pxref{Copying}). You are
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
61 also encouraged to help make Octave more useful by writing and
9033
c7d60ac7a3e6 Documentation cleanup of preface and intro
Rik <rdrider0-list@yahoo.com>
parents: 7090
diff changeset
62 contributing additional functions for it, and by reporting any problems
c7d60ac7a3e6 Documentation cleanup of preface and intro
Rik <rdrider0-list@yahoo.com>
parents: 7090
diff changeset
63 you may have.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
64
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
65 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 16826
diff changeset
66 * Acknowledgements::
16810
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
67 * Citing Octave in Publications::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 16826
diff changeset
68 * How You Can Contribute to Octave::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 16826
diff changeset
69 * Distribution::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
70 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
71
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3928
diff changeset
72 @node Acknowledgements
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
73 @unnumberedsec Acknowledgements
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
74 @cindex acknowledgements
12154
22c99c8cfcb6 Add Makefile rules to auto-generate AUTHORS file from contributors.texi
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
75 @end ifclear
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
76
12154
22c99c8cfcb6 Add Makefile rules to auto-generate AUTHORS file from contributors.texi
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
77 Many people have contributed to Octave's development. The
9033
c7d60ac7a3e6 Documentation cleanup of preface and intro
Rik <rdrider0-list@yahoo.com>
parents: 7090
diff changeset
78 following people have helped code parts of Octave or aided in
6665
cfb849d6f314 [project @ 2007-05-28 05:45:32 by jwe]
jwe
parents: 6620
diff changeset
79 various other ways (listed alphabetically).
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
80
6535
3ef1aa12f04c [project @ 2007-04-18 16:17:25 by jwe]
jwe
parents: 6531
diff changeset
81 @include contributors.texi
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
82
12154
22c99c8cfcb6 Add Makefile rules to auto-generate AUTHORS file from contributors.texi
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
83 @ifclear AUTHORSONLY
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
84 Special thanks to the following people and organizations for
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
85 supporting the development of Octave:
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
86
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
87 @itemize @bullet
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
88 @item
7090
47c1736d7371 [project @ 2007-10-31 21:03:48 by jwe]
jwe
parents: 7031
diff changeset
89 The United States Department of Energy, through grant number
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16810
diff changeset
90 @nospell{DE-FG02-04ER25635}.
7090
47c1736d7371 [project @ 2007-10-31 21:03:48 by jwe]
jwe
parents: 7031
diff changeset
91
47c1736d7371 [project @ 2007-10-31 21:03:48 by jwe]
jwe
parents: 7031
diff changeset
92 @item
19074
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
93 @nospell{Ashok Krishnamurthy, David Hudak, Juan Carlos Chaves}, and
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
94 @nospell{Stanley C. Ahalt} of the Ohio Supercomputer Center.
7090
47c1736d7371 [project @ 2007-10-31 21:03:48 by jwe]
jwe
parents: 7031
diff changeset
95
47c1736d7371 [project @ 2007-10-31 21:03:48 by jwe]
jwe
parents: 7031
diff changeset
96 @item
3839
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
97 The National Science Foundation, through grant numbers CTS-0105360,
7090
47c1736d7371 [project @ 2007-10-31 21:03:48 by jwe]
jwe
parents: 7031
diff changeset
98 CTS-9708497, CTS-9311420, CTS-8957123, and CNS-0540147.
3839
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
99
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
100 @item
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
101 The industrial members of the Texas-Wisconsin Modeling and Control
16792
b157ba28f123 doc: Use Texinfo @url command consistently throughout documentation.
Rik <rik@octave.org>
parents: 14199
diff changeset
102 Consortium (@url{http://www.che.utexas.edu/twmcc, TWMCC}).
3839
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
103
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
104 @item
19074
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
105 The @nospell{Paul A. Elfers} Endowed Chair in Chemical Engineering at the
3839
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
106 University of Wisconsin-Madison.
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
107
db5b02fc39ea [project @ 2001-06-08 20:00:15 by jwe]
jwe
parents: 3663
diff changeset
108 @item
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
109 Digital Equipment Corporation, for an equipment grant as part of their
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
110 External Research Program.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
111
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
112 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
113 Sun Microsystems, Inc., for an Academic Equipment grant.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
114
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
115 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
116 International Business Machines, Inc., for providing equipment as part
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
117 of a grant to the University of Texas College of Engineering.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
118
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
119 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
120 Texaco Chemical Company, for providing funding to continue the
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
121 development of this software.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
122
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
123 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
124 The University of Texas College of Engineering, for providing a
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
125 Challenge for Excellence Research Supplement, and for providing an
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
126 Academic Development Funds grant.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
127
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
128 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
129 The State of Texas, for providing funding through the Texas
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
130 Advanced Technology Program under Grant No. 003658-078.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
131
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
132 @item
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
133 Noel Bell, Senior Engineer, Texaco Chemical Company, Austin Texas.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
134
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
135 @item
19074
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
136 John A. Turner, Group Leader, Continuum Dynamics @nospell{(CCS-2)},
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
137 @nospell{Los Alamos} National Laboratory, for registering the
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
138 @url{octave.org} domain name.
5753
f243564379e5 [project @ 2006-04-12 17:32:04 by jwe]
jwe
parents: 5428
diff changeset
139
f243564379e5 [project @ 2006-04-12 17:32:04 by jwe]
jwe
parents: 5428
diff changeset
140 @item
19074
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
141 @nospell{James B. Rawlings}, Professor, University of Wisconsin-Madison,
5753
f243564379e5 [project @ 2006-04-12 17:32:04 by jwe]
jwe
parents: 5428
diff changeset
142 Department of Chemical and Biological Engineering.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
143
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
144 @item
19074
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 17744
diff changeset
145 @nospell{Richard Stallman}, for writing GNU.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
146 @end itemize
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
147
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
148 This project would not have been possible without the GNU software used
9033
c7d60ac7a3e6 Documentation cleanup of preface and intro
Rik <rdrider0-list@yahoo.com>
parents: 7090
diff changeset
149 in and to produce Octave.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
150
16810
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
151 @node Citing Octave in Publications
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
152 @unnumberedsec Citing Octave in Publications
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
153 @cindex Citing Octave
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
154 @cindex Citations
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
155
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
156 In view of the many contributions made by numerous developers over many years
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
157 it is common courtesy to cite Octave in publications when it has been used
16810
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
158 during the course of research or the preparation of figures. The
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
159 @code{citation} function can automatically generate a recommended citation
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
160 text for Octave or any of its packages. See the help text below on how to
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
161 use @code{citation}.
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
162
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
163 @DOCSTRING(citation)
62fa28af2842 doc: add citation() to documentation.
Rik <rik@octave.org>
parents: 16792
diff changeset
164
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3928
diff changeset
165 @node How You Can Contribute to Octave
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
166 @unnumberedsec How You Can Contribute to Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
167 @cindex contributing to Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
168 @cindex funding Octave development
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
169
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
170 There are a number of ways that you can contribute to help make Octave a
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
171 better system. Perhaps the most important way to contribute is to write
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
172 high-quality code for solving new problems, and to make your code freely
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
173 available for others to use. @xref{Contributing Guidelines}, for detailed
9033
c7d60ac7a3e6 Documentation cleanup of preface and intro
Rik <rdrider0-list@yahoo.com>
parents: 7090
diff changeset
174 information on contributing new code.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
175
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
176 If you find Octave useful, consider providing additional funding to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
177 continue its development. Even a modest amount of additional funding
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
178 could make a significant difference in the amount of time that is
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
179 available for development and support.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
180
14198
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
181 Donations supporting Octave development may be made on the web at
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
182 @url{https://my.fsf.org/donate/working-together/octave}. These
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
183 donations also help to support the Free Software Foundation
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
184
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
185 If you'd prefer to pay by check or money order, you can do so by sending
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
186 a check to the FSF at the following address:
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
187
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
188 @quotation
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
189 Free Software Foundation@*
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
190 51 Franklin Street, Suite 500@*
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
191 Boston, MA 02110-1335@*
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
192 USA
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
193 @end quotation
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
194
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
195 @noindent
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
196 If you pay by check, please be sure to write ``GNU Octave'' in the memo
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
197 field of your check.
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
198
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
199 If you cannot provide funding or contribute code, you can still help
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
200 make Octave better and more reliable by reporting any bugs you find and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
201 by offering suggestions for ways to improve Octave. @xref{Trouble}, for
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
202 tips on how to write useful bug reports.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
203
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3928
diff changeset
204 @node Distribution
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
205 @unnumberedsec Distribution
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
206 @cindex distribution of Octave
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
207
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
208 Octave is @dfn{free} software. This means that everyone is free to
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
209 use it and free to redistribute it on certain conditions. Octave
9033
c7d60ac7a3e6 Documentation cleanup of preface and intro
Rik <rdrider0-list@yahoo.com>
parents: 7090
diff changeset
210 is not, however, in the public domain. It is copyrighted and there are
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
211 restrictions on its distribution, but the restrictions are designed to
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
212 ensure that others will have the same freedom to use and redistribute
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
213 Octave that you have. The precise conditions can be found in the
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
214 GNU General Public License that comes with Octave and that also appears
9033
c7d60ac7a3e6 Documentation cleanup of preface and intro
Rik <rdrider0-list@yahoo.com>
parents: 7090
diff changeset
215 in @ref{Copying}.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
216
14198
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
217 To download a copy of Octave, please visit
39c0e0069895 doc: update preface for release
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
218 @url{http://www.octave.org/download.html}.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
219
12154
22c99c8cfcb6 Add Makefile rules to auto-generate AUTHORS file from contributors.texi
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
220 @end ifclear