[q-lang-cvs] qcalc/doc qcalc.xml,1.5,1.6
Brought to you by:
agraef
Menu
▾
▴
[q-lang-cvs] qcalc/doc qcalc.xml,1.5,1.6
|
From: Albert G. <ag...@us...> - 2007-11-04 19:50:34
|
Update of /cvsroot/q-lang/qcalc/doc In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv18712 Modified Files: qcalc.xml Log Message: update documentation Index: qcalc.xml =================================================================== RCS file: /cvsroot/q-lang/qcalc/doc/qcalc.xml,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** qcalc.xml 4 Nov 2007 12:56:53 -0000 1.5 --- qcalc.xml 4 Nov 2007 19:50:25 -0000 1.6 *************** *** 39,45 **** 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> - After installing the program, you can simply fire it up using the command <command>qcalc</command> or <command>qcalc mysheet.qcalc</command>. To exit the program, use the <guimenuitem>Quit</guimenuitem> option of the <guimenu>File</guimenu> menu or just press <keycap>Ctrl-Q</keycap>; you will be warned and get a chance to abort the operation if the current file hasn't be saved yet. - </para> </chapter> --- 39,42 ---- *************** *** 49,52 **** --- 46,52 ---- </para> <para> + After installing the program, you can simply fire it up using the command <command>qcalc</command> or <command>qcalc mysheet.qcalc</command>. To exit the program, use the <guimenuitem>Quit</guimenuitem> option of the <guimenu>File</guimenu> menu or just press <keycap>Ctrl-Q</keycap>; you will be warned and get a chance to abort the operation if the current file hasn't be saved yet. + </para> + <para> The following screenshot shows QCalc in action: </para> *************** *** 55,63 **** </screenshot> <para> ! QCalc is a standard Qt application with menu, toolbar, main area (showing the spreadsheet by default) and a status bar which displays helpful status information. The spreadsheet takes the form of a table with columns numbered <guilabel>A</guilabel>, <guilabel>B</guilabel>, etc., and rows <guilabel>1</guilabel>, <guilabel>2</guilabel> etc. The table is browsed with the usual mouse and keyboard operations. </para> <para> The <guimenuitem>File</guimenuitem> menu provides the necessary operations to create new spreadsheets and load, save and print them. QCalc saves its spreadsheets in a text format which is in fact valid Q script syntax, but uses the <filename>.qcalc</filename> extension by default. (The contents of the spreadsheet are stored as comments at the beginning of the script; it goes without saying that you shouldn't remove or alter these lines if you edit the file with a text editor!) It is also possible to open any plain Q script, which then becomes an empty spreadsheet with the given Q source as the user script. </para> <section id="evaluation"><title>Formulas and Evaluation</title> --- 55,78 ---- </screenshot> <para> ! QCalc is a standard Qt application with menu, toolbar, main area (showing the spreadsheet by default) and a status bar which displays helpful status information. The spreadsheet takes the form of a table with columns numbered <guilabel>A</guilabel>, <guilabel>B</guilabel>, etc., and rows <guilabel>1</guilabel>, <guilabel>2</guilabel>, etc. The table is browsed with the usual mouse and keyboard operations. </para> <para> + Online help is available with the <keycap>F1</keycap> key or any of the options in the <guimenu>Help</guimenu> menu. These options invoke the Qt assistant program, Qt's HTML help browser. (As you're reading the online manual right now, you probably discovered this already.) The full Q language manual ("The Q Programming Language") is included, too, to assist you on your journey into the "land of Q"; just press <keycap>Shift-F1</keycap> to show the manual in the help browser. + </para> + + <section id="spreadsheet"><title>The Spreadsheet</title> + <para> The <guimenuitem>File</guimenuitem> menu provides the necessary operations to create new spreadsheets and load, save and print them. QCalc saves its spreadsheets in a text format which is in fact valid Q script syntax, but uses the <filename>.qcalc</filename> extension by default. (The contents of the spreadsheet are stored as comments at the beginning of the script; it goes without saying that you shouldn't remove or alter these lines if you edit the file with a text editor!) It is also possible to open any plain Q script, which then becomes an empty spreadsheet with the given Q source as the user script. </para> + <para> + As in other spreadsheets, rows are numbered starting at 1, while columns are denoted using the letters A through Z. Beyond the 26th column the indices are denoted AA, AB, ..., BA, BB, 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> + Each spreadsheet initially starts out with 128x26 cells, i.e. rows 1 thru 128 and columns A thru Z. (This is currently hardcoded in the program, but you can change the default size by editing the <filename>qcalc.ui</filename> file accordingly.) A spreadsheet grows and shrinks as necessary with certain editing operations (see <xref linkend="editing"/>), but QCalc always keeps it at a minimum size of 128x26. + </para> + <para> + Row and column sizes can be changed by dragging the borders in the row and column headers, and you can also quickly adjust the size by double-clicking on the border. The sizes will be remembered on a per-file basis when the spreadsheet is saved and then reloaded. + </para> + </section> <section id="evaluation"><title>Formulas and Evaluation</title> *************** *** 66,74 **** </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> <para> --- 81,86 ---- </para> <para> ! In your formulas you can also use relative and absolute cell references like <literal>A1</literal>, <literal>B$2</literal>, <literal>$C5</literal> or <literal>$E$9</literal> 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 <literal>A1:A10</literal>, which are mapped to Q lists (or lists of lists, if they span multiple rows <emphasis>and</emphasis> columns, as in <literal>B5:C12</literal>). </para> <para> *************** *** 94,98 **** </para> <para> ! Note that QCalc doesn't limit your spreadsheet to operations which always terminate. If a computation (indicated by the status message <guilabel>Computing...</guilabel>) takes longer than expected, or just loops indefinitely, you can abort it with <keycap>Ctrl-G</keycap> (this is the only operation active while an evaluation is in progress), and correct the offending spreadsheet cells and/or definitions in the script. In the latter case you can then force a reevaluation of the entire spreadsheet by recompiling the script with <keycap>F9</keycap> (see <xref linkend="script"/> below). </para> </section> --- 106,110 ---- </para> <para> ! Note that QCalc doesn't limit your spreadsheet to operations which always terminate. If a computation (indicated by the wait cursor) takes longer than expected, or just loops indefinitely, you can abort it with <keycap>Ctrl-G</keycap> (this is the only operation active while an evaluation is in progress), and correct the offending spreadsheet cells and/or definitions in the script. In the latter case you can then force a reevaluation of the entire spreadsheet by recompiling the script with <keycap>F9</keycap> (see <xref linkend="script"/> below). </para> </section> *************** *** 105,109 **** </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> --- 117,121 ---- </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. Using cut/copy and paste you can also transfer ranges between different instances of QCalc. Moreover, QCalc performs 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> *************** *** 117,121 **** </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> --- 129,133 ---- </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, as already mentioned, QCalc always keeps the spreadsheet at a minimum table size of 128x26. </para> </section> *************** *** 129,133 **** </screenshot> <para> ! In the upper pane of the script page, there is a full-featured text editor with syntax highlighting for Q scripts. In the editor you can enter any Q script, which is submitted to the Q compiler when you invoke the Compile operation (<keycap>F9</keycap>). If there are any errors or warning messages, they will be shown in the lower "log" pane of the script page. (The log pane is also used to show output produced by Q's I/O operations like <literal>puts</literal> or <literal>printf</literal>. But note that the log is just that, a log of everything that is printed either by the Q compiler or the operations in your spreadsheet; it's <emphasis>not</emphasis> an interactive kind of terminal window, so it isn't possible to enter any input to operations like <literal>gets</literal> and <literal>scanf</literal> there. Also note that the log is cleared automatically whenever you recompile your script or load a new spreadsheet.) </para> <para> --- 141,148 ---- </screenshot> <para> ! In the upper pane of the script page, there is a full-featured text editor with syntax highlighting for Q scripts. In the editor you can enter any Q script, which is submitted to the Q compiler when you invoke the Compile operation (<keycap>F9</keycap>). The script can also be empty if your spreadsheet only uses the built-in and prelude types and functions of the Q language. Or it may just consist of the appropriate <literal>import</literal> declarations for the additional modules containing the needed operations. But in most cases it will just include any additional definitions required for the operation of your spreadsheet. ! </para> ! <para> ! If there are any errors or warning messages during compilation of the script, they will be shown in the lower "log" pane of the script page. The log pane is also used to show output produced by Q's I/O operations like <literal>puts</literal> or <literal>printf</literal>. But note that the log is just that, a log of everything that is printed either by the Q compiler or the operations in your spreadsheet; it's <emphasis>not</emphasis> an interactive kind of terminal window, so it isn't possible to interact with the interpreter or enter any input to operations like <literal>gets</literal> and <literal>scanf</literal> there. Also note that the log is cleared automatically whenever you recompile your script or load a new spreadsheet. </para> <para> *************** *** 165,179 **** <section id="view"><title>View Options</title> <para> ! There are a few options which allow you to change the visual appearance of the spreadsheet and script display: ! </para> ! <itemizedlist> ! <listitem> ! <para> ! Row and column sizes can be changed by dragging the borders in the row and column headers, and you can also quickly adjust the size by double-clicking on the border. The sizes will be remembered on a per-file basis when the spreadsheet is saved and then reloaded. ! </para> ! </listitem> ! </itemizedlist> ! <para> ! The following settings are global and are remembered across invocations of the program: </para> <itemizedlist> --- 180,184 ---- <section id="view"><title>View Options</title> <para> ! There are a few options which allow you to change the visual appearance of the spreadsheet and the script display. These settings are global and are remembered across invocations of the program. </para> <itemizedlist> |
