Mercurial > hg > octave-lojdl
changeset 9033:c7d60ac7a3e6
Documentation cleanup of preface and intro
Spellcheck files
A few rewordings for greater clarity
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 20 Mar 2009 17:01:49 -0700 |
parents | 349616d9c38e |
children | 52515efc50c0 |
files | doc/interpreter/intro.txi doc/interpreter/preface.txi |
diffstat | 2 files changed, 32 insertions(+), 35 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/intro.txi +++ b/doc/interpreter/intro.txi @@ -36,11 +36,6 @@ This document corresponds to Octave version @value{VERSION}. -@c FIXME -- add explanation about how and why Octave was written. -@c -@c FIXME -- add a sentence or two explaining that we could -@c always use more funding. - @menu * Running Octave:: * Simple Examples:: @@ -56,7 +51,7 @@ commands immediately afterward. If you get into trouble, you can usually interrupt Octave by typing -@kbd{Control-C} (usually written @kbd{C-c} for short). @kbd{C-c} gets +@kbd{Control-C} (written @kbd{C-c} for short). @kbd{C-c} gets its name from the fact that you type it by holding down @key{CTRL} and then pressing @key{c}. Doing this will normally return you to Octave's prompt. @@ -82,7 +77,7 @@ @subsection Creating a Matrix -To create a new matrix and store it in a variable so that it you can +To create a new matrix and store it in a variable so that you can refer to it later, type the command @example @@ -91,8 +86,8 @@ @noindent Octave will respond by printing the matrix in neatly aligned columns. -Ending a command with a semicolon tells Octave to not print the result -of a command. For example +Ending a command with a semicolon tells Octave not to print the result +of the command. For example @example octave:2> B = rand (3, 2); @@ -102,9 +97,9 @@ will create a 3 row, 2 column matrix with each element set to a random value between zero and one. -To display the value of any variable, simply type the name of the -variable. For example, to display the value stored in the matrix -@code{B}, type the command +To display the value of a variable, simply type the name of the +variable at the prompt. For example, to display the value stored in the +matrix @code{B}, type the command @example octave:3> B @@ -209,7 +204,7 @@ @end ifnottex This is straightforward, and may be accomplished by entering the function body directly on the command line. For example, the following -commands define the right hand side function for an interesting pair of +commands define the right-hand side function for an interesting pair of nonlinear differential equations. Note that while you are entering a function, Octave responds with a different prompt, to indicate that it is waiting for you to complete your input. @@ -297,8 +292,8 @@ At the Octave prompt, you can recall, edit, and reissue previous commands using Emacs- or vi-style editing commands. The default keybindings use Emacs-style commands. For example, to recall the -previous command, press @kbd{Control-p} (usually written @kbd{C-p} for -short). Doing this will normally bring back the previous line of input. +previous command, press @kbd{Control-p} (written @kbd{C-p} for +short). Doing this will normally bring back the previous line of input. @kbd{C-n} will bring up the next line of input, @kbd{C-b} will move the cursor backward on the line, @kbd{C-f} will move the cursor forward on the line, etc. @@ -317,8 +312,8 @@ that you want to use. This name of the function may not always be obvious, but a good place to start is to just type @code{help}. This will show you all the operators, reserved words, functions, -built-in variables, and function files. An alternative is to search the -documentation using the @code{lookfor} function. This function is +built-in variables, and function files. An alternative is to search the +documentation using the @code{lookfor} function. This function is described in @ref{Getting Help}. Once you know the name of the function you wish to use, you can get more @@ -519,7 +514,7 @@ @end deftypefn Any parameter whose name contains the name of a type (e.g., -@var{integer}, @var{integer1} or @var{matrix}) is expected to be of that +@var{integer} or @var{matrix}) is expected to be of that type. Parameters named @var{object} may be of any type. Parameters with other sorts of names (e.g., @var{new_file}) are discussed specifically in the description of the function. In some sections, @@ -559,7 +554,7 @@ @cindex command descriptions Command descriptions have a format similar to function descriptions, -except that the word `Function' is replaced by `Command. Commands are +except that the word `Function' is replaced by `Command'. Commands are functions that may be called without surrounding their arguments in parentheses. For example, here is the description for Octave's @code{cd} command:
--- a/doc/interpreter/preface.txi +++ b/doc/interpreter/preface.txi @@ -57,10 +57,10 @@ people to do more ambitious computations just as easily. Everyone is encouraged to share this software with others under the -terms of the GNU General Public License (@pxref{Copying}) as described -at the beginning of this manual. You are also encouraged to help make -Octave more useful by writing and contributing additional functions for -it, and by reporting any problems you may have. +terms of the GNU General Public License (@pxref{Copying}). You are +also encouraged to help make Octave more useful by writing and +contributing additional functions for it, and by reporting any problems +you may have. @menu * Acknowledgements:: @@ -73,7 +73,7 @@ @cindex acknowledgements Many people have already contributed to Octave's development. The -following people have helped write parts of Octave or helped out in +following people have helped code parts of Octave or aided in various other ways (listed alphabetically). @include contributors.texi @@ -142,7 +142,7 @@ @end itemize This project would not have been possible without the GNU software used -in and used to produce Octave. +in and to produce Octave. @node How You Can Contribute to Octave @unnumberedsec How You Can Contribute to Octave @@ -152,7 +152,8 @@ There are a number of ways that you can contribute to help make Octave a better system. Perhaps the most important way to contribute is to write high-quality code for solving new problems, and to make your code freely -available for others to use. +available for others to use. @xref{Contributing Guidelines}, for detailed +information on contributing new code. If you find Octave useful, consider providing additional funding to continue its development. Even a modest amount of additional funding @@ -169,15 +170,16 @@ @cindex distribution of Octave Octave is @dfn{free} software. This means that everyone is free to -use it and free to redistribute it on certain conditions. Octave is not -in the public domain. It is copyrighted and there are restrictions on -its distribution, but the restrictions are designed to ensure that -others will have the same freedom to use and redistribute Octave that -you have. The precise conditions can be found in the GNU General Public -License that comes with Octave and that also appears in @ref{Copying}. +use it and free to redistribute it on certain conditions. Octave +is not, however, in the public domain. It is copyrighted and there are +restrictions on its distribution, but the restrictions are designed to +ensure that others will have the same freedom to use and redistribute +Octave that you have. The precise conditions can be found in the +GNU General Public License that comes with Octave and that also appears +in @ref{Copying}. -Octave is available on CD-ROM with various collections of other free -software, and from the Free Software Foundation. Ordering a copy of +Octave is available on CD-ROM, with various collections of other free +software, from the Free Software Foundation. Ordering a copy of Octave from the Free Software Foundation helps to fund the development of more free software. For more information, write to @@ -189,4 +191,4 @@ @end quotation Octave can also be downloaded from @url{http://www.octave.org}, where -additional information also is available. +additional information is available.