CALCURSE - tekst-gebaseerde organizer
Abstract
This manual describescalcurse
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.
Inhoudsopgave
1. Introductie
calcurse
is een tekstgebaseerde kalender en planner. Het
helpt om overzicht te houden over afspraken en alledaagse taken. Een
aan te passen meldingssysteem herinnert de gebruiker aan komende
deadlines, en de curses-gebaseerde interface kan aangepast worden aan
de wensen van de gebruiker. Alle commando's zijn gedocumenteerd in een
online hulpsysteem.
2. Overzicht
2.1 Inleiding
Ik begon te denken aan dit project toen ik bijna afgestudeerd was in de astrofysica... Het werd moeilijk om alles georganiseerd te houden en ik had behoefte aan een goed hulpmiddel om me daar bij te helpen. ;)
Ik hou van programma's die gebruik maken van de tekst-interface, omdat
ze simpel, snel, overdraagbaar en efficient zijn, dus ik dacht eraan
om een simpele tekst-interface kalender te programmeren. Ook wilde ik
graag verder leren programmeren in de programmeertaal C
,
welke ik alleen in mijn vooropleiding had gebruikt. Zodoende zou ik
dus leren programmeren in C
, en mijn zaakjes voor elkaar
krijgen.
Helaas studeerde ik af voordat ik klaar was met calcurse
,
maar ik was nog steeds geboeid door het project, in de hoop dat het
ook voor anderen een handig programma zou zijn. En hier is dan het
resultaat...
Waarom de naam 'calcurse', vraagt u zich af? Het is simpelweg een samentrekking van 'CALendar' en 'nCURSEs', de naam van de bibliotheek die gebruikt wordt om de gebruikers-interface aan te sturen.
2?2 Belangrijke kenmerken
Calcurse
is multi-platform, neemt weinig systeembronnen
in beslag, en is snel en betrouwbaar. Het moet gebruikt worden binnen
een console of terminal, lokaal of op een aparte computer door middel
van een connectie met een programma zoals ssh.
Calcurse
kan op twee verschillende manieren gebruikt
worden: interactieve of niet-interactieve modus. De eerste modus zorgt
er voor dat men zijn eigen agenda bijna overal kan bekijken, dankzij
de tekst-gebaseerde interface. Met de tweede modus, kan men makkelijk
met geheugensteuntjes werken door calcurse
met de juiste
commandoregel-opties in een cron tab of shell init script te
zetten.
Bovendien, is calcurse
geschreven met de
eindgebruiker in gedachten, en is dus zo gebruikersvriendelijk
mogelijk. Dit betekent dat er een volledige hulp-functie is, en de
beschikbare acties altijd op het scherm staan in de statusbalk. De
gebruikers-interface is ook aan te passen, en men kan tussen
verschillende kleurenschema's en layout-combinaties kiezen. En als
laatste, is er het configurabele meldingssysteem, dat gebruikers
verwittigt van op handen zijnde afspraken.
3. Installatie
3.1 Benodigheden
3.1.1 ncurses
bibliotheek
Calcurse
maakt alleen gebruik van een C
compiler, zoals cc
of gcc
, en de
ncurses
bibliotheek. Het is onwaarschijnlijk dat er nog
geen juiste versie van ncurses
op uw computer staat, maar
indien het niet zo is, is het via de volgende url te vinden:
http://ftp.gnu.org/pub/gnu/ncurses/
3.1.2 gettext
bibliotheek
calcurse
ondersteunt internationalisatie
(i18n
genoemd hierna) door middel van gettext
. Dit betekent
dat calcurse
berichten in verschillende talen kan
weergeven, indien gecompileerd met native language support
(NLS).
NLS is optioneel en als het niet nodig is,
kan het uitgeschakeld worden. Dit wordt gedaan door
--disable-nls
als optie mee te geven aan
configure
(zie sectie Installatieprocedure). Om te zien of
gettext op het systeem aanwezig is, kan er gezocht worden naar het
libintl.h
header bestand b.v.:
locate libintl.h
Indien het header bestand niet gevonden wordt, kan het via de volgende url verkregen worden:
http://ftp.gnu.org/pub/gnu/gettext/
Noot:
Zelfs als libintl.h
gevonden wordt, is het
misschien beter om de lokatie van het bestand tijdens de Installatieprocedure) mee te geven aan
configure
door middel van
--with-libintl-prefix
. Het zou kunnen, dat
configure
de bibliotheek niet kan vinden, als het op een
niet-gangbare plaats geïnstalleerd is.
3.2 Installatieprocedure
Als eerste moet het volgende archief uitgepakt worden met gunzip en untar:
tar zxvf calcurse-1.9.tar.gz
Zodra de benodigde pakketten geïnstalleerd zijn en het archief uitgepakt is, is de installatieprocedure vrij simpel, via de standaard drie stappen:
./configure
make
make install
(mogelijk root privileges nodig)
Typ ./configure --help
om een lijst te zien van mogelijke
opties.
4. calcurse
basis
4.1 Het aanroepen van calcurse
4.1.1 Commandoregel-opties
calcurse
accepteert de volgende opties op de
commandoregel (zowel korte en lange opties worden ondersteund):
-a, --appointment
-
Geeft de afspraken van vandaag weer en verlaat het programma.
Noot: de te gebruiken kalender waaruit de afspraken gelezen moeten worden, kan gekozen worden met de '-c' vlag.
-c <file>, --calendar <file>
-
Kies het te gebruiken kalenderbestand. De standaardkalender is
~/.calcurse/apts
(zie sectiecalcurse
bestanden). -d <date|num>, --day <date|num>
-
Geef de afspraken weer van de gegeven datum of van het gegeven aantal
komende dagen, afhankelijk van de opties. Er zijn twee mogelijkheden:
- een datum zoals volgt 'mm/dd/yyyy'.
- een nummer 'n'.
calcurse -d 3
intypt, zullen de afpraken voor vandaag, morgen en overmorgen worden weergegeven.Noot: Net zoals bij de '-a' vlag, kan de te gebruiken kalender worden gekozen met de '-c' vlag.
-h, --help
- Geeft een korte hulptekst weer, met de ondersteunde commandoregel-opties en verlaat het programma.
-n, --next
-
Geeft de eerstvolgende afspraak weer die binnen 24 uur valt en verlaat
het programma.
De weergegeven tijd is het aantal uren en minuten tot de afspraak.
Noot: de te gebruiken kalender met de afspraken, kan gekozen worden met de '-c' vlag.
-t[num], --todo[=num]
-
Geef de 'todo' lijst weer en verlaat het programma. Als het optionele
nummer
num
wordt meegegeven, zullen alleen de todo's met de prioriteit gelijk aannum
worden weergegeven.Noot: het nummer van de prioriteit moet liggen tussen 1 (hoogste) en 9 (laagste).
-v, --version
-
Geeft het versienummer van
calcurse
weer en verlaat het programma. -x, --export
-
Exporteert de data van de gebruiker naar het iCalender-formaat.
Gebeurtenissen, afspraken en taken worden geconverteerd en naar stdout
gezonden.
Noot: Om de data te exporteren naar een bestand, kan men de standaard output omleiden met een commando zoals:
$ calcurse --export > my_data.ics
4.1.2 Omgevingsvariabele voor i18n
calcurse
kan gecompileerd worden met native language
support (zie gettext
bibliotheek). Als je berichten wilt zien in je moedertaal, kijk
dan eerst na of het beschikbaar is door naar het
po/LINGUAS
bestand te kijken. Dit bestand geeft de
beschikbare talen weer door middel van twee letters. (Voorbeeld,
fr duidt frans aan). Indien je je taal niet vindt, zouden we
het op prijs stellen, als je meehelpt met het vertalen van
calcurse
(zie Hoe kan ik
helpen?).
Als je taal beschikbaar is, start calcurse
met het
volgende commando:
LC_ALL=fr_FR calcurse
waar fr_FR de locale naam van dit voorbeeld is, maar veranderd moet worden naar de locale van de gewenste taal.
De te gebruiken karakterset zou ook gespecificeerd moeten worden,
omdat anders in bepaalde gevallen de accenten en dergelijke niet
correct weergegeven worden. De karakterset wordt gekozen in het begin
van het po bestand, dat overeenkomt met de gewenste taal. Je kan
bijvoorbeeld in het fr.po bestand zien dat het gebruik maakt van de
iso-8859-1 karakterset, dus om calcurse
te starten, kan
het volgende commando worden gebruikt:
LC_ALL=fr_FR.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, thenEDITOR
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 Gebruikers-interface
4.2.1 Niet-interactieve modus
calcurse
wordt in niet-interactieve modus gestart, als
ten minste een van de volgende opties wordt gebruikt:
-a
, -d
, -h
, -n
,
-t
, -v
, -x
,
Dit betekent dat de gewenste informatie wordt getoond, en dat daarna
calcurse
simpelweg wordt verlaten en men weer terug is
bij de shell prompt.
Op deze manier, kan men een regel zoals 'calcurse --todo
--appointment'
in zijn init config bestand zetten, zodat
bij het inloggen de takenlijst en afspraken van vandaag worden
weergegeven.
4.2.2 Interactieve modus
Als calcurse
zonder opties of alleen met de
-c
optie wordt aangeroepen, wordt calcurse
in interactieve modus gestart. In deze modus, wordt er een interface
getoond, dat drie verschillende panels (panelen) bevat, waartussen je
kan schakelen door middel van de 'TAB' toets, een notify-bar
(informatiebalk), en een statusbar (statusbalk) (zie onderstaand
figuur).
afspraken panel---. .---kalender panel | | v v +------------------------------------++----------------------------+ | Afspraken || Kalender | |------------------------------------||----------------------------| | (|) April 6, 2006 || April 2006 | | || Ma Di Wo Do Vr Za Zo | | || 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 | | || | | |+----------------------------+ | |+----------------------------+ | || Taken | taken | ||----------------------------| panel | || | | | || | | | || |<--. | || | +------------------------------------++----------------------------+ |---[ Ma 2006-11-22 | 10:11:43 ]---(apts)----> 01:20 :: lunch <---|<--. +------------------------------------------------------------------+ informatie | ? Help R Herteken H/L -/+1 Dag G Ga Naar C Config | balk | Q Einde S Opslaan J/K -/+1 Week Tab Schakelen |<-. +------------------------------------------------------------------+ | | statusbalk
Het eerste panel geeft een kalender weer, die het mogelijk maakt om een bepaalde datum te kiezen. Het tweede panel bevat de afspraken en gebeurtenissen van die dag. Het laatste panel bevat een lijst met taken (todo's) die nog moeten gebeuren, maar niet aan een bepaalde dag zijn toegewezen.
In het afspraken panel, staat vlak voor de datum het '(|)' teken. Dit geeft de huidige fase van de maan aan. Afhankelijk van de fase, kunnen de volgende tekens worden gezien:
- '
|)
': - eerste kwartier
- '
(|)
': - volle maan
- '
(|
': - laatste kwartier
- '
|
': - nieuwe maan
- geen teken:
- huidige fase van de maan correspondeert met geen van bovenstaande fases
Aan de onderkant van het scherm is de statusbalk, die de mogelijke acties en de daarbij horende toetscombinaties weergeeft.
Net boven de statusbalk is de informatiebalk, die van links naar rechts het volgende toont: de huidige datum, de huidige tijd, het kalenderbestand dat in gebruik is (apts in het bovenstaand voorbeeld, dat het standaardkalender bestand is, zie de volgende sectie), en de volgende afspraak binnen 24 uur. In het voorbeeld staat dat het over een uur en twintig minuten tijd is voor de lunch.
Noot: Voor sommige acties, zoals het bewerken of toevoegen van een item, is het nodig dat er tekst wordt ingevoerd. Dit wordt gedaan met de hulp van de ingebouwde editor.
Als een regel met tekst langer is dan de breedte van het scherm, wordt er in de editor een '>', '*', or '<' karakter getoond in de laatste kolom, wat aanduid dat er respectievelijk meer karakters achter, voor en achter, of voor de huidige positie staan. De tekstregel schuift horizontaal mee als het nodig is.
Sommige bewerkingscommando's zijn gebonden aan speciale controle karakters. Hierna zijn de beschikbare bewerkingscommando's weergegeven ('^' staat voor de control-toets):
^a
:- verplaats de cursor naar het begin van de invoerregel
^b
:- verplaats de cursor terug
^d
:- verwijder een karakter voorwaarts
^e
:- verplaats de cursor naar het einde van de invoerregel
^f
:- verplaats de cursor voorwaarts
^h
:- verwijder een karakter terug
^k
:- verwijder de invoer vanaf de cursor naar het einde van de regel
ESCAPE
:- annuleert het bewerken
4.3 calcurse
bestanden
De volgende structuur wordt in je $HOME
directory
aangemaakt, als calcurse
voor de eerste keer wordt
gestart:
$HOME/.calcurse/ |___notes/ |___conf |___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
:- bevat de configuratie van de gebruiker.
apts
: bevat alle gebeurtenissen en afspraken van de gebruiker.
todo
:- bevat de todo lijst.
4.4 Online hulp
De ingebouwde hulp kan waar nodig aangeroepen worden door middel van de '?' toets. Tijdens het gebruik van de hulpschermen kan een specifiek commando opgevraagd worden door op de toetscombinatie te drukken van dat commando.
5. Opties
Alle opties van calcurse
zijn aan te passen vanuit het
Configuratie menu. Als je op 'C' drukt, kom je in een submenu met 4
keuzes: Druk opnieuw 'C' om naar de configuratie van de
kleurenschema's te gaan, druk op 'L' om naar de hoofdindeling van
calcurse
te gaan (in andere woorden, waar de 3 panels op
het scherm komen), druk op 'G' om een aantal algemene opties in te
stellen, en als laatste kan de informatiebalk worden aangepast worden
met de toets 'N'.
5.1 Algemene opties
Met de volgende opties kan calcurse
naar wens ingesteld
worden:
automatisch_opslaan
(standaard: ja)- Door deze optie wordt de data van de gebruiker automatisch opgeslagen
(indien ingesteld op ja) bij het
afsluiten.
Let op: De data wordt niet automatisch opgeslagen als
automatisch_opslaan
ingesteld is op nee. Dit betekent dat de gebruiker op 'S' moet drukken om de gewijzigde data te bewaren. einde_bevestigen
(standaard: ja)- Bij het beëindigen van
calcurse
, zal er om een bevestiging worden gevraagd, als de optie op ja is ingesteld. Zoniet, dan zalcalcurse
zonder bevestigingsvraag eindigen, als er op 'Q' wordt gedrukt. bevestig_verwijderen
(standaard: ja)- Als deze optie op ja is ingesteld, zal er om een bevestiging gevraagd worden voor het wissen van een item door middel van een toetsdruk op 'D' (dit kan een todo, afspraak, of gebeurtenis zijn. Anders zal er geen bevestiging nodig zijn voor het wissen van een item.
overslaan_systeem_dialoog
(standaard: nee)- Als deze optie ingesteld is op ja zullen de systeem dialogen
gerelateerd aan het opslaan en laden van data worden overgeslagen. Dit
zorgt ervoor dat
calcurse
sneller opstart en afsluit. overslaan_progressie_balk
(standaard: nee)- Indien ingesteld op ja, zal deze optie er voor zorgen dat de
progressie balk, die normaal gesproken getoond wordt bij het opslaan
van data naar bestand, verdwijnt. Ingesteld op ja>, wordt de
progressie balk getoond samen met de bestandsnaam. (zie sectie
calcurse
bestanden). week_begint_op_maandag
(standaard: ja)- Er kan gekozen worden tussen maandag en zondag als de eerste dag van de week. Als week_begint_op_maandag ingesteld is op ja, dan zal maandag als eerste staan in het kalender overzicht. Anders staat zondag als eerste dag van de week.
5.2 Kleurenschema's
De kleurenschema's van calcurse
zijn aan te passen aan de
wensen van de gebruiker. Om het standaard schema te wijzigen, zijn er
in het configuratiescherm de mogelijke opties weergegeven voor voor-
en achtergrondkleuren. Door met de pijltjes-toetsen of de
calcurse
-toetsen de cursor te verplaatsen, en met 'X' of
spatie een kleur te selecteren, kan de gebruiker de kleur toegepast
zien. Het is ook mogelijk om de standaard kleuren van de terminal te
gebruiken. Selecteer hiervoor de corresponderende optie.
De kleuren van de randen, titels, toetshulp, en algemene informatie binnen de statusbalk zullen worden aangepast. Er is ook een zwart-wit schema, voor terminals die geen kleuren ondersteunen.
Noot:
Afhankelijk van het type terminal en van de $TERM
omgevingsvariabele, is het mogelijk dat kleur wel of niet wordt
ondersteund. Indien gepoogd wordt de kleuren te veranderen, terwijl de
terminal geen kleuren ondersteund, zal er een foutbericht
verschijnen.
Als bekend is dat de terminal kleuren ondersteund, maar niet
getoond worden door calcurse
, probeerd dan om de waarde
van de $TERM
variabele te veranderen in iets anders
(zoals bijvoorbeeld xterm-xfree86)
5.3 Layout configuratie
De layout stelt de positie van de panels van calcurse
in.
Bij de standaard layout is de positie van het kalender panel in de
terminal rechtsboven, het todo-panel rechtsonder, en het afspraken
panel wordt aan de linkerkant van het scherm getoond (zie het figuur
in sectie Interactieve
modus voor een voorbeeld van de standaard layout).
Door een andere layout te kiezen in het configuratie scherm, kan de
gebruiker calcurse
zo het beste aan zijn behoeftes
aanpassen.
5.4 Informatiebalk instellingen
De volgende opties stelt het gedrag van de informatiebalk in:
informatiebalk_toon
(standaard: ja)- Deze optie stelt in of de informatiebalk getoond wordt op het scherm of niet.
informatiebalk_datum
(standaard: %a %F)- Door middel van deze optie, kan ingesteld worden hoe de datum wordt
weergegeven in de informatiebalk. Alle mogelijkheden kunnen gezien
worden door
man 3 strftime
in de terminal te typen. informatiebalk_tijd
(standaard: %T)- Door middel van deze optie, kan insteld worden hoe de huidige tijd
wordt weergegeven in de informatiebalk. weergegeven in de
informatiebalk. Alle mogelijkheden kunnen gezien worden door
man 3 strftime
in de terminal te typen. informatiebalk_waarschuwing
(standaard: 300)- Indien een afspraak binnen de tijd valt die is ingesteld in 'informatiebalk_waarschuwing', begint de weergave van die boodschap te knipperen. Zo wordt de gebruiker gewaarschuwd, dat er een op handen zijnde afspraak is. Bovendien zal het commando uitgevoerd worden dat is gedefinieerd door informatiebalk_commando.
informatiebalk_commando
(standaard: printf '\a')- Deze optie geeft het commando weer dat wordt uitgevoerd wanneer er een
op handen zijnde afspraak is, die gemarkeerd is als 'belangrijk'. Het
commando zal naar de shell van de gebruiker gestuurd worden, waar het
door de shell uitgevoerd wordt. Om van de gewenste shell gebruik te
maken, wordt gebruik gemaakt van de
$SHELL
omgevingsvariabele. Er wordt gebruik gemaakt van/bin/sh
, indien de variabele leeg is.Voorbeeld: Stel dat het commando
mail
uit te voeren is op het systeem van de gebruiker. Men kan dan het volgende commando gebruiken om op de hoogte gesteld te worden van een op handen zijnde afspraak (de beschrijving van de afspraak zal ook te zien zijn in de body van de mail):calcurse --next | mail -s "[calcurse] upcoming appointment!" user@host.com
6. bekende bugs
Wanneer calcurse
gebruikt maakt van een zwart-wit schema
terwijl de $TERM
variabele is ingesteld op
xterm-color, zullen er verkeerde items gemarkeerd worden.
Gebruik om deze bug op te lossen, xterm-xfree86 in plaats van
xterm-color in de variabele $TERM
,
adviseert Thomas E. Dickey (xterm
maintainer):
"De waarde van xterm-color voor $TERM is geen goede keuze voor XFree86 xterm, omdat het vaak gebruikt wordt voor een optie in terminfo, dat bce niet ondersteunt. Maak gebruik van de xterm-xfree86 optie die met de xterm van XFree86 wordt gedistribueerd (of eenzelfde die wordt gedistribueerd met ncurses)."
7. Het melden van bugs en aanmerkingen
Meldt bugs en aanmerkingen alstublieft aan:
calcurse @ culot . org
Of aan de auteur:
frederic @ culot . org
8. Hoe kan ik helpen?
Mocht je mee willen helpen aan het project, dan kan je ten eerste
laten weten wat je wel en niet goed vindt, en of er nog dingen zijn
die je mist in calcurse
.
Ook wordt het vertalen van calcurse
berichten en
documentatie zeer gewaardeerd.
Noot:
Alle hulp bij het 'internationaliseren' van
calcurse
wordt zeer op prijs gesteld, maar voordat je
begint, mail dan eerst naar calcurse-i18n @ culot . org
, om
te weten te komen of iemand anders al met een vertaling naar jouw taal
bezig is.
8.1 Vertalen van de documentatie
De doc/ directory van het bronpakket bevat alle vertalingen
van de handleidingen van calcurse
. Als de handleiding van
je moedertaal echter nog niet aanwezig is, wordt het zeer op prijs
gesteld als je kunt helpen met de vertaling.
Kopieer eenvoudig de bestaande handleiding naar
manual_XX.html
, waar XX de code is van je taal.
Vertaal dan het zojuist aangemaakte bestand en zend het naar de
auteur (zie Het melden van bugs en aanmerkingen),
zodat het bij de volgende versie van calcurse
gevoegd can
worden.
8.2 calcurse
i18n
Zoals eerder gezegd, maakt calcurse
gebruikt van
gettext
om berichten weer te geven in meerdere talen.
Deze sectie informeert hoe de berichten te vertalen in je moedertaal.
Deze howto is echter met opzet incompleet, en verlegt de focus op het
werken met gettext
voor calcurse
. Voor meer
gespecificeerde informatie of om het grotere geheel te begrijpen, is
er de GNU gettext
handleiding:
http://www.gnu.org/software/gettext/manual/
In principe, zijn er drie verschillende mensen bezig in de vertaalketen: programmeurs, de vertaal coördinator, en de vertalers. Na in vogelvlucht uit te leggen hoe dingen werken, zal de taak van de vertaler beschreven worden.
8.2.1 Overzicht
Om het mogelijk te maken om teksten weer te geven in de taal van de gebruiker, zijn er twee stappen vereist: internationalisatie (i18n) en localisatie (l10n).
i18n zorgt ervoor dat
calcurse
meerdere talen ondersteund. De programmeurs
markeren de te vertalen tekst (strings genaamd) en bieden een manier
aan om deze direct te vertalen als calcurse
gestart is.
l10n zorgt ervoor dat de i18n-de calcurse
zich instelt op
de taal van de gebruiker, dus worden de door de programmeurs
gemarkeerde strings vertaald, en wordt de omgeving correct ingesteld,
zodat calcurse
gebruik kan maken van de vertaling.
Dus, de te vertalen strings worden eerst gemarkeerd door de
programmeurs binnen in de C
broncode, dan worden ze
verzameld in een sjabloon bestand (calcurse.pot - de
pot extensie staat voor portable object template,
wat zoiets als overdraagbaar object sjabloon betekent). De inhoud van
deze sjabloonbestanden worden dan samengevoegd met de vertaalbestanden
van elke taal (fr.po voor frans, bijvoorbeeld - waar
po voor portable object staat, dus bedoeld om
gelezen en gewijzigd te worden door mensen). Dit bestand wordt door een
vertaalteam vertaald, en verzonden naar de ontwikkelaars. Bij het
compileren wordt voor efficientie een binaire versie van dit bestand
gemaakt (fr.mo - mo staat voor machine
object, dus met als doel gelezen te worden door programma's), en
geïnstalleerd. calcurse
gebruikt dit bestand dan, om de
strings te vertalen volgende de instellingen van de locale van de
gebruiker.
8.2.2 Taken van de vertaler
Stel dat iemand met het vertalen naar een nieuwe taal wil beginnen. Dan zijn dit de stappen die gevolgd moeten worden:
- Vindt eerst uit wat de naam van de locale is. Voor frans
bijvoorbeeld is het 'fr_FR', of simpelweg 'fr'. Dit is de waarde die
in de omgevingsvariabele
LC_ALL
moet staan om software te vertalen (zie De i18n omgevingsvariabele). - Ga dan naar de po/ directory, en maak nieuwe
po-bestanden aan met het volgende commando:
'msginit -i calcurse.pot -o fr.po -l fr --no-translator'
Indienmsginit
niet aanwezig is op het systeem, kopieer dan simpelweg het calcurse.pot bestand en hernoem het naar bijvoorbeeld fr.po en wijzig de header handmatig.
Nu fr.po aangemaakt is, kan de vertaler beginnen.
8.2.3 po-bestanden
De indeling van de po-bestanden is vrij simpel. Po-bestanden bestaan uit vier onderdelen:
- locatie regels: informeert waar de strings gevonden kunnen worden (bestandsnaam en regelnummer), in het geval dat je het een beetje in context wilt zien.
- msgid regels: de te vertalen strings.
- msgstr regels: de vertaalde strings.
- regels met een '#' ervoor: commentaar (sommige met een speciale betekenis, zoals we verderop zullen zien).
Eigenlijk, hoef je alleen de msgstr regels te vullen met de vertaling van bovenstaande msgid regels.
Een paar aanmerkingen:
- Fuzzy strings
- Wanneer je een string tegenkomt die gemarkeerd is met
"#, fuzzy"
, zalcalcurse
de vertaling niet gebruiken totdat je iets verandert. 'Fuzzy' betekent dat de string al vertaald is, maar sindsdien is veranderd in de broncode van het programma, of dat het een nieuwe string is, waargettext
zelf een ruwe vertaling van heeft gemaakt, gebaseerd op andere strings in het bestand. Het komt erop neer dat je de vertaling moet nakijken. Soms is er een kleine verandering in de originele string, omdat er een typfout is verbeterd. In dit geval hoeft er niets te veranderen. Maar het kan ook zo zijn dat de vertaling niet juist meer is, en een verandering noodzakelijk is. Als de vertaling weer in orde is, wis dan de regel met"#, fuzzy"
, en dan zal de vertaling weer gebruikt worden incalcurse
. - c-format strings en speciale tekens
- Sommige string hebben het volgende commentaar:
"#, c-format"
. Dit betekent dat een deel van de te vertalen string een speciale betekenis heeft voor het programma, en niet veranderd mag worden. Bijvoorbeeld, het teken %, gebruikt als"%s"
. Dit betekent datcalcurse
dit teken zal vervangen met een andere string. Het is dus belangrijk dat het niet verwijderd wordt. Er zijn ook andere tekens zoals \, gebruikt als\n
of\t
. Verander ook deze niet. Het zijn respectievelijk tekens voor einde-van-de-regel, en een tab. - Vertalingen mogen afgebroken worden
- Zodra een regel te lang wordt, kan je hem splitsen als volgt:
msgid "" "een hele lange regel" "de volgende regel"
- het begin van het po-bestand
- Aan het begin van het po-bestand, vormt de eerste string de 'header',
waar verschillende soorten informatie kan worden ingevuld. Het
belangrijkste is de karakterset. Het zou er als volgt uit moeten zien:
"Content-Type: text/plain; charset=utf-8\n"
Het is ook belangrijk dat het Last-Translator veld wordt ingevuld, zodat nieuwe vertalers zich bij je kunnen aanmelden, of dat mensen contact kunnen opnemen als ze aanvullingen hebben of typfouten gevonden hebben. Je kan zowel een naam/bijnaam, of email adres invulllen, zoals bijvoorbeeld:"Last-Translator: Frederic Culot <frederic@culot.org>\n"
- Commentaar
- Het toevoegen van commentaar (regels die beginnen met het karakter '#', is een juiste manier om problemen met vertalingen te markeren voor proeflezers of andere vertalers.
- De lengte van strings
calcurse
is een curses/console programma, dus het is nauw verbonden met het aantal kolommen dat de terminal gebruikt. Dit is iets om in gedachten te houden bij het vertalen. Vaak moet een string op een enkele regel passen. Het beste is dus om niet zomaar de strings te vertalen, maar om eerst te kijken waar ze weergegeven worden in het programma, en pas dan te vertalen.- Een paar nuttige hulpmiddelen
- Het po-bestandsformaat is vrij simpel, en het bestand kan gewijzigd
worden met een standaard tekst-editor. Maar er zijn een paar
gespecialiseerde hulpmiddelen, die je misschien handig vindt bij het
vertalen:
poEdit
( http://www.poedit.org/)KBabel
( http://i18n.kde.org/tools/kbabel/)GTranslator
( http://gtranslator.sourceforge.net/)Emacs
po modeVim
po mode
- En als laatste
- Ik hoop dat je het leuk vindt om bij te dragen aan een 'geïnternationaliseerde' wereld. :) Mocht je nog vragen hebben, schroom dat niet om contact met me op te nemen via frederic @ culot . org.
9. Links
Deze sectie bevat links en referenties welke je misschien interesseren.
9.1 calcurse
homepage
De calcurse
homepage is hier te vinden:
http://culot.org/calcurse
9.2 calcurse
mededelingenlijst
Mocht je interesse hebben in het project, en op de hoogte wilt worden
gehouden als er een nieuwe versie uitkomt, kan je jezelf inschrijven
op de calcurse
mededelingenlijst. Je ontvangt dan een
email zodra er iets nieuws is in calcurse
.
Om je in te schrijven, zend dan een email naar
calcurse-announce @ culot . org
met "subscribe"
ingevuld bij 'onderwerp'.
9.3 calcurse
RSS feed
Nog een mogelijkheid om op de hoogte te blijven over nieuwe versies is om de RSS feed te volgen:
http://culot.org/calcurse/news_rss.xml
Deze RSS feed wordt iedere keer vernieuwd als er een nieuwe versie van calcurse beschikbaar is, waarbij ook de nieuwe opties beschreven worden.
10. Dankwoord
Het is tijd om de mensen te bedanken, zonder wie dit programma niet zou bestaan! Hier is een lijst met mensen die ik graag wil bedanken:
- Alex voor zijn patches, hulp en advies met het programmeren in
C
- Gwen voor het testen en voor de discussies om
calcurse
te verbeteren - Herbert voor het maken van een pakket voor
calcurse
voor FreeBSD - Zul voor het maken van een pakket voor
calcurse
voor NetBSD - Wain, Steffen and Ronald voor het maken van een pakket voor
calcurse
voor Archlinux - Kevin, Ryan, en fEnIo voor het maken van een pakket voor
calcurse
voor Debian en Ubuntu - Pascal voor het maken van een pakket voor
calcurse
voor Slackware - Alexandre en Markus voor het maken van een pakket voor
calcurse
voor Mac OsX en Darwin - Igor voor het maken van een pakket voor
calcurse
for ALT Linux - Joel voor zijn kalender script waarop de kalenderview van
calcurse
geïnspireerd is - Michael Schulz en Chris M. voor de duitse vertaling van
calcurse
en handleiding - Jose Lopez voor de spaanse vertaling van
calcurse
en handleiding - Neil Williams voor de engelse vertaling
- Tony voor zijn patch die de recur_item_inday functie verbeterde.
- Jeremy Roon voor de nederlandse vertaling van
calcurse
en handleiding - en de mensen die de software geschreven hebben die ik goed vind
en mij geïnspireerd hebben zoals:
vim
voor de toetsen die de cursor verplaatsenorpheus
enabook
voor de documentatiepine
enaptitude
voor de tekstinterface
En als laatste wil ik graag de mensen bedanken die
calcurse
gebruiken, en mij aanvullingen en opbouwende
kritiek stuurden.