GNOME.org
 

[california/wip/732302-help] docs: added more draft help topics

commit 045579ef6202982529c8af9ee40cb4661d172ad8
Author: Jim Campbell <jcampbell gnome org>
Date:   Thu Sep 4 00:09:26 2014 -0500

    docs: added more draft help topics

 help/C/_delete_me_owncloud_link.txt |    1 +
 help/C/cal-add-calendar.page        |   84 +++++++++++++++++++++++++++++++----
 help/C/cal-change-view.page         |   24 ++++++++++
 help/C/cal-event-edit.page          |   24 ++++++++++
 help/C/cal-event-quick-add.page     |   25 ++++++++++
 help/C/cal-event-recurring.page     |   25 ++++++++++
 help/C/cal-hide-a-calendar.page     |   12 +++++-
 help/C/cal-quickstart.page          |    4 +-
 help/C/cal-remove-calendar.page     |    1 +
 help/C/cal-rename-calendar.page     |   22 +++++++++
 help/C/cal-shortcut-keys.page       |    3 +-
 help/C/index.page                   |    7 ++-
 12 files changed, 217 insertions(+), 15 deletions(-)
---
diff --git a/help/C/_delete_me_owncloud_link.txt b/help/C/_delete_me_owncloud_link.txt
new file mode 100644
index 0000000..fcfdcdd
--- /dev/null
+++ b/help/C/_delete_me_owncloud_link.txt
@@ -0,0 +1 @@
+https://example.com/remote.php/caldav/calendars/bcampbell/defaultcalendar
diff --git a/help/C/cal-add-calendar.page b/help/C/cal-add-calendar.page
index a325af7..8773b07 100644
--- a/help/C/cal-add-calendar.page
+++ b/help/C/cal-add-calendar.page
@@ -5,10 +5,12 @@
       id="cal-add-calendar">
 
   <info>
+    <desc>Sync or display web-based calendar feeds.</desc>
     <link type="guide" xref="index#cal-manage-calendars"/>
+    <link type="seealso" xref="cal-rename-calendar"/>
     <link type="seealso" xref="cal-hide-a-calendar"/>
     <link type="seealso" xref="cal-remove-calendar"/>
-    <revision pkgversion="3.14" date="2014-07-20" status="incomplete"/>
+    <revision pkgversion="3.14" date="2014-09-02" status="draft"/>
 
     <credit type="author copyright">
       <name>Jim Campbell</name>
@@ -23,21 +25,85 @@
     
   <p>By default, <app>California</app> includes two calendars: a
   <em>Personal</em> calendar and a <em>Birthdays &amp; Anniversaries</em>
-  calendar. You can add or sync other calendars, as well. Select the type of
-  calendar that you want to add from the list below:</p>
+  calendar. You can add or sync other calendars, as well:</p>
 
   <section id="cal-sync-gcal" ui:expanded="false">
-    <title>Sync with a Google Calendar</title>
-    <p>Instructions here . . .</p>
+    <title>Add a Google calendar</title>
+    
+    <p>Adding a Google calendar to <app>California</app> will both add and
+    <em>sync</em> the calendar. If you add an event in <app>California</app>,
+    the event will appear in your Google calendar. Likewise, if you add or edit
+    an event in your Google calendar, those changes will also be updated in
+    <app>California</app>.</p>
+    
+    <steps>
+      <title>Follow these steps to syncronize your Google calendar with
+      <app>California</app>:</title>
+      <item><p>Click the <gui>Calendar</gui> icon in the menu bar. A list of
+      your current calendars will appear.</p></item>
+      <item><p>Click the <gui>Plus</gui> icon at the bottom of the window.</p>
+      </item>
+      <item><p>Select <gui>Google Calendar</gui> and click <gui>Add</gui>.</p>
+      </item>
+      <item><p>Enter your Google account name and Google password. Click
+      <gui>Login</gui>.</p>
+      <p>If you have entered the proper credentials, <app>California</app> will
+      indicate that your account has been authenticated. If you have mis-typed
+      your Google password, you will need to enter your password again.</p>
+      </item>
+      <item><p>Your default Google account calendar will appear in a window of
+      <gui>My Calendars</gui>. If you also subscribe to other calendars through
+      your Google account, those calendars will also appear in a list of
+      <gui>Other available calendars</gui>.</p></item>
+      <item><p>Select all of the calendars that you wish to sync, and select
+      <gui>Subscribe</gui>.</p></item>
+    </steps>
+    <note><p>You may also be prompted to enter your Google password one
+    additional time. This will save your password into your computer so that
+    you don't have to enter it again.</p></note>
+    <note><p>Your primary Google calendar will fully sync between
+    <app>California</app> and your Google calendar. However, you may or may
+    not have the proper permissions for any <gui>Other available
+    calendars</gui> to fully sync between <app>California</app> and your
+    Google calendars. Consult the
+    <link href="https://support.google.com/calendar/";>Google Calendar Help
+    Center</link> if you encounter any problems with syncing any of the
+    calendars in your list of <gui>Other available calendars</gui>.</p></note>
   </section>
   
-  <section id="cal-sync-owncloud" ui:expanded="false">
-    <title>Sync with an OwnCloud Calendar</title>
-    <p>Instructions here . . .</p>
+  <section id="cal-sync-caldav" ui:expanded="false">
+    <title>Add a CalDAV calendar</title>
+    <p><code>CalDAV</code> is an open standard for transmitting and storing
+    calendar information. It is used by many popular services including the
+    <app>ownCloud</app> calendar and Apple's <app>iCloud</app> service.</p>
+    
+    <steps>
+      <title>Follow these steps to syncronize a <code>CalDAV</code> calendar
+      with <app>California</app>:</title>
+      
+      <item><p>Click the <gui>Calendar</gui> icon in the menu bar. A list of
+      your current calendars will appear.</p></item>
+      <item><p>Click the <gui>plus</gui> icon at the bottom of the
+      window.</p></item>
+      <item><p>Select <gui>CalDAV</gui> and click <gui>Add</gui>.</p></item>
+      <item><p>Enter a calendar name. This can be any name of your
+      choosing.</p></item>
+      <item><p>Enter the calendar URL. You will need to get this information
+      from your online calendar application or from your system administrator.
+      </p></item>
+      <item><p>Enter your the username for your online calendar into the
+      <gui>Username</gui> field.</p></item>
+      <item><p>Click <gui>Subscribe</gui>.</p>
+      <p>If you have entered a username.</p></item>
+    </steps>
+    <note><p>Although the <gui>Username</gui> field is listed as
+    <gui>Optional</gui>, it is strongly recommended that you enter a username
+    if you have one available. <app>California</app> may not be able to display
+    your calendar if you don't enter the appropriate username.</p></note>
   </section>
 
   <section id="cal-display-ics" ui:expanded="false">
-    <title>Display an ICS Calendar Feed</title>
+    <title>Display an ICS calendar feed</title>
     <p>Instructions here . . .</p>
   </section>   
 </page>
diff --git a/help/C/cal-change-view.page b/help/C/cal-change-view.page
new file mode 100644
index 0000000..2cdfc81
--- /dev/null
+++ b/help/C/cal-change-view.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide" style="tip" version="1.0 ui/1.0"
+      id="cal-change-view">
+
+  <info>
+    <link type="guide" xref="index#cal-manage-calendars"/>
+    <desc>Switch between monthly and weekly views of your calendar.</desc>
+    <revision pkgversion="3.14" date="2014-09-01" status="stub"/>
+
+    <credit type="author copyright">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jcampbell gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Change Your Calendar's View</title>
+  
+  <p></p>
+
+</page>
diff --git a/help/C/cal-event-edit.page b/help/C/cal-event-edit.page
new file mode 100644
index 0000000..9113424
--- /dev/null
+++ b/help/C/cal-event-edit.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide" style="task" version="1.0 ui/1.0"
+      id="cal-event-edit">
+
+  <info>
+    <desc>Change an event's details.</desc>
+    <link type="guide" xref="index#cal-manage-events"/>
+    <revision pkgversion="3.14" date="2014-09-01" status="draft"/>
+
+    <credit type="author copyright">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jcampbell gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Edit an Existing Event</title>
+  
+  <p></p>
+
+</page>
diff --git a/help/C/cal-event-quick-add.page b/help/C/cal-event-quick-add.page
new file mode 100644
index 0000000..5dc2224
--- /dev/null
+++ b/help/C/cal-event-quick-add.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide" style="task" version="1.0 ui/1.0"
+      id="cal-event-quick-add">
+
+  <info>
+    <desc>Use the Quick Add feature to add calendar events.</desc>
+    <link type="guide" xref="index#cal-manage-events"/>
+    <link type="seealso" xref="cal-event-edit"/>
+    <revision pkgversion="3.14" date="2014-09-01" status="draft"/>
+
+    <credit type="author copyright">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jcampbell gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Add an Event to Your Calendar</title>
+  
+  <p></p>
+
+</page>
diff --git a/help/C/cal-event-recurring.page b/help/C/cal-event-recurring.page
new file mode 100644
index 0000000..31f8726
--- /dev/null
+++ b/help/C/cal-event-recurring.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide" style="task" version="1.0 ui/1.0"
+      id="cal-event-recurring">
+
+  <info>
+    <desc>Schedule an event to reoccur on a regular basis.</desc>
+    <link type="guide" xref="index#cal-manage-events"/>
+    <link type="seealso" xref="cal-event-edit"/>
+    <revision pkgversion="3.14" date="2014-09-01" status="stub"/>
+
+    <credit type="author copyright">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jcampbell gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Set a Recurring Event</title>
+  
+  <p></p>
+
+</page>
diff --git a/help/C/cal-hide-a-calendar.page b/help/C/cal-hide-a-calendar.page
index 6371b65..3000456 100644
--- a/help/C/cal-hide-a-calendar.page
+++ b/help/C/cal-hide-a-calendar.page
@@ -5,7 +5,8 @@
 
   <info>
     <link type="guide" xref="index#cal-manage-calendars"/>
-    <revision pkgversion="3.14" date="2014-07-20" status="stub"/>
+    <desc>Simplify your calendar's interface.</desc>
+    <revision pkgversion="3.14" date="2014-08-31" status="draft"/>
 
     <credit type="author copyright">
       <name>Jim Campbell</name>
@@ -17,5 +18,14 @@
   </info>
 
   <title>Hide a Calendar From View</title>
+  
+  <p>If you keep track of multiple calendars (e.g., a calendar to keep track of
+  your weekly course schedule, another to keep track of your work schedule, and
+  yet another to keep track of social events), your calendar may get cluttered
+  with events. This can make it hard to read your calendar.</p>
+  
+  <p>If you want to make it easier to see only certain types of events,
+  you can <em>hide a calendar</em>. This will temporarily remove the calendar
+  from view, but will not delete the calendar altogether.</p>
 
 </page>
diff --git a/help/C/cal-quickstart.page b/help/C/cal-quickstart.page
index 755bccd..af992a6 100644
--- a/help/C/cal-quickstart.page
+++ b/help/C/cal-quickstart.page
@@ -4,8 +4,10 @@
       id="cal-quickstart">
 
   <info>
+    <desc>Get started with California.</desc>
     <link type="guide" xref="index"/>
     <revision pkgversion="3.14" date="2014-07-05" status="draft"/>
+    
     <credit type="author copyright">
       <name>Jim Campbell</name>
       <email its:translate="no">jcampbell gnome org</email>
@@ -14,7 +16,7 @@
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
   </info>
 
-  <title>Get started with California</title>
+  <title>Introduction</title>
   <p><app>California</app> is a modern calendar application for the GNOME
   desktop. Once <app>California</app> launches, you can start using it right
   away. To add a new event, just click the <gui>Plus</gui> icon in the
diff --git a/help/C/cal-remove-calendar.page b/help/C/cal-remove-calendar.page
index aaa9ff4..1c30829 100644
--- a/help/C/cal-remove-calendar.page
+++ b/help/C/cal-remove-calendar.page
@@ -4,6 +4,7 @@
       id="cal-remove-calendar">
 
   <info>
+    <desc>Delete a calendar and its related event details.</desc>
     <link type="guide" xref="index#cal-manage-calendars"/>
     <link type="seealso" xref="cal-hide-a-calendar"/>
     <revision pkgversion="3.14" date="2014-07-20" status="stub"/>
diff --git a/help/C/cal-rename-calendar.page b/help/C/cal-rename-calendar.page
new file mode 100644
index 0000000..f30dd32
--- /dev/null
+++ b/help/C/cal-rename-calendar.page
@@ -0,0 +1,22 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide" style="tip" version="1.0 ui/1.0"
+      id="cal-rename-calendar">
+
+  <info>
+    <desc>Change the name of a calendar.</desc>
+    <link type="guide" xref="index#cal-manage-calendars"/>
+    <revision pkgversion="3.14" date="2014-08-31" status="draft"/>
+
+    <credit type="author copyright">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jcampbell gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>
+
+  <title>Rename a Calendar</title>
+
+</page>
diff --git a/help/C/cal-shortcut-keys.page b/help/C/cal-shortcut-keys.page
index 15732be..6dd8d4f 100644
--- a/help/C/cal-shortcut-keys.page
+++ b/help/C/cal-shortcut-keys.page
@@ -5,6 +5,7 @@
       id="cal-shortcut-keys">
 
   <info>
+    <desc>Learn California's keyboard shortcuts.</desc>
     <link type="guide" xref="index"/>
     <revision pkgversion="3.14" date="2014-07-06" status="incomplete"/>
 
@@ -17,7 +18,7 @@
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
   </info>
 
-  <title>Shortcut keys</title>
+  <title>Shortcut Keys</title>
 
   <p>Use <gui>shortcut keys</gui> to perform common tasks more quickly than with
   the mouse and menus. The following table lists all of <app>California's</app>
diff --git a/help/C/index.page b/help/C/index.page
index ec4d710..2ddb783 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -5,6 +5,7 @@
       id="index">
 
   <info>
+    <desc>The California Help Guide.</desc>
     <title type="link">California</title>
     <title type="text">California</title>
 
@@ -27,8 +28,8 @@
   <p>Welcome to the <app>California</app> help guide. For a
   quick introduction into both <app>California's</app> most basic features,
   as well as some advanced keyboard shortcuts, visit the
-  <link xref="cal-quickstart">Get started with California</link> and
-  <link xref="cal-shortcut-keys">Shortcut keys</link> pages.</p>
+  <link xref="cal-quickstart">Introduction</link> and
+  <link xref="cal-shortcut-keys">Shortcut Keys</link> pages.</p>
 
   <p>Other help topics are grouped together into sections below.  Enjoy using
   <app>California</app>!</p>
@@ -39,7 +40,7 @@
     calendars.</p>
   </section>
 
-  <section id="cal-manage-events">
+  <section id="cal-manage-events" style="2column">
     <title>Manage Calendar Events</title>
   </section>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]