otak home page

(Dokumentacja)

OPIS

Katalog $HOME/.otak jest tworzony, gdy użytkownik uruchamia program po raz pierwszy. Zawiera dwa pliki: config oraz baseconfig.

config to plik konfiguracyjny programu. Zawiera skróty klawiszowe, i opcje, które zostały opisane w części CONFIG (poniżej).

baseconfig jest plikiem konfiguracyjnym bazy danych. Określa jakie informacje będą gromadzone. Standardowo znajdują się tam takie pola jak [name], [email], [sms], [phone], [www] i [comments]. To, jak powinien wyglądać ten plik, zostało opisane w części BASECONFIG (poniżej).

komentarze Komentarzami, w obu plikach, są wszystkie linie zaczynające się od #. Podwójny znak komentarza (##) otwiera blok i komentuje wszystko aż do ponownego wystąpienia podwójnego znaku komentarza (##).

CONFIG

base.config.file = (filename) Gdzie (filename) jest nazwą pliku. Zmienna określa położenie pliku z konfiguracją bazy danych. Standardowa wartość to "$HOME/.otak/baseconfig".

base.dir = (dirname) Zmienna określa położenie katalogu z bazami danych otaka. Główna baza w tym katalogu to plik "main". (od wrsji 1.2.0 otak supportuje wiecej niż jedną baze. Help opisuje skróty klawiszowe obsługi wielu baz). Standardowa wartość to "$HOME/.otak/base-dir".

size.file = (filename) Zmienna określa położenie pliku z zapisanymi rozmiarami okien. (ponadto pozycje okien są zapisywane do tego pliku, przy wyjściu z otak`a) Standardowa wartość to "$HOME/.otak/wins"

cmd.on.enter = (stanza-name) Gdzie (stanza-name) jest nazwą sekcji z pliku konfiguracyjnego bazy danych. Nazwa stanzy, której komenda jest uruchamiana po naciśnięciu klawisza enter, na danej osobie. Jeśli ktoś chce używać programu jako książki adresowej email to wpisuje tam "email", jeśli ktoś chce używać programu jako książki telefonów komórkowych wpisuje tam "sms". Wartość domyślna to "email".

menu.title = (stanza-name) Po jakiej wartości powinna być nazwana osoba w głównym menu. Można nazywać ludzi nie po imionach lecz po nickach czy też po adresach email (jakkolwiek wydaje się to dziwne;). Wartość domyślna to "name".

show.query = (stanza-name) wartość której stanzy powinna zostać wyświetlona, jeśli osoba została "trafiona" opcją --query. Wartość domyślna to "email" (Parametry szukania zostały ustawione pod query z mutt`a :^).

hide.wininfo = (bool) gdzie (bool) może przyjąć wartości : true/false 1/0 etc. Zmienna określa, czy ukrywać okno z informacjami o osobie. Standardowo ustawiona jest na false. Zmienna ta, może być pomocna przy uruchamianiu programu po "wolnym łączu" - ogranicza ilość operacji na ekranie do niezbędnego minimum. Standardowo ustawiona jest na false.

show.intro = (bool) Czy pokazać intro przy uruchamianiu otaka, jeżeli ktoś ma dużo wolnego czasu i zamiłowanie do ASCII art. Standardowo ustawiana jest na false (coż? Przecież trzeba szanować czas ...).

toolbar.up = (bool) Czy wyświetlać toolbar na górze ekranu (true), czy może komuś "pasuje na dole" (false). Standardowa wartość to true.

read.size.file = (bool) Zmienna określa czy czytać plik z rozmiarami okien. Standardowa wartość to true.

big.windows = (bool) Zmienna określa czy wyświtelać duże okna. (Należy zauważyć że bez wyzerowanej zmiennej read.size.file okna wcale nie urosną) Standardowa wartość to false. (Małe jest piękne i najczęściej pyskate ;^)

sort.base = (bool) Czy posortować bazę dannych przed zapisaniem ? Standardowa wartość to true.

show.labels = (bool) Określa czy (w window info) oprócz informacji wyświetlać ich nazwe.
np:
"-) nazwa: FooBar" lub "-) FooBar".
Standardowa wartość to false.

arrow.string = (string) Powyżej zmienna jest ustawiona na "-) ", co z resztą jest standardową wartością.

silent = (bool) Cisza !. Nie pisz niczego na standardowe wyjście (nawet błędów). Standardowa wartość to false.

no.messages = (bool) Działa jak silent, ale wyświetla błędy. Standardowo wartość to true.

Wartością zmiennych "key" jest dowolny znak.
remove.key
add.key
edit.key
back.key
quit.key
move.key
load.key

BASECONFIG

wstęp: Plik baseconfig standardowo znajduje się w katalogu $HOME/.otak. Jego położenie może zostać podane jako argument do programu po opcji -B\fR, lub ustawiony w pliku konfiguracyjnym \fBotak`a. Podstawą tego pliku są stanzy (sekcje).

[stanza_name] nazwa stanzy umieszczona jest w [] (nawiasach kwadratowych) np.: [sms], [music]
po tej nazwie następuje definicja stanzy. Może (jakkolwiek nie musi) zostać w niej umieszczona każda ze zmiennych wylistowanych poniżej.

label = nazwa elementu Text wyświetlany jako nazwa elementu (na data screen)
np.
label=cell phone

key = (dowolny znak) zmienna określa skrót klawiszowy dla tego pola.

multiple = true/false (klasa bool) zmienna określa, czy pole w bazie danych ma mieć jedną czy wiele wartości.
np. chcemy gromadzić tylko jedno nazwisko danej osoby, ale zależy nam na kilku emailach.
Standardowo zmienna ta przyjmuje wartość false.

command = nazwa_komendy nazwa komendy, która wywoływana jest z programu.
np. command=mutt "$name ($email)" command=sms $sms "paka $name! $text /mee"
Wartość tej zmiennej może zostać powiązana z wartościami stanz (z baseconfig`a). Dzieje się tak , ponieważ wszystkie stanzy są eksportowane do zmiennych środowiskowych, a następnie wartość komendy zostaje przekazana do powłoki.
W szczególnym przypadku (gdy zmienna text = true) można umieścić w nazwie komendy zmienną text ($text), (czasami mądrze jest umieścić tę wartość w cudzysłowiach).

text = (bool) Jeśli ta opcja ustawiona jest na true, to w momencie użycia komendy, pojawia się dodatkowe okno, z którego pobierana jest przyszła wartość zmiennej text. Swoją drogą nie wiem czy może się to przydać, poza SMS-ami :/

Przykład całej stanzy znajduje się w /etc/otak/baseconfig.