Jak používat skripty šířené spolu s aplikací Pybliographer.
Zoltán Kóta
zoltank@gmail.com
Frédéric Gobry
frederic.gobry@epfl.ch

Creative Commons Share Alike 3.0

# Existující skripty

Pár skriptů je poskytováno s aplikací Pybliographer a slouží i jako příklady, i jako užitečné nástroje. Jsou poměrně krátké a měly by být dobře čitelné i se základními znalostmi jazyka Python.

# pybcheck

          	Tento nástroj vrací seznam souborů a složek a kontroluje, jestli jsou platné (syntaxe, bez záznamů se stejnými klíči, …)

Jeho výstup je možné použít přímo v překladové vyrovnávací paměti emacs, ke skoku přímo na chybu, která se udála. Uděláte to tak, že vyťukáte M x compile, pak příkaz pybcheck vaše_soubory a použijete prostřední tlačítko myši k přechodu na soubor, který selhal.

# pybcompact

    	Tento nástroj získává citace vytvořené v dokumentech LaTeX a generuje soubor BibTeX, který je obsahuje.

Obvykle každý uchovává bibliografie v jednom nebo několika velkých souborech BibTeX a nechává aplikaci bibtex získávat záznamy použité v dokumentu LaTeX. Občas je ale vhodné vytvořit samostatný balíček (například kvůli sdílení v nativní formě s někým jiným nebo kvůli jeho uložení) s minimalistickým souborem BibTeX obsahujícím jen přesně záznamy použité v dokumentu LaTeX. Přesně to dělá tento nástroj: přečte soubor LaTeX .aux a získá z něj určené databáze BibTeX odpovídajících záznamů.

# pybconvert

    	Tento nástroj převádí z jednoho bibliografického formátu na jiný.

Obecná syntaxe je krásně jednoduchá. Například pro převod z Refer do BibTex prostě spusťte:

    	bash$ pybconvert refer..bibtex toto.refer toto.bib

# pybformat

    	Tento skript generuje bibliografii podle bibliografického stylu a vytvoří výstup v určeném formátu (jako je HTML, LaTeX, …), jak by se měl objevit v dokumentu.

Obecná forma příkazu je

    	bash$pybformat [přepínače] databáze…

Bez přepínačů tento příkaz vytvoří bibliografie ve formátu Text za použití stylu nazvaného alpha. K vytváření dokumentů je k dispozici několik přepínačů:

--style=… nebo -s …: určuje bibliografický styl. Může se jednat o úplnou cestu k existujícímu souboru XML nebo o název, který bude hledán na standardních místech. Výchozí je Alpha.

--format=… nebo -f …: určuje výstupní formát (HTML, LaTeX, Raw, Text, Textau, Textnum). Výchozí je Text. (Textau a Textnum jsou lehce modifikované verze formátu Text. Další informace viz .)

--output=… nebo -o …: určuje výstupní soubor. Výchozí je STDOUT.

--header=… nebo -H …: definuje soubor, který bude vložen na začátek výstupního souboru.

--footer=… nebo -F …: definuje soubor, který bude připojen na konec výstupního souboru.

--list=output nebo -l output: seznam dostupných výstupních formátů

# pybtex

    	Tento nástroj hledá citace v dokumentu LaTeX a generuje soubor s bibliografií LaTeX.

Tento nástroj přečte soubor LaTeX .aux a získáním odpovídajících záznamů ze zadané databáze BibTeX vytvoří soubor LaTeX .bbl.

Forma příkazu je

    	bash$ pybtex soubor_latex [soubory_bibtex…]

# pybtext

    	Tento nástroj zpracovává textové soubory obsahující citace a připojuje bibliografii podle zadaného stylu.

Skript hledá v textovém souboru citace jako [klíč] nebo [klíč1, klíč2 …] (například: …Toto je úryvek textu s citací [AKM95,MPJ+03] vložený z aplikace pybliographer…). Nejdříve je, podle klíčů nalezených v textovém souboru, vygenerován seznam odkazů. Za použití příslušného stylu (viz dále) jsou databázové klíče v těle textu nahrazeny novými klíči vygenerovanými modulem stylu a nakonec se k textu připojí seznam odkazů a výsledkem je nový soubor.

Klíče vybraných záznamů lze snadno zkopírovat z aplikace pybliographer do textového editoru nebo terminálu pomocí funkcí kopírovat a vložit nebo táhni a pusť.

Obecná forma příkazu je

    	bash$ pybtext [-o výstupní_soubor] [-s styl] textový_soubor soubory_bib…

Pokud tento příkaz nemá zadané žádné přepínače, použije styl nazvaný Abbrev a výstupní soubor textfile.pyb. textový_soubor je název souboru, který se má zpracovat a soubory_bib je jeden či více souborů s bibliografickou databází.

Pro pybtext jsou navrženy tři rozdílné styly. Použití abbrvbib dává jako výsledky klíče tak, jak jsou definovány v databázi. Se stylem abbrvau jsou generovány klíče typu autor-rok (např. Satrapa a kol., 2004). Použitím abbrvnum skript vyprodukuje jednoduše očíslovaný seznam. Pro abbrvau a abbrvnum je použit formát Textau resp. Textnum. Jedná se jen o lehce upravený formát Text, optimalizovaný pro tyto styly. Při použití jiných stylů Alpha, Abbrev nebo apa4e) není tělo textu zpracováno, akorát se připojí seznam odkazů ve formě odpovídající použitému stylu.