Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 1.48 KB

README.md

File metadata and controls

23 lines (18 loc) · 1.48 KB

sao-faq

sfnet.atk.ohjelmointi ja sfnet.atk.ohjelmointi.alkeet uutisryhmien usein kysyttyjä kysymyksiä

Dokumentit löytyvät tiedostoista

FAQt on alunperin kirjoitettu DebianDoc SGML -kuvauskielellä, joka on alunperin kehitetty Debian -projektin dokumentointia varten. Nykyään kyseinen projekti on siirtynyt käyttämään Docbook XML:ää, joten katsoin tarpeelliseksi siirtyä käyttämään jotain uudempaa ja standardimpaa kuvauskieltä. Lisäksi siirryttyäni käyttämään Macia minulla ei enää ollut ympäristöä, joka pystyisi käsittelemään DebianDoc SGML:ää.

Ilmeinen valinta on Markdown, jota GitHub tukee suoraan ja joka on suunniteltu lukukelpoiseksi tekstitiedostoksi sellaisenaan. Tämä tekee paitsi tekstin päivittämisestä helpompaa, myös varmistaa, että tiedosto on luettavissa, vaikka prosessointityökaluja ei olisi saatavilla.

Konvertoin SGML-dokumentit ensin Docbookiksi debiandoc2dbk -ohjelmalla ja sen jälkeen käytin pandoc -komentoa kääntämään ne Markdowniksi. Ironisesti tätä varten jouduin rakentamaan DebianDoc SGML -ympäristön, mikä tavallaan poisti alkuperäisen tarpeen kuvauskielen vaihtamiseksi.

Toistaiseksi Markdown tiedostoihin ei ole tehty muutoksia ja säilytän SGML-tiedostot ainakin kunnes olen päivittänyt Makefile-tiedoston.