SVN Commit by andreas: r4499 - in trunk/pgadmin3/docs/en_US: . images - Mailing list pgadmin-hackers

Author: andreas
Date: 2005-10-05 11:41:15 +0100 (Wed, 05 Oct 2005)
New Revision: 4499

Removed:
   trunk/pgadmin3/docs/en_US/images/logs.png
Modified:
   trunk/pgadmin3/docs/en_US/connect-error.html
   trunk/pgadmin3/docs/en_US/connect.html
   trunk/pgadmin3/docs/en_US/guruhints.html
   trunk/pgadmin3/docs/en_US/options-tab1.html
   trunk/pgadmin3/docs/en_US/options-tab2.html
   trunk/pgadmin3/docs/en_US/query.html
   trunk/pgadmin3/docs/en_US/status.html
Log:
Doc updates

Modified: trunk/pgadmin3/docs/en_US/connect-error.html
===================================================================
--- trunk/pgadmin3/docs/en_US/connect-error.html    2005-10-05 10:37:04 UTC (rev 4498)
+++ trunk/pgadmin3/docs/en_US/connect-error.html    2005-10-05 10:41:15 UTC (rev 4499)
@@ -16,8 +16,8 @@
 carefully, we're sure they will help you.
 <br>
 <ul>
-<li><a href="#notrunning">could not connect to Server: Connection refused</a>
-<li><a href="#no-hba">FATAL: no pg_hba.conf entry</a>
+<li><a href="hints/conn-listen.html">could not connect to Server: Connection refused</a>
+<li><a href="hints/conn-hba.html">FATAL: no pg_hba.conf entry</a>
 </ul>
 <br>
 </p>

Modified: trunk/pgadmin3/docs/en_US/connect.html
===================================================================
--- trunk/pgadmin3/docs/en_US/connect.html    2005-10-05 10:37:04 UTC (rev 4498)
+++ trunk/pgadmin3/docs/en_US/connect.html    2005-10-05 10:41:15 UTC (rev 4499)
@@ -47,10 +47,18 @@
 status/start/stop keywords to this. Example:<BR>
 sudo /usr/local/pgsql/bin/pg_ctl -D /data/pgsql
 </P>
-<P>If the password for that server is empty, you can unselect the "need password" option. When connecting
-to the database, the password won't be required from you any more. For
-security reasons, passwords are not stored by pgAdmin.</P>
 <P>
+You can unckeck the "Connect now" checkbox if you don't want the connection
+to the server being established immediately, but only registered for later use. In this
+case, the connection parameters won't be validated.
+</P>
+<P>
+If you select "store password", pgAdmin stores passwords you enter in the ~/.pgpass file under *nix or
%APPDATA%\postgresql\pgpass.conf
+under Win32 for later reuse. For details, see <a href='pg/libpq-pgpass.html'>pgpass documentation</a>.
+It will be used for all libpq based tools. If you want the password removed, you can
+select the server's properties and uncheck the selection any time.
+</P>
+<P>
 This dialog can be launched at a later time to correct or add
 parameters by executing "properties" when the server is selected.
 </P>

Modified: trunk/pgadmin3/docs/en_US/guruhints.html
===================================================================
--- trunk/pgadmin3/docs/en_US/guruhints.html    2005-10-05 10:37:04 UTC (rev 4498)
+++ trunk/pgadmin3/docs/en_US/guruhints.html    2005-10-05 10:41:15 UTC (rev 4499)
@@ -14,6 +14,23 @@
 and good performing databases. They are the result of the long experience of the
 developers worldwide, and the design problems commonly observed.
 </p>
+<p>
+If pgAdmin III thinks it has a valuable hint for you, it will pop up a guru hint unless
+you have chosen to suppress that individual hint or all hints (see
+<a href='options-tab2.html'>options</a>). You can bring up the hint by pressing
+the hint button in the toolbar at any time, if enabled.
+</p>
+<center><img src="images/guru-connect.png"></center>
+<p>
+This is an example of a guru hint, as it appears when trying to connect to a
+non-running or misconfigured PostgreSQL server.
+</p>
+<p>
+If you check 'do not show this hint again', the automatic popup of the individual hint will be
+suppressed in the future, until it is reset in the
+<a href='options-tab2.html'>options</a>). Error messages will still appear, but without
+the extended information as privided by the hints.
+</p>
 </body>

 </html>

Deleted: trunk/pgadmin3/docs/en_US/images/logs.png
===================================================================
(Binary files differ)

Modified: trunk/pgadmin3/docs/en_US/options-tab1.html
===================================================================
--- trunk/pgadmin3/docs/en_US/options-tab1.html    2005-10-05 10:37:04 UTC (rev 4498)
+++ trunk/pgadmin3/docs/en_US/options-tab1.html    2005-10-05 10:41:15 UTC (rev 4499)
@@ -33,7 +33,15 @@
    <li><b>HTTP proxy</b>- Use a proxy to access the web. This must be
    provided in the form host:port or left blank if not proxy is
    used.<br> </li>
-   </ul>
+
+   <li><b>System schemas</b>- You can suppress the display of additional schemas,
+   by declaring them a system schema. This field takes a list of comma separated strings.<br> </li>
+
+   <li><b>Slony-I path</b>- To enable pgAdmin III to create Slony-I replication clusters
+   from scratch, you need to enter the path to the Slony-I script installation directory here. If no
+   valid scripts can be found, only joining existing clusters is possible.
+   <br> </li>
+  </ul>
 </p>

 </body>

Modified: trunk/pgadmin3/docs/en_US/options-tab2.html
===================================================================
--- trunk/pgadmin3/docs/en_US/options-tab2.html    2005-10-05 10:37:04 UTC (rev 4498)
+++ trunk/pgadmin3/docs/en_US/options-tab2.html    2005-10-05 10:41:15 UTC (rev 4499)
@@ -43,6 +43,13 @@
    to disable this option to browse the treeview by double clicking
    instead.<br> </li>

+   <li><b>Do not show guru hints; I'm one myself</b> - pgAdmin III pops up
+   hint windows from time to time, if it thinks you might need some support. If you feel
+   annoyed from this, and want to suppress this behaviour, you can check this box.<br> </li>
+
+   <li><b>Reset guru hints</b> - When a guru hint is displayed, you may have selected to suppress
+   it to be shown in the future. If you want the hint to reappear, check this box.<br> </li>
+
 </ul>
 </p>


Modified: trunk/pgadmin3/docs/en_US/query.html
===================================================================
--- trunk/pgadmin3/docs/en_US/query.html    2005-10-05 10:37:04 UTC (rev 4498)
+++ trunk/pgadmin3/docs/en_US/query.html    2005-10-05 10:41:15 UTC (rev 4499)
@@ -23,7 +23,7 @@
 written in UTF-8, which enables the storage of virtually all
 characters used throughout the world, according to the coding rules
 of the <A HREF="http://www.unicode.org/">Unicode Consortium</A>. If
-you select *.*, the setting from the <A HREF="options-tab1.html">read/write
+you select *.*, the setting from the <A HREF="options-tab2.html">read/write
 unicode option</A> is used.</P>
 <P>To execute the query, you select Execute from the Query menu, or
 you press the execute toolbar button, or you press the F5 function
@@ -33,8 +33,12 @@
 want the server to execute.</P>
 <P>Explain from the Query menu, or F7 function key will execute the
 EXPLAIN command. The database server will analyze the query that's
-sent to it, and will return the results. This enables you to find out
-how the query is parsed, optimized and executed. You can modify the
+sent to it, and will return the results.
+</P><P>
+<center><img src="images/query-analyze.png"></center>
+</P><P>
+The result is displayed as text in the Data Output page, and graphically
+visualized on the Explain page. This enables you to find out how the query is parsed, optimized and executed. You can
modifythe 
 degree of inspection by changing the Explain options for this in the
 Query menu.</P>
 <P>In case the query you sent to the server using the Execute or
@@ -66,7 +70,15 @@
 complete. If a dataset was returned, not only the elapsed time for
 server execution is displayed, but also the time to retrieve the data
 from the server to the Data Output page.</P>
-<P>In the <A HREF="options-tab2.html">options dialog</A>, you
+<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> from
+the combobox, you can add another connection to it.
+</P><P>
+<center><img src="images/query-connect.png"></center>
+</P>
+<P>In the <A HREF="options-tab3.html">options dialog</A>, you
 can specify a default limit for the rowset size to retrieve. By
 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
@@ -75,6 +87,5 @@
 tha max rows setting, or retrieving the complete rowset regardless of
 the setting, or abort the query, effectively retrieving zero rows.</P>

-
 </BODY>
 </HTML>

Modified: trunk/pgadmin3/docs/en_US/status.html
===================================================================
--- trunk/pgadmin3/docs/en_US/status.html    2005-10-05 10:37:04 UTC (rev 4498)
+++ trunk/pgadmin3/docs/en_US/status.html    2005-10-05 10:41:15 UTC (rev 4499)
@@ -57,6 +57,17 @@
 </p>
 <BR><BR>
 <BR><BR>
+<center><img src="images/transaction.png"></center>
+<p>
+On a PostgreSQL server running version 8.1 or newer, the Transaction tab allows
+you to view outstanding prepared transactions. Prepared transactions are an aspect
+of Two Phase Commit (2PC), used in distributed transaction managers. Usually,
+prepared transactions are handled by the transaction manager. In case of a failure,
+it might be necessary to commit or rollback a transaction manually; you can use
+the 'Commit' or 'Rollback' buttons to do this.
+</p>
+<BR><BR>
+<BR><BR>
 <center><img src="images/logfile.png"></center>
 <p>
 The Logfile tab shows server log files, if configured in