Asciiblog - metainformace

— k47

Článek je tvořen dvěma částmi: Hlavičkou a tělem. Obě musí být odděleny prázdným řádkem.

Hlavička obsahuje metainformace článku zapsané ve strojově čitelném formátu. Tělo je pak tvořeno textem nebo HTML.

Příklad hlavičky:

XXX Název článku [2018/slug]
=====
2018-01-01
alias: id:47, y2018a3
rel: 2018/jiny-clanek, 2018/jeste-jeden-clanek, id:11
by: autor
# tag, další tag, (skrytý tag)

Všechny položky kromě názvu a podtržení jsou nepovinné. Blok nesmí obsahovat prázdné řádky, protože prázdný řádek ukončí metainformace a oddělí je od těla dokumentu. Na pořadí jednotlivých druhů metainformací nezáleží.

Pokud názvu článku předchází:

XXX – bude vygenerován, je možné se na něj odkázat, ale nedostane se na hlavní stránku. (Například tento návod je označen XXX.)
??? – bude kompletně ignorován. (Zamýšlel jsem to jako označení rozepsaných textů, aby nebyly publikovány.)

Slug je uzavřen v hranatých závorkách a představuje unikátní identifikátor článku, který bude použit v url. Například tento návod má slug zadaný jako [projekty/asciiblog-metainformace], z nějž se odvodí url https://k47.cz/projekty/asciiblog-metainformace.html.

Pokud nebude slug zadán, dojde k jeho vygenerování z titulku článku tím, že se odstraní háčky a čárky a mezery se převedou na pomlčky.

Slug je možné vynutit nastavením konfigurační direktivy demandExplicitSlugs true (zamýšleno jako prevence proti zapomenutí, když používám vlastní schéma url).

Datum může být v zadáno s různou přesností:

2018-01-30
2018-01-30 10:47
2018-01-30 10:47:05

První část je v pořadí rok-měsíc-den.

Ve výchozím stavu články s datem v budoucnosti budou publikovány. Pokud si to nepřejete, nastavte direktivu excludeFutureArticles false.

alias: slouží pro vyjmenování aliasů – unikátních identifikátorů, kterými je možné se také odkazovat na článek.

rel: je čárkou oddělovaný seznam příbuzných článků, které budou zobrazeny na vyšších příčkách v seznamu podobných článků. Je možné se odkázat přes slug nebo alias.

meta: k článku může připojit uživatelské informace, které (kromě několika málo výjimek jako nozoom, tag, supertag nebo sortby) nemají speciální význam. Mohou být využity z háčků (hooks) pro vlastní přizpůsobení. V ukázkové třídě háčků asciiblog.example.CustomHooks jsou hodnoty jako +:1 nebo +:2 indikují, jak vysoko se má článek zobrazit v globálním doporučení. Meta má specifický formát. Na jednu stranu jde o čárkou oddělovaný seznam, na druhou se položky ve formátu key:value chovají jako asociativní pole. Proto ono +:2: + je klíč a 2 hodnota.

Autora článku můžete zadat v meta-řádku by:. Když ho vynecháte, bude použito jméno nastavené v konfigurační direktivě defaultUser.

Tagy (štítky/značky) se udávají na jeden nebo několik řádků začínajících znakem #. Jde zas o čárkou oddělovaný seznam.

# tag1, tag2, tag3

Tagy v závorkách jsou skryté. Nebudou zobrazeny pod článkem, ale budou použity pro výpočet podobnosti článků pro doporučení podobných.