From 98ccd2c2e109950d806d02a8b9aea9c9447e3003 Mon Sep 17 00:00:00 2001
From: Frederic Culot <calcurse@culot.org>
Date: Mon, 29 Mar 2010 18:18:01 +0000
Subject: html manuals updated.
---
doc/manual_en.html | 76 +++++++++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 69 insertions(+), 7 deletions(-)
(limited to 'doc/manual_en.html')
diff --git a/doc/manual_en.html b/doc/manual_en.html
index d267767..89ba526 100755
--- a/doc/manual_en.html
+++ b/doc/manual_en.html
@@ -1,9 +1,9 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
/*
- * $calcurse: manual_en.html,v 1.28 2009/08/18 13:08:00 culot Exp $
+ * $calcurse: manual_en.html,v 1.29 2010/03/29 18:18:02 culot Exp $
*
- * Copyright (c) 2004-2009 Frederic Culot <frederic@culot.org>
+ * Copyright (c) 2004-2010 Frederic Culot <frederic@culot.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -103,7 +103,8 @@ well as the way one can contribute to <code>calcurse</code> development.
<li><a href="#options_keys">5.2 Key bindings</a></li>
<li><a href="#options_colors">5.3 Color themes</a></li>
<li><a href="#options_layout">5.4 Layout configuration</a></li>
- <li><a href="#options_notify">5.5 Notify-bar settings</a></li>
+ <li><a href="#options_sidebar">5.5 Sidebar configuration</a></li>
+ <li><a href="#options_notify">5.6 Notify-bar settings</a></li>
</ul></li>
<li><a href="#known_bugs">6. Known bugs</a></li>
<li><a href="#bugs">7. Reporting bugs and feedback</a></li>
@@ -251,7 +252,7 @@ All of the commands are documented within an online help system.
<h2>3.2 Install process<a name="install_process"></a></h2>
<p>
First you need to gunzip and untar the source archive:</p>
- <pre>tar zxvf calcurse-2.7.tar.gz</pre>
+ <pre>tar zxvf calcurse-2.8.tar.gz</pre>
<p>
Once you meet the requirements and have extracted the archive,
the install process is quite simple, and follows the standard
@@ -519,6 +520,40 @@ All of the commands are documented within an online help system.
a particular day, the second one contains the list of the events
and appointments on that day, and the last one contains a list
of tasks to do but which are not assigned to any specific day.</p>
+<p>
+ Depending on the selected view, the calendar could either display
+ a monthly (default as shown in previous figure) or weekly view.
+ The weekly view would look like the following:</p>
+ <pre>
+
++------------------------------------+
+| Calendar |
+|----------------------------(# 13)--|
+| Mon Tue Wed Thu Fri Sat Sun |
+| 29 30 31 01 02 03 04 |
+| <----+-- slice 1: 00:00 to 04:00 AM
+| -- -- -- -- -- -- |
+| <----+-- slice 2: 04:00 to 08:00 AM
+| -- -- -- -- -- -- |
+| <----+-- slice 3: 08:00 to 12:00 AM
+| - -- -- -- -- -- -- - <-+-- midday
+| <----+-- slice 4: 12:00 to 04:00 PM
+| -- -- -- -- -- -- |
+| <----+-- slice 5: 04:00 to 08:00 PM
+| -- -- -- -- -- -- |
+| <----+-- slice 6: 08:00 to 12:00 PM
++------------------------------------+
+
+ </pre>
+<p>
+ The current week number is displayed on the top-right side of the panel
+ (<span class="emp"># 13</span> meaning it is the 13th week of the year
+ in the above example). The seven days of the current week are displayed
+ in column. Each day is divided into slices of 4 hours each (6 slices in
+ total, see figure above). A slice will appear in a different color if
+ an appointment falls into the corresponding time-slot.
+</p>
+
<p>
In the appointment panel, one can notice the <span
class="emp">'(|)'</span> sign just in front of the date.
@@ -773,6 +808,11 @@ $HOME/.calcurse/
the name of the file being saved
(see section <a href="#basics_files"><code>calcurse</code> files</a>).
</dd>
+ <dt><code>calendar_default_view</code>
+ (default: <span class="emp">0</span>)</dt>
+ <dd>If set to <span class="emp">0</span>, the monthly calendar view will be
+ displayed by default otherwise it is the weekly view that will be displayed.
+ </dd>
<dt><code>week_begins_on_monday</code>
(default: <span class="emp">yes</span>)</dt>
<dd>One can choose between Monday and Sunday as the first day of the
@@ -874,9 +914,30 @@ $HOME/.calcurse/
By choosing another layout in the configuration screen, user
can customize <code>calcurse</code> appearence to best suit
his needs by placing the different panels where needed.</p>
+<p>
+ The following option is used to modify the layout configuration:</p>
+ <dl>
+ <dt><code>layout</code>
+ (default: <span class="emp">0</span>)</dt>
+ <dd>Eight different layouts are to be chosen from (see layout
+ configuration screen for the description of the available layouts).</dd>
+ </dl>
+
+<h2>5.5 Sidebar configuration<a name="options_sidebar"></a></h2>
+<p>
+ The sidebar is the part of the screen which contains two panels:
+ the calendar and, depending on the chosen layout, either the todo
+ list or the appointment list.</p>
+<p>
+ The following option is used to change the width of the sidebar:</p>
+ <dl>
+ <dt><code>side-bar_width</code>
+ (default: <span class="emp">0</span>)</dt>
+ <dd>Width (in percentage, 0 being the minimum width) of the side bar.</dd>
+ </dl>
-<h2>5.5 Notify-bar settings<a name="options_notify"></a></h2>
+<h2>5.6 Notify-bar settings<a name="options_notify"></a></h2>
<p>
The following options are used to modify the notify-bar behavior:</p>
<dl>
@@ -1252,6 +1313,7 @@ msgid ""
<li><code>orpheus</code> and <code>abook</code> for documentation</li>
<li><code>pine</code> and <code>aptitude</code>
for the text user interface</li>
+ <li><code>tmux</code> for coding style</li>
</ul></li>
</ul>
</p>
@@ -1260,8 +1322,8 @@ msgid ""
users who sent me their feedback.</p>
<div class="footer">
- Copyright © 2004-2009 Fr�d�ric Culot<br>
- Calcurse version 2.7 - Last change: August 18, 2009<br>
+ Copyright © 2004-2010 Fr�d�ric Culot<br>
+ Calcurse version 2.8 - Last change: March 29, 2010<br>
</div>
</div>
--
cgit v1.2.3-70-g09d2