abclinuxu.cz AbcLinuxu.cz itbiz.cz ITBiz.cz HDmag.cz HDmag.cz abcprace.cz AbcPráce.cz
AbcLinuxu hledá autory!
Inzerujte na AbcPráce.cz od 950 Kč
Rozšířené hledání
×
eParkomat, startup z ČR, postoupil mezi finalisty evropského akcelerátoru ChallengeUp!
Robot na pivo mu otevřel dveře k opravdovému byznysu
Internet věcí: Propojený svět? Už se to blíží...
dnes 06:00 | Komunita

Na YouTube byl publikován Blender Institute Reel 2016, ani ne dvouminutový sestřih z filmů, které vznikly za posledních 10 let díky Blender Institutu. V institutu aktuálně pracují na novém filmu Agent 327. Dění kolem filmu lze sledovat na Blender Cloudu. Videoukázka Agenta 327 z června letošního roku na YouTube.

Ladislav Hagara | Komentářů: 0
dnes 01:02 | Zajímavý článek

Minulý týden byly vydány verze 1.2.3 a 1.1.7 webového poštovního klienta Roundcube. V oznámení o vydání bylo zmíněno řešení bezpečnostního problému nalezeného společností RIPS a souvisejícího s voláním funkce mail() v PHP. Tento týden byly zveřejněny podrobnosti. Útočník mohl pomocí speciálně připraveného emailu spustit na serveru libovolný příkaz. Stejně, jak je popsáno v článku Exploit PHP’s mail() to get remote code execution z roku 2014.

Ladislav Hagara | Komentářů: 0
včera 16:00 | Nová verze

Byla vydána verze 0.98 svobodného nelineárního video editoru Pitivi. Z novinek lze zmínit například přizpůsobitelné klávesové zkratky. Videoukázka práce s nejnovější verzí Pitivi na YouTube.

Ladislav Hagara | Komentářů: 1
včera 15:00 | Zajímavý software

Stop motion je technika animace, při níž je reálný objekt mezi jednotlivými snímky ručně upravován a posouván o malé úseky, tak aby po spojení vyvolala animace dojem spojitosti. Jaký software lze pro stop motion použít na Linuxu? Článek na OMG! Ubuntu! představuje Heron Animation. Ten bohužel podporuje pouze webové kamery. Podpora digitálních zrcadlovek je začleněna například v programu qStopMotion.

Ladislav Hagara | Komentářů: 3
7.12. 21:21 | Nová verze Ladislav Hagara | Komentářů: 0
7.12. 11:44 | Zajímavý projekt

Na Indiegogo byla spuštěna kampaň na podporu herní mini konzole a multimediálního centra RetroEngine Sigma od Doyodo. Předobjednat ji lze již od 49 dolarů. Požadovaná částka 20 000 dolarů byla překonána již 6 krát. Majitelé mini konzole si budou moci zahrát hry pro Atari VCS 2600, Sega Genesis nebo NES. Předinstalováno bude multimediální centrum Kodi.

Ladislav Hagara | Komentářů: 2
7.12. 00:10 | Nová verze

Byla vydána verze 4.7 redakčního systému WordPress. Kódové označením Vaughan bylo vybráno na počest americké jazzové zpěvačky Sarah "Sassy" Vaughan. Z novinek lze zmínit například novou výchozí šablonu Twenty Seventeen, náhledy pdf souborů nebo WordPress REST API.

Ladislav Hagara | Komentářů: 9
6.12. 12:00 | Zajímavý projekt

Projekt Termbox umožňuje vyzkoušet si linuxové distribuce Ubuntu, Debian, Fedora, CentOS a Arch Linux ve webovém prohlížeči. Řešení je postaveno na projektu HyperContainer. Podrobnosti v často kladených dotazech (FAQ). Zdrojové kódy jsou k dispozici na GitHubu [reddit].

Ladislav Hagara | Komentářů: 27
6.12. 11:00 | Bezpečnostní upozornění

Byly zveřejněny informace o bezpečnostní chybě CVE-2016-8655 v Linuxu zneužitelné k lokální eskalaci práv. Chyba se dostala do linuxového jádra v srpnu 2011. V upstreamu byla opravena minulý týden [Hacker News].

Ladislav Hagara | Komentářů: 2
5.12. 22:00 | Komunita

Přibližně před měsícem bylo oznámeno, že linuxová distribuce SUSE Linux Enterprise Server (SLES) běží nově také Raspberry Pi 3 (dokumentace). Obraz verze 12 SP2 pro Raspberry Pi 3 je ke stažení zdarma. Pro registrované jsou po dobu jednoho roku zdarma také aktualizace. Dnes bylo oznámeno, že pro Raspberry Pi 3 je k dispozici také nové openSUSE Leap 42.2 (zprávička). K dispozici je hned několik obrazů.

Ladislav Hagara | Komentářů: 6
Kolik máte dat ve svém domovském adresáři na svém primárním osobním počítači?
 (32%)
 (24%)
 (29%)
 (8%)
 (5%)
 (3%)
Celkem 799 hlasů
 Komentářů: 50, poslední 29.11. 15:50
Rozcestník
Reklama

Dotaz: Psaní dokumentace pro webovou aplikaci

Josef Kufner avatar 5.1.2014 13:59 Josef Kufner | skóre: 66
Psaní dokumentace pro webovou aplikaci
Přečteno: 570×
Dobré ráno,

přemýšlím, v čem psát dokumentaci k složitější webové aplikaci napsané v PHP. Chci, aby bylo možné vyrobit tisknutelné PDF (pomocí LaTeXu), a aby bylo možné vložit dokumentaci přímo do aplikace (HTML).

Dokumentace bude tvořena statickým textem. Není to o generování referenční příručky ze zdrojáků, ale o popisu, jak a proč je co uděláno, jak se jednotlivé komponenty dají dál používat a podobně. Druhou takovou "knihou" pak bude uživatelská příručka, což bude po technické stránce prakticky totéž.

Po vzoru knížky ProGit chci celou dokumentaci dát do samostatného repositáře Gitu a napsat to v nějakém plaintextovém formátu, který půjde diffovat a mergovat. Repositář se pak do aplikace přilinkuje jako submodul (či něco podobného) a aplikace se postará o zobrazení dokumentace uživateli.

Pro zobrazování dokumentace nechci používat externí nástroje. To by přidělávalo práci s deploy a editací. Konverzi do HTML tedy musí zvládnout nějaká PHP knihovna přibalená k aplikaci. Konverze do LaTeXu už mne nepálí, tam se nějaký build script použije tak jako tak.

Vzhledem k podpoře na GitHubu a všeobecné rozšířenosti jsem zatím došel k Markdown, jakožto formátu samotného textu. Na první pohled to vypadá nadějně, ale ... neumí číslovat obrázky ani kapitoly, odkazovat na čísla kapitol, generovat obsah, vlastní odkazy, ... takže je vlastně nepoužitelný na cokoliv většího než pár odstavců.

Existuje něco jiného, co je dostatečně rozšířené?

V čem píšete dokumentaci vy?
Hello world ! Segmentation fault (core dumped)

Odpovědi

5.1.2014 15:02 lertimir | skóre: 58 | blog: Par_slov
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
A co Docbook?
Josef Kufner avatar 5.1.2014 15:46 Josef Kufner | skóre: 66
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
Na dokumentaci je nejdůležitější, aby se snadno psala. Docbook to s tím šíleným XML vůbec nesplňuje :-(
Hello world ! Segmentation fault (core dumped)
6.1.2014 00:43 lertimir | skóre: 58 | blog: Par_slov
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
Připadá mi, že je věc jednak zvyku a jednak dobrého XML editoru. Pro někoho LaTeXový dokument je také napsaný "šíleným" jazykem. Zkusil bych XMLmind, které je i linuxové (javové) prostředí. DocBook mi připadá jako přirozené prostředí pro dokumentaci, která potřebuje generovat různé výstupy.
Josef Kufner avatar 6.1.2014 01:26 Josef Kufner | skóre: 66
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
Ono nejde jen o vlastní editaci, ale také o diffy a mergování změn. Tam už to začne být šťanatější.

Navíc pokud to bude v Markdown nebo něčem podobně podporovaném, tak kdokoliv může na GitHubu zmáčknout čudlík "Edit" a velice pohodlně opravit/připsat, co chce, jen s použitím prohlížeče a poslat pull request. To dává trochu lepší šance na udržení dokumentace aktuální.
Hello world ! Segmentation fault (core dumped)
6.1.2014 08:04 alfonz
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
přesně tohle se sphinxem a rst funguje ...

více viz

http://sphinx-doc.org/ http://docutils.sourceforge.net/rst.html http://rst2pdf.ralsina.com.ar/quickstart.html

v případě potřeby se pak pouze vytvářejí nové rst soubory nebo se Sphinx nastaví na automatické skládání. Umí to pak i LaTeX.

Sphinx lze pak nastavit, že dělá automaticky Obsah, Index (mohou být i číslované).. Vkládání souborů obrázků (lze řešit i vložení PDF/SVG)

http://sphinx-doc.org/sphinx.pdf a tady je ukázka PDF přes LaTeX a zde

přes http://sphinx-doc.org/sphinx-rst2pdf.pdf
6.1.2014 09:05 dustin | skóre: 60 | blog: dustin
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
Ten sphinx vypadá opravdu pěkně a seznam projektů, které jej využívají, je pořádně dlouhý.
Josef Kufner avatar 6.1.2014 10:56 Josef Kufner | skóre: 66
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
Jo, Sphinx vypadá opravdu pěkně. Pokud se neobejdu bez exteního nástroje pro vyrobení HTML, asi ho použiju. Raději bych však, aby mi PHP aplikace nezávisela na Pythonu.
Hello world ! Segmentation fault (core dumped)
6.1.2014 21:42 alfonz
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
tak lze použít pouze rst2html > ale to je také závislé na pythonu myslím
7.1.2014 08:12 alfonz
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
jinak zde se píše o PHP aplikaci https://github.com/chobie/PHP_reStructuredText a tam je dále napsáno tohle

currently this library has not maintained. please use rst2xml and parse it. možná existuje ještě nějaká lepší knihovna.. Na druhou stranu, rst je přímo podporavné na githubu, takže si myslím, že to je v pohodě

možná ta zmíněná php knihovna stačí.
5.1.2014 22:21 alfonz
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
řešil jsem podobný problém a vyřešil přes Sphinx + rst2html/rst2pdf Dá se to jednoduše připojit i k dokumentaci generované sphinxem a k tomu přidat pár vlastních python skriptů pro úpravy dokumentace a je to v pohodě.

popravdě jsem s vámi chtěl i pár věcí probrat více předtím..

5.1.2014 22:33 alfonz
Rozbalit Rozbalit vše Re: Psaní dokumentace pro webovou aplikaci
a už jsem to nedopsal.. no nějak se s vámi ještě zkusím zkontaktovat

Založit nové vláknoNahoru

Tiskni Sdílej: Linkuj Jaggni to Vybrali.sme.sk Google Del.icio.us Facebook

ISSN 1214-1267   www.czech-server.cz
© 1999-2015 Nitemedia s. r. o. Všechna práva vyhrazena.