zettelkasten/README.md

# ztlk (Zettelkasten)
Et minimalistisk «suckless» shell-script for å søke gjennom BibTeX-filer og åpne tilhørende PDF-er.

Det er gitt navnet ztlk etter Zettelkasten på tysk, et kortsystem for å håndtere referanser som bl.a. Walter Benjamin brukte under produksjonen av *Passasjeverket*, se [Zettelkasten på Wikipedia](https://en.wikipedia.org/wiki/Zettelkasten).

## Funksjonalitet
Scriptet leser BibTeX-filer, viser dem i en meny, og lar deg:
- Søke og velge referanser
- Åpne tilhørende PDF-filer
- Kopiere BibTeX-nøkler til utklippstavlen

## Avhengigheter
- POSIX-kompatibel shell
- `awk` - For parsing av BibTeX-filer

Slik scriptet er konfigurert nå bruker det:
- `wmenu` - dmenu for Wayland
- `wl-copy` - Wayland clipboard (fra wl-clipboard)
- `sioyek` - PDF-leser

Imidlertid kan det endres til fzf, ditt clipboard og din PDF-leser.

## Installasjon
```sh
chmod +x ztlk
# Flytt til en mappe i $PATH, f.eks.:
mv ztlk ~/.local/bin/
```


## Konfigurasjon
Rediger følgende variabler i scriptet:
```sh
BIB_FIL="/sti/til/dine/*.bib"    # BibTeX-filer
PDF_DIR="/sti/til/pdf/"          # PDF-mappe
MENU_CMD="wmenu ..."             # Meny-kommando og styling
FONT="Iosevka Term Light 8"      # Font, må defineres separat pga. wmenus håndtering av flag.
PDF_CMD="sioyek"                 # PDF-leser
```

## Filstruktur
PDF-filene må ha samme navn som BibTeX-nøklene:
```
@article{Benjamin2020,
  ...
}
```
→ PDF-fil: `Benjamin2020.pdf`

## Bruk
```sh
./ztlk
```
1. Scriptet viser alle referanser i en søkbar meny
2. Velg en referanse
3. Hvis PDF finnes, åpner meny med følgende handlinger:
   - `open` - Åpner PDF og kopierer nøkkelen
   - `yank [key]` - Kopierer bare nøkkelen
   - `..` - Går tilbake til hovedmenyen
4. Hvis PDF ikke finnes, kopieres nøkkelen automatisk

Nøkkelen kopieres i formatet `@Benjamin2020` for enkel innsetting i LaTeX/Markdown-dokumenter.