GNOME.org
 

[gnote] Document synchronization features

commit b12216d57b66acdd2bbf25ce4940e64c175e9384
Author: Aurimas Äernius <aurisc4 gmail com>
Date:   Sat Aug 11 18:52:54 2012 +0300

    Document synchronization features
    
    * General synchronization documentation
    * Local Folder synchronization addin documentation
    * WebDAV synchronization addin documentation
    * Updates to existing documentation regarding synchronization
    * Screenshot updates

 help/C/figures/gnote-preferences-add-ins.png |  Bin 27756 -> 31243 bytes
 help/C/figures/gnote-preferences-editing.png |  Bin 35926 -> 37647 bytes
 help/C/figures/gnote-preferences-hotkeys.png |  Bin 29367 -> 31538 bytes
 help/C/figures/gnote-sync-progress.png       |  Bin 0 -> 31384 bytes
 help/C/figures/gnote-syncprefs-advanced.png  |  Bin 0 -> 15158 bytes
 help/C/figures/gnote-syncprefs-local.png     |  Bin 0 -> 22858 bytes
 help/C/figures/gnote-syncprefs-webdav.png    |  Bin 0 -> 26412 bytes
 help/C/gnote-addin-sync-local.page           |   26 ++++++++++++++++++
 help/C/gnote-addin-sync-webdav.page          |   31 ++++++++++++++++++++++
 help/C/gnote-common-problems.page            |    3 --
 help/C/gnote-notes-preferences.page          |   20 ++++++++++++++
 help/C/gnote-synchronization.page            |   36 ++++++++++++++++++++++++++
 12 files changed, 113 insertions(+), 3 deletions(-)
---
diff --git a/help/C/figures/gnote-preferences-add-ins.png b/help/C/figures/gnote-preferences-add-ins.png
index 100ffec..c7ff9a9 100644
Binary files a/help/C/figures/gnote-preferences-add-ins.png and b/help/C/figures/gnote-preferences-add-ins.png differ
diff --git a/help/C/figures/gnote-preferences-editing.png b/help/C/figures/gnote-preferences-editing.png
index f15afe3..20cee7a 100644
Binary files a/help/C/figures/gnote-preferences-editing.png and b/help/C/figures/gnote-preferences-editing.png differ
diff --git a/help/C/figures/gnote-preferences-hotkeys.png b/help/C/figures/gnote-preferences-hotkeys.png
index f6bdfb6..770bbf8 100644
Binary files a/help/C/figures/gnote-preferences-hotkeys.png and b/help/C/figures/gnote-preferences-hotkeys.png differ
diff --git a/help/C/figures/gnote-sync-progress.png b/help/C/figures/gnote-sync-progress.png
new file mode 100644
index 0000000..a5f0f14
Binary files /dev/null and b/help/C/figures/gnote-sync-progress.png differ
diff --git a/help/C/figures/gnote-syncprefs-advanced.png b/help/C/figures/gnote-syncprefs-advanced.png
new file mode 100644
index 0000000..0c8383d
Binary files /dev/null and b/help/C/figures/gnote-syncprefs-advanced.png differ
diff --git a/help/C/figures/gnote-syncprefs-local.png b/help/C/figures/gnote-syncprefs-local.png
new file mode 100644
index 0000000..6b3fafd
Binary files /dev/null and b/help/C/figures/gnote-syncprefs-local.png differ
diff --git a/help/C/figures/gnote-syncprefs-webdav.png b/help/C/figures/gnote-syncprefs-webdav.png
new file mode 100644
index 0000000..b218384
Binary files /dev/null and b/help/C/figures/gnote-syncprefs-webdav.png differ
diff --git a/help/C/gnote-addin-sync-local.page b/help/C/gnote-addin-sync-local.page
new file mode 100644
index 0000000..db219f2
--- /dev/null
+++ b/help/C/gnote-addin-sync-local.page
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="addin-sync-local">
+
+  <info>
+    <link type="guide" xref="notes-preferences#sync-addins"/>
+    <link type="guide" xref="synchronization#configuration"/>
+    <desc>Synchronize to local folder</desc>
+    <license><p>GNU Free Documentation License (GFDL), Version 1.1</p></license>
+    <credit type="author">
+      <name>Aurimas Cernius</name>
+      <years>2012</years>
+    </credit>
+  </info>
+
+  <title>Local Folder Synchronization</title>
+  <p>This type of synchronization allows you to set local folder as synchronization storage.</p>
+  <p>To configure this type of synchronization, select &quot;Local Folder&quot; in <gui>Service</gui> drop-down and then select the desired folder as <gui>Folder Path</gui>.</p>
+  <figure>
+    <title>Local Folder Synchronization configuration</title>
+    <media type="image" src="figures/gnote-syncprefs-local.png" mime="image/png"/>
+  </figure>
+  <p>After selecting the desired folder click the <gui>Save</gui> button. Use the <gui>Clear</gui> button to turn synchronization off.</p>
+
+</page>
diff --git a/help/C/gnote-addin-sync-webdav.page b/help/C/gnote-addin-sync-webdav.page
new file mode 100644
index 0000000..5c5ff43
--- /dev/null
+++ b/help/C/gnote-addin-sync-webdav.page
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="addin-sync-webdav">
+
+  <info>
+    <link type="guide" xref="notes-preferences#sync-addins"/>
+    <link type="guide" xref="synchronization#configuration"/>
+    <desc>Synchronize to WebDAV share</desc>
+    <license><p>GNU Free Documentation License (GFDL), Version 1.1</p></license>
+    <credit type="author">
+      <name>Aurimas Cernius</name>
+      <years>2012</years>
+    </credit>
+  </info>
+
+  <title>WebDAV Synchronization</title>
+  <p>This type of synchronization allows you to set WebDAV as synchronization storage.</p>
+  <p>To configure this type of synchronization:</p>
+  <list>
+    <item><title>select &quot;WebDAV&quot; in <gui>Service</gui> drop-down and then select the desired folder as <gui>Folder Path</gui></title></item>
+    <item><title>enter the URL to your share</title></item>
+    <item><title>enter username and password</title></item>
+  </list>
+  <figure>
+    <title>Local Folder Synchronization configuration</title>
+    <media type="image" src="figures/gnote-syncprefs-webdav.png" mime="image/png"/>
+  </figure>
+  <p>After selecting the desired folder click the <gui>Save</gui> button. Use the <gui>Clear</gui> button to turn synchronization off.</p>
+
+</page>
diff --git a/help/C/gnote-common-problems.page b/help/C/gnote-common-problems.page
index 8317523..96b2466 100644
--- a/help/C/gnote-common-problems.page
+++ b/help/C/gnote-common-problems.page
@@ -21,9 +21,6 @@
     <list>
       <item><title>Does <app>Gnote</app> work with <app>Tomboy</app>?</title><p>You can import <app>Tomboy</app> Notes. An add-in has to be activated.</p>
       </item>
-      <item><title>How to Synchronize Notes?</title>
-        <p>There is no Synchronization feature. However, your notes are stored into <file>~/.local/share/gnote</file> folder, so may synchronize this folder.</p>
-      </item>
       <item><title>I can not find the Gnote status icon</title>
         <p>You can activate the <app>Gnote</app> status icon using a command from <app>terminal</app>: <cmd>gsettings set org.gnome.gnote use-status-icon true</cmd>.</p></item>
       <item><title>How to automatically start <app>Gnote</app> when I log in?</title>
diff --git a/help/C/gnote-notes-preferences.page b/help/C/gnote-notes-preferences.page
index ea3a174..e4bae92 100644
--- a/help/C/gnote-notes-preferences.page
+++ b/help/C/gnote-notes-preferences.page
@@ -39,5 +39,25 @@
   <section id="advanced" style="2column">
     <title>Advanced Settings</title>
   </section>
+  <section id="sync">
+    <title>Synchronization Settings</title>
+    <section id="sync-addins" style="2column">
+      <title>Synchronization services</title>
+    </section>
+    <section id="sync-advanced">
+      <title>Advanced</title>
+      <p>Clicking <gui>Advanced</gui> button in <gui>Synchronization</gui> tab of <gui>Preferences</gui> dialog brings another dialog for setting up conflict resolution.</p>
+      <figure>
+        <title>Advanced Synchronization Settings</title>
+        <media type="image" src="figures/gnote-syncprefs-advanced.png" mime="image/png"/>
+      </figure>
+      <p>This dialog lets you choose what to do, when a conflict occurrs. A conflict happends, when the note is modified before synchronizing and it has been also modified on other device (and synchronized to synchronization storage). You can select one of these options:</p>
+      <list>
+        <item><title>Rename existing note by appending &quot;(Old)&quot; to it's title and download the one from storage</title></item>
+        <item><title>Replace existing note by the one from storage, losing all modifications</title></item>
+        <item><title>Get the choice for earch conflicting note individually</title></item>
+      </list>
+    </section>
+  </section>
 
 </page>
diff --git a/help/C/gnote-synchronization.page b/help/C/gnote-synchronization.page
new file mode 100644
index 0000000..e9a59a7
--- /dev/null
+++ b/help/C/gnote-synchronization.page
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="synchronization">
+
+  <info>
+    <link type="guide" xref="index#advanced"/>
+    <desc>Synchronize Notes</desc>
+    <license><p>GNU Free Documentation License (GFDL), Version 1.1</p></license>
+    <credit type="author">
+      <name>Aurimas Cernius</name>
+      <years>2012</years>
+    </credit>
+  </info>
+
+  <title>Synchronization</title>
+  <section id="description">
+    <title>About synchronization</title>
+    <p><app>Gnote</app> allows you to synchronize notes accross multiple machines, so that you could use it on multiple devices and work with the same notes on all of them.</p>
+    <p>In order to use synchronization, you have to configure it first in <app>Gnote</app> configuration dialog.</p>
+    <p>Notes are synchronized to one location, common to all <app>Gnote</app> installations. This location stores the history of your notes. When synchronizing, each <app>Gnote</app> instance uploads new and updated notes to this location, downloads new and updated notes on other installations. The synchronization location also contains information on deleted notes: when synchronizing, <app>Gnote</app> publishes all deleted notes and deletes the ones, that are published as such. This way multiple <app>Gnote</app> installations can keep the same set of notes.</p>
+  </section>
+  <section id="configuration" style="2column">
+    <title>Configure synchronization</title>
+  </section>
+  <section id="usage">
+    <title>Synchronize</title>
+    <p>To synchronize, select <guiseq><gui>Tools</gui><gui>Synchronize Notes</gui></guiseq> from main menu. This item is only available, if synchronization is configured.</p>
+    <p>After selected the <gui>Synchronize Notes</gui> menu item, a progress dialog will be displayed, which will let you know, when synchronization is complete. Also, all notes will be disabled for editing while synchronization is in progress.</p>
+    <figure>
+      <title>Synchronization progress</title>
+      <media type="image" src="figures/gnote-sync-progress.png" mime="image/png"/>
+    </figure>
+  </section>
+
+</page>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]