GNOME.org
 

[polari] A number of small fixes to match the GNOME Docs style guide.

commit df7aa8351703b5a2a3e1c02a3515610cf6a33912
Author: Paul Cutler <paul r cutler gmail com>
Date:   Mon Mar 20 08:21:25 2017 -0500

    A number of small fixes to match the GNOME Docs style guide.
    
    Fix all lines in all documents to be 80 characters or less.  Change the word Click to Press when a user 
presses a gui button.  Use a dash in locations, such as top-right.

 help/C/index.page                  |    4 +++-
 help/C/introduction.page           |    7 +++++--
 help/C/irc-commands.page           |    9 +++++----
 help/C/irc-join-room.page          |   15 +++++++++------
 help/C/irc-nick-password.page      |   17 +++++++++--------
 help/C/irc-start-conversation.page |   21 ++++++++++++---------
 help/C/network-connect.page        |   36 +++++++++++++++++++++---------------
 help/C/overview.page               |    9 +++++----
 8 files changed, 69 insertions(+), 49 deletions(-)
---
diff --git a/help/C/index.page b/help/C/index.page
index 5d3af82..e3c2fff 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -24,7 +24,9 @@
   </license>
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
-    <desc><app>Polari</app> is a clean, simple, and minimal Internet Relay Chat (IRC) client which 
completely integrates with the GNOME desktop. Learn more about Polari.</desc>
+    <desc><app>Polari</app> is a clean, simple, and minimal Internet Relay Chat 
+    (IRC) client which integrates with the GNOME desktop. 
+    Learn more about Polari.</desc>
   </info>
 
   <title>
diff --git a/help/C/introduction.page b/help/C/introduction.page
index 499e0eb..0322664 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -22,13 +22,16 @@
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
-    <desc>An introduction to <app>Polari</app>, a clean, minimal IRC client.</desc>
+    <desc>An introduction to <app>Polari</app>, a clean, minimal IRC client.
+    </desc>
   </info>
 
   <title>Introduction</title>
 
   <p>
-    <app>Polari</app> is a simple Internet Relay Chat (IRC) client which integrates with the GNOME desktop 
and enables you to chat with people around the world through large chatrooms or private messaging.
+    <app>Polari</app> is a simple Internet Relay Chat (IRC) client which 
+    integrates with the GNOME desktop and enables you to chat with people 
+    around the world through large chatrooms or private messaging.
   </p>
 
   <media type="image" mime="image/png" src="images/polari-screenshot.png">
diff --git a/help/C/irc-commands.page b/help/C/irc-commands.page
index f598d78..e4f1646 100644
--- a/help/C/irc-commands.page
+++ b/help/C/irc-commands.page
@@ -22,13 +22,14 @@
 
   <title>Supported IRC commands</title>
   <p>
-    To see the list of the supported IRC commands, in a chat room type <input>/help</input>
-    and press <key>Enter</key>.
+    To see the list of the supported IRC commands, in a chat room type 
+    <input>/help</input> and press <key>Enter</key>.
   </p>
   <note>
     <p>
-      All commands available will be listed and you can type <input> /help commandname</input>
-      to get additional help with a specific command.
+      All commands available will be listed and you can type 
+      <input>/help commandname</input> to get additional help with a specific 
+      command.
     </p>
   </note>
 </page>
diff --git a/help/C/irc-join-room.page b/help/C/irc-join-room.page
index 40dd171..4a3c4f1 100644
--- a/help/C/irc-join-room.page
+++ b/help/C/irc-join-room.page
@@ -20,21 +20,24 @@
 
   <title>Join an IRC chat room</title>
 
-  <p>You can join IRC chat rooms (also known as IRC channels) on any IRC network you are
-  connected to.  To connect to an IRC network, see <link xref="network-connect"/>.</p>
+  <p>You can join IRC chat rooms (also known as IRC channels) on any IRC 
+  network you are connected to.  To connect to an IRC network, 
+  see <link xref="network-connect"/>.</p>
 
   <p>To join an IRC chat room:</p>
 
   <steps>
     <item>
-      <p>Click on the <key>+</key> in the top left corner.</p>
+      <p>Press <key>+</key> in the top-left corner.</p>
     </item>
     <item>
-      <p>Enter the name of the chat room you would like to join or select the chat room(s) from the list and
-      then press <gui>Join</gui>.  You can select multiple rooms from the list to join.</p>
+      <p>Enter the name of the chat room you would like to join or select 
+      the chat room(s) from the list and then press <gui>Join</gui>.  
+      You can select multiple rooms from the list to join.</p>
      </item>
      <item>
-       <p>Click the <gui>Join</gui> button to connect to the chat room or rooms.</p>
+       <p>Click the <gui>Join</gui> button to connect to the chat room or rooms.
+       </p>
      </item>
   </steps>
 </page>
diff --git a/help/C/irc-nick-password.page b/help/C/irc-nick-password.page
index e6e544e..681fc88 100644
--- a/help/C/irc-nick-password.page
+++ b/help/C/irc-nick-password.page
@@ -29,11 +29,12 @@
   and identify yourself.  Some IRC chat rooms may not allow you to join without
   a registered nickname.</p>
 
-  <p><app>Polari</app> does not currently support nickname registration automatically.
-  Every IRC network handles registering a specific nickname differently and you will
-  need to check with the IRC network on how to register your nickname.
-  After you have registered a nickname, you will need to message NickServ to identify
-  yourself after connecting to the IRC Network with the following command: </p>
+  <p><app>Polari</app> does not currently support nickname registration 
+  automatically.  Each IRC network handles registering a specific nickname 
+  differently and you will need to check with the IRC network on how to 
+  register your nickname.  After you have registered a nickname, you will 
+  need to message NickServ to identify yourself after connecting to the 
+  IRC Network with the following command: </p>
   <steps>
     <item>
       <p><input>/msg NickServ identify username password</input></p>
@@ -48,9 +49,9 @@
     </p>
   </note>
 
-  <p><app>Polari</app> will remember your username and password and the next time
-  you connect to the IRC network <gui>Polari</gui> will automatically register you
-  with the Nickserv service.</p>
+  <p><app>Polari</app> will remember your username and password and the next 
+  time you connect to the IRC network <gui>Polari</gui> will automatically 
+  register you with the Nickserv service.</p>
 
 
   <note>
diff --git a/help/C/irc-start-conversation.page b/help/C/irc-start-conversation.page
index d134800..65725fe 100644
--- a/help/C/irc-start-conversation.page
+++ b/help/C/irc-start-conversation.page
@@ -34,7 +34,8 @@
     </item>
     <item>
       <p>Information about the user, including their name and the last time they
-      were active in the channel, will appear.  Click <gui>Message</gui> to start a private conversation.
+      were active in the channel, will appear.  Click <gui>Message</gui> to 
+      start a private conversation.
       </p>
     </item>
   </steps>
@@ -43,22 +44,24 @@
 
   <steps>
     <item>
-      <p>In the upper right hand corner of <app>Polari</app> a number is displayed
-      that shows the total number of users in the chat room.  Click on the number.
+      <p>In the upper-right hand corner of <app>Polari</app> a number is 
+      displayed that shows the total number of users in the chat room.  
+      Click on the number.
       </p>
     </item>
     <item>
-      <p>Select the name of the user you want to message.  Information about the user,
-      including their name and the last time they were active in the channel, will appear.</p>
+      <p>Select the name of the user you want to message.  Information about 
+      the user, including their name and the last time they were active in 
+      the channel, will appear.</p>
     </item>
     <item>
-      <p>Click <gui>Message</gui> to start a private conversation.</p>
+      <p>Press <gui>Message</gui> to start a private conversation.</p>
     </item>
   </steps>
 
-    <p>A new private conversation will start and a chat room will be started. The chat room
-    will be shown in the left sidebar of <app>Polari</app> with the name of the person
-    you are chatting with.
+    <p>A new private conversation will start and a chat room will be created. 
+    The chat room will be shown in the left sidebar of <app>Polari</app> 
+    with the name of the person you are chatting with.
     </p>
 
 
diff --git a/help/C/network-connect.page b/help/C/network-connect.page
index 2f0ec48..eca07a1 100644
--- a/help/C/network-connect.page
+++ b/help/C/network-connect.page
@@ -23,38 +23,44 @@
 
   <title>Connect to an IRC Network</title>
 
-    <p>The first time you start <app>Polari</app> you will be asked to join a network.
-    Polari comes with over fifty IRC networks configured for you.   Choose the IRC Network
-    you would like to connect to and click on it.
+    <p>The first time you start <app>Polari</app> you will be asked to join a 
+    network.  <app>Polari</app> comes with over fifty IRC networks configured 
+    for you.  Choose the IRC Network you would like to connect to and click 
+    on it.
     </p>
 
-    <p>If you do not see the IRC network you would like to join, you can also enter the details of
-    the IRC network.  Click the <gui>Custom Network</gui> button and enter the <gui>Server Address</gui>.
-    You can optionally enter the name of the network as you want it to appear in the list of networks
-    in the <gui>Network Name</gui> field.
+    <p>If you do not see the IRC network you would like to join, you can also 
+    enter the details of the IRC network.  Click the <gui>Custom Network</gui> 
+    button and enter the <gui>Server Address</gui>.  You can optionally 
+    enter the name of the network as you want it to appear in the list of 
+    networks in the <gui>Network Name</gui> field.
     </p>
 
-    <p>After you have connected to an IRC Network, you can also connect to other IRC Networks.
+    <p>After you have connected to an IRC Network, you can also connect to 
+    other IRC Networks.
     </p>
 
   <steps>
     <item>
-        <p>Click on the <key>+</key> in the top left corner.</p>
+        <p>Press on the <key>+</key> in the top left corner.</p>
     </item>
     <item>
-        <p>Click <gui>Add Network</gui> and select the IRC network from the list you would like to join
-        or click on <gui>Custom Network</gui> and enter the details.</p>
+        <p>Press <gui>Add Network</gui> and select the IRC network from the 
+        list you would like to join or press <gui>Custom Network</gui> and 
+        enter the details.</p>
     </item>
     <item>
-        <p>Enter the name of the chat room you would like to join or select the chat room(s) from the list 
and
-        then press <gui>Join</gui>.</p>
+        <p>Enter the name of the chat room you would like to join or 
+        select the chat room(s) from the list and then press 
+        <gui>Join</gui>.</p>
     </item>
     <item>
-        <p>Click the <gui>Join</gui> button to connect to the room or rooms.</p>
+        <p>Press the <gui>Join</gui> button to connect to the room or rooms.</p>
     </item>
   </steps>
 
-  <note><p>If the IRC network you are connecting to uses a custom port, you can append it to the name of the 
network with a
+  <note><p>If the IRC network you are connecting to uses a custom port, 
+  you can append it to the name of the network with a
   colon and the port number, for example <em>irc.example.org:12345</em></p>
   </note>
 </page>
diff --git a/help/C/overview.page b/help/C/overview.page
index 5be660b..69d61d3 100644
--- a/help/C/overview.page
+++ b/help/C/overview.page
@@ -22,10 +22,11 @@
 
   <p>
     Internet Relay Chat (IRC) is a means of chatting with people online using
-    public and private chatrooms.  IRC networks, such as Freenode or Gimpnet, are unique
-    and host their own servers with its own channels.  IRC uses a client / server model
-    where you can use a client, such as Polari, to connect to an IRC server on and join a channel.
-    Channels, also known as chat rooms, are where users meet online to chat.
+    public and private chatrooms.  IRC networks, such as Freenode or Gimpnet, 
+    are unique and host their own servers with its own channels.  IRC uses 
+    a client / server model where you can use a client, such as Polari, to 
+    connect to an IRC server and join a channel.  Channels, also known 
+    as chat rooms, are where users meet online to chat.
 
   </p>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]