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í
×
dnes 11:00 | Komunita

Členové a příznivci spolku OpenAlt se pravidelně schází v Praze a Brně. Fotky z pražských srazů za uplynulý rok si můžete prohlédnout na stránkách spolku. Příští sraz se koná už zítra 19. ledna – tentokrát je tématem ergonomie ovládání počítače – tzn. klávesnice, myši a další zařízení. Také budete mít příležitost si prohlédnout pražský hackerspace Brmlab.

xkucf03 | Komentářů: 0
včera 21:55 | Komunita

Nadace pro svobodný software (FSF) oznámila aktualizaci seznamu prioritních oblastí (changelog), na které by se měli vývojáři a příznivci svobodného softwaru zaměřit. Jsou to například svobodný operační systém pro chytré telefony, hlasová a video komunikace nebo softwarový inteligentní osobní asistent.

Ladislav Hagara | Komentářů: 5
včera 16:44 | Nová verze

Byla vydána verze 2.0.0 knihovny pro vykreslování grafů v programovacím jazyce Python Matplotlib (Wikipedie, GitHub). Přehled novinek a galerie grafů na stránkách projektu.

Ladislav Hagara | Komentářů: 0
včera 15:33 | Komunita

V australském Hobartu probíhá tento týden konference linux.conf.au 2017. Na programu je celá řada zajímavých přednášek. Sledovat je lze online.

Ladislav Hagara | Komentářů: 0
včera 10:20 | Zajímavý článek

Pavel Tišnovský se v dvoudílném článku na MojeFedora.cz věnuje bitmapovým (rastrovým) grafickým editorům ve Fedoře. V prvním dílu se věnuje editorům MyPaint, MtPaint, Pinta, XPaint, Krita a GIMP. V pokračování pak editorům GNU Paint (gpaint), GrafX2, KolourPaint, KIconEdit a Tux Paint.

Ladislav Hagara | Komentářů: 1
16.1. 17:11 | Komunita

Byl proveden bezpečnostní audit svobodného IMAP a POP3 serveru Dovecot (Wikipedie). Audit byl zaplacen z programu Mozilla Secure Open Source a provedla jej společnost Cure53. Společnost Cure53 byla velice spokojena s kvalitou zdrojových kódu. V závěrečné zprávě (pdf) jsou zmíněny pouze 3 drobné a v upstreamu již opravené bezpečnostní chyby.

Ladislav Hagara | Komentářů: 0
16.1. 15:30 | IT novinky

Nadace Raspberry Pi představila na svém blogu Raspberry Pi Compute Module 3 (CM3 a CM3L), tj. zmenšené Raspberry Pi vhodné nejenom pro průmyslové využití. Jedná se o nástupce Raspberry Pi Compute Module (CM1) představeného v dubnu 2014. Nový CM3 vychází z Raspberry Pi 3 a má tedy dvakrát více paměti a desetkrát větší výkon než CM1. Verze CM3L (Lite) je dodávána bez 4 GB eMMC flash paměti. Uživatel si může připojit svou vlastní. Představena byla

… více »
Ladislav Hagara | Komentářů: 2
16.1. 01:23 | Nová verze

Oficiálně bylo oznámeno vydání verze 3.0 multiplatformního balíku svobodných kancelářských a grafických aplikací Calligra (Wikipedie). Větev 3 je postavena na KDE Frameworks 5 a Qt 5. Krita se osamostatnila. Z balíku byly dále odstraněny aplikace Author, Brainstorm, Flow a Stage. U Flow a Stage se předpokládá jejich návrat v některé z budoucích verzí Calligry.

Ladislav Hagara | Komentářů: 7
15.1. 15:25 | Nová verze

Bylo oznámeno vydání první RC (release candidate) verze instalátoru pro Debian 9 s kódovým názvem Stretch. Odloženo bylo sloučení /usr jako výchozí nastavení v debootstrap. Vydán byl také Debian 8.7, tj. sedmá opravná verze Debianu 8 s kódovým názvem Jessie.

Ladislav Hagara | Komentářů: 6
15.1. 13:37 | Zajímavý projekt

1. ledna byl představen projekt Liri (GitHub). Jedná se o spojení projektů Hawaii, Papyros a původního projektu Liri s cílem vyvíjet operační systém (linuxovou distribuci) a aplikace s moderním designem a funkcemi. Včera byl představen Fluid 0.9.0 a také Vibe 0.9.0. Jedná se o toolkit a knihovnu pro vývoj multiplatformních a responzivních aplikací podporující Material Design (Wikipedie) a volitelně také Microsoft Design Language (designový jazyk Microsoft) [reddit].

Ladislav Hagara | Komentářů: 10
Jak se stavíte k trendu ztenčování přenosných zařízení (smartphony, notebooky)?
 (10%)
 (3%)
 (74%)
 (3%)
 (10%)
Celkem 313 hlasů
 Komentářů: 24, poslední včera 10:14
    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: 586×
    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: 59 | 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: 59 | 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.