mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
284 lines
7.5 KiB
Markdown
284 lines
7.5 KiB
Markdown
# DOXA-TODO Uživatelská Příručka
|
|
|
|
## Úvod
|
|
|
|
DOXA-TODO je terminálová aplikace pro správu úkolů, která vám pomůže organizovat vaše úkoly s podporou kategorií, priorit a štítků. Tato příručka poskytuje podrobné informace o všech funkcích a způsobech použití.
|
|
|
|
## Začínáme
|
|
|
|
### První spuštění
|
|
|
|
Když poprvé spustíte `doxa-todo`:
|
|
1. Aplikace vytvoří konfigurační adresář `~/.doxa-todo/`
|
|
2. Vytvoří se prázdný soubor se seznamem úkolů `doxa_todo.json`
|
|
3. Zobrazí se úvodní obrazovka
|
|
|
|
Stiskněte `Enter` pro zahájení práce s aplikací.
|
|
|
|
## Hlavní rozhraní
|
|
|
|
Hlavní rozhraní zobrazuje:
|
|
- Název aplikace
|
|
- Stavové zprávy (pokud existují)
|
|
- Možnosti menu
|
|
- Seznam úkolů
|
|
- Nápověda
|
|
|
|
### Možnosti menu
|
|
|
|
- **1: Přidat** - Přidat nový úkol
|
|
- **2: Upravit** - Upravit vybraný úkol
|
|
- **3: Export** - Exportovat vybraný úkol do textového souboru
|
|
- **4: Smazat** - Smazat vybraný úkol
|
|
- **/: Hledat** - Vyhledat úkoly podle názvu, popisu nebo štítků
|
|
- **b: Tagy** - Procházet všechny štítky
|
|
- **c: Filtr** - Filtr úkolů podle kategorie
|
|
- **t: Splněno** - Přepnout stav splnění vybraného úkolu
|
|
- **l: EN/CS** - Přepnout jazyk mezi angličtinou a češtinou
|
|
- **q: Konec** - Ukončit aplikaci
|
|
|
|
## Přidávání úkolu
|
|
|
|
1. Stiskněte `1` pro přidání nového úkolu
|
|
2. Vyplňte pole:
|
|
- **Název** (povinný): Název vašeho úkolu
|
|
- **Popis** (nepovinný): Podrobný popis
|
|
- **Štítky** (nepovinné): Seznam štítků oddělených čárkami
|
|
3. Úkolu se automaticky přiřadí:
|
|
- Střední priorita
|
|
- Osobní kategorie
|
|
- Aktuální časové razítko
|
|
4. Stiskněte `Enter` pro uložení (když nejste v poli popisu)
|
|
5. Použijte klávesu `+` pro cyklické přepínání úrovní priority
|
|
|
|
## Úprava úkolu
|
|
|
|
1. Navigujte k úkolu, který chcete upravit, pomocí `↑/↓` nebo `j/k`
|
|
2. Stiskněte `2` pro úpravu
|
|
3. Upravte pole podle potřeby
|
|
4. Stiskněte `Enter` pro uložení změn
|
|
|
|
## Úrovně priority
|
|
|
|
Úkoly mají 3 úrovně priority s barevným kódováním:
|
|
- **Nízká** (Zelená ●): Pro úkoly, které mohou počkat
|
|
- **Střední** (Oranžová ●): Výchozí priorita pro nové úkoly
|
|
- **Vysoká** (Červená ●): Pro naléhavé úkoly
|
|
|
|
Použijte klávesu `+` při přidávání/úpravě pro přepínání úrovní priority.
|
|
|
|
## Kategorie
|
|
|
|
Úkoly lze kategorizovat jako:
|
|
- **Osobní** (🏠 Modrá): Pro osobní úkoly
|
|
- **Pracovní** (💼 Fialová): Pro pracovní úkoly
|
|
|
|
### Filtrace podle kategorie
|
|
|
|
1. Stiskněte `c` pro otevření filtru kategorií
|
|
2. Vyberte:
|
|
- `1`: Zobrazit pouze osobní úkoly
|
|
- `2`: Zobrazit pouze pracovní úkoly
|
|
- `0`: Zobrazit všechny úkoly (odebrat filtr)
|
|
3. Filtr zůstává aktivní, dokud ho nezměníte nebo nezrušíte
|
|
|
|
## Štítky
|
|
|
|
Štítky vám pomohou organizovat a rychle nalézt úkoly.
|
|
|
|
### Přidávání štítků
|
|
|
|
Při přidávání nebo úpravě úkolu zadejte štítky oddělené čárkami do pole Štítky:
|
|
```
|
|
práce, naléhavé, projekt-x
|
|
```
|
|
|
|
### Procházení štítků
|
|
|
|
1. Stiskněte `b` pro procházení všech štítků
|
|
2. Navigujte pomocí `↑/↓` nebo `j/k`
|
|
3. Stiskněte `Enter` pro filtrování úkolů podle vybraného štítku
|
|
4. Stiskněte `q` nebo `Esc` pro návrat do hlavního seznamu
|
|
|
|
## Vyhledávání
|
|
|
|
1. Stiskněte `/` pro otevření vyhledávání
|
|
2. Zadejte svůj dotaz
|
|
3. Stiskněte `Enter` pro vyhledávání
|
|
4. Seznam zobrazí pouze úkoly odpovídající vašemu dotazu v názvu, popisu nebo štítcích
|
|
5. Stiskněte `Esc` pro vymazání vyhledávání
|
|
|
|
## Zobrazení úkolu
|
|
|
|
1. Navigujte k úkolu pomocí `↑/↓` nebo `j/k`
|
|
2. Stiskněte `Enter` pro zobrazení detailů
|
|
3. V detailním zobrazení:
|
|
- `q`: Zavřít a vrátit se do seznamu
|
|
- `2`: Upravit úkol
|
|
- `↑/↓`: Posouvat obsah
|
|
|
|
## Export úkolu
|
|
|
|
1. Vyberte úkol, který chcete exportovat
|
|
2. Stiskněte `3` pro export
|
|
3. Úkol se uloží jako textový soubor do `~/doxa-todo-export/`
|
|
4. Formát názvu souboru je: `{název}_{id}.txt`
|
|
|
|
Exportovaný soubor obsahuje:
|
|
- Název
|
|
- Kategorii
|
|
- Prioritu
|
|
- Štítky
|
|
- Datum vytvoření
|
|
- Popis
|
|
|
|
## Mazání úkolu
|
|
|
|
1. Vyberte úkol, který chcete smazat
|
|
2. Stiskněte `4` pro otevření potvrzení smazání
|
|
3. Stiskněte `y` pro potvrzení smazání
|
|
4. Stiskněte `n` nebo `Esc` pro zrušení
|
|
|
|
## Splněné úkoly
|
|
|
|
Aplikace umožňuje označovat úkoly jako splněné, což vám pomůže sledovat váš pokrok.
|
|
|
|
### Označování úkolů jako splněných
|
|
|
|
1. Navigujte k úkolu, který chcete označit jako splněný/nesplněný
|
|
2. Stiskněte `t` pro přepnutí stavu
|
|
3. Splněné úkoly budou:
|
|
- Zobrazeny přeškrtlé a šedě
|
|
- Automaticky přesunuty na konec seznamu
|
|
- Uloženy s novým stavem
|
|
|
|
### Vlastnosti splněných úkolů
|
|
|
|
- **Automatické řazení**: Splněné úkoly jsou vždy zobrazeny jako poslední v seznamu
|
|
- **Vizualizace**: Splněné úkoly jsou přeškrtlé a zobrazují se šedou barvou pro snadnou identifikaci
|
|
- **Trvalé uložení**: Stav splnění je uložen v JSON souboru spolu s úkolem
|
|
- **Filtrace**: Splněné úkoly jsou zahrnuty ve všech filtrech a vyhledáváních
|
|
- **Export**: Při exportu splněného úkolu je jeho stav zahrnut v exportovaných datech
|
|
|
|
## Přehled klávesových zkratek
|
|
|
|
### Navigace
|
|
- `↑/↓` nebo `j/k`: Pohyb kurzoru nahoru/dolů
|
|
- `Enter`: Výběr/Potvrzení
|
|
- `Esc`: Zpět/Zrušit
|
|
- `q`: Konec
|
|
|
|
### Akce
|
|
- `1`: Přidat nový úkol
|
|
- `2`: Upravit vybraný úkol
|
|
- `3`: Exportovat vybraný úkol
|
|
- `4`: Smazat vybraný úkol
|
|
- `/`: Vyhledat
|
|
- `b`: Procházet štítky
|
|
- `c`: Filtr podle kategorie
|
|
- `t`: Přepnout stav splnění úkolu
|
|
- `l`: Přepnout jazyk
|
|
- `+`: Zvýšit prioritu (při přidávání/úpravě)
|
|
- `Tab`: Přepínat mezi poli
|
|
|
|
## Uložení dat
|
|
|
|
Všechny úkoly jsou uloženy v JSON formátu na:
|
|
```
|
|
~/.doxa-todo/doxa_todo.json
|
|
```
|
|
|
|
Soubor se automaticky vytvoří při prvním spuštění a aktualizuje se s každou změnou.
|
|
|
|
### Záloha
|
|
|
|
Pro zálohování úkolů:
|
|
```bash
|
|
cp ~/.doxa-todo/doxa_todo.json ~/.doxa-todo/doxa_todo_backup.json
|
|
```
|
|
|
|
### Obnovení
|
|
|
|
Pro obnovení ze zálohy:
|
|
```bash
|
|
cp ~/.doxa-todo/doxa_todo_backup.json ~/.doxa-todo/doxa_todo.json
|
|
```
|
|
|
|
## Exportní adresář
|
|
|
|
Exportované úkoly jsou uloženy v:
|
|
```
|
|
~/doxa-todo-export/
|
|
```
|
|
|
|
Každý exportovaný soubor obsahuje úplné informace o úkolu v čitelné textové podobě.
|
|
|
|
## Řešení problémů
|
|
|
|
### Aplikace se nespustí
|
|
|
|
Ujistěte se, že máte:
|
|
1. Nainstalované Go (verze 1.26+)
|
|
2. Zkompilovanou a nainstalovanou aplikaci
|
|
3. `~/.local/bin` ve svém PATH
|
|
|
|
### Úkoly se neukládají
|
|
|
|
Zkontrolujte:
|
|
1. Oprávnění zápisu pro `~/.doxa-todo/`
|
|
2. Existence adresáře
|
|
3. Že se při ukládání nezobrazují žádné chyby
|
|
|
|
### Jazyk se nepřepíná
|
|
|
|
Ujistěte se, že stisknete `l` z hlavního zobrazení seznamu úkolů, ne z jiných obrazovek.
|
|
|
|
## Použití z příkazové řádky
|
|
|
|
### Základní použití
|
|
```bash
|
|
doxa-todo
|
|
```
|
|
|
|
### Spuštění ze zdrojového kódu
|
|
```bash
|
|
cd doxa-todo
|
|
go run .
|
|
```
|
|
|
|
## Konfigurace
|
|
|
|
Aplikace používá následující adresáře:
|
|
- `~/.doxa-todo/`: Konfigurace a uložení dat
|
|
- `~/doxa-todo-export/`: Exportované úkoly
|
|
|
|
Můžete upravit zdrojový kód pro změnu těchto cest, pokud je to potřeba.
|
|
|
|
## Aktualizace
|
|
|
|
Pro aktualizaci na nejnovější verzi:
|
|
```bash
|
|
cd doxa-todo
|
|
git pull origin master
|
|
go build -o doxa-todo .
|
|
cp doxa-todo ~/.local/bin/
|
|
```
|
|
|
|
## Odinstalování
|
|
|
|
Pro odinstalování:
|
|
```bash
|
|
rm ~/.local/bin/doxa-todo
|
|
rm -rf ~/.doxa-todo/
|
|
rm -rf ~/doxa-todo-export/
|
|
```
|
|
|
|
## Licence
|
|
|
|
MIT License - Copyright (c) 2026 Kankys
|
|
|
|
## Podpora
|
|
|
|
Pro hlášení problémů, dotazy nebo příspěvky navštivte prosím repositář projektu:
|
|
https://codeberg.org/Kankys/doxa-todo
|