From 5d5c1110e0720a723476e6f510ed8356b19b5e43 Mon Sep 17 00:00:00 2001 From: Joris van der Hoeven Date: Wed, 7 Mar 2012 14:03:34 +0000 Subject: [PATCH] Reorganize documentation of plug-ins --- main/interface/man-scripting-language.en.tm | 58 +++++++- main/interface/man-session-edit.en.tm | 62 ++++++++- main/interface/man-session-input.en.tm | 139 ++++++++++---------- main/interface/man-spreadsheet.en.tm | 56 +------- 4 files changed, 186 insertions(+), 129 deletions(-) diff --git a/main/interface/man-scripting-language.en.tm b/main/interface/man-scripting-language.en.tm index ecb3bd6..55db145 100644 --- a/main/interface/man-scripting-language.en.tm +++ b/main/interface/man-scripting-language.en.tm @@ -1,9 +1,9 @@ - + <\body> - + provides a few other kinds of additional interfaces to external systems in addition to shell-like interfaces. First of all, it is possible @@ -19,17 +19,67 @@ evaluated output *+1|)>>>. Using , you enable multi-line input. This kind of executable switches are very useful for - plugins such as >, , , + plug-ins such as >, , , , which are mainly used for the efficient computation and insertion of special graphics inside documents. - Some plugins such as can even be selected as a can even be selected as a using . When doing so, a special menu will appear, which allows for many useful operations directly on formulas. For instance, when putting the cursor inside the formula and pressing or , the formula gets evaluated automatically to yield . + If a plug-in can be used as a scripting language, then it is possible to + create executable switches with links between them. More precisely, + assuming that you selected a scripting language from + , you may insert a new + using or . As before, when pressing , the current input is + evaluated and you will see the corresponding output; you may switch back to + the input by pressing once more. + + Contrary to executable switches, you may attach an identifier to the + executable input field by disactivating the field or by editing the + field in the focus bar. Inside other executable input fields, + you may then refer to the value of the field by inserting a using or . As a variant to executable input fields, you may sometimes + prefer to insert plain using + or . These fields can only be used as inputs + and pressing inside such a field will only recompute those + other fields which depend on it. + + <\example> + The excutable input fields may for instance be nice in pedagogic + documents in which parts of the document may be modified and recomputed + by the reader. For instance, evaluation of the input fragment + + <\quote-env> + The derivative of >>> + equals ,x)|*+1|)>>>>. + + The second derivative is given by ,x)|*+1|)>+x>>>. + + + yields + + <\quote-env> + The derivative of >>> + equals ,x)|*+1|)>>>>. + + The second derivative is given by ,x)|*+1|)>+x>>>. + + + Of course, if the reader changes the input function > into + something else and presses , then the first and second + derivatives will be updated automatically. + + + - +> <\body> @@ -27,11 +27,69 @@ Subsessions have a nice rendering on the screen when using the package in . + Notice that input/output fields and subsessions are foldable: when clicking + on the prompt with the mouse, you may fold or unfold the entry to hide or + show the output. For laptop presentations, this folding and unfolding + process is done automatically when traversing your presentation. It is also + possible to fold or unfold all fields in a session using + and . + Other useful editing operations are , which is useful for creating a demo session which will be executed later on, and , which can be used for splitting a session into parts for inclusion into a paper. + <\example> + A typical session is given below. If + is present on your system, then you may put your cursor in + one of the inputs, perform some edits, and try to reexecute it. + + <\session|maxima|default> + <\output> + Maxima 5.25.1 http://maxima.sourceforge.net + + using Lisp SBCL 1.0.51 + + Distributed under the GNU Public License. See the file COPYING. + + Dedicated to the memory of William Schelter. + + The function bug_report() provides bug reporting information. + + + <\unfolded-io> + 1) > + <|unfolded-io> + diff (x^x^x, x) + <|unfolded-io> + ) + >>x>**log + *+1|)>+x|)>>> + + + <\unfolded-io> + 2) > + <|unfolded-io> + integrate (%o1, x) + <|unfolded-io> + ) + >>\>*log + >>> + + + <\unfolded-io> + 3) > + <|unfolded-io> + integrate (x^5 / (x^2 - x + 17), x) + <|unfolded-io> + ) + >>-x+17|)>|2>+>|)>|>++4*x-96*x-396*x|12>>> + + + + + <\body> - + By default, will attempt to evaluate the input field when - pressing . Multiline input can be created using - . Alternatively, when selecting the multiline - input mode using , the - key will behave as usual and - may be used in order to evaluate the input + pressing . Multiline input can be created using . + Alternatively, when selecting the multiline input mode using + , the key will behave + as usual and may be used in order to evaluate the input field. Notice finally that certain systems admit built-in heuristics for - testing whether the input has been completed; if not, then the - may behave as usual. + testing whether the input has been completed; if not, then the + may behave as usual. Certain applications allow you to type the mathematical input in a graphical, two dimensional form. This feature can be used by selecting - . If this feature is - available, then it is usually also possible to copy and paste output back - into the input. However, it depends on the particular application how well - this works. + . If this feature is available, + then it is usually also possible to copy and paste output back into the + input. However, it depends on the particular application how well this + works. - + <\example> + Below, you will find the , but now using + mathematical input: - + <\session|maxima|default> + <\output> + Maxima 5.25.1 http://maxima.sourceforge.net + + using Lisp SBCL 1.0.51 + + Distributed under the GNU Public License. See the file COPYING. + + Dedicated to the memory of William Schelter. + + The function bug_report() provides bug reporting information. + + + <\unfolded-io-math> + 1) > + <|unfolded-io-math> + diff>,x|)> + <|unfolded-io-math> + ) + >>x>**log + *+1|)>+x|)>>> + + + <\unfolded-io-math> + 2) > + <|unfolded-io-math> + %o1*\ x + <|unfolded-io-math> + ) + >>\>*log + >>> + + + <\unfolded-io-math> + 3) > + <|unfolded-io-math> + |x-x+17>*\ x + <|unfolded-io-math> + ) + >>-x+17|)>|2>+>|)>|>++4*x-96*x-396*x|12>>> + + + + + + + <\initial> <\collection> - - - - - - - - - - - - - - -<\references> - <\collection> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - - - -<\auxiliary> - <\collection> - <\associate|idx> - |Session>||Insert fields>>|> - - |Session>||Remove fields>>|> - - |Session>||Insert fields>||Insert - text field>>|> - - |Text>||Session>>|> - - |Text>||Session>||Other>>|> - - - + \ No newline at end of file diff --git a/main/interface/man-spreadsheet.en.tm b/main/interface/man-spreadsheet.en.tm index 2612555..baf72b1 100644 --- a/main/interface/man-spreadsheet.en.tm +++ b/main/interface/man-spreadsheet.en.tm @@ -78,59 +78,7 @@ Similarly, automatic renumbering is used when inserting new columns or rows, or when removing existing columns or rows. - also allows you to use some of the spreadsheet capacities outside - tables. For instance, assuming that you selected a scripting language from - , you may insert a new - using or . The behaviour is similar to the one of : when pressing , the - current input is evaluated and you will see the corresponding output; you - may switch back to the input by pressing once more. In - particular, the input does not need to be preceded by (as in the - case of spreadsheet cells). - - Contrary to executable switches, you may attach an identifier to the - executable input field by disactivating the field or by editing the - field in the focus bar. Inside other executable input fields, - you may then refer to the value of the field by inserting a using or . As a variant to executable input fields, you may sometimes - prefer to insert plain using - or . These fields can only be used as inputs - and pressing inside such a field will only recompute those - other fields which depend on it. - - <\example> - The excutable input fields may for instance be nice in pedagogic - documents in which parts of the document may be modified and recomputed - by the reader. For instance, evaluation of the input fragment - - <\quote-env> - The derivative of >>> - equals ,x)|*+1|)>>>>. - - The second derivative is given by ,x)|*+1|)>+x>>>. - - - yields - - <\quote-env> - The derivative of >>> - equals ,x)|*+1|)>>>>. - - The second derivative is given by ,x)|*+1|)>+x>>>. - - - Of course, if the reader changes the input function > into - something else and presses , then the first and second - derivatives will be updated automatically. - - - We notice that field references can also be used inside spreadsheet cells + We also notice that field references can be used inside spreadsheet cells in order to refer to some computational markup outside the table. Inversely, each spreadsheet also carries an invisible field which can be edited by deactivating the spreadsheet or from the focus bar @@ -138,7 +86,7 @@ spreadsheet is used as a prefix for refering to the contents of cells outside the table or from within other spreadsheets. For instance, if equals , then will refer to the - field inside the table. + field inside the spreadsheet.