diff options
| author | Ales Cepek <[email protected]> | 2025-01-20 13:35:05 +0100 |
|---|---|---|
| committer | Ales Cepek <[email protected]> | 2025-01-20 13:35:05 +0100 |
| commit | 4e18830e7a8f2efd6374ffe675bb6c4786d8371e (patch) | |
| tree | 351f916e186d09cf2cfd4a2bb0a251875a23d88e | |
| parent | b399de90d77c8ad67522adf107b6095cc64e181f (diff) | |
| download | qt-master.tar.gz | |
new file: .gitignore
modified: README.md
deleted: qgama.html
modified: qgama.md
| -rw-r--r-- | qgama/help/.gitignore | 2 | ||||
| -rw-r--r-- | qgama/help/README.md | 10 | ||||
| -rw-r--r-- | qgama/help/qgama.html | 405 | ||||
| -rw-r--r-- | qgama/help/qgama.md | 2 |
4 files changed, 9 insertions, 410 deletions
diff --git a/qgama/help/.gitignore b/qgama/help/.gitignore new file mode 100644 index 0000000..3432c3f --- /dev/null +++ b/qgama/help/.gitignore @@ -0,0 +1,2 @@ +*.html + diff --git a/qgama/help/README.md b/qgama/help/README.md index 939fc87..d5d4d30 100644 --- a/qgama/help/README.md +++ b/qgama/help/README.md @@ -1,6 +1,10 @@ # Qgama help Since qgama-2.09 the program help is defined in qgama/help/qgama.md in -Markdown format. Temporarily the previous corresponding qgama.html -file is temporarily kept for comparison/verification but shall be -removed in a future update. +Markdown format. + +## Suggested viewer + +https://pandoc.org/ + + pandoc -s qgama.md -o view-qgama.html diff --git a/qgama/help/qgama.html b/qgama/help/qgama.html deleted file mode 100644 index 58fa812..0000000 --- a/qgama/help/qgama.html +++ /dev/null @@ -1,405 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'> -<head> -<style type='text/css'> - table { border:0; margin:0.2em 0; } - th { white-space:nowrap; } - p.qgama-note { margin-left: 2em; } -</style> -<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> - -<title>Qgama</title></head> -<body> - - - -<h1>Qgama</h1> - -<p>Qgama is a <a href="http://qt.io/">Qt</a> application for -adjustment of geodetic networks with database support, where the -database can be a simple SQLite3 flat file, used for storing geodetic -network data, or any full-featured relational DBMS -with <a href="http://doc.qt.io/qt-5/sql-driver.html">Qt driver</a> -available like PostgreSQL or MySQL. It is build on the -<a href="http://www.gnu.org/software/gama/">GNU gama</a> adjustment -library</p> - -<p>Qgama Graphical User Interface (GUI) has two main panels. One -<b>Main Control Panel</b> that is open on the application startup -and <b>Network Adjustment Panel</b> open for a selected network -configuration. More than one network adjustment panels can be opened -simultaneously.</p> - - - - -<h2>Quick Start</h2> -<!-- *********** --> - -<p>Start <b>qgama</b> and select from the <i>Main Control Panel</i> menu</p> - -<dl> -<!-- dt>Database → Connect to Database → OK</dt --> -<dt>Database → Import Examples → OK</dt> -<dt>Adjustment → Network Adjustment → <i>select an example</i> -→ OK </dt> -<dt>Adjustment → Run</dt> -</dl> - -<p>and start experimenting with the adjustment. Enjoy!</p> - - - - -<h2>Main Control Panel</h2> -<!-- ****************** --> - -<p>Main Control Menu has four menus and a bottom status bar -temporarily displaying program messages. This panel is displayed at -program startup and the user typically starts with connection to a -database.</p> - -<p> -<table> -<tr><th colspan="2">Qgama Main Control Panel</th></tr> -<tr><td colspan="2" class="divider"><hr /> </td></tr> - -<tr><td>Database</td></td><td>Connect to database </td></tr> -<tr><td> </td><td>Import Configuration File <sup>*</sup></td></tr> -<tr><td> </td><td>Import Krumm Network File <sup>*</sup></td></tr> -<tr><td> </td><td>New Empty Configuration <sup>*</sup></td></tr> -<tr><td> </td><td>Import Examples <sup>*</sup></td></tr> -<tr><td> </td><td colspan="1" class="divider"><hr /> </td></tr> -<tr><td> </td><td>Drop Schema tables </td></tr> -<tr><td> </td><td>Delete all Data from the Schema </td></tr> -<tr><td> </td><td>Delete Network Configuration </td></tr> -<tr><td> </td><td colspan="1" class="divider"><hr /> </td></tr> -<tr><td> </td><td>Exit </td></tr> -<tr><td colspan="2" class="divider"><hr /> </td></tr> - -<tr><td>Adjustment - </td><td>Network Adjustment </td></tr> -<tr><td colspan="2" class="divider"><hr /> </td></tr> - -<tr><td>Tools </td><td>Adjustment results language </td></tr> -<tr><td> </td><td>Application font </td></tr> -<tr><td colspan="2" class="divider"><hr /> </td></tr> - -<tr><td>Help </td><td>Qgama help </td></tr> -<tr><td> </td><td colspan="1" class="divider"><hr /> </td></tr> -<tr><td> </td><td>About Qgama </td></tr> -<tr><td> </td><td>About Qt </td></tr> -<tr><td colspan="2" class="divider"><hr /> </td></tr> - -</table> -</p> - -<p class="qgama-note"> -Functions marked <sup>*</sup> can be run without connecting to a database -first; in such a case implicit <i>in memory database</i> is used and -the user is responsible for exporting data before exit, if they are needed -(for example export configuration XML input file after editing the network -configuration). -</p> - - -<h3>Database menu</h3> - -<dl> -<dt>Connect to database</dt> - -<dd> -<p>starts up a dialog for connecting to a database. Until the -connection is established, some program functions are blocked. To open -database connection the user must select <i>Database Drive</i> which is -implicitly set to <i>QSQLITE</i>. For Sqlite the database file must be -selected in <i>Open File dialog</i>, for new database you must check -the <i>Create a New Sqlite Database</i> check box. Alternatively you -can work with temporary database <i>:memory:</i> (implicit database -name), but its content is lost when the program is closed.</p> - -<p>If you select another <i>Database Driver</i> in the top combo-box -(for example to <i>QPSQL</i>) dialog changes and input fields -for <i>Database Name, Username, Passwords, Hostname and Port</i> are -displayed (depending on your system only some of the attributes need -to be entered). -</p> -</dd> - - - -<dt>Import Configuration File</dt> - -<dd> -<p>XML input adjustment data (<i>Configuration File</i>) contains -information on points, observations and other adjustment parameters, -for details see GNU gama -<a href="http://www.gnu.org/software/gama/manual/index.html">documentation</a>. -After selection the file (with .xml or .gkf extension), the dialog -displays <i>existing configuration names</i> and user can either -replace selected existing configuration or create a <i>new -configuration name</i>. The configuration name can be arbitrary, but -<i>white spaces</i> are removed by the application. -</p> -</dd> - - - -<dt>New Empty Configuration</dt> - -<dd> -<p>Creates new network configuration without points and observation -(implicit values are used for network adjustment parameters). -The menu dialog is similar to <i>Import Configuration File</i>.</p> -</dd> - - - -<dt>Import Examples</dt> - -<dd> -<p>Imports a set of example networks distributed with the application to the -opened database.</p> -</dd> - -<dt>Drop Schema Tables</dt> -<dt>Delete All Data from the Schema</dt> -<dt>Delete Network Configuration</dt> - -<dd> -<p>are corresponding administrative database operations.</p> -</dd> - -<dt>Plugins ...</dt> -<dd> -<p>if plugins are available, they are listed here. -</p> -</dd> - -<dt>Exit</dt> - -<dd> -<p>The program stops when all panels are closed. You can even -close <i>Main Control Panel</i> and have one or more <i>Network -Adjustment Panels</i> open and continue work. In situations like this -the exit dialog asks if you want to exit just the <i>Main Control -Panel</i> (yes) or all other opened panels as well (yes to all). -</p> -</dd> - -</dl> - - - -<h3>Adjustment menu</h3> - -<dl> -<dt>Network Adjustment</dt> - -<dd><p>Opens dialog for selecting <i>network configuration</i> stored -in the database. If the configuration is selected, a new <i>Network -Adjustment Panel</i> is created. -</p> -</dd> - -</dl> - - - -<h3>Tools Menu</h3> - -<dl> -<dt>Adjustement results language</dt> - -<dd><p>Enables to select a language for the adjustment results text. -</p> -</dd> - -</dl> - - - -<h3>Help menu</h3> - -<dl> -<dt>Qgama help</dt> - -<dd><p>this text. -</p> -</dd> - -<dt>About Qgama</dt> - -<dd><p> Basic information about Qgama, its version, GNU gama build -version and the GPL licence. -</p> -</dd> - - -<dt>About Qt</dt> - -<dd><p>Qt version, licencing and basic information on Qt C++ cross-platform. -</p></dd> -</dl> - - - - -<h2>Network Adjustment Panel</h2> -<!-- ************************ --> - -Network adjustment panel has five menus (File, Adjustment, Edit, -Settings and Help) and five tabbed/docked windows (Paramaters, -Points, Observations, View and Results). - -<h3>File menu</h3> - -<dl> -<dt>Save Configuration to Database</dt> -<dd><p>Save network data into database. -</p> -</dd> - -<dt>Save Configuration As ...</dt> -<dd><p>Save copy of network data into database under a new name. -</p> -</dd> - -<dt>Export as XML input file</dt> -<dd> - <p>Export information from Parameters, Points and Observations - editors to a XML configuration file (gkf). This file contains all - information needed for the adjustment and can be used as input - by qgama or gama-local. - </p> -</dd> - -<dt>Export as XML SQL file</dt> -<dd> - <p>Similar to the previous function, adjustment information is - stored in SQL format which can be imported to a database. - </p> -</dd> - -<dt>Print Adjustment Results</dt> -<dd> - <p>Implicitly disabled until the adjustment is ready.</p></dd> - -<dt>Export Adjustment Results As</dt> -<dd> - <ul> - <li>XML adjustment results</li> - <li>HTML file</li> - <li>Plaint text file</li> - <li>Octave matrix file</li> - </ul> - <p>These submenus are also implicitly disabled until - the adjustment is run.</p> -</dd> - -<dt>Save network configuration outline</dt> -<dd> - <p>Save configuration sketch in SVG format. - </p> -</dd> - -<dt>Close</dt> -<dd> - <p>Close current <i>Network Adjustment Panel</i> (or all opened panels). - </p> -</dd> - -</dl> - - -<h3>Adjustment menu</h3> - -<dl> -<dt>Run</dt> -<dd><p>Start adjustment of the network. -</p> -</dd> - - -<h3>Edit Menu</h3> - -<dl> -<dt>Parameters</dt> -<dt>Points</dt> -<dt>Observations</dt> -<dd><p>Implicitly editing of network adjustment parameters, points -and observations are disabled. In the <i>Edit menu</i> users can -enable/disable one or all three editors. -</p> -</dd> -</dl> - - -<h3>Settings</h3> - -<dl> -<dt>Outline draw</dt> -<dd><p>Opens dialog for changing parameters of the network outline draw. -</p> -</dd> -</dl> - - -<h3>Help</h3> - -<dl> -<dt>Qgama help</dt> - -<dd><p>this text. -</p> -</dd> -</dl> - - - - -<h2>Editors and adjustment results</h2> -<!-- ****************************** --> - -<p><i>Network Adjustment Results</i> has three editor panels for -adjustment parameters, points and observations and two output panels, -the <i>outline draw</i> and the adjustment results text output. These -five panels can be organized as tabbed or docked (as indicated by the -user on opening a new adjustment configuration). -</p> - -<p>Adjustment parameters editor is strightforward, the meaning of -individual parameters is described in GNU gama -<a href="http://www.gnu.org/software/gama/manual/index.html">documentation</a>. -</p> - -<p>Points editor is also simple, attributes <i>Txx</i> and <i>Tz</i> -define how the role of the point coordinates in the adjustment:</p> - -<dl> -<dt>fixed</dt> -<dd><p>Given coordinates.</p></dd> -<dt>free</dt> -<dd><p>Adjusted coordinates (ie. unknown adjustment parameter).</p></dd> -<dt>constrained</dt> -<dd><p>Adjusted coordinates that are subject to a second adjustment -constraint (the sum of squares of constrained coordinates corrections is -minimal).</p> -<p>Constrained coordinates are also special in that their given approximate -values are not updated in possible linearization updates.</p></dd> -</dl> - -<p>All other points/coordinates (not explicitly specified) are unused in the -adjustment.</p> - -<p>Observations editor is more tricky. You must remember that in qgama -observations are organized by clusters. Cluster is a set of somehow -related observations, for example observations measured from one -point, or more generally, observations with the common covariance -matrix. If you want to add observations to an empty configuration, you -must first create a new cluster.</p> - -</body> -</html> diff --git a/qgama/help/qgama.md b/qgama/help/qgama.md index f729415..73c6043 100644 --- a/qgama/help/qgama.md +++ b/qgama/help/qgama.md @@ -33,8 +33,6 @@ temporarily displaying program's messages. This panel is displayed at program startup and the user typically starts with connection to a database. - <!-- forcing vertical space before the table ---> - | Qgama | Main Control Panel | |:------ |:----- | | Database | Connect to database | |