Commit df7aa835 authored by Paul Cutler's avatar Paul Cutler
Browse files

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.
parent 5c912fef
......@@ -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>
......
......@@ -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">
......
......@@ -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>
......@@ -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>
......@@ -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>
......
......@@ -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>
......
......@@ -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>
......@@ -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>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment