[polari/docs: 1/5] Added documentation



commit 0c695c22ceccd5477138bf3b1e1ef23ade14e2fd
Author: Ankit R Gadiya <ankit4922 gmail com>
Date:   Fri Aug 19 17:15:58 2016 +0530

    Added documentation

 help/C/images/Polari.png                    |  Bin 0 -> 1816 bytes
 help/C/images/add-custom-network-config.png |  Bin 0 -> 22941 bytes
 help/C/images/add-custom-network.png        |  Bin 0 -> 19016 bytes
 help/C/images/add-predefined-network.png    |  Bin 0 -> 17823 bytes
 help/C/images/connected.png                 |  Bin 0 -> 11717 bytes
 help/C/images/join-room-custom.png          |  Bin 0 -> 16183 bytes
 help/C/images/join-room.png                 |  Bin 0 -> 15529 bytes
 help/C/images/main-dark.png                 |  Bin 0 -> 15466 bytes
 help/C/images/main.png                      |  Bin 0 -> 15544 bytes
 help/C/index.page                           |   12 ++++-
 help/C/introduction.page                    |   34 +++++++++++++
 help/C/network-connect-custom.page          |   68 +++++++++++++++++++++++++++
 help/C/network-connect-preconfigured.page   |   47 ++++++++++++++++++
 help/C/start.page                           |   21 ++++++++
 14 files changed, 181 insertions(+), 1 deletions(-)
---
diff --git a/help/C/images/Polari.png b/help/C/images/Polari.png
new file mode 100644
index 0000000..d136cb9
Binary files /dev/null and b/help/C/images/Polari.png differ
diff --git a/help/C/images/add-custom-network-config.png b/help/C/images/add-custom-network-config.png
new file mode 100644
index 0000000..708af4a
Binary files /dev/null and b/help/C/images/add-custom-network-config.png differ
diff --git a/help/C/images/add-custom-network.png b/help/C/images/add-custom-network.png
new file mode 100644
index 0000000..7ad73b5
Binary files /dev/null and b/help/C/images/add-custom-network.png differ
diff --git a/help/C/images/add-predefined-network.png b/help/C/images/add-predefined-network.png
new file mode 100644
index 0000000..ba13ce0
Binary files /dev/null and b/help/C/images/add-predefined-network.png differ
diff --git a/help/C/images/connected.png b/help/C/images/connected.png
new file mode 100644
index 0000000..1e86291
Binary files /dev/null and b/help/C/images/connected.png differ
diff --git a/help/C/images/join-room-custom.png b/help/C/images/join-room-custom.png
new file mode 100644
index 0000000..cc3bdf3
Binary files /dev/null and b/help/C/images/join-room-custom.png differ
diff --git a/help/C/images/join-room.png b/help/C/images/join-room.png
new file mode 100644
index 0000000..be47fb5
Binary files /dev/null and b/help/C/images/join-room.png differ
diff --git a/help/C/images/main-dark.png b/help/C/images/main-dark.png
new file mode 100644
index 0000000..0131df9
Binary files /dev/null and b/help/C/images/main-dark.png differ
diff --git a/help/C/images/main.png b/help/C/images/main.png
new file mode 100644
index 0000000..51fe69e
Binary files /dev/null and b/help/C/images/main.png differ
diff --git a/help/C/index.page b/help/C/index.page
index 76dde4f..8fafe6f 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -4,11 +4,21 @@
       id="index">
 
   <info>
+    <title type="text">Polari</title>
     <revision pkgversion="3.20" date="2016-05-06" status="stub" />
 
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+    <desc><app>Polari</app> is a clean, simple, and minimal 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="start" style="2column">
+       <title>Getting Started</title>
+  </section>
+       
 
 </page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..bb0efae
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,34 @@
+<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-05-06" status="stub" />
+
+       <credit type="author copyright">
+               <name>Ankit R Gadiya</name>
+               <email its:translate="no">ankit4922 gmail com</email>
+               <years>2016</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 irc client which integrates perfectly with gnome desktop and provides 
you distraction free window.
+  </p>
+
+  <media type="image" mime="image/png" src="images/main.png">
+       <p>A screenshot of main window of Polari(not connected to any network)</p>
+  </media>
+  <media type="image" mime="image/png" src="images/main-dark.png">
+       <p>A screenshot of main windo of Polari(not connected to any network) when global dark theme is 
enabled</p>
+  </media>
+
+</page>
diff --git a/help/C/network-connect-custom.page b/help/C/network-connect-custom.page
new file mode 100644
index 0000000..369bebd
--- /dev/null
+++ b/help/C/network-connect-custom.page
@@ -0,0 +1,68 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic" style="task"
+      id="network-connect-custom">
+
+  <info>
+    <link type="guide" xref="index#start" group="#first"/>
+    <revision pkgversion="3.20" date="2016-05-06" status="stub" />
+
+    <credit type="author copyright">
+      <name>Ankit R Gadiya</name>
+      <email its:translate="no">ankit4922 gmail com</email>
+      <years>2016</years>
+    </credit>
+    
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>How to connect to a custom network.</desc>
+       
+  </info>
+  <title>Connect to custom network</title>
+  <p>Its really easy to connect to a custom network too.</p>
+  <steps>
+       <item>
+               <p>Open Polari</p>
+       </item>
+       <item>
+               <p>Click on the <key>+</key>on the top left corner.</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/main.png"/>
+       </item>
+       <item>
+               <p>In Add network window click the <key>Custom Network</key> button on bottom left.</p>
+               <media type="image" mime="image/png" its:translate="no" 
src="images/add-predefined-network.png"/>
+       </item>
+       <item>
+               <p>Type the Server Address, Network name.</p>
+               
+       </item>
+       <item>
+               <p>(Optional) If you want to connect securely using SSL and your network supports it, then 
you can check the box.</p>
+               <media type="image" mime="image/png" its:translate="no" 
src="images/add-custom-network-config.png"/>
+               <p>Notice I've mentioned 
+       </item>
+       <item>
+               <p>Click on <key>Add</key> button.</p>
+       </item> 
+       <item>
+               <p>Next you have to type Nickname and Real Name.</p>
+               <p>Note: Real Name is optional.</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/nickname-realname.png"/>
+       </item>
+       <item>
+               <p>Click the <key>Add</key> button.</p>
+       </item>
+       <item>  
+               <p>Now type room name and password(optional).</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/join-room-custom.png"/>
+       </item>
+       <item>
+               <p>Click the <key>Join</key> button on the top right.</p>
+       </item>
+       <item>
+               <p>Done!</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/*.png"/>
+       </item>
+       
+  </steps>
+</page>
diff --git a/help/C/network-connect-preconfigured.page b/help/C/network-connect-preconfigured.page
new file mode 100644
index 0000000..14d17fc
--- /dev/null
+++ b/help/C/network-connect-preconfigured.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic" style="task"
+      id="network-connect-preconfigured">
+
+  <info>
+    <link type="guide" xref="index#start" group="#first"/>
+    <revision pkgversion="3.20" date="2016-05-06" status="stub" />
+
+    <credit type="author copyright">
+      <name>Ankit R Gadiya</name>
+      <email its:translate="no">ankit4922 gmail com</email>
+      <years>2016</years>
+    </credit>
+    
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>How to connect to a preconfigured network.</desc>
+       
+  </info>
+  <title>Connect to preconfigured network</title>
+  <p>Its really easy to connect to a network.</p>
+  <steps>
+       <item>
+               <p>Open Polari</p>
+       </item>
+       <item>
+               <p>Click on the <key>+</key>on the top left corner.</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/main.png"/>
+       </item>
+       <item>
+               <p>In Add network window select the preconfigured network.</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/add-network.png"/>
+       </item>
+       <item>
+               <p>In Join room window, type the room name and password(password is optional)</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/join-room.png"/>
+       </item>
+       <item>
+               <p>Click the <key>Join</key> button on the top right.</p>
+       </item>
+       <item>
+               <p>Done!</p>
+               <media type="image" mime="image/png" its:translate="no" src="images/in-network.png"/>
+       </item>
+  </steps>
+</page>
diff --git a/help/C/start.page b/help/C/start.page
new file mode 100644
index 0000000..ddf71fb
--- /dev/null
+++ b/help/C/start.page
@@ -0,0 +1,21 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide" style="task"
+      id="start">
+
+  <info>
+       <revision pkgversion="3.20" date="2016-05-06" status="stub" />
+       <credit type="author copyright">
+               <name>Ankit R Gadiya</name>
+               <email its:translate="no">ankit4922 gmail com</email>
+               <years>2016</years>
+        </credit>
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <title>Get Started</title>
+
+  
+
+</page>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]