[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    branches/extragear/kde3/graphics/doc/kst
From:       Yiwen Mao <yiwenv () live ! ca>
Date:       2008-03-01 1:23:59
Message-ID: 1204334639.606848.27770.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 780799 by yiwenmao:

updated

 M  +39 -16    extensions-chapter.docbook  


--- branches/extragear/kde3/graphics/doc/kst/extensions-chapter.docbook \
#780798:780799 @@ -43,7 +43,7 @@
 <title>ELOG Browser</title>
 <para>
 To view existing logbook through Kst, choose <guimenuitem>Lanuch ELOG \
                Browser...</guimenuitem> from the <guimenu>File</guimenu> menu.
-If it is not automatically linked to the elog sever, manually type the logbook URL \
in the address box, i.e URL: http://yourhostname/logbookname:8080(or other port you \
started the elog) +
 </para>
 
 <screenshot>
@@ -65,8 +65,8 @@
 Add an ELOG Entry
 </title>
 <para>
-To add an entry to the logbook, choose Add ELOG Entry.. in the File meun.
-This will generate a dialog which allows the user to provide information for \
attributes as well as write the contents of the log message. Information for Author \
and Type is essential. This dialog also allows the user to change the configuration \
of the ELOG setting. +To add an entry to the logbook, choose Add ELOG Entry.. in the \
<guimenu>File</guimenu> meun. +This will generate a dialog which allows the user to \
provide information for attributes as well as to write the contents of the log \
message. Information for <userinput>Author</userinput> and \
<userinput>Type</userinput> is essential. This dialog also allows the user to change \
the configuration of the ELOG setting.  </para>
 
 <screenshot>
@@ -121,8 +121,8 @@
 Click <guibutton>Configuration...</guibutton> will open the <link \
linkend="extensions-elog-settings">Configuration dialog</link>  </para>
 
+<para>Finally, click on <guibutton>Submit</guibutton> to submit the message to the \
logbook.</para>  
-
 <tip>
 <para>
 To quickly view elog browser and add an entry to logbook, just click the \
<inlinemediaobject> @@ -133,7 +133,8 @@
 <phrase>ELOG Browser</phrase>
 </textobject>
 </inlinemediaobject>
-<guiicon>Launch ELOG Browse</guiicon> and <inlinemediaobject>
+to launch ELOG browser and 
+<inlinemediaobject>
 <imageobject>
 <imagedata fileref="Screenshot-kst-extensions-elogentryicon.png" format="PNG" />
 </imageobject>
@@ -141,7 +142,7 @@
 <phrase>Entry Icon</phrase>
 </textobject>
 </inlinemediaobject>
-<guiicon>Add ELOG Entry icons</guiicon> in the tool bar.
+to add an ELOG entry.
 </para>
 </tip>
 
@@ -151,7 +152,7 @@
 <sect2 id="extensions-elog-settings">
 <title>Server and Logging Settings</title>
 <para>
-Server and logging settings should be configured if ELOG functionality is enabled \
for an event monitor object. To configure logging settings, click the \
<guibutton>Configure...</guibutton> button in the <guilabel>ELOG</guilabel> section \
of the Event Monitor dialog. The ELOG Event Entry dialog should be displayed: +Server \
and logging settings should be configured if ELOG functionality is enabled for an \
<link linkend="data-types-eventmonitors">event monitor object</link>. To configure \
logging settings, click the <guibutton>Configure...</guibutton> button in the \
<guilabel>ELOG</guilabel> section of the Event Monitor dialog. The ELOG Event Entry \
dialog should be displayed:  </para>
 
 <screenshot>
@@ -173,11 +174,27 @@
 
 <para>
 Use the three checkboxes at the bottom to select the type of information to be \
                logged.
-<guilabel>Include Kst capture</guilabel> specifies that a screen capture of the
-currently active window should be included in the entry.  <guilabel>Include Kst \
                configuration file</guilabel>
-specifies that <filename>*.kst</filename> save file should be attached to the entry. \
                Finally, if
-<guilabel>Include Kst debugging information</guilabel> is checked, a copy of the
+<itemizedlist>
+
+<listitem><para>
+<userinput><guilabel>Include Kst capture</guilabel></userinput> specifies that a \
screen capture of the +currently active window should be included in the entry. 
+</para></listitem>
+
+<listitem><para>
+<userinput><guilabel>Include Kst configuration file</guilabel></userinput>
+specifies that <filename>*.kst</filename> save file should be attached to the entry. \
 +</para></listitem>
+
+<listitem><para>
+<userinput><guilabel>Include Kst debugging information</guilabel></userinput> is \
checked, a copy of the  <link linkend="settings-debuglog">debug log</link> will be \
attached to the entry as well. +</para></listitem>
+
+</itemizedlist>
+
+ 
+
 </para>
 
 <para>
@@ -293,19 +310,24 @@
 can be used to send a test logbook entry.  Click <guibutton>Close</guibutton> to \
exit the dialog.  </para>
 
-<tip>
-<para>Alternatively, users can also use Elog class provided in KstScript to write \
and submit messages in logbook and change the sever and logging settings. See details \
                in the <link linkend="class_ELOG">Elog class \
                documentation</link>.</para>
-</tip>
 
+</sect2>
+
+<sect2 id="extensions-using-elog-class">
+<title>Using ELOG Class in KstScript</title>
+<para>
+Alternatively, you can use ELOG class provided in KstScript to write and submit \
messages in logbook and change the sever and logging settings. See details in the \
<link linkend="class_ELOG">ELOG class documentation</link>. +</para>
+
 <example id="Elog-class-eg">
-<title>Adding an Elog entry through KstScript</title>
+<title>Adding an ELOG entry through KstScript</title>
 <programlisting>
 elog = new ELOG(); //construct a new ELOG object
 elog.port = 8080; //specify the port
 elog.hostname = "localhost"; //specify the hostname;
 elog.logbook = "demo"; // specify the logbook;
 elog.text = "message"; //write the message;
-elog.addAttribute("Author", "author"); //specify the author of the log entry
+elog.addAttribute("Author", "Kst"); //specify the author of the log entry
 elog.addAttribute("Type", "Routine"); //specify the the type of the log entry; 
                          //see <link linkend="extensions-elog-entry">explaination \
above</link>.  elog.submit(); //submit this entry
@@ -314,6 +336,7 @@
 </sect2>
 
 
+
 </sect1>
 
 <sect1 id="extensions-kstscript">


[prev in list] [next in list] [prev in thread] [next in thread]