GNOME.org
 

[polari/docs: 5/5] Update last commit, Mallard pages weren't added.

commit fc86cb1094db547acfbaab80ef360c451ed4c8db
Author: Paul Cutler <paul r cutler gmail com>
Date:   Mon Mar 13 15:32:58 2017 -0500

    Update last commit, Mallard pages weren't added.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=722498

 help/C/account-irc.page            |  162 ++++++++++++++++++++++++++++++++++++
 help/C/irc-commands.page           |   33 +++++++
 help/C/irc-join-room.page          |   43 ++++++++++
 help/C/irc-nick-password.page      |   60 +++++++++++++
 help/C/irc-start-conversation.page |   48 +++++++++++
 help/C/network-connect.page        |   56 ++++++++++++
 help/C/overview.page               |   32 +++++++
 help/C/sharing.page                |   41 +++++++++
 8 files changed, 475 insertions(+), 0 deletions(-)
---
diff --git a/help/C/account-irc.page b/help/C/account-irc.page
new file mode 100644
index 0000000..4b4b927
--- /dev/null
+++ b/help/C/account-irc.page
@@ -0,0 +1,162 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="topic" style="screen"
+      id="account-irc">
+
+  <info>
+    <link type="guide" xref="irc-manage#manage"/> 
+    <desc>Additional information necessary for connecting to IRC networks.</desc>
+    <revision pkgversion="2.28" version="0.1" date="2009-08-31" status="review">
+      <!--
+      <e:review by="shaunm gnome org" date="2009-08-31" status="done"/>
+      -->
+    </revision>
+    <revision pkgversion="2.30" version="0.2" date="2010-04-19" status="review"/>
+    <credit type="author">
+      <name>Shaun McCance</name>
+      <email its:translate="no">shaunm gnome org</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>    
+<!--
+    <copyright>
+      <year>2009</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> 
+-->
+  </info>
+
+  <title>IRC account details</title>
+
+  <p>IRC accounts require different information than many other types of
+  accounts.  To create an IRC account, you must specify at least an IRC
+  network and a nickname.  This page details the information you can
+  provide for an IRC account.</p>
+
+  <note style="info package">
+    <p>You must have the <sys>telepathy-idle</sys> package installed to use IRC 
+    in <app>Empathy</app>.</p>
+  </note>
+
+  <terms>
+    <item>
+      <title><gui>Network</gui></title>
+      <p>IRC is an open system that allows people to run separate IRC
+      networks.  Each network is distinct and has its own users and
+      chat rooms.  <app>Empathy</app> lists the most popular networks
+      in the <gui>Network</gui> drop-down list.  You can add additional
+      networks.  See <link xref="#networks"/> below.</p>
+    </item>
+    <item>
+      <title><gui>Nickname</gui></title>
+      <p>Your nickname is your unique name on the IRC network. Only one
+      person on a network may use a given nickname.  If you get an error
+      message that says <link xref="prob-conn-name" role="error-msg"/>
+      you will need to change your nickname.</p>
+    </item>
+    <item>
+      <title><gui>Password</gui></title>
+      <p>Some servers, particularly those on private networks, require
+      a password to connect.  If you are authorized to use the network,
+      the network administrators should provide you with a password.</p>
+      <note>
+        <title>NickServ Passwords</title>
+        <p>On some networks, nicknames can be registered using a service
+        known as NickServ.  <app>Empathy</app> does not directly support
+        nickname passwords.  On some networks, including the popular
+        freenode network, server passwords are automatically forwarded
+        to NickServ, allowing you to set this field to identify yourself
+        with NickServ.  See <link xref="irc-nick-password"/> for more
+        details.</p>
+      </note>
+    </item>
+    <item>
+      <title><gui>Real name</gui></title>
+      <p>You can provide your real name in addition to your nickname.  Other
+      users will be able to see this when they view your information.</p>
+    </item>
+    <item>
+      <title><gui>Quit message</gui></title>
+      <p>When you go offline, a quit message is sent to all the chat rooms
+      you’re in and to all the users you’re having a private conversation
+      with.  Use this field to provide a custom quit message.</p>
+    </item>
+  </terms>
+
+<!--
+telepathy-idle note
+-->
+
+  <section id="networks">
+    <info>
+      <title type="link">IRC Networks</title>
+    </info>
+
+    <title>Networks</title>
+
+    <p><app>Empathy</app> includes a list of popular IRC networks.  If you
+    wish to another IRC network, you can add it to the list.  You can also
+    modify networks and remove them from the list.</p>
+
+    <list>
+      <item><p>To add a network to the list, click <media type="image"
+      mime="image/png" src="figures/gtk-add.png" width="16"
+      height="16" its:translate="no"><span
+      its:translate="yes">Add</span></media>.</p></item>
+      <item><p>To modify a network in the list, select the network and click
+      <media type="image" mime="image/png" src="figures/gtk-edit.png" width="16"
+      height="16" its:translate="no"><span
+      its:translate="yes">Edit</span></media>.</p></item>
+      <item><p>To remove a network from the list, select the network and
+      click <media type="image" mime="image/png" src="figures/gtk-remove.png"
+      width="16" height="16" its:translate="no"><span
+      its:translate="yes">Remove</span></media>.</p></item>
+    </list>
+
+    <p>When adding or modifying a network, you can enter the following
+    information:</p>
+
+    <terms>
+      <item>
+        <title><gui>Network</gui></title>
+        <p>This is the name of the network as you want it to appear in
+        the list of networks.</p>
+      </item>
+      <item>
+        <title><gui>Charset</gui></title>
+        <p>This specifies the character encoding that is typically used on
+        this network.  A character encoding is a specific way of recording
+        characters internally in a computer.  There are many character
+        encodings, and you need to use the same character encoding as other
+        users to see their messages correctly.</p>
+        <!--
+            Translators: Recommend character encodings that are common
+            for your language.
+        -->
+        <p>By default, <app>Empathy</app> uses UTF-8, a modern character
+        encoding that can handle text from most of the world's languages.
+        Another common encoding for English and some other Western languages
+        is ISO-8859-1.</p>
+      </item>
+      <item>
+        <title><gui>Servers</gui></title>
+        <p>An IRC network may have many servers you can connect to.  When
+        you are connected to a server on a particular network, you can
+        communicate with all users on all other servers on that network.
+        You can add and remove servers for this network using the
+        <gui>Add</gui> and <gui>Remove</gui> buttons.</p>
+        <p>When a server is selected, click the field under <gui>Server</gui>
+        or <gui>Port</gui> to edit it.  Alternatively, use the left and right
+        arrow keys to focus the field, and press the space bar to begin
+        editing.</p>
+        <p>Select the check box in the <gui>SSL</gui> column to encrypt
+        all communication with a server.  Note that this does not prevent
+        other users on the network from seeing what you write on public
+        chat rooms.</p>
+      </item>
+    </terms>
+  </section>
+</page>
diff --git a/help/C/irc-commands.page b/help/C/irc-commands.page
new file mode 100644
index 0000000..292fcfa
--- /dev/null
+++ b/help/C/irc-commands.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="irc-commands">
+      
+  <info>
+    <link type="guide" xref="index#conversations"/>
+    <desc>The supported IRC commands.</desc>
+    <revision pkgversion="3.22" version="0.1" date="2017-03-20" status="draft"/>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <credit type="author">
+      <name>Paul Cutler</name>
+      <email>pcutler gnome org</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.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>
diff --git a/help/C/irc-join-room.page b/help/C/irc-join-room.page
new file mode 100644
index 0000000..e25c39e
--- /dev/null
+++ b/help/C/irc-join-room.page
@@ -0,0 +1,43 @@
+<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.22" date="2016-03-13" status="draft"/>
+    <credit type="author">
+      <name>Paul Cutler</name>
+      <email>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>In Join room window, type the <em>Room name</em> and <em>Password</em> if joining a 
+       password protected room.</p>
+       </item>
+  </steps>
+
+  <note style="tip">
+    <p>
+      To join multiple rooms, you need to repeat the steps above for each room.
+    </p>
+  </note>
+</page>
diff --git a/help/C/irc-nick-password.page b/help/C/irc-nick-password.page
new file mode 100644
index 0000000..9df336f
--- /dev/null
+++ b/help/C/irc-nick-password.page
@@ -0,0 +1,60 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      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.22" version="0.1" date="2016-03-213" status="draft"/>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <credit type="author">
+      <name>Paul Cutler</name>
+      <email>pcutler gnome org</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.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>
diff --git a/help/C/irc-start-conversation.page b/help/C/irc-start-conversation.page
new file mode 100644
index 0000000..62745e8
--- /dev/null
+++ b/help/C/irc-start-conversation.page
@@ -0,0 +1,48 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallrd.org/experimental/";
+      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>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <credit type="author">
+      <name>Paul Cutler</name>
+      <email>pcutler gnome org</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.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>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.
+      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>
diff --git a/help/C/network-connect.page b/help/C/network-connect.page
new file mode 100644
index 0000000..9672467
--- /dev/null
+++ b/help/C/network-connect.page
@@ -0,0 +1,56 @@
+<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.22" 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 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 you would like to join
+               or click on <gui>Custom Network</gui> and enter the details.</p>
+       </item>
+       <item>
+               <p>In Join room window, type the <em>Room name</em> and <em>Password</em> if joining a
+               password protected room.</p>
+       </item>
+       <item>
+               <p>Click the <gui>Join</gui> button to connect.</p>
+       </item>
+  </steps>
+</page>
diff --git a/help/C/overview.page b/help/C/overview.page
new file mode 100644
index 0000000..a0751ca
--- /dev/null
+++ b/help/C/overview.page
@@ -0,0 +1,32 @@
+<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.7" 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.  C
+    hannels, also known as chat rooms, are where users meet online to chat.
+
+  </p>  
+  
+  </page>
diff --git a/help/C/sharing.page b/help/C/sharing.page
new file mode 100644
index 0000000..0572bca
--- /dev/null
+++ b/help/C/sharing.page
@@ -0,0 +1,41 @@
+<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>
+
+  <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>.  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>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]