summaryrefslogtreecommitdiff
authorspiralman <spiralman>2002-08-09 14:57:06 (UTC)
committer spiralman <spiralman>2002-08-09 14:57:06 (UTC)
commitf0d1b8604699b964303288877db7b85a24222f5c (patch) (side-by-side diff)
treed2c6fd899fc27bf1ddf9e2c8bd83e8d5edf73c3e
parent021c0c4811e44e96cbb33b31c2f66308e46fbd1d (diff)
downloadopie-f0d1b8604699b964303288877db7b85a24222f5c.zip
opie-f0d1b8604699b964303288877db7b85a24222f5c.tar.gz
opie-f0d1b8604699b964303288877db7b85a24222f5c.tar.bz2
Added documentation for the Today application
Diffstat (more/less context) (show whitespace changes)
-rw-r--r--docs/usermanual/today.sgm53
-rw-r--r--docs/usermanual/usermanual.sgm2
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
@@ -10,6 +10,7 @@
<!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>
@@ -25,6 +26,7 @@
&contacts;
&calendar;
&todo;
+&today;
&filemanager;
&embeddedkonsole;
</part>