Thread: [Ktutorial-commits] SF.net SVN: ktutorial:[187] trunk/ktutorial/ktutorial-editor/doc/en

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 187
          http://ktutorial.svn.sourceforge.net/ktutorial/?rev=187&view=rev
Author:   danxuliu
Date:     2010-03-24 19:18:06 +0000 (Wed, 24 Mar 2010)

Log Message:
-----------
Minor handbook fixes

Modified Paths:
--------------
    trunk/ktutorial/ktutorial-editor/doc/en/commands.docbook
    trunk/ktutorial/ktutorial-editor/doc/en/installation.docbook
    trunk/ktutorial/ktutorial-editor/doc/en/using.docbook

Modified: trunk/ktutorial/ktutorial-editor/doc/en/commands.docbook
===================================================================

--- trunk/ktutorial/ktutorial-editor/doc/en/commands.docbook	2010-03-23 22:22:03 UTC (rev 186)
+++ trunk/ktutorial/ktutorial-editor/doc/en/commands.docbook	2010-03-24 19:18:06 UTC (rev 187)
@@ -117,7 +117,7 @@
                         </term>
                         <listitem>
                             <para>
-                                <action>Opens the dialog to add a new step to the tutorial</action>
+                                <action>Opens the dialog to add a new step to the tutorial.</action>
                             </para>
                         </listitem>
                     </varlistentry>

Modified: trunk/ktutorial/ktutorial-editor/doc/en/installation.docbook
===================================================================
--- trunk/ktutorial/ktutorial-editor/doc/en/installation.docbook	2010-03-23 22:22:03 UTC (rev 186)
+++ trunk/ktutorial/ktutorial-editor/doc/en/installation.docbook	2010-03-24 19:18:06 UTC (rev 187)
@@ -38,7 +38,7 @@
             <prompt>$</prompt> <userinput><command>make</command></userinput>
         </screen>
 
-        <para>That will create a <filename>build</filename> directory, change to it, prepare the build directory to build KTutorial on it and finally build KTutorial. If <command>cmake</command> complains, you have to install the required dependencies asked in the error message.</para>
+        <para>That will create a <filename class="directory">build</filename> directory, change to it, prepare the build directory to build KTutorial on it and finally build KTutorial. If <command>cmake</command> complains, you have to install the required dependencies asked in the error message.</para>
 
         <para>To install KTutorial, become root user and run:</para>
 

Modified: trunk/ktutorial/ktutorial-editor/doc/en/using.docbook
===================================================================
--- trunk/ktutorial/ktutorial-editor/doc/en/using.docbook	2010-03-23 22:22:03 UTC (rev 186)
+++ trunk/ktutorial/ktutorial-editor/doc/en/using.docbook	2010-03-24 19:18:06 UTC (rev 187)
@@ -36,11 +36,11 @@
 
         <para>On the other hand, scripted tutorials are external data to the application. When an application that supports KTutorial starts, it looks for scripted tutorials in some specific directories and loads those found. If you add new scripted tutorials to the directories, the next time the application starts they will be available. You don't have to compile again the application, not even to reinstall it.</para>
 
-        <para>Scripted tutorials are looked for in the <filename>tutorials/</filename> subdirectory of the application data directory. The application data directory is <filename>KDE_PREFIX/share/apps/applicationName/</filename>. Special cases aside, the <emphasis>KDE_PREFIX</emphasis> can be the KDE installation prefix (usually <filename>/usr/</filename>) or the user KDE4 configuration directory (<filename>/home/userName/.kde4/</filename>).</para>
+        <para>Scripted tutorials are looked for in the <filename class="directory">tutorials/</filename> subdirectory of the application data directory. The application data directory is <filename class="directory">KDE_PREFIX/share/apps/applicationName/</filename>. Special cases aside, the <emphasis>KDE_PREFIX</emphasis> can be the &kde; installation prefix (usually <filename class="directory">/usr/</filename>) or the user &kde; configuration directory (<filename class="directory">/home/userName/.kde4/</filename>).</para>
 
         <para>When the scripted tutorial is part of an application (it is installed with the rest of the application data when the application is installed), the strings in the scripted tutorial can be extracted to be localized before the installation like any other string in the C++ code, as explained in KTutorial documentation. Scripted tutorials that are added after the application was installed, however, can not be localized, as KTutorial uses the same translation file as the rest of the application where it is used.</para>
 
-        <para>As you may have guessed already, KTutorial editor creates scripted tutorials. Right now, only Javascript is supported, as KDE libraries offer out of the box support for Javascript scripts. Python or Ruby, on the other hand, require some specific packages to be installed in the system.</para>
+        <para>As you may have guessed already, &ktutorial-editor; creates scripted tutorials. Right now, only Javascript is supported, as &kde; libraries offer out of the box support for Javascript scripts. Python or Ruby, on the other hand, require some specific packages to be installed in the system.</para>
     </sect1>
 
     <sect1 id="main-window">
@@ -114,7 +114,7 @@
         <sect2 id="edition-dialogs-step">
             <title>Step edition</title>
 
-            <para>The step data dialog is used to set the id and text of a tutorial. The id and text are mandatory properties, as the id is used by other steps to change to this step, and the text is shown to the user to explain him what must be done. Thus, the id must be unique for every step in the same tutorial.</para>
+            <para>The step data dialog is used to set the id and text of a step. The id and text are mandatory properties, as the id is used by other steps to change to this step, and the text is shown to the user to explain him what must be done. Thus, the id must be unique for every step in the same tutorial.</para>
             <para>The step data dialog is also shown when a new step is added. If the dialog is accepted, the step is added. If the dialog is cancelled, the step is not added.</para>
             <para>Also note that, in every tutorial, there must be one step with id <emphasis>start</emphasis>, so KTutorial knows where to start the tutorial.</para>
 
@@ -137,7 +137,7 @@
         <sect2 id="edition-dialogs-reaction">
             <title>Reaction edition</title>
 
-            <para>The reaction dialog is used to set the trigger and response of a step. The trigger and response are mandatory properties, as they define how the reaction behaves.</para>
+            <para>The reaction dialog is used to set the trigger and response of a reaction. The trigger and response are mandatory properties, as they define how the reaction behaves.</para>
             <para>The trigger can be either an option selected or a condition met, but not both. If the trigger type is the option, its name will be shown to the user in the step and the response will be executed when the user selects it. If the type is the condition, the response will be executed when the condition is met.</para>
             <para>Likely, the response can be changing to another step or executing some custom code, but not both. If the response type is the custom code, it will be used as the body of a function called when the reaction is triggered. Again, the signature of the function is automatically provided and you have to set only the body.</para>
 
@@ -158,7 +158,7 @@
 
                 <para>The condition that acts as a trigger of a reaction can be a simple condition or a composed condition. Simple conditions wait for something to happen, like a signal emitted by an object. Composed conditions wait for its child conditions. For example, waiting until a signal is emitted by an object or an event is received in another object, whatever comes first.</para>
                 <para>Due to this, conditions are represented in a tree, and it also affects how they are edited.</para>
-                <para>A condition can be added as the root condition when there are no other conditions set, or as a child of the selected composed condition, but not when a simple condition is selected. When a new condition is added, you must select its type. Note that the type of the condition can not be changed later, you will have to remove the condition.</para>
+                <para>A condition can be added as the root condition when there are no other conditions set, or as a child of the selected composed condition, but not when a simple condition is selected. When a new condition is added, you must select its type. Note that the type of the condition can not be changed later, you will have to remove the condition and set a new one.</para>
 
                 <screenshot>
                     <screeninfo>The dialog to select the type of the new condition to add</screeninfo>
@@ -184,7 +184,7 @@
         <title>Exporting the tutorial</title>
 
         <para>Once you have finished designing the tutorial you can export it to a scripted tutorial. To do this, just use <menuchoice><guimenu>File</guimenu><guimenuitem>Export...</guimenuitem></menuchoice>, select where to save the file and you are done. Remember that you have to export the file to some specific directory to be found by KTutorial, as explained in <xref linkend="understanding-ktutorial"/>.</para>
-        <para>The export dialog supports exporting to remote directories (via FTP, SSH, etc), although it will be very strange that you need to use that.</para>
+        <para>The export dialog supports exporting to remote directories (via <acronym>FTP</acronym>, <acronym>SSH</acronym>, etc), although it will be very strange that you need to use that.</para>
     </sect1>
 
     <sect1 id="command-line-options">
@@ -193,7 +193,7 @@
         <para>Though &ktutorial-editor; will be usually started from the &kde; program menu, or a desktop icon, it can also be opened from the command line prompt of a terminal window. There are a few options that are available when doing this.</para>
 
         <sect2 id="other-command-line-options">
-            <title>Default KDE4 Command Line Options</title>
+            <title>Default &kde; Command Line Options</title>
 
             <para>The following command line help options are available:</para>
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




Thread: [Ktutorial-commits] SF.net SVN: ktutorial:[187] trunk/ktutorial/ktutorial-editor/doc/en

ktutorial-commits