SVN Commit by dpage: r4247 - in trunk/pgadmin3: docs/en_US src/agent src/agent/include

Author: dpage
Date: 2005-05-25 08:43:42 +0100 (Wed, 25 May 2005)
New Revision: 4247

Modified:
trunk/pgadmin3/docs/en_US/pgadmin3.hhp.cached
trunk/pgadmin3/docs/en_US/pgagent-jobs.html
trunk/pgadmin3/docs/en_US/pgagent-schedules.html
trunk/pgadmin3/docs/en_US/pgagent-steps.html
trunk/pgadmin3/src/agent/dlgJob.cpp
trunk/pgadmin3/src/agent/dlgSchedule.cpp
trunk/pgadmin3/src/agent/dlgStep.cpp
trunk/pgadmin3/src/agent/include/dlgJob.h
trunk/pgadmin3/src/agent/include/dlgSchedule.h
trunk/pgadmin3/src/agent/include/dlgStep.h
Log:
Display pgAgent docs when requestd. Fix layout.

Modified: trunk/pgadmin3/docs/en_US/pgadmin3.hhp.cached
===================================================================
(Binary files differ)

Modified: trunk/pgadmin3/docs/en_US/pgagent-jobs.html
===================================================================
--- trunk/pgadmin3/docs/en_US/pgagent-jobs.html 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/docs/en_US/pgagent-jobs.html 2005-05-25 07:43:42 UTC (rev 4247)
@@ -17,13 +17,13 @@
which individual jobs are shown. New jobs may be created, and existing
jobs modified in the same way as any other object in pgAdmin.</P>

-<center><img src="images/pgagent-jobdetails.png" alt="Job details"></center>
+<P><center><img src="images/pgagent-jobdetails.png" alt="Job details"></center></P>

<P>The properties tab in the main pgAdmin window will display the
details of the selected job, and the Statistics tab will show the
details of each run of the job.</P>

-<center><img src="images/pgagent-jobstats.png" alt="Job statistics"></center>
+<P><center><img src="images/pgagent-jobstats.png" alt="Job statistics"></center></P>

<P>Job themselves are very simple - the complexity is in the steps and
schedules. When configuring a job, we specify the job name, whether or
@@ -34,7 +34,7 @@
batch/shell steps may need to be targetted to a specific server. A
comment may also be included.</P>

-<center><img src="images/pgagent-jobproperties.png" alt="Job properties"></center>
+<P><center><img src="images/pgagent-jobproperties.png" alt="Job properties"></center></P>

</BODY>
</HTML>

Modified: trunk/pgadmin3/docs/en_US/pgagent-schedules.html
===================================================================
--- trunk/pgadmin3/docs/en_US/pgagent-schedules.html 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/docs/en_US/pgagent-schedules.html 2005-05-25 07:43:42 UTC (rev 4247)
@@ -22,14 +22,14 @@
as a sub-object. The <I>Properties</I> tab of the main pgAdmin window will display
details of the selected schedule.</P>

-<center><img src="images/pgagent-scheduleproperties.png" alt="Schedule properties"></center>
+<P><center><img src="images/pgagent-scheduleproperties.png" alt="Schedule properties"></center></P>

<P>Each schedule consists of the basic details such as a name, whether or not it
is enable and a comment. In addition, a start date and time is specified (before
which the schedule has no effect), and optionally and end date and time (after
which the schedule has no effect).</P>

-<center><img src="images/pgagent-scheduledetails1.png" alt="Step details - properties tab"></center>
+<P><center><img src="images/pgagent-scheduledetails1.png" alt="Step details - properties tab"></center></P>

<P>Schedules are specified using a cron-style format, For each selected time or
date element, the schedule will execute. For example, to execute at 5 minutes
@@ -40,7 +40,7 @@
the <I>Month Days</I> check list includes an extra <I>Last Day</I> option. This matches the
last day of the month, whether it happens to be the 28th, 29th, 30th or 31st.</P>

-<center><img src="images/pgagent-scheduledetails2.png" alt="Step details - days & times tabs"></center>
+<P><center><img src="images/pgagent-scheduledetails2.png" alt="Step details - days & times tabs"></center></P>

<P>On occasion it may be desirable to specify an exception for a schedule - for
example, you may not want a schedule to fire on a particular national holiday.
@@ -48,7 +48,7 @@
attached to it. If an schedule lands on an exception, that instance will be
skipped, and the following occurance will become the next runtime.</P>

-<center><img src="images/pgagent-scheduledetails3.png" alt="Step details - exceptions tab"></center>
+<P><center><img src="images/pgagent-scheduledetails3.png" alt="Step details - exceptions tab"></center></P>

</BODY>
</HTML>

Modified: trunk/pgadmin3/docs/en_US/pgagent-steps.html
===================================================================
--- trunk/pgadmin3/docs/en_US/pgagent-steps.html 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/docs/en_US/pgagent-steps.html 2005-05-25 07:43:42 UTC (rev 4247)
@@ -18,7 +18,7 @@
details of the selected step, and the <I>Statistics</I> tab will display details
of each run of the step, including and output or errors from the script.</P>

-<center><img src="images/pgagent-stepstats.png" alt="Step statistics"></center>
+<P><center><img src="images/pgagent-stepstats.png" alt="Step statistics"></center></P>

<P>Each step consists of the details shown on the screenshot below, most of
which are self-explanatory. If <I>Kind</I> is set to SQL, then it goes without
@@ -27,7 +27,7 @@
controls how failure of this step will affect the
status of the overall job.</P>

-<center><img src="images/pgagent-stepdetails.png" alt="Step details"></center>
+<P><center><img src="images/pgagent-stepdetails.png" alt="Step details"></center></P>

<P>The <I>Definition</I> tab contains a single text box into which the step
script should be entered. For SQL steps, this should be a series of one or more

Modified: trunk/pgadmin3/src/agent/dlgJob.cpp
===================================================================
--- trunk/pgadmin3/src/agent/dlgJob.cpp 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/src/agent/dlgJob.cpp 2005-05-25 07:43:42 UTC (rev 4247)
@@ -486,4 +486,7 @@

}

-
+wxString dlgJob::GetHelpPage() const
+{
+ return wxT("../pgagent-jobs");
+}
\ No newline at end of file

Modified: trunk/pgadmin3/src/agent/dlgSchedule.cpp
===================================================================
--- trunk/pgadmin3/src/agent/dlgSchedule.cpp 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/src/agent/dlgSchedule.cpp 2005-05-25 07:43:42 UTC (rev 4247)
@@ -603,3 +603,8 @@

return res;
}
+
+wxString dlgSchedule::GetHelpPage() const
+{
+ return wxT("../pgagent-schedules");
+}
\ No newline at end of file

Modified: trunk/pgadmin3/src/agent/dlgStep.cpp
===================================================================
--- trunk/pgadmin3/src/agent/dlgStep.cpp 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/src/agent/dlgStep.cpp 2005-05-25 07:43:42 UTC (rev 4247)
@@ -262,3 +262,8 @@
}
return sql;
}
+
+wxString dlgStep::GetHelpPage() const
+{
+ return wxT("../pgagent-steps");
+}
\ No newline at end of file

Modified: trunk/pgadmin3/src/agent/include/dlgJob.h
===================================================================
--- trunk/pgadmin3/src/agent/include/dlgJob.h 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/src/agent/include/dlgJob.h 2005-05-25 07:43:42 UTC (rev 4247)
@@ -29,6 +29,7 @@
wxString GetInsertSql();
pgObject *CreateObject(pgCollection *collection);
pgObject *GetObject();
+ wxString GetHelpPage() const;

private:
pgaJob *job;

Modified: trunk/pgadmin3/src/agent/include/dlgSchedule.h
===================================================================
--- trunk/pgadmin3/src/agent/include/dlgSchedule.h 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/src/agent/include/dlgSchedule.h 2005-05-25 07:43:42 UTC (rev 4247)
@@ -34,6 +34,7 @@
pgObject *CreateObject(pgCollection *collection);
pgObject *GetObject();
void SetJobId(long id) { jobId = id; }
+ wxString GetHelpPage() const;

private:
long jobId;

Modified: trunk/pgadmin3/src/agent/include/dlgStep.h
===================================================================
--- trunk/pgadmin3/src/agent/include/dlgStep.h 2005-05-24 21:37:58 UTC (rev 4246)
+++ trunk/pgadmin3/src/agent/include/dlgStep.h 2005-05-25 07:43:42 UTC (rev 4247)
@@ -32,6 +32,7 @@
pgObject *CreateObject(pgCollection *collection);
pgObject *GetObject();
void SetJobId(long id) { jobId = id; }
+ wxString GetHelpPage() const;

private:
long jobId;