Série je kapitola

./blog.sh v1.11 — díl 3 z 12

Příručka k tomuhle enginu, kterou drží manual.blogsh.app, má 75 stránek v deseti kapitolách, a každá kapitola je jedna série příspěvků. Do 1.10 to byla série, o které menu nevědělo. Do menu šel štítek, stránka nebo adresa. Adresu série tam dát šlo, jenže na jejích dílech se nerozsvítila, takže čtenář uprostřed kapitoly nepoznal, že v kapitole je.

1.11 tohle spravuje čtyřmi věcmi, které k sobě patří a dají se zapnout každá zvlášť.

Série jako položka menu

nav:
  - { label: "Úvod", url: "/" }
  - { label: "Fotky", tag: "foto" }
  - { label: "První kroky", series: "První kroky" }

Položka series: bere jméno série tak, jak ho píšou příspěvky, nebo její slug, a vede na její výpis. Na každém jejím dílu se rozsvítí, ale jinak než na samotném výpisu: výpis je stránka, na které jsi, díl je kapitola, ve které jsi. Čtečka obrazovky dostane dvě různé hodnoty aria-current, "page" a "true", skin dva selektory, a každý skin, který engine nese, je kreslí odlišně.

Výpis série ale existuje, až když má série dva zveřejněné díly. Do té doby položka vede na 404 a doctor to řekne.

Nadpis nad kapitolami

Menu o dvaceti kapitolách je seznam, který si nikdo nezapamatuje. Položka s group: true a popiskem, bez cíle, je nadpis nad položkami za ní, až do další skupiny:

nav:
  - { label: "Začni tady", url: "/zacni-tady/" }
  - { label: "Základy", group: true }
  - { label: "Instalace", series: "Instalace" }
  - { label: "Psaní", series: "Psaní" }
  - { label: "Provoz", group: true }
  - { label: "Nasazení", series: "Nasazení" }

Seznam zůstává plochý. ./style.sh skupinu zapíše jako každou jinou položku a soubor druhého jazyka ji pojmenuje stejným způsobem. Skupina, pod kterou nic není, se vynechá, a adresa napsaná na skupině se nikdy nenásleduje. Obojí doctor pojmenuje.

Jak se skupina nakreslí, je věc skinu. Classic a Minimal nechávají položky v jedné řadě a popisek před nimi stojí jako tichý titulek, na telefonu je to nadpis nad nimi. Manual z ní dělá nadpis nad kapitolami v menu na boku.

Každý díl zná ostatní

layout:
  series_contents: true

Na stránce každého dílu stojí seznam všech dílů série, pod řádkem „díl N z M“ a nad textem, a ten, který čteš, je označený. Seznam se nikdy nezkracuje, ať je série dlouhá, jak chce. Zapnuté to není, dokud o to nepožádáš. Je to stálá navigace příručky, jejíž kapitoly jsou série.

Seznam sérií

Stránka /series/ s výpisem všech sérií dostala v 1.10 svůj vstup. Teď má taky titulek, popis a pořadí:

series_index:
  title: "Kapitoly"
  description: "Každá kapitola příručky, v pořadí, v jakém vznikala."
  order: oldest

order: oldest řadí série podle dne, kdy která začala, tedy v pořadí, v jakém se příručka psala. Bez toho stojí první série s nejnovějším dílem. Soubor druhého jazyka smí dát vlastní titulek a popis.

Průvodce na to myslí

./style.sh se zeptá na skin a na úvodník. Má-li web sérii, zeptá se i na series_contents a series_index, a nabídne ji i jako položku menu. Žádný z těch tří klíčů nemusíš psát rukou.

Co z toho plyne

Série zůstává jedna věc: jedna adresa, jedna sada dílů. Nové je to, že na ni menu umí ukázat a že čtenář v ní vždycky vidí, kde je. Příručka, deník z cesty nebo kurz po lekcích, cokoli, co má kapitoly, se dá postavit z příspěvků a nemusí kvůli tomu opustit engine.

Jak to vypadá, když kapitoly stojí v menu na boku, ukazuje průvodce skinem Minimal Manual.

Komentáře