Ponuka
× Domov Xoops Novinky Fórum Na stiahnutie
Užívateľ
Registrácia Prihlásenie
Vyhľadávanie
XOOPS štandardizuje svoju dokumentáciu na platforme GitBook
Iné | 2.12.2014 | 1601   
XOOPS štandardizuje pre najbližšiu budúcnosť všetku svoju dokumentáciu do platformy GitBook. Ako je zobrazené na obrázku nižšie, už niekoľko dokumentov bolo prevedených do GitBooku a pribudnú tam aj ďalšie. Dovtedy prosím navštívte úložisko XOOPSu na GitBooku pre kontrolu a dajte nám vedieť, čo si o tejto zmene myslíte.





Čo je to GitBook?

GitBook je nástroj pre vytváranie perfektných kníh pomocou syntaxu Markdown. Tým je možné vytvárať vlastné elektronické knihy v rôznych formátoch: PDF, ePub, Mobi, alebo ako webové stránky. Vďaka využitiu GitHubu vznikol najlepší nástroj pre spoluprácu vývojárov s tvorcami dokumentácií s vynikajúcim systémom správy verzií.

Najväčšou výhodou projektov Open Source, ako je aj XOOPS, je to, že tvoriť dokumentáciu môže každý, jednoduchých vetvením dokumentov a predkladaním zmien do tímu.

GitBook ponúka ako ďalšiu výhodu možnosť viacjazyčných verzií v jednom úložisku, kde si môžu užívatelia vybrať svoj vlastný jazyk. Toto je samozrejme pre nás veľmi dôležité, keďže XOOPS je medzinárodný projekt.

Niektoré z kľúčových vlastností:

Kontrola verzií: GitBook je založený na GIT scm. "git push" jednoducho zverejní novú verziu.

Markdown: knihy sú písané pomocou syntaxe Markdown. Plánovaná je podpora Asciidoc a TeX.

Jednoduchá aktualizácia: pomocou Git alebo pomocou editora môžete pohodlne publikovať a aktualizovať svoje knihy.

Prístup: knihy si môžete prečítať na všetkých zariadeniach, notebookoch, tabletoch, telefónoch, atď.

Čítačky elektronických kníh: knihy sú čitateľné na Amazon Kindle, Nook a ostatných čítačkách (PDF, ePub, Mobi).

GitHub: napíšte knihu na GitHub a za niekoľko sekúnd bude zverejnená tiež na GitBook.

Cena: vyberte si cenu, alebo príjmite dary od 0$ (alebo bez) do 100$.

Komunikujte, aktualizujte a zapájajte svojich členov do vývoja vašej práce.

Toto rozširuje obzor pre XOOPS, ktorý bol doteraz známy kvalitou zdrojového kódu a modernou architektúrou, no chýbala mu dobrá dokumentácia. GitBook zabezpečí v tomto smere zjednodušenie a štandardizáciu dokumentácie a tiež zapojí do jej tvorby celú komunitu XOOPS.


Pre xoopserov, ktorí chcú pomôcť je vytvorený proces dokumentácie XOOPS, preto ho skontrolujte a dajte nám vedieť, či je u vás v poriadku.
Tiež je vytvorený Štartovací balík dokumentov XOOPS s vopred definovanou štruktúrou priečinkov a súborov, ktoré môžete použiť pre spustenie vášho projektu.
Veríme, že akonáhle si uvedomíte, aké ľahké je tvoriť dokumentáciu, prispejete vašimi vlastnými projektami a pomôžete XOOPSu zažiariť aj v tomto smere.
FACEBOOK / komentáre k článku