Asciiblog - konfigurační direktivy

Soupis všech konfiguračních direktiv a jejich výchozích hodnot.

encoding utf-8
# Kódování vstupních souborů. Výchozí je utf-8. Tuto direktivu udávejte jako
# první, protože udává kódování samotného konfiguračního souboru.

title
# Název blogu. Bude použit jako titulek.

baseUrl
# Url domény na které bude blog publikován.

files
# Seznam zdrojových souborů, ze kterých bude blog vygenerován. Může jít o
# absolutní cesty nebo o relativní vůči konfiguračnímu souboru. Jednotlivé
# soubory musí být odděleny mezerou. Je možné uvést cestu ke složce a pak budou
# použity všechny soubory, které se v ní nacházejí.

outDir
# Složka do které se bude blog generovat. Pokud chybí, použije je složka, ze
# které byl asciiblog spuštěn.

imageRoot
# Základní url pro obrázky zadané relativní cestou. Pokud není nastavena,
# použije se hodnota `baseUrl`. Jde o pouhou zkratku, abyste nemuseli zadávat
# plné url. Je užitečná hlavně v případech, kdy máte obrázky na jiné doméně a
# přesto se na ně chcete odkazovat relativními cestami.

imageDir
# Složka na disku, kde se nacházejí obrázky. Když není zadána, obrázky se
# hledají relativně ke složce obsahující konfigurační soubor. Pokud je obrázek
# zadaný absolutní url, stáhne se z disku jen když je z `imageRoot` jinak je
# stažen z url.

localImages true
# (true, false) Udává zdali se obrázky pro generování náhledů mají hledat na
# místním disku nebo na serveru.

index | fullArticles 7
index | archive
# ???


groupArchiveBy year
# (year, month nebo nějaké číslo) Udává jak organizovat archiv. Pokud je
# nastavené na year, je shlukován po rocích. Pokud na month, je shlukován po
# měsících (hodí se pro blogy aktualizované velice často jako třeba k47.cz).
# Dále může být nastaveno libovolné číslo. To znamená, že se každá stránka bude
# obsahovat právě tolik článků.

archiveFormat link
# (link, short, full) Udává jak se bude zobrazovat obsah archivu. Pokud je
# nastavené na hodnotu link, každý článek se ukáže jen jako odkaz. Pokud má
# hodnotu short, článek se ukáže jako krátké shrnutí s obrázkem. Hodnota full
# zobrazí článek celý.

tagFormat link
# (link, short) Funguje podobně jako archiveFormat, jen ovlivňuje zobrazení
# seznamů na stránkých tagů.

style
# Vlastní CSS styl. Bude vložen do každé stránky a selektivně minilamizován
# (jenom ta pravidla, která jsou ve stránce použita, budou zachována).

cssFile
# Soubor s externím CSS stylem.

header
# HTML fragment, který bude použit jako hlavička každé stránky.

footer
# HTML fragment, který bude použit jako patička každé stránky.

thumbnailWidth 150
# (číslo) šírka malého náhledu obrázku

thumbnailHeight 100
# (číslo) výška malého náhledu obrázku

bigThumbnailWidth 800
# (číslo) šířka velkého náhledu, který bude roztažen na plnou šířku blogu.

rssLimit 2147483647
# (číslo) Kolik článků by se mělo zobrazit v RSS kanále. Ve výchozím stavu se
# zobrazí všechny.

fullArticlesInRss false
# (true, false) mají se v RSS kanále ukazovat plné články nebo jen odkazy na ně

similarLinksLimit 5
# (číslo) Udává kolik se může pod článkem zobrazit odkazů na podobné články.
# Podobnost se vypočítává ze sdílených tagů.

sortByDate false
# (true, false) Mají se články seřadit podle data nebo se mají ukazovat tak jak
# jsou uvedeny ve zdrojových souborech. Pokud generujete blog z několika
# souborů, vyplatí se tuto volbu nastavit na true.

language en
# Jazyk blogu, ovlivní použité překlady. Funguje velice jednoduše: načte soubor
# lang.${language} ze stejné složky jako asciiblog.jar

fileSuffix .html
# Přípona vygenerovaných souborů. Standardně je nastavená na .html, aby blog
# mohl hostovat kdejaký server bez zvláštního nastavení.

imageMarker
# Řetězec, který se přidá za odkaz na článek, který obsahuje obrázky.

albumsDir
# Složka, kde se nacházejí alba. Používá se, když je asciiblog používán jako
# galerie, nikoli jako blog.

allowComments false
# (true, false) Povolí komentáře. Ke svému chodu potřebuje server s PHP aspoň
# verze 5.5 (ale ideálně co nejnovější) s json rozšířením.

shareLinks false
# (true, false) Pokud je toto nastaveno na true, pod každým článkem se zobrazí
# odkazy pro sdílení na twitteru, facebooku a google plus.

articlesMustBeSorted false
# (true, false) Tato direktiva vynucuje, že články ve zdrojových souborech
# musejí být seřazeny podle data (od nejnovějších po nejstarší).

articlesMustNotBeMixed false
# (true, false) Tato direktiva vynucuje, že viditelné a skryté články (jejichž
# titulek začíná ???) nesmějí být pomíchané. Na začátku souboru musí být
# všechny skryté a pod nimi všechny veřejné.

demandExplicitSlugs false
# (true, false) Vynutí, že ve zdrojových souborech musí každý článek mít slug.
# Zakáže generování slugů ze jména. Jde o kontrolní mechanismus, že jsem
# nezapomněl na stabilní slug, na který můžu odkazovat a který se nezmění, když
# přejmenuji článek.

excludeFutureArticles false
# (true, false) Pokud je tato direktiva nastavena na true, články s datem v
# budoucnu budou zcela vynechány.

openGraph false
# (true, false) Pokud je toto nastavené na true, do každé stránky se zahrne
# open graph HTML tag, který trochu zkrášlí sdílení na sociálních sítích.

twitter.site
twitter.creator
# Uživatelské jméno twitteru, které má být použito v open graph HTML tagu (včetně
# @). Direktiva twitter.site nebo twitter.creator automaticky nastaví openGraph
# na true.

defaultUser
# Jméno, které bude použito jako autor všech článků, které nemají autorství
# určené v `by:`.

hooks asciiblog.NoHooks
# Nastaví java třídu implementující rozhraní asciiblog.Hooks, která přizpůsobí
# některé detaily jak se bude blog zobrazovat. Ve standardní distribuci je
# třída asciiblog.example.CustomHooks, která zkrášlí nadpisy a na hlavní
# stránce ukáže odkazy na důležité články, které mají nastavenou meta-informaci
# meta: +:1 nebo vyšší.

printTiming false
printErrors true

inline!
# tato direktiva označuje, že všechno, co po ní následuje v konfiguračním
# souboru, je obsah blogu. Když je použita, není třeba nastavovat direktivu
# files.