html manuals updated with parts related to notes

2008-02-14 20:07:43 +00:00 · 2008-02-14 20:07:43 +00:00 · 9fe5d3d476
commit 9fe5d3d476
parent fe5621c547
7 changed files with 164 additions and 13 deletions
--- a/3
+++ b/3
@ -1,3 +1,6 @@
+14 Feb 2008:
+	html manuals updated with parts related to notes
+	
 13 Feb 2008:
 	manpage updated
 	NOTESIZ shortened to be 6 characters long, as only 6 'X' are
--- a/doc/manual.css
+++ b/doc/manual.css
@ -1,4 +1,4 @@
-/*	$Id: manual.css,v 1.2 2008/02/10 11:33:23 culot Exp $	*/
+/*	$Id: manual.css,v 1.3 2008/02/14 20:07:43 culot Exp $	*/

 /*
 * Calcurse - text-based organizer
@ -242,7 +242,7 @@ a {
 	padding-left:		1cm;
 }

-div.todo {
+.todo {
 	color:		green;	
 }

--- a/doc/manual_de.html
+++ b/doc/manual_de.html
@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <!--
 /*
- *	$calcurse: manual_de.html,v 1.13 2008/02/10 11:33:23 culot Exp $
+ *	$calcurse: manual_de.html,v 1.14 2008/02/14 20:07:43 culot Exp $
 *
 * Calcurse - text-based organizer
 * Copyright (c) 2004-2008 Frederic Culot
@ -77,6 +77,8 @@ well as the way one can contribute to <code>calcurse</code> development.
 	<ul>
 	    <li><a href="#basics_invocation_commandline">4.1.1 Programmargumente</a></li>
 	    <li><a href="#basics_invocation_variable">4.1.2 Umgebungsvariable f&uuml;r i18n</a></li>
+	    <li><a href="#basics_invocation_environment"><span class="todo">4.1.3 Other environment
+	    variables</span></a></li>
 	</ul></li>
 	<li><a href="#basics_interface">4.2 Benutzer-Interface</a>
 	<ul>
@ -339,6 +341,28 @@ Es werden sowohl kurze als auch lange Optionsangaben unterst&uuml;tzt.</p>
 	aufrufen:</p>
 	<pre>LC_ALL=fr_FR.ISO8859-1 calcurse</pre>

+<div class="todo">
+<h3>4.1.3 Other environment variables<a name="basics_invocation_environment"></a></h3>
+<p>
+	The following environment variables affect the way <code>calcurse</code>
+	operates:</p>
+        <dl>
+	    <dt><code>VISUAL</code></dt>
+	    <dd>Specifies the external editor to use for writing notes.
+	    </dd>
+	    <dt><code>EDITOR</code></dt>
+	    <dd>If the <code>VISUAL</code> environment variable 
+	    is not set, then <code>EDITOR</code> will be used as 
+	    the default external editor. If none of those variables are set, 
+	    then <code>/usr/bin/vi</code> is used instead.
+	    </dd>
+	    <dt><code>PAGER</code></dt>
+	    <dd>Specifies the default viewer to be used for reading notes. 
+	    If this variable is not set, then <code>/usr/bin/less</code> is used.
+	    </dd>
+	</dl>
+</div>
+
 <h2>4.2 Benutzer-Interface<a name="basics_interface"></a></h2>
 <h3>4.2.1 Nicht interaktiver Modus<a name="basics_interface_noninteractive"></a></h3>
 <p>
@ -470,11 +494,17 @@ Die folgende Verzeichnisstruktur wird im $HOME-Verzeichnis angelegt,
 wenn <code>calcurse</code> das erste Mal gestartet wird:</p>
 <pre>
 $HOME/.calcurse/
+           |___notes/
           |___conf
           |___apts
           |___todo
 </pre>
 <dl class="compact">
+	<dt><code>notes/</code>:</dt>
+	<dd><span class="todo">this subdirectory contains descriptions of the notes 
+	which are attached to appointments, events or todos. One text file is
+	created per note, whose name is built using mkstemp(3) and should be
+	unique, but with no relation with the corresponding item's description.</span></dd>
 	<dt><code>conf</code>:</dt>
        <dd>Datei enth&auml;lt die Informationen zur Benutzerkonfiguration.</dd>
 	<dt><code>apts</code>:</dt>
@ -922,10 +952,10 @@ Und zuletzt, vielen vielen Dank an alle <code>calcurse</code>
 Benutzer, die mir Ihr Feedback mitgeteilt haben.</p>

 <div class="footer">
-	Copyright (c) 2004-2007 Fr&eacute;d&eacute;ric Culot<br>
+	Copyright (c) 2004-2008 Fr&eacute;d&eacute;ric Culot<br>
 	German translation by Michael Schulz
 	<code>&lt;bloodshower .at. web .dot. de&gt;</code>, and Chris.<br>
-	Calcurse version 2.0 - Last change: February 07, 2008<br>
+	Calcurse version 2.0 - Last change: February 14, 2008<br>
 </div>
 </div>

--- a/doc/manual_en.html
+++ b/doc/manual_en.html
@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <!--
 /*
- *	$calcurse: manual_en.html,v 1.13 2008/02/10 11:33:24 culot Exp $
+ *	$calcurse: manual_en.html,v 1.14 2008/02/14 20:07:43 culot Exp $
 *
 * Calcurse - text-based organizer
 * Copyright (c) 2004-2008 Frederic Culot
@ -75,6 +75,7 @@ well as the way one can contribute to <code>calcurse</code> development.
 	<ul>
 	    <li><a href="#basics_invocation_commandline">4.1.1 Command line arguments</a></li>
 	    <li><a href="#basics_invocation_variable">4.1.2 Environment variable for i18n</a></li>
+	    <li><a href="#basics_invocation_environment">4.1.3 Other environment variables</a></li>
 	</ul></li>
 	<li><a href="#basics_interface">4.2 User interface</a>
 	<ul>
@ -356,6 +357,26 @@ All of the commands are documented within an online help system.
 	could run <code>calcurse</code> using the following command:</p>
 	<pre>LC_ALL=fr_FR.ISO8859-1 calcurse</pre>

+<h3>4.1.3 Other environment variables<a name="basics_invocation_environment"></a></h3>
+<p>
+	The following environment variables affect the way <code>calcurse</code>
+	operates:</p>
+        <dl>
+	    <dt><code>VISUAL</code></dt>
+	    <dd>Specifies the external editor to use for writing notes.
+	    </dd>
+	    <dt><code>EDITOR</code></dt>
+	    <dd>If the <code>VISUAL</code> environment variable 
+	    is not set, then <code>EDITOR</code> will be used as 
+	    the default external editor. If none of those variables are set, 
+	    then <code>/usr/bin/vi</code> is used instead.
+	    </dd>
+	    <dt><code>PAGER</code></dt>
+	    <dd>Specifies the default viewer to be used for reading notes. 
+	    If this variable is not set, then <code>/usr/bin/less</code> is used.
+	    </dd>
+	</dl>
+
 <h2>4.2 User interface<a name="basics_interface"></a></h2>
 <h3>4.2.1 Non-interactive mode<a name="basics_interface_noninteractive"></a></h3>
 <p>
@ -491,11 +512,17 @@ All of the commands are documented within an online help system.
 	directory the first time <code>calcurse</code> is run :</p>
 	<pre>
 $HOME/.calcurse/
+           |___notes/
           |___conf
           |___apts
           |___todo
        </pre>
 	<dl class="compact">
+		<dt><code>notes/</code>:</dt>
+		<dd>this subdirectory contains descriptions of the notes 
+		which are attached to appointments, events or todos. One text file is
+		created per note, whose name is built using mkstemp(3) and should be
+		unique, but with no relation with the corresponding item's description.</dd>
 		<dt><code>conf</code>:</dt>
 	        <dd>this file contains the user configuration</dd>
 		<dt><code>apts</code>:</dt>
@ -982,7 +1009,7 @@ msgid ""

 <div class="footer">
 	Copyright (c) 2004-2008 Fr&eacute;d&eacute;ric Culot<br>
-	Calcurse version 2.0 - Last change: February 06, 2008<br>
+	Calcurse version 2.0 - Last change: February 13, 2008<br>
 </div>
 </div>

--- a/doc/manual_es.html
+++ b/doc/manual_es.html
@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <!--
 /*
- *	$calcurse: manual_es.html,v 1.10 2008/02/10 11:33:24 culot Exp $
+ *	$calcurse: manual_es.html,v 1.11 2008/02/14 20:07:43 culot Exp $
 *
 * Calcurse - text-based organizer
 * Copyright (c) 2004-2008 Frederic Culot
@ -77,6 +77,8 @@ well as the way one can contribute to <code>calcurse</code> development.
 	<ul>
 	    <li><a href="#basics_invocation_commandline">4.1.1 Argumentos de la linea de comandos</a></li>
 	    <li><a href="#basics_invocation_variable">4.1.2 Variable de entorno para i18n</a></li>
+	    <li><a href="#basics_invocation_environment"><span class="todo">4.1.3 Other environment
+	    variables</span></a></li>
        </ul></li>
        <li><a href="#basics_interface">4.2 Interfaz de usuario</a>
 	<ul>
@ -345,6 +347,28 @@ well as the way one can contribute to <code>calcurse</code> development.
 	utilizando el siguiente comando:</p>
 	<pre>LC_ALL=es_ES.ISO8859-1 calcurse</pre>

+<div class="todo">
+<h3>4.1.3 Other environment variables<a name="basics_invocation_environment"></a></h3>
+<p>
+	The following environment variables affect the way <code>calcurse</code>
+	operates:</p>
+        <dl>
+	    <dt><code>VISUAL</code></dt>
+	    <dd>Specifies the external editor to use for writing notes.
+	    </dd>
+	    <dt><code>EDITOR</code></dt>
+	    <dd>If the <code>VISUAL</code> environment variable 
+	    is not set, then <code>EDITOR</code> will be used as 
+	    the default external editor. If none of those variables are set, 
+	    then <code>/usr/bin/vi</code> is used instead.
+	    </dd>
+	    <dt><code>PAGER</code></dt>
+	    <dd>Specifies the default viewer to be used for reading notes. 
+	    If this variable is not set, then <code>/usr/bin/less</code> is used.
+	    </dd>
+	</dl>
+</div>
+
 <h2>4.2 Interfaz de usuario<a name="basics_interface"></a></h2>
 <h3>4.2.1 Modo no-interactivo<a name="basics_interface_noninteractive"></a></h3>
 <p>
@ -481,11 +505,17 @@ well as the way one can contribute to <code>calcurse</code> development.
 	la primera vez que se ejecuta <code>calcurse</code> :</p>
 	<pre>
 $HOME/.calcurse/
+           |___notes/
           |___conf
           |___apts
           |___todo
 	</pre>
 	<dl class="compact">
+		<dt><code>notes/</code>:</dt>
+		<dd><span class="todo">this subdirectory contains descriptions of the notes 
+		which are attached to appointments, events or todos. One text file is
+		created per note, whose name is built using mkstemp(3) and should be
+		unique, but with no relation with the corresponding item's description.</span></dd>
 		<dt><code>conf</code>:</dt>
 		<dd>contiene la configuración del usuario.</dd>
 		<dt><code>apts</code>:</dt>
@ -943,7 +973,7 @@ msgid ""
 	Copyright (c) 2004-2008 Fr&eacute;d&eacute;ric Culot<br>
 	Traducido al Español por José López
 	<code>&lt;testinground .at. gmail .dot. com&gt;</code><br>
-	Calcurse version 2.0 - Last change: February 09, 2008<br>
+	Calcurse version 2.0 - Last change: February 14, 2008<br>
 </div>
 </div>

--- a/doc/manual_fr.html
+++ b/doc/manual_fr.html
@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <!--
 /*
- *	$calcurse: manual_fr.html,v 1.14 2008/02/10 11:33:24 culot Exp $
+ *	$calcurse: manual_fr.html,v 1.15 2008/02/14 20:07:43 culot Exp $
 *
 * Calcurse - text-based organizer
 * Copyright (c) 2004-2008 Frederic Culot
@ -78,6 +78,7 @@ pour faire remonter les bogues et pour contribuer au d
 	<ul>
 	    <li><a href="#basics_invocation_commandline">4.1.1 Arguments en ligne de commande</a></li>
 	    <li><a href="#basics_invocation_variable">4.1.2 Variable d'environnement pour l'i18n</a></li>
+	    <li><a href="#basics_invocation_environment">4.1.3 Autres variables d'environnement</a></li>
 	</ul></li>
 	<li><a href="#basics_interface">4.2 Interface utilisateur</a>
 	<ul>
@ -393,6 +394,28 @@ disponibles.
        <code>calcurse</code>:</p>
 	<pre>LC_ALL=fr_FR.ISO8859-1 calcurse</pre>

+<h3>4.1.3 Autres variables d'environnement<a name="basics_invocation_environment"></a></h3>
+<p>
+	Les variables d'environnement suivantes agissent sur le comportement de
+	<code>calcurse</code>:</p>
+        <dl>
+	    <dt><code>VISUAL</code></dt>
+	    <dd>Indique l'éditeur externe qui sera utilisé pour rédiger des notes.
+	    </dd>
+	    <dt><code>EDITOR</code></dt>
+	    <dd>Si la variable d'environnement <code>VISUAL</code> n'est pas
+	    renseignée, l'éditeur externe qui sera utilisé par défaut est celui
+	    contenu dans la variable <code>EDITOR</code>. Si aucune de ces deux
+	    variables n'est renseignée, alors <code>/usr/bin/vi</code> sera
+	    appelé par défaut.
+	    </dd>
+	    <dt><code>PAGER</code></dt>
+	    <dd>Indique le visualiseur utilisé par défaut pour consulter les
+	    notes. Si cette variable n'est pas renseignée, alors 
+	    <code>/usr/bin/less</code> sera utilisé.
+	    </dd>
+	</dl>
+
 <h2>4.2 Interface utilisateur<a name="basics_interface"></a></h2>
 <h3>4.2.1 Mode non-interactif<a name="basics_interface_noninteractive"></a></h3>
 <p>
@ -536,11 +559,19 @@ disponibles.
 	<code>calcurse</code> est lancé :</p>
 	<pre>
 $HOME/.calcurse/
+           |___notes/
           |___conf
           |___apts
           |___todo
 	</pre>
 	<dl class="compact">
+		<dt><code>notes/</code>:</dt>
+		<dd>ce sous-répertoire contient la description des notes
+		rattachées aux rendez-vous, événements ou tâches. Un fichier
+		texte est créé par note, et son nom est construit à l'aide de
+		la fonction mkstemp(3). Ainsi, l'unicité de ce nom est assurée,
+		mais il n'a pas de relation avec l'élément auquel la note est
+		rattachée.</dd>
 		<dt><code>conf</code>:</dt>
 		<dd>ce fichier contient la configuration de l'utilisateur</dd>
 		<dt><code>apts</code>:</dt>
@ -1117,7 +1148,7 @@ msgid ""

 <div class="footer">
 	Copyright (c) 2004-2008 Frédéric Culot<br>
-	Calcurse version 2.0 - Dernière modification: 06 Février 2008<br>
+	Calcurse version 2.0 - Dernière modification: 14 Février 2008<br>
 </div>
 </div>

--- a/doc/manual_nl.html
+++ b/doc/manual_nl.html
@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//NL">
 <!--
 /*
- *	$calcurse: manual_nl.html,v 1.4 2008/02/10 11:33:24 culot Exp $
+ *	$calcurse: manual_nl.html,v 1.5 2008/02/14 20:07:43 culot Exp $
 *
 * Calcurse - text-based organizer
 * Copyright (c) 2004-2008 Frederic Culot
@ -77,6 +77,8 @@ well as the way one can contribute to <code>calcurse</code> development.
 	<ul>
 	    <li><a href="#basics_invocation_commandline">4.1.1 Commandoregel-opties</a></li>
 	    <li><a href="#basics_invocation_variable">4.1.2 Omgevingsvariabele voor i18n</a></li>
+	    <li><a href="#basics_invocation_environment"><span class="todo">4.1.3 Other environment
+	    variables</span></a></li>
 	</ul></li>
 	<li><a href="#basics_interface">4.2 Gebruikers-interface</a>
 	<ul>
@ -354,6 +356,28 @@ well as the way one can contribute to <code>calcurse</code> development.
 	het volgende commando worden gebruikt:</p>
 	<pre>LC_ALL=fr_FR.ISO8859-1 calcurse</pre>

+<div class="todo">
+<h3>4.1.3 Other environment variables<a name="basics_invocation_environment"></a></h3>
+<p>
+	The following environment variables affect the way <code>calcurse</code>
+	operates:</p>
+        <dl>
+	    <dt><code>VISUAL</code></dt>
+	    <dd>Specifies the external editor to use for writing notes.
+	    </dd>
+	    <dt><code>EDITOR</code></dt>
+	    <dd>If the <code>VISUAL</code> environment variable 
+	    is not set, then <code>EDITOR</code> will be used as 
+	    the default external editor. If none of those variables are set, 
+	    then <code>/usr/bin/vi</code> is used instead.
+	    </dd>
+	    <dt><code>PAGER</code></dt>
+	    <dd>Specifies the default viewer to be used for reading notes. 
+	    If this variable is not set, then <code>/usr/bin/less</code> is used.
+	    </dd>
+	</dl>
+</div>
+
 <h2>4.2 Gebruikers-interface<a name="basics_interface"></a></h2>
 <h3>4.2.1 Niet-interactieve modus<a name="basics_interface_noninteractive"></a></h3>
 <p>
@ -490,11 +514,17 @@ well as the way one can contribute to <code>calcurse</code> development.
 	gestart:</p>
 	<pre>
 $HOME/.calcurse/
+           |___notes/
           |___conf
           |___apts
           |___todo
        </pre>
 	<dl class="compact">
+		<dt><code>notes/</code>:</dt>
+		<dd><span class="todo">this subdirectory contains descriptions of the notes 
+		which are attached to appointments, events or todos. One text file is
+		created per note, whose name is built using mkstemp(3) and should be
+		unique, but with no relation with the corresponding item's description.</span></dd>
 		<dt><code>conf</code>:</dt>
 		<dd>bevat de configuratie van de gebruiker.</dd>
 		<dt><code>apts</code>:</dt
@ -968,7 +998,7 @@ msgid ""

 <div class="footer">
 	Copyright (c) 2004-2008 Fr&eacute;d&eacute;ric Culot<br>
-	Calcurse version 2.0 - Last change: February 09, 2008<br>
+	Calcurse version 2.0 - Last change: February 14, 2008<br>
 </div>
 </div>