[gnome-terminal/mallard-help: 6/69] help: review



commit eaf907a1dc45ea9474bed25b1df2f05a4b133618
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Tue Jan 8 19:51:19 2013 +0000

    help: review
    
    Comments added to the relevant files and some minor fixes.

 help/C/index.page        |    2 ++
 help/C/introduction.page |   23 +++++++++++++++++++++--
 help/C/legal.xml         |    1 +
 3 files changed, 24 insertions(+), 2 deletions(-)
---
diff --git a/help/C/index.page b/help/C/index.page
index c9ad5cb..852ea54 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -12,4 +12,6 @@
     <title>Advanced Settings</title>
   </section>
 
+<!-- It is relatively traditional to have a troubleshooting section here. -->
+
 </page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
index ca8062e..f9a7d24 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -9,6 +9,11 @@
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <link type="guide" xref="index"/>
 
@@ -16,15 +21,29 @@
   </info>
 
   <title>Introduction</title>
+  
+<!-- The application is called <app>Terminal</app> in the menu, so we should
+     use that instead of 'GNOME Terminal'. -->
+
+  <p>GNOME Terminal is a terminal emulator application that you can use to
+  access a UNIX shell environment and run any application available under the
+  GNOME Desktop environment.</p>
 
-  <p>GNOME Terminal is a terminal emulation application that you can use to access a UNIX shell environment and run any application available under GNOME Desktop environment.</p>
+  <p>GNOME <app>Terminal</app> emulates the xterm. In turn, xterm emulates a
+  text terminal with support for escape sequences that control cursor position
+  and colors.</p>
 
- <p>GNOME <app>Terminal</app> emulates the xterm. In turn, xterm emulates a text terminal with support for escape sequences that control cursor position and colors.</p>
+<!-- You are saying here that an emulator is emulating an emulator, which is a
+     bit confusing. Improve the first sentence, maybe even merging it into the
+     second one. -->
 
     <table>
       <tr>
        <td>
         <media type="image" src="figures/gnome-terminal.png" width="700">
+<!-- The screenshot should be only of the application itself, not the whole
+     desktop. You can use the 'Take screenshot' application to automatically
+     take a screenshot only of the selected window. -->
           <p>Screenshot of GNOME <app>Terminal</app></p>
         </media>
        </td>
diff --git a/help/C/legal.xml b/help/C/legal.xml
index e1c4a93..9f1ed73 100644
--- a/help/C/legal.xml
+++ b/help/C/legal.xml
@@ -1,3 +1,4 @@
+<!-- This page needs updating to reflect the new GPL and CC dual licence that we are using. -->
    <legalnotice id="legalnotice">
          <para>
            Permission is granted to copy, distribute and/or modify this



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]