CALCURSE - organizador basado en modo texto

Abstract

This manual describes calcurse functionnalities, and how to use them. The installation from source is first described, together with the available command line arguments. The user interface is then presented, with all of the customizable options that change calcurse behavior. Last, bug reporting procedure is explained, as well as the way one can contribute to calcurse development.

Tabla de Contenidos

1. Introducción

calcurse es un calendario y organizador de tareas personal basado en modo texto. Te ayuda a mantener un seguimiento de tus eventos, citas y tareas diarias. Un sistema de notificacion recuerda al usuario sus proximas citas y la interfaz de usuario basanda en ncurses puede ser personalizada para cubrir las necesidades del usuario. Todos los comandos están documentados a través de un sistema de ayuda en linea.

2. Descripción

2.1 Historia

Comencé a pensar en este proyecto cuando estaba acabando mi doctorado en Astrofísica... Empezaba a ser un poco complicado el organizarme y realmente necesitaba una buena herramienta que me ayudase en esa difícil tarea ;-)

Me gustan los programas que utilizan las interfaces de usuario en modo texto porque son simples, rápidos y eficientes, por eso pensé en programar un calendario simple en ese tipo de interfaz. Por otra parte, esperaba aprender el lenguaje C que había utilizado solo a ratos durante mi época de estudiante. Por eso pensé que podía ser un buen proyecto para empezar a estar organizado y ¡ aprender algunas cosas sobre C !

Por desgracia acabe mi doctorado antes de acabar calcurse, pero de todas formas aun quería trabajar en el y esperaba que pudiese ser de ayuda a otra gente. Y aquí esta...

Pero ¿por que 'calcurse'? Bien, es simplemente una concatenación de CALendar y nCURSEs, el nombre de la librería utilizada para construir la interfaz de usuario.

2.2 Características importantes

Calcurse es multi-plataforma e intenta ser ligero, rápido y fiable. Esta hecho para ser usado en consola o terminal, tanto en local como en una maquina remota a través de ssh o una conexión similar.

Calcurse puede funcionar de dos modos diferentes : modo interactivo o no-interactivo. El primero permite a un usuario ver su organizador en casi cualquier maquina gracias a la interfaz basada en modo texto. El segundo modo permite crear recordatorios de una forma muy fácil, únicamente añadiendo calcurse, con los argumentos apropiados en la linea de comando, en el crontab o mediante un sell init script.

Por otra parte, calcurse fue creado pensando en el usuario final y trata de ser lo mas amigable posible. Esto significa un completo sistema de ayuda en linea, conjuntamente con tener todas las posibles acciones visualizadas en todo momento en la barra de estado. La interfaz de usuario también es configurable y uno puede elegir entre combinaciones de colores y disposiciones. Key bindings are also configurable, to fit everyone's needs. Finalmente, un sistema de notificacion recuerda al usuario sus proximas citas. The reminders are sent even if the user's interface is not running, as calcurse is able to run in background.

3. Instalación

3.1 Requerimientos

3.1.1 librería ncurses

Calcurse requiere solo un compilador C, como cc o gcc, y la librería ncurses. Sería muy sorprendente no tener una librería ncurses valida ya instalada en tu ordenador, pero si no la tienes, puedes encontrarla en la siguiente dirección :

http://ftp.gnu.org/pub/gnu/ncurses/

Note: It is also possible to link calcurse against the ncursesw library (ncurses with support for unicode). However, UTF-8 is not yet supported by calcurse.

3.1.2 librería gettext

calcurse soporta internacionalización (de aquí en adelante i18n) con las utilidades gettext. Esto significa que calcurse puede producir mensajes en diferentes lenguas si esta compilado con el soporte para lengua nativa (p.e. NLS).

Por otra parte, NLS es opcional, si tu no quieres tener soporte para esta característica, basta con que utilices la opción --disable-nls en el comando configure (ver la sección Proceso de instalación). Para comprobar si las utilidades gettext están instaladas en tu sistema, puedes buscar el archivo cabecera libintl.h, por ejemplo :

locate libintl.h

Si este archivo cabecera no se encuentra, entonces puedes obtener las fuentes de gettext en la siguiente dirección :

http://ftp.gnu.org/pub/gnu/gettext/

Nota: Incluso si libintl.h se encuentra en tu sistema, puede ser necesario especificar su localización durante el proceso de instalación, utilizando la opción --with-libintl-prefix en el comando configure. De hecho, el comando configure puede fallar al tratar de localizar esta librería si esta instalada en un lugar infrecuente.

3.2 Proceso de instalación

Primero necesitas descomprimir ( gunzip y untar) el archivo fuente:

tar zxvf calcurse-2.7.tar.gz

Una vez has resuelto los requisitos y has extraído el archivo, el proceso de instalación es muy simple y sigue los tres pasos habituales:

  1. ./configure
  2. make
  3. make install (puede requerir privilegios de administrador)

Utiliza ./configure --help para obtener una lista de posibles opciones.

4. calcurse básicos

4.1 Invocación (arranque del programa)

4.1.1 Argumentos de la linea de comando

calcurse acepta las siguientes opciones en la linea de comando (ambas opciones, cortas y largas estan soportadas):

-a, --appointment
Imprime las citas y eventos para el día actual y sale.

Nota: el calendario desde donde leerán puede ser especificado usando la opción '-c'.

-c <file>, --calendar <file>
Especifica el archivo de calendario a usar. El calendario por defecto es ~/.calcurse/apts (ver la sección Archivos de calcurse).
-d <date|num>, --day <date|num>
Imprime las citas y eventos para la fecha dada o para el numero dado de días próximos, dependiendo del formato del argumento. Soporta dos posible formatos :
  • una fecha (possible formats described below).
  • un numero 'n'.
En el primer caso, devolverá la lista de citas y eventos para la fecha especificada mientras que en el segundo caso devolverá la lista de citas y eventos para los 'n' próximos días. Por ejemplo, tecleando calcurse -d 3 mostrara tus citas y eventos para hoy, mañana y pasado mañana.
Possible formats for specifying the date are defined inside the general configuration menu (see General options), using the input_datefmt variable.

Nota: al igual que para la opción '-a' , el calendario desde donde se leerán puede ser especificado usando la opción '-c' .

-D <dir>, --directory <dir>
Specify the data directory to use. This option is incompatible with -c. If not specified, the default directory is '~/.calcurse/'.
-h, --help
Imprime un breve texto de ayuda describiendo las opciones soportadas en la linea de comando y sale.
-i <file>, --import <file>
Import the icalendar data contained in file.
-n, --next
Imprime las citas para las próximas 24 horas y sale. El tiempo indicado es el numero de horas y minutos que faltan hasta la proxima cita.

Nota: el calendario desde donde se leeran las citas puede ser especificado usando la opcion '-c'.

-N, --note
When used with the '-a' or '-t' flag, also print note content if one is associated with the displayed item.
-r[num], --range[=num]
Print events and appointments for the num number of days and exit. If no num is given, a range of 1 day is considered.
-s[date], --startday[=date]
Print events and appointments from date and exit. If no date is given, the current day is considered.
-S<regex>, --search=<regex>
When used with the '-a', '-d', '-r', '-s', or '-t' flag, print only the items having a description that matches the given regular expression.
--status
Display the status of running instances of calcurse. If calcurse is running, this will tell if the interactive mode was launched or if calcurse is running in background. The process pid will also be indicated.
-t[num], --todo[=num]
Imprime la lista de tareas pendientes ('ToDo') y sale. Si se especifica la opcion numero, se mostraran todas las tareas pendientes que tengan la prioridad igual a numero.
The priority number must be between 1 (highest) and 9 (lowest). It is also possible to specify '0' for the priority, in which case only completed tasks will be shown.

-v, --version
Muestra la versión de calcurse y sale.
-x[format], --export[=format]
Export user data to specified format. Events, appointments and todos are converted and echoed to stdout. Two possible formats are available: ical and pcal (see section Links below). If the optional argument format is not given, ical format is selected by default.

Nota: redirecciona la salida standard para exportar los datos a un archivo usando un comando como este: $ calcurse --export > my_data.dat

4.1.2 Variable de entorno para i18n

calcurse puede ser compilado son soporte para lenguaje nativo (ver librería gettext ). Así, si quieres ver los mensajes en tu lengua nativa, primero comprueba que esta disponible mirando en el fichero po/LINGUAS. Este fichero indica la lista de lenguas disponibles mostrando el código de dos letras correspondiente (por ejemplo, es sería para español). Si no encuentras tu lengua, tu ayuda seria muy apreciada si pudieses traducir calcurse (ver la sección ¿Como puedo ayudar?.

Si tu lengua esta disponible, arranca calcurse con el siguiente comando:

LC_ALL=es_ES calcurse

donde es_ES es el nombre locale en este ejemplo, pero puede ser remplazado por el locale correspondiente a la lengua deseada.

Debes especificar también tipo de caracteres 'charset' que se usara porque en algunos casos los acentos podrían no mostrarse correctamente. Este tipo de caracteres o 'charset' esta indicado al principio del archivo po correspondiente al lenguaje deseado. Como puedes ver en el archivo es.po se usa el tipo de caracteres iso-8859-1, entonces puedes iniciar calcurse utilizando el siguiente comando:

LC_ALL=es_ES.ISO8859-1 calcurse

4.1.3 Other environment variables

The following environment variables affect the way calcurse operates:

VISUAL
Specifies the external editor to use for writing notes.
EDITOR
If the VISUAL environment variable is not set, then EDITOR will be used as the default external editor. If none of those variables are set, then /usr/bin/vi is used instead.
PAGER
Specifies the default viewer to be used for reading notes. If this variable is not set, then /usr/bin/less is used.

4.2 Interfaz de usuario

4.2.1 Modo no-interactivo

Cuando es llamado por lo menos con uno de los siguientes argumentos: -a, -d, -h, -n, -t, -v, -x, calcurse arranca en modo no-interactivo. Esto significa que se mostrara la información deseada, y después de esto, calcurse simplemente se cierra y eres de nuevo devuelto al prompt del shell.

De esta forma, uno puede añadir una linea como 'calcurse --todo --appointment' en el archivo de inicialización de su entorno gráfico (X o consola) para ver, cuando entras en el sistema; la lista de tareas, citas y eventos programadas para el día actual.

4.2.2 Modo interactivo

Note: Key bindings that are indicated in this manual correspond to the default ones, defined when calcurse is launched for the first time. If those key bindings do not suit user's needs, it is possible to change them within the keys configuration menu (see key bindings).

Cuando es llamado sin ningún argumento o solo con la opción -c, calcurse arranca en modo interactivo. En este modo, se muestra una interfaz conteniendo tres paneles diferentes por los cuales puedes navegar usando la tecla 'TAB' (tabulador), mas una barra de notificaciones, mas una barra de estado (ver la figura de abajo).


   panel de citas y eventos ---.                         .--- panel de calendario
                               |                         |  
                               v                         v
 +------------------------------------++----------------------------+
 |          Citas y eventos           ||        Calendario          |
 |------------------------------------||----------------------------|
 |                 (|)  Abril 6, 2006 ||         Abril 2006         |
 |                                    ||Lun Mar Mie Jue Vie Sab Dom |
 |                                    ||                      1   2 |
 |                                    ||  3   4   5   6   7   8   9 |
 |                                    || 10  11  12  13  14  15  16 |
 |                                    || 17  18  19  20  21  22  23 |
 |                                    || 24  25  26  27  28  29  30 |
 |                                    ||                            |
 |                                    |+----------------------------+
 |                                    |+----------------------------+
 |                                    ||     Tareas Pendientes      | 
 |                                    ||----------------------------| panel de tareas pendientes
 |                                    ||                            |   |
 |                                    ||                            |   |
 |                                    ||                            |<--.
 |                                    ||                            |
 +------------------------------------++----------------------------+
 |---[ Lun 6-4-2006 | 10:11:43 ]---(citas)----> 01:20 :: comida <---|<--.
 +------------------------------------------------------------------+ barra de notificaciones
 | ? Ayuda    R Redibujar    H/L -/+1 Dia      G Ir a    C Config   | 
 | Q Salir    S Guardar      J/K -/+1 Semana   Tab Cambiar vista    |<-. 
 +------------------------------------------------------------------+  |
                                                                       |
                                                                 barra de estado

        

El primer panel representa un calendario que permite iluminar un día en particular, el segundo contiene la lista de citas y eventos pertenecientes a ese día, y el ultimo contiene una lista de tareas pendientes (ToDo) pero que no están asignadas a ningún día especifico.

In the appointment panel, one can notice the '(|)' sign just in front of the date. This indicates the current phase of the moon. Depending on which is the current phase, the following signs can be seen:

' |) ':
first quarter
' (|) ':
full moon
' (| ':
last quarter
' | ':
new moon
no sign:
phase of the moon does not correspond to any of the above ones

En la parte inferior de la pantalla hay una barra de estado, que indica las posibles acciones y sus correspondientes atajos de teclado.

Justo encima de esta barra de estado esta la barra de notificaciones, que indica de izquierda a derecha : la fecha actual, la hora actual, el archivo de calendario actualmente en uso (en el ejemplo de arriba, el de citas, que es el fichero de calendario por defecto, ver la sección siguiente), y la cita mas cercana para las proximas 24 horas. En el ejemplo seria una comida dentro de una hora y 20 minutos.

Nota: Algunas acciones, como editar o añadir un elemento, requieren teclear algo de texto. Esto se hace con la ayuda del editor incorporado.

Dentro de este editor, si una linea es mas larga que el ancho de la pantalla, se mostrara un caracter como '>', '*', o '<' al final de la columna indicando que hay mas caracteres despues, antes y despues, o antes de la posicion actual, respectivamente. La linea se movera horizontalmente si es necesario.

Por otra parte, hay algunos caracteres que se utilizan para editar. Aqui se indican los comandos de edicion disponibles ('^' significa la tecla "control"):

^a:
mueve el cursor al principio de la linea
^b:
mueve el cursor para atras
^d:
borra un caracter por delante
^e:
mueve el cursor al final de la linea
^f:
mueve el cursor para alante
^h:
borra un caracter hacia atras
^k:
borra desde el cursor hasta el final de la linea
ESCAPE
b>: cancela la edicion

4.3 Background mode

When the daemon mode is enabled in the notification configuration menu (see Notify-bar settings), calcurse will stay in background when the user interface is not running. In background mode, calcurse checks for upcoming appointments and runs the user-defined notification command when necessary. When the user interface is started again, the daemon automatically stops.

calcurse background activity can be logged (set the notify-daemon_log variable in the notification configuration menu), and in that case, information about the daemon start and stop time, reminders' command launch time, signals received... will be written in the daemon.log file (see section files).

Using the --status command line option (see section Command line arguments), one can know if calcurse is currently running in background or not. If the daemon is running, a message like the following one will be displayed (the pid of the daemon process will be shown):

calcurse is running in background (pid 14536)

Note: To stop the daemon, just send the TERM signal to it, using a command such as: 'kill daemon_pid', where daemon_pid is the process id of the daemon (14536 in the above example).

4.4 Archivos de calcurse

La siguiente estructura se crea en tu directorio $HOME

(or in the directory you specified with the -D option)
la primera vez que se ejecuta calcurse :

$HOME/.calcurse/
           |___notes/
           |___conf
           |___keys
           |___apts
           |___todo
	
notes/:
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.
conf:
contiene la configuración del usuario.
keys:
this file contains the user-defined key bindings
apts:
contiene todos los eventos y citas del usuario.
todo:
contiene la lista de tareas pendientes.

Note: If the logging of calcurse daemon activity was set in the notification configuration menu, the extra file daemon.log will appear in calcurse data directory. This file contains logs about calcurse activity when running in background.

4.5 Import/Export capabilities

The import and export capabilities offered by calcurse are described below.

4.5.1 Import

Data in icalendar format as described in the rfc2445 specification (see links section below) can be imported into calcurse. Calcurse ical parser is based on version 2.0 of this specification, but for now on, only a subset of it is supported.

The following icalendar properties are handled by calcurse:

The icalendar "DESCRIPTION" property will be converted into calcurse format by adding a note to the item. If a "VALARM" property is found, the item will be flagged as important and the user will get a notification (this is only applicable to appointments).

Here are the properties that are not implemented:

4.5.2 Export

Two possible export formats are available: ical and pcal (see section Links below to find out about those formats).

4.6 Ayuda en linea

En cualquier momento, puedes consultar el sistema de ayuda integrado presionando la tecla '?'. Una vez en la pantalla de ayuda, puedes acceder a la información acerca de un comando especifico presionando la tecla correspondiente a ese comando.

5. Opciones

Todos los parámetros de calcurse se peden configurar desde el menú de Configuración disponible pulsando 'C'. Entonces aparecerá un submenu con tres posibilidades : pulsando 'C' de nuevo, te lleva a la configuración del esquema de colores. Pulsando 'L' te permite elegir la disposición de la pantalla principal de calcurse (en otras palabras, donde colocar los tres diferentes paneles en pantalla), pressing 'K' opens the key bindings configuration menu, y finalmente puedes elegir entre diferentes opciones generales pulsando 'G'.

5.1 Opciones generales

Estas opciones controlan el comportamiento general en la forma que se describe a continuación:

auto_guardar (por defecto: si)
Esta opción permite salvar automáticamente los datos del usuario (si esta fijada en si) cuando se sale del programa.

aviso: Los datos no serán guardados automáticamente si auto_guardar esta fijada en no. Esto significa que el usuario debe pulsar 'S' (guardar) para guardar sus modificaciones antes de salir.

periodic_save (default: 0)
If different from '0', user's data will be automatically saved every periodic_save minutes. When an automatic save is performed, two asterisks (i.e. '**') will appear on the top right-hand side of the screen).
confirmar_salir (por defecto: si)
Si se fija en si, se requerirá confirmación antes de salir, de otra forma cuando se pulse 'Q' causara que calcurse se cierre sin esperar confirmación del usuario.
confirmar_borrar (por defecto: si)
Si se fija esta opción en si, cuando se pulse 'D' para borrar una anotación (bien sea un ToDo (tarea pendiente), cita, o evento), se requerirá confirmación del usuario antes de borrar de la lista la anotación seleccionada. De otra forma, no será necesaria confirmación antes de borrar la anotación.
saltar_dialogos_sistema (por defecto: no)
Fijando esta opción en si causará la omisión de los diálogos del sistema relativos al guardado y carga de los datos. Esto puede ser útil para acelerar los procesos de entrada y salida al programa.
saltar_barra_progreso (por defecto: no)
Si se fija en si, ocasionara la desaparición de la barra de progreso que normalmente se muestra cuando se salvan datos a un archivo. Si esta fijada en no, se mostrará esta barra, conjuntamente con el nombre del archivo que se esta guardando (ver sección Archivos de calcurse).
empezar_semana_en_lunes (por defecto: si)
Uno puede elegir entre el Lunes o el Domingo como primer día de la semana. Si la opción empezar_semana_en_lunes esta fijada en si, el Lunes será el primer día de la semana en la vista del calendario. Por el contrario, si esta opción esta fijada en no, entonces el Domingo será el primer día de la semana.
output_datefmt (default: %D)
This option indicates the format to be used when displaying dates in non-interactive mode. Using the default values, dates are displayed the following way: mm/dd/aa. You can see all of the possible formats by typing man 3 strftime inside a terminal.
input_datefmt (default: 1)
This option indicates the format that will be used to enter dates in calcurse. Four choices are available:
  1. mm/dd/yyyy
  2. dd/mm/yyyy
  3. yyyy/mm/dd
  4. yyyy-mm-dd

5.2 Key bindings

One can define it's own keybindings within the 'Keys' configuration menu. The default keys look like the one used by the vim editor, especially the displacement keys. Anyway, within this configuration menu, users can redefine all of the keys available from within calcurse's user interface.

To define new keybindings, first highlight the action to which it will apply. Then, delete the actual key binding if necessary, and add a new one. You will then be asked to press the key corresponding to the new binding. It is possible to define more than one key binding for a single action.

An automatic check is performed to see if the new key binding is not already set for another action. In that case, you will be asked to choose a different one. Another check is done when exiting from this menu, to make sure all possible actions have a key associated with it.

The following keys can be used to define bindings:

While inside the key configuration menu, an online help is available for each one of the available actions. This help briefly describes what the highlighted action is used for.

5.3 Color (temas)

El tema de color de calcurse puede se configurado para cubrir las necesidades del usuario. Para cambiar el tema por defecto, la pagina de configuracion muestra las posibles opciones para el color de fondo y del texto. Usando las teclas de las flechas o las teclas de desplazamiento de calcurse para moverse y 'X'o la barra espaciadora para seleccionar el color, el usuario puede previsualizar el tema que se aplicara. Tambien es posible mantener los colores por defecto del terminal seleccionando la opcion correspondiente en la lista.

The chosen color theme will then be applied to the panel borders, to the titles, to the keystrokes, and to general informations displayed inside status bar. A black and white theme is also available, in order to support non-color terminals.

Notas: Dependiendo de tu tipo de terminal y del valor de la variable de entorno $TERM, color puede no estar soportado. En ese caso, si intentas cambiar los colores aparecerá un mensaje de error puesto que tu terminal no soporta esta característica. Si sabes que tu terminal soporta colores pero no puedes conseguir que calcurse los muestre, intenta fijar tu variable $TERM a otro valor. (como por ejemplo xterm-xfree86).

5.4 Configuración de la disposición

La disposición corresponde a la posición de los paneles dentro de la pantalla de calcurse. La disposición por defecto hace que el calendario se muestre en la esquina superior derecha del terminal, el panel de 'ToDo' (tareas pendientes) en la esquina inferior derecha, mientras que el panel de citas se muestra en la parte izquierda de la pantalla (ver la figura de la sección Modo interactivo como ejemplo de la disposición por defecto). Eligiendo otra disposición en la pantalla de configuración, el usuario puede modificar la apariencia de calcurse que mejor se adapte a sus necesidades colocando los diferentes paneles donde los necesite.

5.5 Ajustes de la barra de notificaciones

Las siguientes opciones se usan para modificar el comportamiento de la barra de notificaciones:

mostrar-barra-notificaciones (por defecto: si)
Esta opción indica si quieres que se muestre la barra de notificaciones o no.
fecha_barra-notificaciones (por defecto: %a %F)
Con esta opcion puedes especificar el formato que se usara para mostrar la fecha actual dentro de la barra de notificaciones. Puedes ver todos los formatos posibles tecleando man 3 strftime en un terminal.
hora_barra-notificaciones (por defecto: %T)
Con esta opcion puedes especificar el formato que se usara para mostrar la hora actual dentro de la barra de notificaciones. Puedes ver todos los formatos posibles tecleando man 3 strftime dentro de un terminal.
alarma_barra-notificaciones (por defecto: 300)
Cuando tienes una cita dentro de los siguientes 'alarma_barra-notificaciones' segundos, la referencia a esa cita dentro de la barra de notificaciones comienza a parpadear. Además, se lanzara el comando definido por la opcion comando_barra-notificaciones. De esta forma, se alerta al usuario y este sabe que detro de poco tiene una cita.
comando_barra-notificaciones (por defecto: printf '\a')
Esta opcion indica que comando se lanzara cuando haya una cita proxima marcada como "inportante". Este comando sera pasado al shell del usuario que lo interpretara. Para saber que tipo de shell debe usarse, se utilizara el contenido dela variable de entorno $SHELL. Si esta variable no esta seleccionada, se usara /bin/sh.

Ejemplo: Digamos que el comando mail esta disponible en el sistema del usuario, uno puede usar este comando para ser notificado por correo electronico cuando se acerque la cita (la descripcion de la cita se mencionara en el cuerpo del mensaje):

calcurse --next | mail -s "[calcurse] upcoming appointment!" user@host.com
notify-daemon_enable (default: no)
If set to yes, daemon mode will be enabled, meaning calcurse will run into background when the user's interface is exited. This will allow the notifications to be launched even when the interface is not running. More details can be found in section 'Background mode'.
notify-daemon_log (default: no)
If set to yes, calcurse daemon activity will be logged (see section files).

6. Bugs conocidos

Aparece una incorrecta iluminación de las anotaciones cuando se usa el tema calcurse blanco y negro conjuntamente con la variable $TERM fijada a xterm-color. Para solucionar este bug, y tal como fue anunciado por Thomas E. Dickey (que mantiene xterm), xterm-xfree86 puede ser usado en vez de xterm-color para fijar la variable $TERM:

"The xterm-color value for $TERM is a bad choice for XFree86 xterm because it is commonly used for a terminfo entry which happens to not support bce. Use the xterm-xfree86 entry which is distributed with XFree86 xterm (or the similar one distributed with ncurses)."

7. Informar de bugs y comentarios

Por favor envía los informes de bugs y tus comentarios a :

calcurse @ culot . org

o al autor:

frederic @ culot . org

8. ¿Como contribuir?

Si te gustaría contribuir al proyecto, puedes enviar tus comentarios acerca de lo que te gusta o no te gusta, y si hay alguna funcionalidad que echas de menos en calcurse. Por ahora, las posibles contribuciones están limitadas a la traducción de la documentación y mensajes de error de calcurse.

Nota: Cualquier ayuda para la internacionalización de calcurse será muy bienvenida, pero antes de contribuir envía en email a : calcurse-i18n @ culot . org para saber si alguien ha empezado ya el proceso de traducción a tu lengua.

8.1 Traduciendo la documentación

El directorio doc/ del paquete fuente ya contiene versiones traducidas del manual de calcurse. Aunque si el manual no esta aun disponible en tu lengua nativa, sería de gran ayuda si tu pudieses traducirlo.

Para hacerlo, únicamente copia uno de los archivos de los manuales existentes de manual_XX.html, donde XX identifica tu lengua. Entonces traduce este nuevo archivo creado y envía un email al autor (ver Informar de bugs y comentarios), para que pueda ser incluido en la nueva edición de calcurse.

8.2 calcurse i18n

Como ya se ha mencionado, las utilidades de gettext son usadas por calcurse para producir mensajes en diferentes lenguas. Esta sección proporciona información acerca de como traducir estos mensajes a tu lengua nativa. Por otra parte este 'como' es deliberadamente incompleto, centrado específicamente en trabajar con gettext para calcurse. Para una información mas completa deberás dirigirte al manual de GNU gettext en:

http://www.gnu.org/software/gettext/manual/

Básicamente, hay tres tipos de personas diferentes que están involucradas en la cadena de traducción: programadores, coordinadores de lenguaje y traductores. Después de una rápida descripción de como funcionan las cosas, las tareas del traductor se describen a continuación.

8.2.1 Descripción

Para que se muestren mensajes en la lengua nativa del usuario, se requieren dos pasos: internacionalización (i18n) y localización (l10n).

i18n se refiere a como hacer que calcurse soporte múltiples lenguas. Esto es realizado por programadores, quienes seleccionan los textos traducibles y proporcionan una manera de que se muestren traducidos en el arranque.

l10n se refiere a como hacer que el calcurse internacionalizado se adapte a la lengua especifica del usuario, p.e. traduciendo las sentencias previamente marcadas por los desarrolladores y seleccionando el entorno correcto para que calcurse utilice el resultado de esta traducción.

Entonces, las sentencias traducibles son primero marcadas por los programadores dentro de el código fuente de los archivos en código C, y después recogidas en un archivo plantilla (calcurse.pot - la extensión pot significa portable object template). El contenido de esta plantilla es entonces combinado con los ficheros de traducción para cada lengua (fr.po para francés por ejemplo - donde po significa portable object, lo cual quiere decir que puede ser leído y editado por humanos). Un equipo de traducción dado, cogería este archivo, traduciría estas sentencias y se las mandaría de nuevo a los desarrolladores. En el momento de la compilación, una versión binaria de esta archivo (por razones de eficacia) producirá (fr.mo - donde mo significa machine object, lo que quiere decir que puede ser leído por programas), y entonces instalado. Ahora calcurse utilizara este archivo en el arranque, traduciendo las sentencias acorde con la configuración del locale del usuario.

8.2.2 Tareas del traductor

Supongamos que alguien quiere iniciar la traducción de una nueva lengua. Estos son los pasos a seguir:

Ahora, teniendo el archivo fr.po, estas preparado para empezar.

8.2.3 Archivos-po

El formato de los archivos-po es muy simple. De hecho, los archivos-po están formados de cuatro cosas:

  1. lineas de localización: te dicen donde están las sentencias (nombre del archivo y numero de linea), en caso de que necesites un poco mas de contexto.
  2. lineas msgid: las sentencias a traducir.
  3. lineas msgstr: las sentencias traducidas.
  4. lineas con prefijo '#': comentarios (algunos con un significado especial, como veremos más abajo).

Básicamente, todo lo que tienes que hacer es llenar las lineas msgstr con la traducción de la linea msgid de encima.

Algunas notas:

  • Sentencias Fuzzy
    Encontraras sentencias marcadas con un comentario "#, fuzzy". calcurse no utilizara las traducciones de ese tipo de sentencias hasta que tu elimines este comentario. Si una sentencia es fuzzy significa que ya ha sido traducida pero que desde entonces ha sido cambiada en el código fuente del programa, o que es una nueva sentencia para la cual gettext ha hecho una traducción 'forzosa' basada en otras sentencias del archivo. Esto quiere decir que tu debes revisar la traducción. Algunas veces, la sentencia original ha cambiado solo porque se ha arreglado una tipografía. En ese caso, tu no tienes que cambiar nada. Pero a veces, la traducción puede no ser muy precisa y necesitara ser modificada. Una vez que has acabado y estas satisfecho con la traducción, tan solo elimina el comentario "#, fuzzy" y la traducción podrá ser usada de nuevo en calcurse.
    Sentencias c-format y sentencias especiales
    Algunas sentencias tienen el siguiente comentario: "#, c-format". Esto te esta diciendo que partes de la sentencia a traducir tienen un significado especial para el programa, puede ser que la sentencia contenga alguna variable, como por ejemplo % , si ves algo como esto "%s", eso quiere decir que el programa remplazara esta variable por algún valor o por otra sentencia. En ese caso, puedes traducir el resto de la sentencia pero sin modificar las variables que pueda contener. También hay sentencias que contienen \ , como por ejemplo \n o \t, lo primero significa un final de linea y lo otro una tabulación, así pues, puedes traducir la sentencia pero con cuidado de no modificar estos símbolos.
    Las traducciones pueden ser excesivamente largas
    Si las lineas son demasiado largas, pueden ser partidas de la siguiente forma:
    msgid ""
    "alguna linea muy larga"
    "otra linea"
            
    Cabecera del archivo-po
    Al principio del archivo-po, la primera sentencia forma una cabecera, donde hay varios tipos de información. Lo mas importante es el 'charset'. Suele parecerse a esto:
    "Content-Type: text/plain; charset=utf-8\n"
            
    Debes cumplimentar también el campo 'Last-Translator' (último traductor), para que los potenciales contribuidores puedan contactar contigo si ellos quieren colaborar en el equipo de traducción, o hacer algún tipo de corrección sobre las traducciones. Puedes poner solo tu nombre/nick o añadir tu dirección de email, por ejemplo:
    "Last-Translator: Frederic Culot <frederic@culot.org>\n"
            
    Comentarios
    Añadir comentarios (lineas que comiencen con el carácter '#') puede ser una buena manera de evitar problemas o dificultades a los correctores u otros miembros de tu equipo.
    Tamaño de las sentencias
    calcurse es un programa basado en curses/consola, así que puede ser muy dependiente del tamaño del terminal donde se ejecute (numero de columnas). Piensa en ello cuando lo traduzcas. A menudo una sentencia puede colocarse en una sola linea (la longitud standard es de 80 caracteres). No traduzcas a lo loco, intenta ver donde se mostrara la sentencia y adapta a ello tu traducción.
    Algunas herramientas útiles
    El formato de los archivos-po es muy simple, y puede ser editado con casi cualquier editor, pero si lo prefieres, hay unas pocas herramientas especializadas que pueden resultarte interesantes para traducir: >
    Y finalmente
    Espero que te hayas divertido contribuyendo a un mundo mas internacionalizado :) Si tienes alguna pregunta no dudes en contactar conmigo en frederic @ culot . org.
  • 9.Enlaces

    Esta sección contiene enlaces y referencias que pueden ser de tu interés.

    9.1 Pagina web de calcurse

    La pagina web de calcurse es:

    http://culot.org/calcurse

    9.2 Lista de anuncios de calcurse

    Si estas interesado en el proyecto y quieres ser avisado cuando salga una nueva versión, puedes suscribirte a la lista de anuncios de calcurse. Si lo haces, recibirás un email tan pronto como una nueva funcionalidad se añada a calcurse.

    Para suscribirte a la lista, envía un email a : calcurse-announce @ culot . org poniendo "subscribe" en el asunto.

    9.3 calcurse RSS feed

    Otra posibilidad para enterarte de cuando aparecen nuevas versiones de Calcurse es seguir el RSS feed en:

    http://culot.org/calcurse/news_rss.xml

    Este RSS feed es actualizado cada vez que hay una nueva version de Calcurse disponible describiendo las nuevas caracteristicas.

    9.4 Other links

    You may want to look at the ical format specification (rfc2445) at:

    http://tools.ietf.org/html/rfc2445

    The pcal project page can be found at:

    http://pcal.sourceforge.net/

    10. Gracias a ...

    Es la hora de dar las gracias a personas sin las que este programa ¡ no existiría ! Por eso esta es una lista de las personas que contribuyeron y a las que me gustaría dar las gracias :

    Y por último, muchas muchas gracias a todos los usuarios de calcurse que me han enviado sus comentarios.