dotNETportal.cz

Dobrý den,

berte mě prosím jako člověka, který v Latex nikdy nic nepsal a rozhoduje se, zda v něm napsat dokumentaci či použít něco jiného. Pro mé rozhodování je důležité, zda je možné dostat pomocí Latexu formátovaný text programovacího jazyka, resp. potřebuji napsat dokumentaci, aby vypadala a potřebuji v něm zveřejnit části kódu, jenže potřebuji docílit efektu, aby formátování bylo stejné jako při programování - aby prostě klíčová slova byla jinak než proměnné apod.

Myslíte si, že se má cenu pouštět do větších akcí?

Pro psaní dokumentace k programu jsou určeny specializované nástroje. Microsoft k tomuto účelu vyvinul Sandcastle, což je sada nástrojů (vše jsou konzolové aplikace pro použití v příkazovém řádku) pro tvorbu dokumentace a používá se i pro kompilaci MSDN. Potom existují i GUI aplikace třetích stran, z nichž nejlepší je Innovasys HelpStudio (pro majitele Visual Studia Standard nebo lepšího k dispozici zdarma ve verzi Lite) a Document! X. S něčím tak směšným jako je LaTeX bych se vůbec nezabýval.

Nechápu váš postoj.

Abych to přesnil - potřebuji snadno přenositelný, snadno upravitelný dokument, do kterého budu mít možnost vložit třeba vzorce. Nejde jenom o dokumentaci k programu, jen mě tak napadlo, jestli neví někdo o šabloně pro programy. Potřebuji, aby to vypadalo.

Pokud potřebujete snadno přenositelný, univerzální dokument tak zvolte formát PDF. K jeho vytváření a úpravám existuje zdarma dostupných nástrojů víc než dost.

Latex generuje PDF velmi spolehlivě a typografie je znamenitá. Viděl jste někdy PDF vygenerové z LaTexu?

Pokud vám to takto vyhovuje, nechápu smysl vašeho dotazu. Pokud chcete dělat dokumentaci k softwaru, doporučuji vám výše uvedené nástroje.

Pokud se chcete patlat s Latexem, přeji příjemnou zábavu a ocelové nervy. O poznání méně trablí (i když také je jich dost) je s Wordem a pokud umíte správně nastavit a používat styly, dosáhnete naprosto srovnatelného výsledku. PDF generovaná z Latexu jsou mimochodem šílená, alespoň ty, které jsem viděl, byly při větším zazoomování kostičkované. Asi nějaký divný font.

Tak to je mi líto, že jste viděl špatná. Mohu Vám nějaká poslat, abyjste změnil názor.

Ale to je jedno, diskuse se stáčí špatným směrem.

Dejme tomu, že pro čistou dokumentaci ja lepší jiný nástroj, než Latex, ale na druhou stranu dejme tomu (a to je můj případ), děláte nějaké výpočty, máte rovnice matice, integrály atp. děláte výpočty ručně a následně v Matlabu něco ověřujete, kreslíte charakteristiky apod. No a jelikož to máte ve funkci, potřebujete ji vypsat do dokumentace... A teď co?

Word je nepoužitelný, psaní rovnic je v něm katastrofické a celkově je to šílený. Latex je pro tuhle potřebuje nedocenitelný - jenže jak spojit jeho přednosti s tím, aby strojový kód vypadal rozumně formátován.

Dotaz byl, jestli nevíte o šabloně s typografií, která by se hodila pro daný jazyk.

Výsledek je, že nevíte. Nejste jediní - nevím to já, neví to kolegové, nevíte to vy. Neví to spousta lidí. Ale radit, že to mám psát ve Wordu... To ani nemám k čemu bych to přirovnal.

O Wordu toho teda moc nevíte. Neříkám, že to je nástroj určený k sázení knížek, ale pokud chcete dělat dokumentaci tak bych ho klidně doporučil. Umí vše, co můžete potřebovat, jen se s tím musí pořádně umět (což samozřejmě musíte i s latexem). Pokud tam chcete navíc dávat ukázky zdrojáku, tak při kopírování z Visual Studia ho umí i obarvit, což se v Texu bude dělat hodně blbě. Jediný problém je, že si musíte trochu přizpůsobit a nastavit styly, ale to není takový problém.