Commit 0b6dd785 authored by Paul Cutler's avatar Paul Cutler Committed by Florian Müllner
Browse files

help: Add user documentation

Provide documentation for the basic feature set, including how
to join a network, joining a room, starting a conversation,
sharing via paste and IRC commands.

Some of the page are based on Empathy's IRC documentation
and initial work from Ankit R Gadiya <ankit4922@gmail.com>

https://bugzilla.gnome.org/show_bug.cgi?id=722498
parent 4a0f7ede
......@@ -4,11 +4,41 @@
id="index">
<info>
<revision pkgversion="3.20" date="2016-05-06" status="stub" />
<title type="text">Polari</title>
<revision pkgversion="3.20" date="2016-08-06" status="stub" />
<revision pkgversion="3.24" version="0.1" date="2017-03-12" status="draft" />
<credit type="author">
<name>Ankit R Gadiya</name>
<email its:translate="no">ankit4922@gmail.com</email>
<years>2016</years>
</credit>
<credit type="author">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 4.0</p>
</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>
</info>
<title>Polari</title>
<title>
<media type="image" mime="image/png" its:translate="no" src="images/Polari.png"/>
Polari
</title>
<section id="connect" style="2column">
<title>Connecting to IRC Servers and Chat Rooms</title>
</section>
<section id="conversations" style="2column">
<title>Conversations</title>
</section>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="introduction">
<info>
<link type="guide" xref="index"/>
<revision pkgversion="3.20" date="2016-08-06" status="stub" />
<revision pkgversion="3.24" version="0.1" date="2017-03-12" status="draft" />
<credit type="author copyright">
<name>Ankit R Gadiya</name>
<email its:translate="no">ankit4922@gmail.com</email>
<years>2016</years>
</credit>
<credit type="author copyright">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
<years>2017</years>
</credit>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<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.
</p>
<media type="image" mime="image/png" src="images/polari-screenshot.png">
<p>Polari IRC Client</p>
</media>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic"
id="irc-commands">
<info>
<link type="guide" xref="index#conversations"/>
<desc>The supported IRC commands.</desc>
<revision pkgversion="3.24" version="0.1" date="2017-03-20" status="draft"/>
<credit type="author">
<name>Milo Casagrande</name>
<email its:translate="no">milo@ubuntu.com</email>
</credit>
<credit type="author">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 4.0</p>
</license>
</info>
<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>.
</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.
</p>
</note>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:e="http://projectmallrd.org/experimental/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="irc-join-room">
<info>
<link type="guide" xref="index#connect"/>
<link type="seealso" xref="network-connect"/>
<desc>Join an IRC channel.</desc>
<revision pkgversion="3.24" version="0.1" date="2016-03-13" status="draft"/>
<credit type="author">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 4.0</p>
</license>
</info>
<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>To join an IRC chat room:</p>
<steps>
<item>
<p>Click on the <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>
</item>
<item>
<p>Click the <gui>Join</gui> button to connect to the chat room or rooms.</p>
</item>
</steps>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:e="http://projectmallard.org/experimental/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task nocando"
id="irc-nick-password">
<info>
<link type="guide" xref="index#connect"/>
<link type="seealso" xref="network-connect"/>
<desc>Protect your nickname to prevent other IRC users from using it.</desc>
<revision pkgversion="3.24" version="0.1" date="2016-03-13" status="draft"/>
<credit type="author">
<name>Milo Casagrande</name>
<email its:translate="no">milo@ubuntu.com</email>
</credit>
<credit type="author">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 4.0</p>
</license>
</info>
<title>Use a nickname password on IRC</title>
<p>On some IRC networks, you can register your nickname with a service called
NickServ. By sending special messages to NickServ, you can set your password
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>
<steps>
<item>
<p><input>/msg NickServ identify username password</input></p>
</item>
<item>
<p>Press <key>Enter</key></p>
</item>
</steps>
<note>
<p>Use the username and password you registered with the IRC network with this
command.
</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>
<note>
<p>These instructions only allow you to use a password-protected nickname
on certain IRC networks. It is not currently possible to register an IRC
nickname or change your nickname password using <app>Polari</app>.</p>
</note>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:e="http://projectmallrd.org/experimental/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="irc-start-conversation">
<info>
<link type="guide" xref="index#conversations"/>
<desc>Start a conversation with an individual in IRC.</desc>
<revision pkgversion="3.24" version="0.1" date="2016-03-13" status="draft"/>
<credit type="author">
<name>Milo Casagrande</name>
<email its:translate="no">milo@ubuntu.com</email>
</credit>
<credit type="author">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 4.0</p>
</license>
</info>
<title>Chat with somebody on IRC</title>
<p>You can hold private conversations with other IRC users, outside of the
public IRC chat rooms. To start a conversation with another IRC user:</p>
<steps>
<item>
<p>Click on the name of the person in the channel you would like to start
a chat with.
</p>
</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.
</p>
</item>
</steps>
<p>Another option to start a conversation with a user:</p>
<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>
</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>
</item>
<item>
<p>Click <gui>Message</gui> to start a private conversation.</p>
</item>
</steps>
<p>A new private conversation will start and 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>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="network-connect">
<info>
<link type="guide" xref="index#connect"/>
<revision pkgversion="3.20" date="2016-08-06" status="stub" />
<revision pkgversion="3.24" version="0.1" date="2017-03-13" status="draft" />
<credit type="author copyright">
<name>Ankit R Gadiya</name>
<email its:translate="no">ankit4922@gmail.com</email>
<years>2016</years>
</credit>
<credit type="author copyright">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
<years>2017</years>
</credit>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<desc>How to connect to an IRC network.</desc>
</info>
<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>
<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>
<steps>
<item>
<p>Click 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>
</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>
</item>
<item>
<p>Click 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
colon and the port number, for example <em>irc.example.org:12345</em></p>
</note>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic"
id="overview">
<info>
<link type="guide" xref="index"/>
<revision pkgversion="3.24" version="0.1" date="2012-11-30" status="draft"/>
<desc>
What IRC is and how you can use it.
</desc>
<credit type="author">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 4.0</p>
</license>
</info>
<title>Overview of Internet Relay Chat</title>
<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.
</p>
</page>
<page xmlns="http://projectmallard.org/1.0/"
xmlns:e="http://projectmallrd.org/experimental/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="irc-send-file">
<info>
<link type="guide" xref="index#conversations"/>
<desc>How to easily share multiple lines of text or images.</desc>
<revision pkgversion="3.24" version="0.1" date="2012-11-30" status="draft"/>
<credit type="author copyright">
<name>Paul Cutler</name>
<email its:translate="no">pcutler@gnome.org</email>
<years>2017</years>
</credit>
<license>
<p>Creative Commons Share Alike 4.0</p>
</license>
</info>
<title>Share text or images</title>
<p>It is considered rude in IRC to copy and paste more than five lines of text.
If you attempt to paste more than five lines of text, <gui>Polari</gui> will ask you if you
would like the text to automatically be pasted to a public paste service. If you agree to paste
the text, press the <gui>Paste</gui> button as seen in the following screenshot. After pressing
<gui>Paste</gui>, the link to the paste website will be automatically entered into the chat box.
Press <key>Enter</key> to share the link with the chat room.
</p>
<media type="image" mime="image/png" src="images/polari-paste.png"/>
<p>To share an image file, drag and drop the image from <app>Files</app> into the chat box
in <app>Polari</app> or drag and drop a file from <app>Files</app> to <app>Polari</app>.
You will be asked if you wish to upload the image to a public paste service.
If you agree to upload the image, press the <gui>Paste</gui> button as seen in the following screenshot.
After pressing <gui>Paste</gui>, the link to the where the image was uplaoded will be automatically
entered into the chat box. Press <key>Enter</key> to share the link with the chat room.
</p>
</page>
......@@ -4,6 +4,19 @@ HELP_ID=$(APP_ID)
HELP_FILES = \
index.page \
legal.xml
introduction.page \
irc-commands.page \
irc-join-room.page \
irc-nick-password.page \
irc-start-conversation.page \
legal.xml \
network-connect.page \
overview.page \
sharing.page
HELP_MEDIA = \
images/polari-paste.png \
images/polari-screenshot.png \
images/Polari.png
HELP_LINGUAS = cs de es fr hu pt_BR sv
gnome.yelp(app_id,
sources: ['index.page', 'legal.xml'],
sources: ['index.page',
'introduction.page',
'irc-commands.page',
'irc-join-room.page',
'irc-nick-password.page',
'irc-start-conversation.page',
'legal.xml',
'network-connect.page',
'overview.page',
'sharing.page'],
media: ['images/polari-paste.png',
'images/polari-screenshot.png',
'images/Polari.png'],
languages: ['cs', 'de', 'fr', 'hu', 'pt_BR', 'sv'])
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