[q-lang-cvs] qcalc/doc findreplace.png, 1.1, 1.2 options.png, 1.1, 1.2 print.png, 1.1, 1.2 qcalc.xm
Brought to you by:
agraef
Menu
▾
▴
[q-lang-cvs] qcalc/doc findreplace.png, 1.1, 1.2 options.png, 1.1, 1.2 print.png, 1.1, 1.2 qcalc.xml, 1.4, 1.5 qcalc1.png, 1.1, 1.2 qcalc2.png, 1.1, 1.2
|
From: Albert G. <ag...@us...> - 2007-11-04 12:57:03
|
Update of /cvsroot/q-lang/qcalc/doc In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv31282/doc Modified Files: findreplace.png options.png print.png qcalc.xml qcalc1.png qcalc2.png Log Message: update documentation Index: qcalc2.png =================================================================== RCS file: /cvsroot/q-lang/qcalc/doc/qcalc2.png,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 Binary files /tmp/cvs09zJUq and /tmp/cvsBoGGIJ differ Index: qcalc.xml =================================================================== RCS file: /cvsroot/q-lang/qcalc/doc/qcalc.xml,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** qcalc.xml 31 Oct 2007 09:17:43 -0000 1.4 --- qcalc.xml 4 Nov 2007 12:56:53 -0000 1.5 *************** *** 37,41 **** </para> <para> ! Also note that there's only one spreadsheet (of fixed size) and one script per file in the current implementation. But the provided 128x26 cells should be plenty for most purposes, considering that each cell may hold an arbitrarily complex Q value. And the user script may import other source files as necessary, using Q's import/include statements, so the single script page doesn't really limit what you can do. </para> <para> --- 37,41 ---- </para> <para> ! Also note that there's only one spreadsheet and one script per file in the current implementation. But the spreadsheet can get as large as you want and each cell may hold an arbitrarily complex Q value. The user script may import other source files as necessary, using Q's import/include statements, so the single script page doesn't really limit what you can do either. </para> <para> *************** *** 46,50 **** <chapter id="usage"><title>Using QCalc</title> <para> ! More complete documentation still needs to be written, but if you have ever used another spreadsheet program then the basic paradigm should be familar and using QCalc should be rather straightforward. In the following we discuss the most important aspects of QCalc's operation, which will hopefully provide you with enough information to get started. </para> <para> --- 46,50 ---- <chapter id="usage"><title>Using QCalc</title> <para> ! More complete documentation still needs to be written, but if you have ever used another spreadsheet program then the basic paradigm should be familiar and using QCalc should be rather straightforward. In the following we discuss the most important aspects of QCalc's operation, which will hopefully provide you with enough information to get started. </para> <para> *************** *** 63,70 **** <section id="evaluation"><title>Formulas and Evaluation</title> <para> ! Q expressions to be evaluated are written in the customary "<literal>= <varname>expr</varname></literal>" format. (Note that the <literal>=</literal> symbol must be the first character, the formula won't be recognized as such if it is preceded by whitespace). Thus, e.g., if you have the literal values <literal>1</literal> and <literal>2</literal> in cells A1 and B1, and A2 contains "<literal>= A1+B2</literal>", then you will get the value <literal>3</literal> there. The cell will also show a little arrow symbol to indicate that there is a computed value there, so it will actually look like "<inlinegraphic fileref="1rightarrow.png"/><literal> 3</literal>". </para> <para> ! In your formulas you can use relative and absolute cell references like A1, B$2, $C5 or $E$9 just like in any other spreadsheet. These work exactly the same, as far as evaluation is concerned, but behave differently when they are copied or filled (see <xref linkend="editing"/> below). You can also employ ranges of the form A1:A10, which are mapped to Q lists (or lists of lists, if they span multiple rows <emphasis>and</emphasis> columns, as in B5:C12). </para> --- 63,73 ---- <section id="evaluation"><title>Formulas and Evaluation</title> <para> ! Q expressions to be evaluated are written in the customary "<literal>= <varname>expr</varname></literal>" format. (Note that the <literal>=</literal> symbol must be the first character, the formula won't be recognized as such if it is preceded by whitespace). Thus, e.g., if you have the literal values <literal>6</literal> and <literal>7</literal> in cells A1 and B1, and A2 contains "<literal>= A1*B2</literal>", then you will get the value <literal>42</literal> there. The cell will also show a little arrow symbol to indicate that there is a computed value there, so it will actually look like "<inlinegraphic fileref="1rightarrow.png"/><literal> 42</literal>". </para> <para> ! As in other spreadsheets, rows are numbered starting at 1, while columns are denoted using the letters A through Z. Columns beyond the 26th column are denoted AA, AB, etc. In formulas, cell indices are always written with the column letters first. (These are also valid Q variable identifiers, thus you cannot use a global Q variable in formulas if it looks like a cell index.) ! </para> ! <para> ! In your formulas you can also use relative and absolute cell references like A1, B$2, $C5 or $E$9 just like in any other spreadsheet. These work exactly the same, as far as evaluation is concerned, but behave differently when they are copied or filled (see <xref linkend="editing"/> below). You can also employ ranges of the form A1:A10, which are mapped to Q lists (or lists of lists, if they span multiple rows <emphasis>and</emphasis> columns, as in B5:C12). </para> *************** *** 102,110 **** </para> <para> ! Rectangular ranges of spreadsheet cells can be selected by sweeping the mouse over them as usual. You can also click a row or column header to select the entire row or column. Such ranges can be cut, copied and pasted as usual, also ! between different instances of QCalc, with automatic adjustment of relative column and row indices in formulas. Thus, if you copy a cell containing the formula "<literal>= foo A1</literal>" to a position at an offset of, say, 2 rows and 3 columns from the original position, it will become "<literal>= foo D3</literal>". As usual, you can use the $ symbol to indicate absolute row or column indices (or both) which will not be adjusted. </para> <para> ! The <guimenuitem>Copy</guimenuitem> operation only works with the QCalc program, but there is also a second "<guimenuitem>Copy values</guimenuitem>" operation to just copy the literal cell contents (without the formulas). This uses a tab-delimited textual format to store the selection in the clipboard, which can readily be pasted into almost any other application, including text editors and other spreadsheet programs, just as well as QCalc. On X11, the global selection is also supported; just select a range of cells, and you can paste their contents in textual format into any other application with the middle mouse button. </para> <para> --- 105,112 ---- </para> <para> ! Rectangular ranges of spreadsheet cells can be selected by sweeping the mouse over them as usual. You can also click a row or column header to select the entire row or column. Such ranges can be deleted, cut, copied and pasted as usual, also between different instances of QCalc, with automatic adjustment of relative column and row indices in formulas. Thus, if you copy a cell containing the formula "<literal>= foo A1</literal>" to a position at an offset of, say, 2 rows and 3 columns from the original position, it will become "<literal>= foo D3</literal>". As usual, you can use the $ symbol to indicate absolute row or column indices (or both) which will not be adjusted. </para> <para> ! The <guimenuitem>Paste</guimenuitem> operation always copies formulas for computed cells, but there is also a second "<guimenuitem>Paste values</guimenuitem>" operation to just copy the literal cell contents (without the formulas). QCalc can also exchange data with other programs, using the customary textual "tab-separated values" format to store the selection in the clipboard, which can readily be pasted into almost any other application, including text editors and other spreadsheet programs. On X11, the global mouse selection is also supported; just select a range of cells, and you can paste their contents in tab-separated format into any other application with the middle mouse button. </para> <para> *************** *** 112,119 **** </para> <para> ! Note that neither drag and drop of selected cells nor the customary fill handle are currently supported in QCalc, but cut/copy/paste and the fill operation described above work just as well or even better for most purposes. </para> <para> ! Last but not least, there's also an unlimited undo/redo facility, so if you mess up your spreadsheet you can always go back and forth in time as needed. </para> </section> --- 114,121 ---- </para> <para> ! You can also insert and delete entire rows and columns by selecting a cell (a single cell will do, although you can also select a range, in which case the upper left cell of the range determines where the operation is to be performed) and choose the corresponding option in the <guimenu>Edit</guimenu> menu. The corresponding keyboard shortcuts are <keycap>F7</keycap> and <keycap>Shift-F7</keycap> to insert and delete a row, and <keycap>F8</keycap> and <keycap>Shift-F8</keycap> to insert and delete a column, respectively. Each operation only inserts or deletes a single row or column, so you have to invoke the command repeatedly if you want more. Also note that the other editing operations will enlarge the table if needed, e.g., when you paste a range of cells near the edges of the spreadsheet. Thus it is not necessary to explicitly insert table rows and columns in such cases. </para> <para> ! QCalc has an unlimited undo/redo facility, so if you mess up your spreadsheet you can always go back and forth in time as needed. These operations also adjust the table size as needed. They may also shrink the table if there is unused extra space; this also happens when you load a spreadsheet from a file. However, QCalc enforces a minimum table size, which is currently hardcoded as 128x26 (to change this you can edit the <filename>qcalc.ui</filename> file accordingly). </para> </section> *************** *** 141,146 **** </para> <para> ! NOTE: With the Qt3 highlighting engine, the syntax highlighting of the script editor can slow things down quite a bit with large scripts. As a remedy, if the highlighting makes the editor unresponsive and sluggish, you can disable ! it with the <guimenuitem>Syntax highlighting</guimenuitem> toggle (<keycap>Ctrl-H</keycap>). </para> <para> --- 143,147 ---- </para> <para> ! Some special support operations for use in QCalc scripts can be found in the <filename>calclib.q</filename> module which is to be installed on the Q path. These operations allow you to show messages in the QCalc status line while a computation is in progress, and to change spreadsheet cells programmatically. Convenience functions to insert a vector or matrix given as a Q list into a corresponding range of table cells are also provided. It is even possible to perform asynchronous updates of the spreadsheet, using Q threads. Please have a look at the sample spreadsheets in the examples subdirectory of the QCalc distribution which show how these operations are used. </para> <para> *************** *** 156,159 **** --- 157,164 ---- Just enter the text to be searched and, if applicable, the replacement text in the corresponding fields and hit the <guibutton>Next</guibutton> button to search for the first occurrence behind the cursor, or press the <keycap>Return</keycap> key. Keep on pushing <guibutton>Next</guibutton> or <keycap>Return</keycap> to search for further occurrences, or push <guimenuitem>Replace</guimenuitem> to perform a replacement <emphasis>and</emphasis> search for the next occurrence. Backward searches and replacements work analogously, using the <guibutton>Prev</guibutton> button instead of <guibutton>Next</guibutton>. (You can switch the search direction at any time.) There are also various options which determine whether the search is case-sensitive and/or for whole words only, and whether to preserve the case of replaced text (which works as in Emacs). </para> + <para> + NOTE: With the Qt3 highlighting engine, the syntax highlighting of the script editor can slow things down quite a bit with large scripts. As a remedy, if the highlighting makes the editor unresponsive and sluggish, you can disable + it with the <guimenuitem>Syntax highlighting</guimenuitem> toggle (<keycap>Ctrl-H</keycap>). + </para> </section> *************** *** 180,190 **** <listitem> <para> ! The <guimenuitem>Zoom in</guimenuitem> and <guimenuitem>Zoom out</guimenuitem> (<keycap>Ctrl-+</keycap> and <keycap>Ctrl--</keycap>) commands allow you to quickly change the font size on either the sheet or the script page, and, as already mentioned, the <guimenuitem>Syntax highlighting</guimenuitem> toggle (<keycap>Ctrl-H</keycap>) switches syntax highlighting in the script editor on and off. </para> </listitem> ! </itemizedlist> <para> ! Also note that cell formatting is fixed in the current implementation. In particular, the format used for displaying floating point numbers (<literal>"%0.6g"</literal> by default) is hard-coded (see the <literal>FFORMAT</literal> variable at the beginning of the <filename>qcalc.q</filename> script), but you can easily change this in <filename>qcalc.q</filename> if you know what you are doing. </para> </section> --- 185,202 ---- <listitem> <para> ! The <guimenuitem>Zoom in</guimenuitem> and <guimenuitem>Zoom out</guimenuitem> (<keycap>Ctrl-+</keycap> and <keycap>Ctrl--</keycap>) commands allow you to quickly change the font size on either the sheet or the script page. </para> </listitem> ! <listitem> <para> ! The <guimenuitem>Increase precision</guimenuitem> and <guimenuitem>Decrease precision</guimenuitem> (<keycap>Alt-+</keycap> and <keycap>Alt--</keycap>) commands let you to change the precision of floating point values in computed cells. (This affects the display of floating point values only; internally, these values are always stored at full precision.) ! </para> ! </listitem> ! <listitem> ! <para> ! As already mentioned, the <guimenuitem>Syntax highlighting</guimenuitem> toggle (<keycap>Ctrl-H</keycap>) switches syntax highlighting in the script editor on and off. </para> + </listitem> + </itemizedlist> </section> *************** *** 231,235 **** <sect1 id="requirements"><title>Requirements</title> <para> ! You'll need the Q programming system, including Qt/Q module, available from the Q website at <ulink url="http://q-lang.sourceforge.net">http://q-lang.sourceforge.net</ulink>. Currently this script needs Qt3 (<ulink url="http://trolltech.com">http://trolltech.com</ulink>), but we're planning to port it to Qt4 asap. </para> </sect1> --- 243,247 ---- <sect1 id="requirements"><title>Requirements</title> <para> ! You'll need the Q programming system, including the Qt/Q module, available from the Q website at <ulink url="http://q-lang.sourceforge.net">http://q-lang.sourceforge.net</ulink>. Currently this script needs Qt3 (<ulink url="http://trolltech.com">http://trolltech.com</ulink>), but we're planning to port it to Qt4 asap. </para> </sect1> Index: findreplace.png =================================================================== RCS file: /cvsroot/q-lang/qcalc/doc/findreplace.png,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 Binary files /tmp/cvsx30LtT and /tmp/cvsQnmQwd differ Index: print.png =================================================================== RCS file: /cvsroot/q-lang/qcalc/doc/print.png,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 Binary files /tmp/cvsE1HV87 and /tmp/cvsjI4eFs differ Index: options.png =================================================================== RCS file: /cvsroot/q-lang/qcalc/doc/options.png,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 Binary files /tmp/cvstsoBxk and /tmp/cvsUl68sF differ Index: qcalc1.png =================================================================== RCS file: /cvsroot/q-lang/qcalc/doc/qcalc1.png,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 Binary files /tmp/cvsomEWkw and /tmp/cvskofwER differ |
