Added documentation for the Today application

2 files changed, 55 insertions, 0 deletions

diff --git a/docs/usermanual/today.sgm b/docs/usermanual/today.sgm
new file mode 100644
index 0000000..d77921c
--- a/dev/null
+++ b/docs/usermanual/today.sgm
@@ -0,0 +1,53 @@
+<chapter><title>Today</title>
+<para>
+The Today application is a convenient way to view both the appointments from the Calendar and the tasks from the
+Todo application for the current day, as well as seeing what e-mail is available.  It provides no interface for editing your
+appointments, or your tasks, but if you click the icon of the application, it will be launched.  For those familiar with
+PocketPC, this is similar to the Today application included with that.
+</para>
+<section><title>Configuration</title>
+<para>
+You can configure the Today application by pressing the wrench icon in the bottom left corner of the window.  This will 
+open the configuration dialog, from which you can change various settings related to display, amongst other things.
+</para>
+<section><title>Calendar</title>
+<para>
+The Calendar tab in the configuration dialog lets you change the settings for how your appointments should be displayed.  
+</para>
+<para>
+The first field allows you to select the number of appointments to be shown in the Calendar section of the application.  
+If you add more appointments, you will be taking away screen space from the other sections.
+The "Should location be shown?" is for determining exactly that.  If checked, the location field of the appointment 
+will be shown in the Today main view.
+"Show only later appoinmtnets" will only show appointments that begin after the current time.
+Finally, if the "Should the notes be shown" checkbox is checked, then the notes for each appointment will be visible 
+in the main view.
+</para>
+</section>
+<section><title>Tasks</title>
+<para>
+The Tasks tab lets you change how tasks are displayed in the Today main view.
+</para>
+<para>
+The first field lets you chose how many tasks to display in the main view.  The more that are shown, the more space 
+is taken from the other categories.
+</para>
+</section>
+<section><title>Miscellaneous</title>
+<para>
+The Misc. tab allows you to set global settings that affect the entire application.
+</para>
+<para>
+The "Clip after how many letters" field lets you change the number of characters from each appointment or task that 
+are displayed in the main view.  The "Should today be autostarted on resume" checkbox lets you set whether or not 
+the Today application should be started each time you resume from a suspend or not.<note><para>This only works 
+if you have a full installation of Opie.  If you are running Today on some other environment (Qtopia, for example) 
+this feature will not work.</para></note>The final field, "Activate autostart after how many minutes", lets you set 
+the number of minutes that the device must be suspended before the Today application will start automatically on 
+resume.  For instance, if this is set to 5, and you suspend the device for 3 minutes, when you resume the device, the 
+Today application will not start automatically.  However, if it is set to 5 and you leave the device in the suspend state 
+for 6 minutes, then Today will be started automatically upon resume.
+</para>
+</section>
+</section>
+</chapter>
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index 8ad298e..65d424f 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,34 +1,36 @@
 <!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [
 <!ENTITY arrow "-->">
 <!ENTITY whatis SYSTEM "whatisopie.sgm">
 <!ENTITY installation SYSTEM "installation.sgm">
 <!ENTITY gettingaround SYSTEM "gettingaround.sgm">
 <!ENTITY upgrading SYSTEM "upgrading.sgm">
 <!ENTITY contacts SYSTEM "contacts.sgm">
 <!ENTITY calendar SYSTEM "calendar.sgm">
 <!ENTITY todo SYSTEM "todo.sgm">
 <!ENTITY filemanager SYSTEM "filemanager.sgm">
 <!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm">
 <!ENTITY software SYSTEM "software.sgm">
+<!ENTITY today SYSTEM "today.sgm">
 ]>
 <book><title>Opie User Manual</title>
 <bookinfo><authorgroup><collab>
 <collabname>The Opie Team</collabname>
 </collab></authorgroup></bookinfo>
 <part><title>Getting Started</title>
 &whatis;
 &installation;
 &gettingaround;
 &upgrading;
 </part>
 <part><title>Applications</title>
 &contacts;
 &calendar;
 &todo;
+&today;
 &filemanager;
 &embeddedkonsole;
 </part>
 <part><title>Settings</title>
 &software;
 </part>
 </book>