glom r1480 - in branches/glom-1-6/docs/user-guide: . C C/figures
- From: murrayc svn gnome org
- To: svn-commits-list gnome org
- Subject: glom r1480 - in branches/glom-1-6/docs/user-guide: . C C/figures
- Date: Sat, 29 Mar 2008 11:46:43 +0000 (GMT)
Author: murrayc
Date: Sat Mar 29 11:46:43 2008
New Revision: 1480
URL: http://svn.gnome.org/viewvc/glom?rev=1480&view=rev
Log:
2008-03-29 Murray Cumming <murrayc murrayc com>
* C/glom.xml: Merged changes from svn trunk, mostly adding screenshots
and a section about defining reports.
Added:
branches/glom-1-6/docs/user-guide/C/figures/glom_data_details.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_data_list.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_design_layout_details.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_design_layout_list.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports_details.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports_group_by.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports_vertical_group.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_design_translations.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_report_result.png (contents, props changed)
branches/glom-1-6/docs/user-guide/C/figures/glom_tables.png (contents, props changed)
Modified:
branches/glom-1-6/docs/user-guide/C/glom.xml
branches/glom-1-6/docs/user-guide/ChangeLog
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_data_details.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_data_list.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_design_layout_details.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_design_layout_list.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports_details.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports_group_by.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_design_reports_vertical_group.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_design_translations.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_report_result.png
==============================================================================
Binary file. No diff available.
Added: branches/glom-1-6/docs/user-guide/C/figures/glom_tables.png
==============================================================================
Binary file. No diff available.
Modified: branches/glom-1-6/docs/user-guide/C/glom.xml
==============================================================================
--- branches/glom-1-6/docs/user-guide/C/glom.xml (original)
+++ branches/glom-1-6/docs/user-guide/C/glom.xml Sat Mar 29 11:46:43 2008
@@ -44,7 +44,7 @@
not specified, the publisher/author is the same for all versions of the
document. -->
<publisher>
- <publishername> Glom Development Team </publishername>
+ <publishername>&app; Development Team </publishername>
</publisher>
&legal;
@@ -57,7 +57,7 @@
<firstname>Murrayc</firstname>
<surname>Cumming</surname>
<affiliation>
- <orgname>Glom Development Team</orgname>
+ <orgname>&app; Development Team</orgname>
<address> <email>murrayc murrayc com</email> </address>
</affiliation>
</author>
@@ -93,7 +93,7 @@
<!-- to V3.0, and so on. -->
<revhistory>
<revision>
- <revnumber>Glom &appversion;</revnumber>
+ <revnumber>&app; &appversion;</revnumber>
<date>&date;</date>
<revdescription>
<para role="author">Murray Cumming</para>
@@ -116,7 +116,7 @@
</legalnotice>
<abstract role="description">
- <para>User manual for Glom.</para>
+ <para>User manual for &app;.</para>
</abstract>
</articleinfo>
@@ -133,7 +133,8 @@
the application is and what it does. -->
<sect1 id="mrp-introduction">
<title>Introduction</title>
- <para>&app; allows you to design and use database systems.</para>
+ <para>&app; allows you to design and use database systems.</para>
+ <!-- TODO: Take text from the website. -->
</sect1>
<!-- =========== Getting Started ============================== -->
@@ -180,8 +181,7 @@
fileref="figures/start.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Shows &app; main window.
- </phrase>
+ <phrase>Shows &app; main window.</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -195,21 +195,80 @@
<sect1 id="glom-operator-usage">
- <title>Using Glom as an Operator</title>
- <para>To open an existing glom document, either open that document from the File Manager, or choose Glom from the Applications menu, and then choose the document when asked. Glom will ask you for a user name and password to access the database. Your administrator will provide your user name and password.</para>
+ <title>Using &app; as an Operator</title>
+ <para>To open an existing glom document, either open that document from the File Manager, or choose &app; from the Applications menu, and then choose the document when asked. &app; will ask you for a user name and password to access the database. Your administrator will provide your user name and password.</para>
- <para>When you open an existing document, Glom will be in <literal>Operator</literal> <literal>user level</literal>. This user level allows you to find and edit records, but does not allow you to change the fundamental structure of the database.</para>
+ <para>When you open an existing document, &app; will be in <literal>Operator</literal> <literal>user level</literal>. This user level allows you to find and edit records, but does not allow you to change the fundamental structure of the database.</para>
<sect2>
<title>Navigation</title>
- <para>Each database has several tables. To look at a different table, choose <literal>Table</literal> from the <literal>Navigate</literal> menu. Then double-click on the table, or select it and click the <literal>Open</literal> button.</para>
+ <para>Each database has several tables. To look at a different table, choose <literal>Tables</literal> from the <literal>Navigate</literal> menu. Then double-click on the table, or select it and click the <literal>Open</literal> button.</para>
+
+ <figure id="operator-navigation-tables">
+ <title>Navigating to a Table</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_tables.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Navigating to a Table.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
</sect2>
<sect2>
- <title>Entering Data</title>
- <para>When in <literal>Data Mode</literal>, you can enter information into either the <literal>List</literal> or <literal>Details</literal> view. The List view shows many records at once, but does not show every field. The details view shows only one record, and shows all the fields arranged suitably.</para>
- <para>When you enter data into a field it will be saved into the database immediately after you finish editing the field. If it is a date or time field then the data format will be checked for you.</para>
- <para>To create a new record just click the <literal>New</literal> button. A new record will be created with blank fields for you to fill in.</para>
+ <title>Viewing and Entering Data</title>
+ <para>When in <literal>Data Mode</literal>, you can view or enter information in either the <literal>List</literal> or <literal>Details</literal> view.</para>
+
+ <sect3>
+ <title>The List View</title>
+ <para>The List view shows many records at once and usually shows only the most important fields.</para>
+ <para>When you enter data into a field it will be saved into the database immediately after you finish editing the field. If it is a date or time field then the data format will be checked for you.</para>
+ <para>To create a new record just click the <literal>New</literal> button, or start typing into a field in the last empty row. A new record row will be created with blank fields for you to fill in.</para>
+
+ <figure id="operator-data-list">
+ <title>The List View</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_data_list.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>The List View.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>To sort the records just click on a column header. For instance, you could might click on a date column to list invoices in order of their date, and click again to list them in reverse order.</para>
+ </sect3>
+
+ <sect3>
+ <title>The Details View</title>
+ <para>The details view shows only one record and usually shows all the fields arranged suitably.</para>
+ <para>When you enter data into a field it will be saved into the database immediately after you finish editing the field. If it is a date or time field then the data format will be checked for you.</para>
+ <para>To create a new record just click the <literal>New</literal> button. A new record will be created with blank fields for you to fill in.</para>
+
+ <figure id="operator-data-details">
+ <title>The Details View</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_data_details.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>The Details View.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ </sect3>
+
</sect2>
<sect2>
@@ -217,18 +276,40 @@
<para>Choose <literal>Find Mode</literal> from the Mode menu. The fields in the List and Details views will now be empty, and a Find button will appear at the bottom of the window.</para>
<para>Enter information, or part of the information, into a field to find records with that information in that field. For instance, enter Jim into a name field to find records with "Jim" or "Jimmy" in the name.</para>
<para>When you press the <literal>Find</literal> button, glom will search for records and then display them. If only one record is found then it will show you that record in the Details view. If several records are found then it will show you those records in the List view.</para>
+ <!-- TODO: screenshot -->
+ </sect2>
+
+ <sect2 id="glom-operator-printing-reports">
+ <title>Printing Reports</title>
+ <para>If your database developer has defined some reports for a table then you will seem them listed in the <literal>Reports</literal> menu. Just choose the report from the menu to create the report. If you have previously performed a search then the report will contain only the currently-found data. Otherwise it will contain all data in the current report. Remember that each table has its own reports so you may need to switch to the relevant table to use a particular report.</para>
+
+ <figure id="operator-report-result">
+ <title>A report</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_report_result.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>A report.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
</sect2>
</sect1>
<sect1 id="glom-developer-usage">
- <title>Using Glom as a Developer</title>
- <para>When you create a new document, Glom will be in the <literal>Developer</literal> <literal>user level</literal>. You can also change to the Developer user level after opening an existing document, with the <literal>User Level</literal> menu. Glom will only allow this if the administrator has allowed it.</para>
+ <title>Using &app; as a Developer</title>
+ <para>When you create a new document, &app; will be in the <literal>Developer</literal> <literal>user level</literal>. You can also change to the Developer user level after opening an existing document, with the <literal>User Level</literal> menu. &app; will only allow this if the administrator has allowed it.</para>
<sect2>
<title>Adding Tables</title>
- <para>You can see the list of existing tables by choosing <literal>Table</literal> from the <literal>Navigate</literal> menu. You will also see this window after connecting to a database server, after creating a new document. To create a new table, click the <literal>Add</literal> button and enter the name for the new table. This name should not contain any spaces or special characters. Glom will suggest a human-readable title for this table. <literal>Operators</literal> will see this title instead of the actual table name. You can also marka a tables as <literal>hidden</literal> from Operators. For instance, Operators should see "Invoice Lines" as related records from the "Invoices" table, but they should never be able to navigate directly to the "Invoice Lines" table.</para>
+ <para>You can see the list of existing tables by choosing <literal>Tables</literal> from the <literal>Navigate</literal> menu. You will also see this window after connecting to a database server, after creating a new document. To create a new table, click the <literal>Add</literal> button and enter the name for the new table. This name should not contain any spaces or special characters. &app; will suggest a human-readable title for this table. <literal>Operators</literal> will see this title instead of the actual table name. You can also mark a tables as <literal>hidden</literal> from Operators. For instance, Operators should see "Invoice Lines" as related records from the "Invoices" table, but they should never be able to navigate directly to the "Invoice Lines" table.</para>
+ <!-- TODO: screenshot -->
<para>You can also specify one table as the <literal>default table</literal>. This table will be shown whenever an operator opens an existing document, without asking him to select a table from the list.</para>
<para>You can also use this window to rename an existing table.</para>
<para>Click the <literal>Open</literal> button to look at the selected table.</para>
@@ -237,7 +318,7 @@
<sect2>
<title>Editing Fields</title>
<para>Choose <literal>Fields</literal> from the <literal>Developer</literal> menu. This shows the list of fields in the table. New tables automatically have a primary key field, but you can change this field if necessary.</para>
- <para>Click the <literal>Add</literal> button to add a new field, then enter the name of the new field. The name should not contain spaces or special characters. Glom will guess an appropriate human-readable title for this field, but you can edit this. <literal>Operators</literal> will see this title instead of the actual field name.</para>
+ <para>Click the <literal>Add</literal> button to add a new field, then enter the name of the new field. The name should not contain spaces or special characters. &app; will guess an appropriate human-readable title for this field, but you can edit this. <literal>Operators</literal> will see this title instead of the actual field name.</para>
<para>To specify more field details, select the field and click the <literal>Details</literal> button.</para>
<figure id="developer-editing-fields">
@@ -248,8 +329,7 @@
fileref="figures/glom_design_fields.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Editing the table's fields.
- </phrase>
+ <phrase>Editing the table's fields.</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -263,7 +343,7 @@
<sect3>
<title>Field Types</title>
- <para>Glom offers a few simple field types:
+ <para>&app; offers a few simple field types:
<orderedlist>
<listitem><simpara>Number</simpara></listitem>
<listitem><simpara>Text</simpara></listitem>
@@ -286,16 +366,52 @@
<sect2>
<title>Arranging Layouts</title>
<para>Each table has <literal>List</literal> and <literal>Details</literal> views, and by default these show all fields in the table, in order of creation. You can edit the layout by choosing <literal>Layout</literal> from the <literal>Developer</literal> menu.</para>
+
+ <sect3>
+ <title>Arranging the List View</title>
<para>For the <literal>List</literal> view, you can specify the sequence of field columns, and whether some fields are hidden.</para>
+
+ <figure id="developer-layout-list">
+ <title>Editing the List Layout</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_design_layout_list.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Editing the list layout.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </sect3>
+
+ <sect3>
+ <title>Arranging the Details View</title>
<para>For the <literal>Details</literal> view, you can create groups of fields, and give these groups titles. You can then place fields in these groups and specify the sequence fo fields in these groups. You can also specify the sequence of these groups. For instance, in a "Contacts" table, you might create a "Name" group, and place the "title", "first_name" and "last_name" fields in that group. You might have other groups for the "Address" fields.</para>
- <para>Date and Time fields will be displayed, and entered, in the correct format according to the user's locale, but stored in the database in a canonical form. Therefore, a German user can enter a date in the German format, but this will later be displayed to a U.S. user in the U.S. format.</para>
+ <figure id="developer-layout-details">
+ <title>Editing the details Layout</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_design_layout_details.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Editing the Details Layout.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </sect3>
+
</sect2>
<sect2 id="sec-developer-relationships">
<title>Creating Relationships</title>
- <para>Tables in the Database are often related together. For instance, an "Invoices" table might have a "Customer ID" field. A value in this field would specify a record in the "Customers" table with the same value. Glom can show extra information, such as the customer name, from that related record. Or it can show a list of several related records - for instance, several related "Invoice Lines" that are related to a record in the "Invoice" record.</para>
+ <para>Tables in the Database are often related together. For instance, an "Invoices" table might have a "Customer ID" field. A value in this field would specify a record in the "Customers" table with the same value. &app; can show extra information, such as the customer name, from that related record. Or it can show a list of several related records - for instance, several related "Invoice Lines" that are related to a record in the "Invoice" record.</para>
<para>To create relationships, choose <literal>Relationships</literal> from the <literal>Developer</literal> menu. This will show the list of existing relationships. Click the <literal>Add</literal> button to create a new relationship, and enter a name for it. You should then choose a field in the current table, and a field in another table to which it should be related. This relationship will find any records in the other table for which the values in both fields are equal.</para>
+ <!-- TODO: screenshot -->
<para>You can use the relationship in the following places.
<orderedlist>
@@ -309,7 +425,129 @@
<sect2>
<title>Users Administration</title>
- <para>To define the <literal>Operators</literal> who can use your database, and to specify what access they have to the various tables, choose <literal>Users</literal> from the <literal>Developer</literal> menu..</para>
+ <para>To define the <literal>Operators</literal> who can use your database, and to specify what access they have to the various tables, choose <literal>Users</literal> from the <literal>Developer</literal> menu.</para>
+ <!-- TODO: screenshot -->
+ </sect2>
+
+ <sect2>
+ <title>Translations</title>
+ <para>&app;'s user interface (and this document) is translated into several languages, as you should see already if you are using your computer with a non-English user interface. In addition, &app; automatically shows and understands numbers and dates according to the current user's local conventions. For instance, a user in the USA might enter a price as 1.99 and a date as 1/13/2008, but a German user of the same database will later see that as 1,99 and 13.1.2008.</para>
+ <para>However, the &app; system that you create also contains text that must be translated if it will be used by people who speak different languages. For instance, you must provide translations for the titles of your tables, fields, and reports. All of these text items can be seen in a list when you choose <literal>Translations</literal> from the <literal>Developer</literal> menu. In this window you can specify the language that you used for the original text, and enter translations for each text item for additional languages. When the &app; system is opened by a user of that language then these
+text items will be shown in the user interface.</para>
+
+ <!-- TODO: Update this screenshot -->
+ <figure id="developer-translations">
+ <title>Translations</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_design_translations.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Translations.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>Experienced translators may be more familiar with the .po file format, or you might wish to use the many tools that work with the .po file format. By using the <literal>Export</literal> button you can create a .po file to use in a separate tool or to send to a translator. You can then import the resulting translation by using the <literal>Import</literal> button.</para>
+
+ </sect2>
+
+ <sect2>
+ <title>Defining Reports</title>
+
+ <sect3>
+ <title>Adding or Editing Reports</title>
+
+ <para>&app; can produce reports to show specific fields for sets of records, sorted and grouped.
+For instance, a shop might need a report listing all products sold in one month, grouped by product type, and sorted by price inside each group. Each table has its own reports, which are available to the operator from the <literal>Reports</literal> menu.</para>
+ <para>To define a report, or to change the definition of an existing report, choose <literal>Reports</literal> from the <literal>Developer</literal> menu.</para>
+ <figure id="developer-editing-reports">
+ <title>Creating or Editing Reports</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_design_reports.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Creating or editing reports.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>Notice that each report has an ID as well as a human-readable name. This allows your report to have a translated title when used on a computer that uses a different language.</para>
+
+ </sect3>
+
+ <sect3>
+ <title>Editing a Report</title>
+
+ <para>A &app; report has three areas:
+ <orderedlist>
+ <listitem><simpara>The Header, which appears at the start of the report</simpara></listitem>
+ <listitem><simpara>The Main area, in which the records and summary lines are shown, with the actual data from the database.</simpara></listitem>
+ <listitem><simpara>The Footer, which appears at the end of the report.</simpara></listitem>
+ </orderedlist>
+ </para>
+
+ <para>Inside an area, such as the Main part, you may add report <literal>Parts</literal>, such as fields, text, or images. These will usually appear in a row on the printed report, with one row for each record. In the simple case, this will look much like &app;'s list view. You can add parts to your report by selecting them from the <literal>Available Parts</literal> list and then clicking the <literal>Add</literal> button. The part will then be added to the <literal>Parts</literal> list, in the selected area.</para>
+ <para>To specify details for the parts, such as the text or image to display, or to choose the field to display, select the part in the <literal>Parts</literal> list and click the <literal>Edit</literal> button. You may also specify field formatting by clicking the <literal>Formatting</literal> button, just as you would when defining a details or list layout.</para>
+
+ <figure id="developer-editing-reports-details">
+ <title>Editing a Report</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_design_reports_details.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Editing a report.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>Some parts may contain other parts and have extra properties to control how they present their child parts. For instance, the <literal>Group By</literal> part groups records together by a field. For instance, a products report might group a list of products by product type. You can even add a second sub-grouping inside the main <literal>Group By</literal> part, by selecting your top-level <literal>Group By</literal> part in the <literal>Parts</literal> list while adding a new <literal>Group By</literal> part from the <literal>Available Parts</literal> list. For instance, you might group your products by manufacturer, inside each product type group.</para>
+ <para>To specify the field by which the records should be grouped, select your <literal>Group By</literal> part in the <literal>Parts</literal> list and click the <literal>Edit</literal> button. You can then choose the field by which the records should be grouped, and select the fields by which these records should be sorted within the group. You may also specify some additional fields to be displayed in the group's title row. For instance, you might want to group products by a manufacturer ID, but also show the manufacturer name.</para>
+
+ <figure id="developer-editing-reports-group_by">
+ <title>Editing a Group By Part</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_design_reports_group_by.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Editing a report.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>The <literal>Vertical Group</literal> part may contain other items. For instance, it allows you to arrange fields below each other instead of just one after the other in the horizontal row. This is useful for grouping related fields such as address lines, or just to squeeze more information into the records's row on the report.</para>
+
+ <figure id="developer-editing-reports-vertical_group">
+ <title>A Report with Vertical Groups</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata
+ fileref="figures/glom_design_reports_vertical_group.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>A Report with Vertical Groups.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>When you have finished, click the <literal>Close</literal> button to save the report's definition. Your report can then be chosen from the <literal>Reports</literal> menu. See the <link linkend="glom-operator-printing-reports">Printing Reports</link> section for more details.</para>
+
+
+
+ </sect3>
+
</sect2>
</sect1>
@@ -331,14 +569,14 @@
<sect2 id="dialog_connection">
<title>Dialog: Connection</title>
-<para>This dialog requests a user name and password for connection to a database server. This is usually not the same username and password combination with which you log in to your system. All Glom systems require a database server on which the actual data will be stored. If the database server is not running on your local computer ("localhost"), then you must also provide its network hostname, such as "glomserver.openismus.com", though your hostname will be different.</para>
+<para>This dialog requests a user name and password for connection to a database server. This is usually not the same username and password combination with which you log in to your system. All &app; systems require a database server on which the actual data will be stored. If the database server is not running on your local computer ("localhost"), then you must also provide its network hostname, such as "glomserver.openismus.com", though your hostname will be different.</para>
<para>Your system administrator can provide these database login details.</para>
-<para>If you are the system administrator, see Glom's <ulink url="http://www.glom.org/wiki/index.php?title=Initial_Postgres_Configuration"; type="http">Postgres Configuration</ulink> web page for help with installing and configuring a database server.</para>
+<para>If you are the system administrator, see &app;'s <ulink url="http://www.glom.org/wiki/index.php?title=Initial_Postgres_Configuration"; type="http">Postgres Configuration</ulink> web page for help with installing and configuring a database server.</para>
</sect2>
<sect2 id="dialog_error_connection">
<title>Dialog: Connection Error</title>
-<para>This dialog is shown when Glom could not connect to the specified database server. Either the database server is not running at the specified hostname, or the user name and password were not accepted by the database server. See the <link linkend="dialog_connection">Connection Dialog</link> section for more details.</para>
+<para>This dialog is shown when &app; could not connect to the specified database server. Either the database server is not running at the specified hostname, or the user name and password were not accepted by the database server. See the <link linkend="dialog_connection">Connection Dialog</link> section for more details.</para>
<para></para>
</sect2>
@@ -454,7 +692,7 @@
manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
<sect1 id="&app;-about">
<title>About &app;</title>
- <para> &app; is maintained by Glom and GNOME community volunteers.
+ <para> &app; is maintained by &app; and GNOME community volunteers.
To find more information about
&app;, please visit the
<ulink url="http://www.glom.org/"; type="http">&app; Web
@@ -480,7 +718,7 @@
<appendix id="sec-concepts">
<title>Concepts</title>
- <para>Glom is easy to use, but you must understand the following basic concepts.
+ <para>&app; is easy to use, but you must understand the following basic concepts.
<orderedlist>
<listitem><simpara><literal>Database</literal>: Each glom document allows access to one database.</simpara></listitem>
<listitem><simpara><literal>Table</literal>: Each database contains several tables, such as "Customers" and "Invoices" tables.</simpara></listitem>
@@ -503,8 +741,7 @@
fileref="figures/glom_design_fields_dialog_calculated.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Editing the definition of a calculated field.
- </phrase>
+ <phrase>Editing the definition of a calculated field.</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -539,7 +776,7 @@
<sect2>
<title>Non-text fields</title>
- <para>Non-text fields may be empty, indicating that the user has not entered any value in the field. For instance, Glom does not assume that an empty value in a numeric field should mean 0.</para>
+ <para>Non-text fields may be empty, indicating that the user has not entered any value in the field. For instance, &app; does not assume that an empty value in a numeric field should mean 0.</para>
<para>You can test whether a field is empty by using Python's None. For instance:</para>
<para>
<programlisting>
@@ -562,7 +799,7 @@
<sect2>
<title>Text fields</title>
- <para>For text fields, you should check for zero-length strings. It is not possible in Glom to distinguish between zero-length strings and the absence of any string, because there is no advantage to doing so. For instance:</para>
+ <para>For text fields, you should check for zero-length strings. It is not possible in &app; to distinguish between zero-length strings and the absence of any string, because there is no advantage to doing so. For instance:</para>
<para>
<programlisting>
if(record["name_full"] == ""):
@@ -579,7 +816,7 @@
<title>Using the full pygda API</title>
<para>pygda is a python API for the libgda API. The record's <literal>connection</literal> attribute provides a gda.connection that can be used to access the current database directly. This allows you to run any SQL query, for instance to read data from the database with a SELECT, or to change values in the database with an UPDATE. Note that the connection is already open so you can avoid the difficult work of specifying the connection details.</para>
<para>The record's <literal>table_name</literal> attribute also provides the name of the current table.</para>
- <para>(Note that the <literal>record.connection</literal> and <literal>record.table_name</literal> attributes are only available since Glom 1.1.6.)</para>
+ <para>(Note that the <literal>record.connection</literal> and <literal>record.table_name</literal> attributes are only available since &app; 1.1.6.)</para>
<para>This example reads all data from the current table and prints the values to the terminal: </para>
<para>
<programlisting>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
