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í
×

včera 11:33 | Pozvánky

Konference LinuxDays 2017 proběhne o víkendu 7. a 8. října v Praze v Dejvicích v prostorách FIT ČVUT. Konference OpenAlt 2017 proběhne o víkendu 4. a 5. listopadu na FIT VUT v Brně. Organizátoři konferencí vyhlásili CFP (LinuxDays, OpenAlt). Přihlaste svou přednášku nebo doporučte konference známým.

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

Byla vydána verze 1.3.0 odlehčeného desktopového prostředí Lumina (Wikipedie, GitHub) postaveného nad toolkitem Qt. Z novinek lze zmínit nový motiv ikon nahrazující Oxygen (material-design-[light/dark]) nebo vlastní multimediální přehrávač (lumina-mediaplayer).

Ladislav Hagara | Komentářů: 2
26.6. 17:33 | Bezpečnostní upozornění

Před šesti týdny byly publikovány výsledky bezpečnostního auditu zdrojových kódů OpenVPN a nalezené bezpečnostní chyby byly opraveny ve verzi OpenVPN 2.4.2. Guido Vranken minulý týden oznámil, že v OpenVPN nalezl další čtyři bezpečnostní chyby (CVE-2017-7520, CVE-2017-7521, CVE-2017-7522 a CVE-2017-7508). Nejzávažnější z nich se týká způsobu, jakým aplikace zachází s SSL certifikáty. Vzdálený útočník může pomocí speciálně

… více »
Ladislav Hagara | Komentářů: 1
26.6. 06:55 | Zajímavý projekt

V Edici CZ.NIC vyšla kniha Průvodce labyrintem algoritmů. Kniha je ke stažení zcela zdarma (pdf) nebo lze objednat tištěnou verzi za 339 Kč (připojení přes IPv4) nebo 289 Kč (připojení přes IPv6).

Ladislav Hagara | Komentářů: 6
26.6. 06:33 | Zajímavý software

Byla vydána verze 2.2.0 svobodného správce hesel KeePassXC (Wikipedie). Jedná se o komunitní fork správce hesel KeePassX s řadou vylepšení.

Ladislav Hagara | Komentářů: 0
26.6. 06:11 | IT novinky

Vývojář Debianu Henrique de Moraes Holschuh upozorňuje v diskusním listu debian-devel na chybu v Hyper-Threadingu v procesorech Skylake a Kaby Lake od Intelu. Za určitých okolností může chyba způsobit nepředvídatelné chování systému. Doporučuje se aktualizace mikrokódu CPU nebo vypnutí Hyper-Threadingu v BIOSu nebo UEFI [reddit].

Ladislav Hagara | Komentářů: 0
24.6. 01:23 | Komunita

Phoronix spustil 2017 Linux Laptop Survey. Tento dotazník s otázkami zaměřenými na parametry ideálního notebooku s Linuxem lze vyplnit do 6. července.

Ladislav Hagara | Komentářů: 3
23.6. 22:44 | Nová verze

Po třech měsících vývoje od vydání verze 5.5.0 byla vydána verze 5.6.0 správce digitálních fotografií digiKam (digiKam Software Collection). Do digiKamu se mimo jiné vrátila HTML galerie a nástroj pro vytváření videa z fotografií. V Bugzille bylo uzavřeno více než 81 záznamů.

Ladislav Hagara | Komentářů: 1
23.6. 17:44 | Nová verze

Byla vydána verze 9.3 open source alternativy GitHubu, tj. softwarového nástroje s webovým rozhraním umožňujícího spolupráci na zdrojových kódech, GitLab. Představení nových vlastností v příspěvku na blogu a na YouTube.

Ladislav Hagara | Komentářů: 3
23.6. 13:53 | Nová verze

Simon Long představil na blogu Raspberry Pi novou verzi 2017-06-21 linuxové distribuce Raspbian určené především pro jednodeskové miniaturní počítače Raspberry Pi. Společně s Raspbianem byl aktualizován také instalační nástroj NOOBS (New Out Of the Box Software). Z novinek lze zdůraznit IDE Thonny pro vývoj v programovacím jazyce Python a především offline verzi Scratche 2.0. Ten bylo dosud možné používat pouze online. Offline bylo možné používat pouze Scratch ve verzi 1.4. Z nového Scratchu lze ovládat také GPIO piny. Scratch 2.0 vyžaduje Flash.

Ladislav Hagara | Komentářů: 2
Chystáte se pořídit CPU AMD Ryzen?
 (6%)
 (31%)
 (1%)
 (9%)
 (44%)
 (9%)
Celkem 851 hlasů
 Komentářů: 65, poslední 1.6. 19:16
    Rozcestník

    Dotaz: Psaní dokumentace pro webovou aplikaci

    Josef Kufner avatar 5.1.2014 13:59 Josef Kufner | skóre: 67
    Psaní dokumentace pro webovou aplikaci
    Přečteno: 630×
    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: 60 | 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: 67
    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: 60 | 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: 67
    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: 61 | 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: 67
    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.