GNOME.org
 

[gnome-terminal] help: review

commit fe4bf9fbc9b6babefe8172465b13f98da412674f
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Tue Feb 5 23:35:20 2013 +0000

    help: review

 help/C/app-colors.page                   |   23 +++++++++++++++-
 help/C/copy-paste.page                   |    2 +
 help/C/cursor.page                       |   25 +++++++++++++++---
 help/C/introduction.page                 |   11 +++++---
 help/C/{overview1.page => overview.page} |   16 +++++++++--
 help/C/pref-app-background.page          |   22 +++++++++++++---
 help/C/pref-customexit.page              |    3 ++
 help/C/pref-customshells.page            |    2 +
 help/C/pref-encoding.page                |   12 +++++++-
 help/C/pref-profiles.page                |   41 ++++++++++++++++++++++++------
 help/C/pref-titlebyprogram.page          |    2 +
 help/C/reset.page                        |    4 ++-
 help/C/set-title.page                    |    2 +
 help/C/tabbed-terminals.page             |    4 ++-
 help/C/textselection.page                |    3 ++
 15 files changed, 143 insertions(+), 29 deletions(-)
---
diff --git a/help/C/app-colors.page b/help/C/app-colors.page
index 59e4883..f4b31b4 100644
--- a/help/C/app-colors.page
+++ b/help/C/app-colors.page
@@ -9,6 +9,11 @@
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <link type="guide" xref="index#appearence"/>
 
@@ -18,7 +23,21 @@
 
   <title>Set colors</title>
 
-  <p> You have the option of using colors from 1. system theme 2. Selecting from build in schemes (3 colors) 
and 3. Selecting from 16 color preset scheme. You will be able to modify any preset's colors. </p>
-
+<!-- What do these colours affect? How does one edit them? -->
+
+  <p>You have the option of using colors from:</p>
+  <list>
+    <item>
+      <p>system theme</p>
+    </item>
+    <item>
+      <p>Selecting from build in schemes (3 colors)</p>
+    </item>
+    <item>
+      <p>3. Selecting from 16 color preset scheme</p>
+    </item>
+  </list>
+
+  <p>You will be able to modify any color presets.</p>
 
 </page>
diff --git a/help/C/copy-paste.page b/help/C/copy-paste.page
index 8eb42e2..d6444ca 100644
--- a/help/C/copy-paste.page
+++ b/help/C/copy-paste.page
@@ -16,6 +16,8 @@
 
   </info>
 
+<!-- Apply fixes as discussed on 2013-02-05 -->
+
   <title>Copy and paste into <app>Terminal</app></title>
 <p>To copy: left click and drag cursor on the text, press Ctrl + C on keyboard or edit>Copy or shift + ctrl 
+ C </p>
 <p>To paste: press cursor on terminal where ever you want to paste, press ctrl + v or right click and press 
paste or edit > paste or shift + ctrl + v</p>
diff --git a/help/C/cursor.page b/help/C/cursor.page
index 1bd3944..704ed7c 100644
--- a/help/C/cursor.page
+++ b/help/C/cursor.page
@@ -9,15 +9,32 @@
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <link type="guide" xref="index#appearence"/>
 
-    <desc>Select different cursors</desc>
+    <desc>Select different cursor style</desc>
 
   </info>
 
-  <title>Cursor shapes and blinking behaviour</title>
-<p>You can change the cursor shape of your <app>Terminal</app> by selecting <guiseq><gui 
style="menu">Edit</gui><gui style="menuitem">Profile Preferences</gui></guiseq> or press 
<keyseq><key>Alt</key><key>E</key><key>o</key></keyseq></p>
+  <title>Change cursor</title>
+
+<!-- Always use steps for instructions -->
+
+  <p>You can select one of three cursor types in <gui>Terminal</gui>:</p>
+  <steps>
+    <item>
+      <p>Select<guiseq><gui style="menu">Edit</gui>
+      <gui style="menuitem">Profile Preferences</gui></guiseq></p>
+    </item>
+    <item>
+      <p>In the <gui style="tab">General</gui> tab, select the cursor shape
+      from the drop down menu next to <gui>Cursor shape</gui>.</p>
+    </item>
+  </steps>
 
-<p>In the option 'Cursor shape', press the drop down menu for options. You can select from Block, I-beam and 
Underline as your <app>Terminal</app> cursor.</p>
 </page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
index 6202d08..8129175 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -11,20 +11,23 @@
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
-    <credit type="editor">
+    <credit type="copyright editor">
       <name>Ekaterina Gerasimova</name>
       <email>kittykat3756 gmail com</email>
       <years>2013</years>
     </credit>
 
-    <desc>What is a Terminal?</desc>
+    <desc>What is <gui>Terminal</gui>?</desc>
   </info>
 
   <title>Introduction</title>
 
-  <p><app>Terminal</app> is a terminal emulator application for accessing a UNIX shell environment which can 
be used to run programs available on your system. </p>
+  <p><app>Terminal</app> is a terminal emulator application for accessing a
+  UNIX shell environment which can be used to run programs available on your
+  system.</p>
 
-  <p><app>Terminal</app> supports escape sequences that control cursor position and colors.</p>
+  <p><app>Terminal</app> supports escape sequences that control cursor position
+  and colors.</p>
 
   <figure>
     <title>GNOME Terminal</title>
diff --git a/help/C/overview1.page b/help/C/overview.page
similarity index 54%
rename from help/C/overview1.page
rename to help/C/overview.page
index 953de24..d085c8e 100644
--- a/help/C/overview1.page
+++ b/help/C/overview.page
@@ -4,19 +4,29 @@
   <info>
     <revision version="0.1" date="2013-01-10" status="draft"/>
     <link type="guide" xref="index"/>
+
     <credit type="author copyright">
       <name>Sindhu S</name>
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <desc>What is a terminal?</desc>
   </info>
 
-  <title>Overview of <app>Terminal</app></title>
+  <title>Overview of a terminal</title>
 
-  <p><app>Terminal</app> is a terminal emulator for GNOME. A terminal is a text input point in a computer 
also called the Command Line Interface (CLI). A terminal emulator emulates a text terminal inside a GUI 
environment such as GNOME. </p>
+  <p><app>Terminal</app> is a terminal emulator for GNOME. A terminal is a text
+  input point in a computer also called the Command Line Interface (CLI). A
+  terminal emulator emulates a text terminal inside a graphical user interface
+  (GUI) environment such as GNOME.</p>
 
-  <p>A shell is a program that provides an interface to run commands and programs inside a terminal.</p>
+  <p>A shell is a program that provides an interface to run commands and
+  programs inside a terminal.</p>
 
 </page>
diff --git a/help/C/pref-app-background.page b/help/C/pref-app-background.page
index 2cbd7bb..2f32fd3 100644
--- a/help/C/pref-app-background.page
+++ b/help/C/pref-app-background.page
@@ -9,6 +9,11 @@
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
     <link type="guide" xref="index#appearence"/>
 
@@ -17,7 +22,12 @@
   </info>
 
   <title>Change background</title>
-  <p>To change the background of <app>Terminal</app> by selecting <guiseq><gui style="menu">Edit</gui><gui 
style="menuitem">Profile Preferences</gui><gui style="tab">Background</gui></guiseq> or press 
<keyseq><key>Alt</key><key>E</key><key>P</key></keyseq>.</p>
+
+<!-- Use a steps list! -->
+  <p>Change the background of <app>Terminal</app> by selecting
+  <guiseq><gui style="menu">Edit</gui>
+  <gui style="menuitem">Profile Preferences</gui>
+  <gui style="tab">Background</gui></guiseq>.</p>
 
   <terms>
     <title>There are three different options for setting background.
@@ -36,7 +46,11 @@
     </item>
   </terms>
 
-<note><p>Tip: If you have selected an image as your <app>Terminal</app> background, set transparency to 0 
(that is, 'None' level) if you would like to see the image without any transparency from your system's 
background</p>
-</note>
+  <note style="tip">
+    <p>If you have selected an image as your <app>Terminal</app>
+    background, set transparency to 0 (that is, 'None' level) if you would like
+    to see the image without any transparency from your system's background.
+    </p>
+  </note>
 
-</page>
\ No newline at end of file
+</page>
diff --git a/help/C/pref-customexit.page b/help/C/pref-customexit.page
index 83caef3..6bbcf8e 100644
--- a/help/C/pref-customexit.page
+++ b/help/C/pref-customexit.page
@@ -17,6 +17,9 @@
   </info>
 
   <title>Behaviour on program quit or exit</title>
+
+<!-- Are you sure this is what this does? This is not the behaviour that it exhibits for me, although my 
version is slightly out of date. -->
+
   <p>Menu::Edit>Preferences go to "Title and Command" tab and choose from the drop down menu next to "When 
command exits:" . The options are 1. Exit the terminal 2. Restart the command and 3. Hold the terminal open. 
</p>
 
 </page>
diff --git a/help/C/pref-customshells.page b/help/C/pref-customshells.page
index 80a235f..841b068 100644
--- a/help/C/pref-customshells.page
+++ b/help/C/pref-customshells.page
@@ -20,6 +20,8 @@
 
   <p>Go to Menu:: Edit> Profile Preferences > Title and Command tab or alternatively you can press Alt + o 
and click on the "Title and Command" tab.</p>
 
+<!-- Some more instructions and a simpler explanation needed. -->
+
   <p>A shell is software that provides an interface for users of an operating system to invoke or "launch" 
another program; however, shells frequently have additional capabilities such as viewing the contents of 
directories. So the hierarchy is CLI has ( terminal has Shell ) and Terminal emulates those.</p>
   
 </page>
diff --git a/help/C/pref-encoding.page b/help/C/pref-encoding.page
index f7c2bc6..5724baf 100644
--- a/help/C/pref-encoding.page
+++ b/help/C/pref-encoding.page
@@ -18,8 +18,16 @@
 
   <title>Character encoding</title>
 
- <p>Go to Menu:: Terminal > Set Character Encoding and select your character encoding from the menu. Press 
Alt + T + C to reach the menu alternatively.</p>
+<!-- Start by explaining why one may want to edit this. -->
 
- <p>If can add more encodings to the menu by clicking on "Add or Remove" in the menu. Select the encoding 
you want to be added to the menu and click on the right pointing arrow button. If you wish to remove any 
encoding from the menu, select the encoding from the list and click on the left pointing arrow button. </p>
+  <p>Go to Menu:: Terminal > Set Character Encoding and select your character
+  encoding from the menu. Press Alt + T + C to reach the menu
+  alternatively.</p>
+
+  <p>If can add more encodings to the menu by clicking on "Add or Remove" in
+  the menu. Select the encoding you want to be added to the menu and click on
+  the right pointing arrow button. If you wish to remove any encoding from the
+  menu, select the encoding from the list and click on the left pointing arrow
+  button.</p>
 
 </page>
diff --git a/help/C/pref-profiles.page b/help/C/pref-profiles.page
index 7c3daff..1022332 100644
--- a/help/C/pref-profiles.page
+++ b/help/C/pref-profiles.page
@@ -11,21 +11,46 @@
       <email>sindhus live in</email>
       <years>2013</years>
     </credit>
+    <credit type="author copyright editor">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+      <years>2013</years>
+    </credit>
 
-    <desc>How to create, edit and delete <app>Terminal</app> profiles</desc>
+    <desc>Create, edit and delete <app>Terminal</app> profiles</desc>
   </info>
 
-  <title>Manage Profiles</title>
-  <p> Profile is a collection of Terminal settings. Any changes you make to Terminal settings will be stored 
in "Default Profile" unless specified a separate profile. Terminal always opens with the profile "Default 
Setting" unless it has been told to do otherwise.</p>
+  <title>Manage profiles</title>
+
+  <p>A profile is a collection of <gui>Terminal</gui> settings. The default
+  profile is loaded when a new terminal is opened unless you have selected
+  another profile and any changes that you make to the settings will be stored
+  in the selected profile.</p>
+
+<!-- Use lists for instructions. Do not give keyboard shortcut instructions
+     unless the keyboard shortcut will take you directly to the desired dialog.
+     You may want to consider using sections here. -->
 
-  <p>Create New Profile: Menu: File > New Profile. Or use keyboard sequence of Alt + F, then press P. In the 
Profile Name textbox type a name for your new profile and select base settings from available profiles. This 
means your new profile will be populated /filled with settings from existing profile up on which you can make 
changes. Changes will be stored in your new profile and will not affect settings of existing profiles.</p>
+  <p>Create New Profile: Menu: File > New Profile. Or use keyboard sequence of
+  Alt + F, then press P. In the Profile Name textbox type a name for your new
+  profile and select base settings from available profiles. This means your new
+  profile will be populated /filled with settings from existing profile up on
+  which you can make changes. Changes will be stored in your new profile and
+  will not affect settings of existing profiles.</p>
 
-  <p>Edit profiles : by going to Edit >> Profile Preferences option or Edit >> Profiles , select profile you 
want to edit and click Edit button, which will open the Profile Preferences window for profile you had 
selected to edit.</p>
+  <p>Edit profiles : by going to Edit >> Profile Preferences option or Edit >>
+  Profiles , select profile you want to edit and click Edit button, which will
+  open the Profile Preferences window for profile you had selected to edit.</p>
 
-  <p>Delete profile: by going to Edit >> Profiles option. Select profile you want to delete and hit Delete 
button. Exit this window using close or X mark button</p>
+  <p>Delete profile: by going to Edit >> Profiles option. Select profile you
+  want to delete and hit Delete button. Exit this window using close or X mark
+  button</p>
 
-  <p>Set default profile: by going to Edit >> Profiles and selecting Profile in the dropdown menu of 
"Profile used when launching a new terminal"</p>
+  <p>Set default profile: by going to Edit >> Profiles and selecting Profile in
+  the dropdown menu of "Profile used when launching a new terminal"</p>
 
-  <p>Change profile in currently using terminal: Go to Menu:Terminal > Change Profile, select profile you'd 
like. This will change your existing Terminal window to use the profile you have selected.</p>
+  <p>Change profile in currently using terminal: Go to Menu:Terminal > Change
+  Profile, select profile you'd like. This will change your existing Terminal
+  window to use the profile you have selected.</p>
 
 </page>
diff --git a/help/C/pref-titlebyprogram.page b/help/C/pref-titlebyprogram.page
index 1eb1bb5..d1ba69a 100644
--- a/help/C/pref-titlebyprogram.page
+++ b/help/C/pref-titlebyprogram.page
@@ -20,6 +20,8 @@
 
   <p>You can set Terminal to name your Terminal tabs automatically on launch of a command. To enable this go 
to Menu:: Edit > Preferences > Title and Command tab and choose from the options under "When terminal 
commands set their own titles".</p>
 
+<!-- use an item list -->
+
   <p>Replace initial title: Commands that have been executed in Terminal can be allowed to set title of 
Terminal with this option.</p>
 
   <p>Append initial title: Commands executed in Terminal can append their titles to the already set title of 
the Terminal.</p>
diff --git a/help/C/reset.page b/help/C/reset.page
index 65f755d..5574ddc 100644
--- a/help/C/reset.page
+++ b/help/C/reset.page
@@ -18,4 +18,6 @@
 
   <title>Reset changes</title>
 
-</page>
\ No newline at end of file
+<!-- link this to profile page -->
+
+</page>
diff --git a/help/C/set-title.page b/help/C/set-title.page
index 82ca413..f41d7a0 100644
--- a/help/C/set-title.page
+++ b/help/C/set-title.page
@@ -18,5 +18,7 @@
 
   <title>Set title</title>
 
+<!-- this is the same as pref-titlebyprogram.page, one page is enough to cover
+     both points -->
 
 </page>
diff --git a/help/C/tabbed-terminals.page b/help/C/tabbed-terminals.page
index 888d38b..e8d65e5 100644
--- a/help/C/tabbed-terminals.page
+++ b/help/C/tabbed-terminals.page
@@ -16,7 +16,9 @@
   </info>
 
   <title>Multiple sessions</title>
-  
+
+<!-- Page needs to be renamed if it is about new tabs *and* new windows. -->
+
   <p>Open a tab: Click Menu:File > Open tab and select profile among those listed. This will create a new 
terminal tab inside your existing Terminal window with the selected profile. </p>
 
   <p>Open a window: Click Menu:File > Open Terminal and select profile among those listed. This will create 
a new Terminal window on your desktop with the selected profile. </p>
diff --git a/help/C/textselection.page b/help/C/textselection.page
index 85b6882..122d676 100644
--- a/help/C/textselection.page
+++ b/help/C/textselection.page
@@ -19,4 +19,7 @@
   <title>Selecting text</title>
 <!-- TODO: Should I include "Select-by-word" option here? -->
 
+<!-- If the instructions are different for each type of selection and consist
+     of more than manually highlighting the relevant section, then yes. -->
+
 </page>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]