Documentation fixes.
authorguillaume <guillaume@a7884b65-44f6-0310-8a51-81a127f17b15>
Tue, 31 Mar 2009 15:53:03 +0000 (15:53 +0000)
committerguillaume <guillaume@a7884b65-44f6-0310-8a51-81a127f17b15>
Tue, 31 Mar 2009 15:53:03 +0000 (15:53 +0000)
git-svn-id: svn://svn.pgadmin.org/trunk/pgadmin3@7782 a7884b65-44f6-0310-8a51-81a127f17b15

17 files changed:
docs/en_US/bugreport.html
docs/en_US/debugger.html
docs/en_US/extend.html
docs/en_US/gqb.html
docs/en_US/macros.html
docs/en_US/maintenance.html
docs/en_US/options-tab1.html
docs/en_US/options-tab2.html
docs/en_US/options-tab3.html
docs/en_US/options-tab4.html
docs/en_US/options-tab5.html
docs/en_US/pgagent-schedules.html
docs/en_US/pgscript.html
docs/en_US/query.html
docs/en_US/reports.html
docs/en_US/slony-install.html
docs/en_US/using.html

index 3af1b60293f2f7ce90b64d6b4a1f60d8c51d09ad..0cbf83e1c7833b40bb6892c1d1c0f5dd63ada71f 100644 (file)
@@ -22,8 +22,8 @@ following:</P>
 </UL>
 <P>Ahh, so you've found a new one then? 
 </P>
-<P>Post your report to <A HREF="http://archives.postgresql.org/pgadmin-support/">support
-mailing list</A>, include the following informations:</P>
+<P>Post your report to the <A HREF="http://archives.postgresql.org/pgadmin-support/">support
+mailing list</A>, and include the following informations:</P>
 <UL>
        <LI>Platform you're running on 
        <LI>Language
index 0224e0f0555129c4db4120f51564a933e10b0900..950a9bbb60cd59eab133ccd39581fd2566a6567f 100644 (file)
@@ -44,12 +44,12 @@ of just two single quotes, enter \'\'. PostgreSQL 8.4 and above supports
 variadic function parameters. These may be entered as a comma-delimited list\r
 of values, quoted and/or cast as required.</p>\r
 \r
-<p>Once the debugger session has started you can step through the code using\r
+<p>Once the debugger session has started, you can step through the code using\r
 the menu options, keyboard shortcuts or toolbar buttons. Breakpoints may be \r
 set or cleared by clicking in the margin of the source window, or by clicking\r
 on the desired code line and using the "Toggle breakpoint" button or menu\r
 option. If you step into other functions, the Stack pane may be used to navigate\r
-to different stack frames - simply select the frame you with to view.</p>\r
+to different stack frames - simply select the frame you wish to view.</p>\r
 \r
 <p>When the debugger has reached the end of the executable code, if running in-context\r
 it will wait for the next call to the function, otherwise it will prompt for \r
index ee588b7d304fb579628b4c7f3c70f55c896bc21a..3e852c450244c36bb03900fa28ae770138e57430 100644 (file)
@@ -48,7 +48,7 @@ if required):</p>
 </pre>
 
 <p>The module should now be built, and installed into your existing PostgreSQL installation.
-to be used, you must now install the module into the database you use as pgAdmin's <I>Maintenance
+To be used, you must now install the module into the database you use as pgAdmin's <I>Maintenance
 DB</I> (normally <i>postgres</i>, though you may wish to use a different database). To do so, 
 locate the <i>admin.sql</i> or <i>admin81.sql</i> file installed in the previous step - normally 
 this may be found in /usr/local/pgsql/share/contrib/ and run it against your database. You will 
index 1781f81c24ba7e2e7075474182af5f3cb745d4c1..91aafbe43a27d79497a1cbb1d3ff8aba23d762dd 100644 (file)
@@ -47,7 +47,7 @@ the criteria will be joined to the next (if any).</p>
 <p>The query results may be ordered on the Ordering tab. Select the columns\r
 required on the left, and use the buttons in the middle to add them to the\r
 ordering list on the right. You can also remove columns in the same way. \r
-For each column added to the ordering list you can specify the sorting\r
+For each column added to the ordering list, you can specify the sorting\r
 direction. You can also adjust the priority of each ordering column by\r
 selecting it, and moving it up or down the list using the buttons on the \r
 right.</p>\r
index 8032ec099dd056eaaeb0412976cb44458c3586b2..7beed36e4a246b053ad4a17fb797652084a1a2ca 100644 (file)
@@ -13,8 +13,8 @@
     <p>\r
       Query Tool Macros enable you to execute pre-defined SQL queries\r
       with single key press. Pre-defined queries can contain the placeholder\r
-      $SELECTION$. Upon macro execution the placeholder will be replaced with\r
-      the text current selected in the SQL pane of the Query Tool.\r
+      $SELECTION$. Upon macro execution, the placeholder will be replaced with\r
+      the currently selected text in the SQL pane of the Query Tool.\r
     </p>\r
 \r
     <p>To create a macro, select the Manage Macros option from the Macros menu\r
index 34ebf57dc32db76e72fde8bbb05585e9b74bf2c4..7ba2806451318d91aaecf1bcb860da6f63f5efd5 100644 (file)
@@ -28,7 +28,7 @@ VACUUM command to learn more about the options.</P>
 <P>The output of the database server is displayed in the messages
 page as they arrive. If Verbose is selected, the server will send
 very detailed info about what it did.</P>
-<P>While this tools is very handy for ad-hoc maintenance purposes,
+<P>While this tool is very handy for ad-hoc maintenance purposes,
 you are encouraged to install an automatic job, that performs a
 VACUUM job regularly to keep your database in a neat state.</P>
 <H3>ANALYZE</H3>
index 27aa954906285df15b0540c5cb978e02e710f999..8cc3a67a63daca4c33f2c92bd3b2980652c6f780 100644 (file)
@@ -24,7 +24,7 @@
    notation), or the path to a Compiled HTML Help (.chm) file (on
    Windows), an HTML Help project (.hhp) file, or a Zip archive containing the HTML
    files and the HTML Help project file. The PostgreSQL Help is used when selected
-   from the Help menu, or when working with many database objects on PostgreSQL.
+   from the Help menu, or when working with many database objects on PostgreSQL
    servers.<br>&nbsp;</li>
 
    <li><b>EDB help path</b> - This option is used to specify the path
@@ -51,7 +51,7 @@
 
    <li><b>PG bin path</b>- This should be set to the path to the standard PostgreSQL pg_dump, pg_restore
    and pg_dumpall utilities. pgAdmin will use these for backing up and restoring your PostgreSQL databases.
-   If this path is not set, pgAdmin will attempt to find the utilities in it's installation directory,
+   If this path is not set, pgAdmin will attempt to find the utilities in its installation directory,
    the 'hint' directory set by a local PostgreSQL installation (on Windows) and in the system path.
    <br>&nbsp;</li>
 
index 12c71757a0316ded0bb6646208262bb93cb956bb..3f06b1c1cb777b8925ae0e328c4b4bbad0ea3ae5 100644 (file)
    will prevent pgAdmin from prompting you to save SQL queries upon
    exit.<br>&nbsp;</li>
 
-   <li><b>Confirm object deletion?</b> - Select this option to ensure pgAdmin 
+   <li><b>Confirm object deletion</b> - Select this option to ensure pgAdmin 
    gives you a chance to confirm before objects are deleted
    (recommended).<br>&nbsp;</li> 
   
-   <li><b>Show users for privileges?</b> - When viewing the Privileges tab on 
+   <li><b>Show users for privileges</b> - When viewing the Privileges tab on 
    objects that support them, selecting this option will include usernames as 
    well as groups in the subject list. Switching off this option is useful on 
    large systems with many users that are organised in groups.<br>&nbsp;</li>
 
-   <li><b>Show object properties on double click in treeview?</b> - Selecting 
+   <li><b>Show object properties on double click in treeview</b> - Selecting 
    this option will allow double clicking of objects in the treeview
    to open the Properties dialogue for that object. Some users prefer
    to disable this option to browse the treeview by double clicking
index d5fde8dae2a3c598a6d6bd49fcf1334da1ddd6e8..bbb3378bdac1c91810cb88f2a5aaf9c00ce9b723 100644 (file)
@@ -54,7 +54,7 @@
   Tool, with this option selected, any object definition being displayed in the 
   main object browser will be inserted as a default query in the Query Tool.<br>&nbsp;</li>
    
-  <li><b>Show NULL values as &lt;NULL&gt;?</b> - This option will cause NULL values to be shown
+  <li><b>Show NULL values as &lt;NULL&gt;</b> - This option will cause NULL values to be shown
   as &lt;NULL&gt; in the Query Tool's results grid. Note that this option does not affect data
   that is exported from the grid, only what is displayed.<br>&nbsp;</li>
     
index a9d3866923ea3b4254303cc8b0246920a2c06ac1..d8bed08ca06760258c6d9ba4c435330795671345 100644 (file)
@@ -14,7 +14,7 @@
 
 <p>
 <ul>
-  <li><b>Logfile</b> - This option specifies the file the pgAdmin will store any 
+  <li><b>Logfile</b> - This option specifies the file pgAdmin will store any 
   logging data in. If %ID is found in the name it will be replaced with the 
   process ID, allowing multiple versions of pgAdmin to run with logging at once.<br>&nbsp;</li>
   
index 75ea1e30acf3c47b1f29fdb034174af536aed0df..0fd09b16c3a9fc9b827cb19fe396fa66a8e58333 100644 (file)
@@ -22,7 +22,7 @@ The list of check boxes is used to select which object types to show in the
 browser tree. By default, only the most commonly used object types are\r
 shown. Reducing the number of object types shown can increase the speed\r
 of pgAdmin when querying the system catalogs. Use the <b>Default</b> button\r
-to reset the list to it's default settings.\r
+to reset the list to its default settings.\r
 </p>\r
 \r
 </body>\r
index 2729b5f6147fe33749783d4514e2746741e1f275..9c52c02fa0fc56f3b02eb6213d142298adbbf398 100644 (file)
@@ -10,7 +10,7 @@
 \r
 <H3>pgAgent Schedules</H3>\r
 <P>Each Job is executed according to one or more schedules. Each time the\r
-job or any or any of it's schedules are altered, the next runtime of the \r
+job or any of its schedules are altered, the next runtime of the \r
 job is re-calculated. Each instance of pgAgent periodically polls the database\r
 for jobs with the next runtime value in the past. By polling at least once \r
 every minute, all jobs will normally start within one minute of the specified\r
@@ -26,12 +26,12 @@ details of the selected schedule.</P>
 \r
 <P>Each schedule consists of the basic details such as a name, whether or not it\r
 is enable and a comment. In addition, a start date and time is specified (before \r
-which the schedule has no effect), and optionally and end date and time (after\r
+which the schedule has no effect), and optionally an end date and time (after\r
 which the schedule has no effect).</P>\r
 \r
 <P><center><img src="images/pgagent-scheduledetails1.png" alt="Step details - properties tab"></center></P>\r
 \r
-<P>Schedules are specified using a cron-style format, For each selected time or \r
+<P>Schedules are specified using a cron-style format. For each selected time or \r
 date element, the schedule will execute. For example, to execute at 5 minutes \r
 past every hour, simply tick '5' in the <I>Minutes</I> list box. Values from more than\r
 one field may be specified in order to further control the schedule. For example, \r
@@ -44,8 +44,8 @@ last day of the month, whether it happens to be the 28th, 29th, 30th or 31st.</P
 \r
 <P>On occasion it may be desirable to specify an exception for a schedule - for \r
 example, you may not want a schedule to fire on a particular national holiday.\r
-To achieve this, each schedule may have a list of dates and or time exceptions\r
-attached to it. If an schedule lands on an exception, that instance will be\r
+To achieve this, each schedule may have a list of date and/or time exceptions\r
+attached to it. If a schedule lands on an exception, that instance will be\r
 skipped, and the following occurance will become the next runtime.</P>\r
 \r
 <P><center><img src="images/pgagent-scheduledetails3.png" alt="Step details - exceptions tab"></center></P>\r
index 95901d1264e6adaca7fb3156bdb9c617784880e0..2670e4b320c790c2139c78e953ca336e8aa8a4e8 100644 (file)
@@ -76,9 +76,9 @@ END</pre>
 <pre class="screen">DECLARE @I, @J, @T, @G;
 SET @I = 0;
 SET @G1 = INTEGER(10, 29, 1); /* Random integer generator
-                             Unique numbers beetween 10 and 29 */
+                             Unique numbers between 10 and 29 */
 SET @G2 = STRING(10, 20, 3); /* Random string generator
-                             3 words beetween 10 and 20 characters */
+                             3 words between 10 and 20 characters */
 WHILE @I &lt; 20
 BEGIN
     SET @T = 'table' + CAST (@I AS STRING);
@@ -168,7 +168,7 @@ PRINT @A; -- Prints an integer between 100 and 200
 PRINT @A; -- Prints another integer between 100 and 200</pre>
 <p>A variable can contain a generator but its type is one of:
     number (real or integer), string. For a list of available generators
-    and their associated type see <a href="#generators">Random data generators</a>.</p>
+    and their associated type, see <a href="#generators">Random data generators</a>.</p>
 <h4><a name="variable2"></a>Records</h4>
 <h5>Record declaration</h5>
 <p>Declaring a record is <strong>required</strong>.
@@ -179,7 +179,7 @@ DECLARE @R3 { @A, @B, @C, @D };         -- One record  with four columns</pre>
 <p>The number of lines is dynamic: see the next section.</p>
 <h5>Record affectation</h5>
 <p>To access a specific location in a record, one must use the line
-    number (starts at 0) and can user either the column name (between
+    number (starts at 0) and can use either the column name (between
     quotes) or the column number (starts at 0). This specific location
     behaves like a simple variable. Note that a record cannot contain a
     record.</p>
@@ -187,7 +187,7 @@ DECLARE @R3 { @A, @B, @C, @D };         -- One record  with four columns</pre>
 SET @R1[0][0] = 1;    -- Same location
 SET @R1[4]['@B'] = 1; -- Fifth line &amp; second column
 SET @R1[0][1] = 1;    -- Same location</pre>
-<p>In the above example three empty lines are automatically
+<p>In the above example, three empty lines are automatically
     inserted between the first and the fifth. Using an invalid column
     number or name results in an exception.</p>
 <p>Specific location can be used as right values as well. A
@@ -197,7 +197,7 @@ SET @A = @R1[1]; -- @A becomes a record which is the first line of @R1</pre>
 <p>Remember that <code>SET @R1[0][0] = @R2</code> is impossible
     because a record cannot contain a record.</p>
 <p>It is possible to assign a record to a variable, in this case
-    the variables does not need to be declared:</p>
+    the variable does not need to be declared:</p>
 <pre class="screen">SET @A = @R3; -- @A becomes a record because it is assigned a record</pre>
 <h5>SQL queries</h5>
 <p>Any SQL query executed returns a record. If the query is a <code>SELECT</code> query then it returns the results of the query. If
@@ -215,12 +215,12 @@ SET @B = INSERT INTO table ...; -- @B is a one-line record if the query succeeds
 SET @A = CAST (@B AS REAL);
 SET @A = CAST (@B AS INTEGER);
 SET @A = CAST (@B AS RECORD);</pre>
-<p>When a record is converted to a string it is converted to its flat
-    representation. When converted to a number the record is first converted
+<p>When a record is converted to a string, it is converted to its flat
+    representation. When converted to a number, the record is first converted
     to a string and then to a number (see string conversion for more
     details).</p>
-<p>When a number is converted to a string it is converted to its
-    string representation. When converted to a record it is converted to a
+<p>When a number is converted to a string, it is converted to its
+    string representation. When converted to a record, it is converted to a
     one-line-one-column record whose value is the number.</p>
 <p>When a string is converted to a number, if the string represents a
     number then this number is returned else an exception is thrown. When
@@ -470,8 +470,8 @@ REGEX ( '[a-z]{1,3}@[0-9]{3}' );</pre>
     </li>
 </ul>
 <p>Note: be careful with spaces because <code>'a {3}'</code> means
-    one <code>a</code> followed by three spaces because the <code>3</code> is about the last character or set of characters which is .</p>
-<p>If you need to use <code>[</code> <code>]</code> <code>\</code> <code>{</code> or <code>}</code> they must be escaped because they are
+    one <code>a</code> followed by three spaces because the <code>3</code> is about the last character or set of characters which is a space in this example.</p>
+<p>If you need to use <code>[</code> <code>]</code> <code>\</code> <code>{</code> or <code>}</code>, they must be escaped because they are
     special characters. Remember to use <strong>double
     backslash</strong>: <code>'\\[{3}'</code> for three <code>[</code>.</p>
 <h5>Strings from dictionary files</h5>
index 93a7d8cdaadb8b85767e92bf9fda4d227ce8f0d0..43bc9ef832fbaf645998de899ee665e20f7118db 100644 (file)
@@ -87,7 +87,7 @@ composed of regular SQL commands but add some enhancements:</p>
        <li>Local variables (<span class="fixed">SET @VARIABLE = 5</span>) </li>
        <li>Random data generators (<span class="fixed">INTEGER(10, 20)</span> or <span class="fixed">REFERENCE(table, column)</span>) </li>
 </ul>
-<p>For more information on the pgScript language please look at the 
+<p>For more information on the pgScript language, please look at the 
 <a href="pgscript.html">pgScript scripting language reference</a>.</p>
 <p>If you want to have help about a SQL command you want to execute,
 you can mark a SQL keyword and select SQL Help from the Help menu,
@@ -115,7 +115,7 @@ from the server to the Data Output page.</p>
 <p>
 In the toolbar combobox you can quickly change your database connection from
 one database to another, without launching another instance of the query tool. 
-Initially, only one database will be available, but by selecting &less;new connection&gt; from 
+Initially, only one database will be available, but by selecting &lt;new connection&gt; from 
 the combobox, you can add another connection to it.
 </p><p>
 <center><img src="images/query-connect.png"></center>
@@ -126,7 +126,7 @@ default, this value will be 100. If the number of rows to retrieve
 from the server exceeds this value, a message box will appear asking
 what to do to prevent retrieval of an unexpected high amount of data.
 You may decide to retrieve just the first rows, as configured with
-tha max rows setting, or retrieving the complete rowset regardless of
+the max rows setting, or retrieving the complete rowset regardless of
 the setting, or abort the query, effectively retrieving zero rows.</p>
 
 <p>If you have queries that you execute often, you can add these to the
index e6279ce74305113db52c27a3473520f06ac312f2..fd120aafc02536cf4ca1d34828afb350e84ab182 100644 (file)
@@ -25,7 +25,7 @@ a report in the Query Tool, select the Quick Report option from the File menu.
 \r
 <P>Each report contains a title and optional notes that can be modified before\r
 the report is produced. In addition, you may select whether or not to include\r
-any SQL that may be relevant to the report you have select.\r
+any SQL that may be relevant to the report you have selected.\r
 </P>\r
 \r
 <P>Reports are generated internally in XML, however pgAdmin can apply an XML\r
index 34e0d2e2b865b530327bc7b6e9205b8f75cfc961..937202f2a48a04c1f9ed2bdcf5a71f3aa3a776b3 100644 (file)
@@ -13,7 +13,7 @@
 <H4>Prerequisites</H4>\r
 <p>\r
 As a prerequisite to running Slony-I on PostgreSQL, the slony modules \r
-xxid and slony1_funcs must be present on all servers that have are to run a\r
+xxid and slony1_funcs must be present on all servers that have to run a\r
 Slony-I replication node. This is usually done by the Slony-I installation routine. \r
 </p>\r
 \r
index 1436d3a9dd5766087e963f93ded33d89234364f0..7e08d9bd15fbc42a79ee834b951dfa905b59391f 100644 (file)
@@ -44,7 +44,8 @@ pgAdmin II for these.</P>
         <LI><P>The <A HREF="reports.html">Report Tool</A> generates
         simple reports from data and objects within your databases.</P>
        <LI><P>The <A HREF="status.html">Server status</A> window will show
-       the currently connected users, locks and the server log of the selected database server.</P>
+       the currently connected users, locks, prepared transactions and the server
+        log of the selected database server.</P>
        <LI><P>The <A HREF="options.html">Options</A> dialogue will allow
        you to configure pgAdmin.</P>
        <LI><P><A HREF="guruhints.html">Guru Hints</A> help you perfect your databases.</P>
@@ -52,7 +53,7 @@ pgAdmin II for these.</P>
 </UL>
 <P>When editing the properties of a database object, pgAdmin will
 support you with help about the underlying PostgreSQL SQL commands,
-if you press the F1 function key. In order for this to work, the <A HREF="options-tab1.html">sql
+if you press the F1 function key. In order for this to work, the <A HREF="options-tab1.html">SQL
 helpsite</A> setting in the <A HREF="options.html">options dialog</A>
 must be set correctly.</P>
 </BODY>