{HEADER END}
{COMPARE START}

MLAB

Porovnej cestu:  Revize
S umístěním:  Revize

Toto porovnání ukazuje změny pro převedení /Articles (Revize 3239) na /Articles (Revize 3241)

Reverzní porovnání

HowTo/Rules/DOC/HTML/Rules.cs.html

@@ -340,7 +340,7 @@

HDL
</th>
<td>
<i>XXX</i> zdrojové soubory popisující hardware (VHDL)
zdrojové soubory popisující hardware (VHDL)
</td>
</tr>
<tr>

@@ -395,28 +395,27 @@

<h1> Tvorba dokumentace </h1>
<p>
Základní dokumentace se vytváří jako dokument v programu MS Word ze
Základní dokumentace se vytváří jako dokument ze
kterého se generuje PDF podoba dokumentace a HTML stránky. Dokument je
připraven tak, aby pokud možno vyhovoval tisku v podobě knížečky formátu
A5 (oboustranný tisk na listy A4 jako brožura). Tomu se snažíme
přizpůsobit počet stran textu (násobek 4).
</p>
<h2> Å ablona MS Word </h2>
<h2> Šablony dokumentů </h2>
<p>
Dokumenty se vytvářejí na základě šablony projektu uložené v souboru
<a href="../../../../../Library/Templates/DOC/MLAB_Å ablona.dot">MLAB_Å ablona.dot</a>.
Dokumenty se vytvářejí v LaTEXu, LibreOffice Writer, nebo Wordu, na základě šablon uložených v
<a href="http://www.mlab.cz/WebSVN/listing.php?repname=MLAB&path=%2FLibrary%2FTemplates%2F#_Library_Templates_">databázi MLAB</a>.
</p>
<p>
Je velmi vhodné použít šablonu tak, jak je, bez větších formátovacích
zásahů do textu. Zejména je vhodné vyvarovat se individuálních změn
formátování textu. Nedodržení této zásady komplikuje proces vytváření
HTML podoby dokumentu.
formátování textu. Nedodržení této zásady komplikuje proces jakékoli úpravy dokumentu.
</p>
<h3> Hlavička a patička a název dokumentu </h3>
<h3> Hlavička, patička a název dokumentu </h3>
<p>
V hlavičce vlevo je vložen název dokumentu, který se bere z vlastností

@@ -432,14 +431,6 @@

(<i>Soubor/Vlastnosti/Autor</i>)
</p>
<p>
V případě změny údajů ve vlastnostech dokumentu je třeba zajistit
aktualizaci automatických polí v hlavičce a patičce. Aktualizace
automatických polí je vůbec obecným problémem MS Wordu autorovi je
poněkud záhadou, proč se automatická pole neaktualizují opravdu
automaticky.
</p>
<h3> Titul </h3>
<p>

@@ -474,21 +465,15 @@

Nezapomeňte obrázku nastavit alternativní text pro Web.
</p>
<h3> Seznam </h3>
<h3> Obsah </h3>
<p>
Pokud je dokument delší, bývá na svém začátku doplněn o seznam. Seznam
není povinný.
Pokud je dokument delší, bývá na svém začátku doplněn o obsah. (není povinný)
</p>
<h3> Nadpisy </h3>
<p>
Nadpisy užíváme obvykle jen do třetí úrovně vnoření protože nepíšeme
vědeckou knihu.
</p>
<p>
U dokumentace standardního modulu je první nadpis umístěn pod
ilustrativním obrázkem a obsahuje pouze tabulku základních parametrů
modulu. To vše by se mělo vejít na první stranu dokumentu. Viz

@@ -499,7 +484,7 @@

<p>
Text se píše stylem normálního odstavce. Samostatných modifikací
normálního stylu používáme co nejméně.
normálního stylu nepoužíváme.
</p>
<h3> Přehled doporučených stylů </h3>

@@ -514,66 +499,6 @@

<i>Puntíkaté seznamy</i> pro seznamy, i vnořené <br>
</p>
<h3> Aktualizace Å¡ablony </h3>
<p>
Aktualizaci šablony provádí autor projektu tak, aby nedocházelo k
tříštění nastavení šablony. Je žádoucí omezit co nejvíce složitost
šablony a zaváděn jen nezbytná a užitečná rozšíření.
</p>
<p>
Šablona se postupně rozvíjí dle potřeb autorů a konstrukce webu
(zejména v návaznosti na kaskádové styly a na podporu automatického
generování HTML).
</p>
<h2> Nastavení programu MS Word </h2>
<h3> Automatické nastavení přepínání klávesnice </h3>
<p>
<i>Nástroje\Nástroje\Možnosti\Úpravy</i>
</p>
<p>
Po nastavení se po přemístění kurzoru na nové místo v dokumentu dojde
současně k přepnutí klávesnice na jazyk, kterým je v daném místě
dokumentu psáno. Česky psané části se píší česky (česká klávesnice
znamená současně i český jazyk), anglické části (i jednotlivá slova) se
píší anglicky. <i>Je vhodné naučit se psát speciální znaky (různé druhy
závorek, menšítka, většíta a podobně) na české klávesnici.</i>
Dělá se to přes <i>pravý&nbsp;alt</i>. Omezí se tak nesmyslné značkování
anglickým jazykem těchto znamének.
</p>
<h3> Přidání šablony do dostupných šablon </h3>
<p>
<i>Nástroje\Možnosti\Umístění souborů</i> – <i>Uživatelské šablony</i>
nebo <i>Å ablony skupiny</i>
</p>
<p>
Další možností je přidat odkaz (link) na šablonu do některého adresáře
ve kterém jsou umístěny šablony.
</p>
<h3> Nastavení UTF-8 pro export </h3>
<p>
<i>Nástroje\Možnosti\Obecné\Webové možnosti\Kódování</i> - <i>Kódování
Unicode (UTF-8)</i>
</p>
<p>
Pro export dat do HTML je třeba nastavit výstupní kódování na UTF-8.
Výsledkem je to, že se nekazí speciální znaky. Například znak Ω pro
ohmy se často zkazí na W což působí směšně. Kdo by chtěl odpor 100kW v
SMD provedení, že?
</p>
<h2> Psaní dokumentu </h2>
<h3> Doporučená osnova pro standardní popis modulů </h3>

@@ -589,21 +514,7 @@

Bitmapové obrázky (fotografie) pro vložení si připravíme jako samostatné
soubory (oříznutí, zmenšení datové velikosti, nastavení 300DPI a podobně).
</p>
<p>
Schémata kopírujeme přímo z programu OrCAD. V případě, že je třeba
obrázek otočit lze to udělat například vložením do programu Corel,
otočením a vykousnutím zpátky do schránky (tedy bez ukládání na disk).
</p>
<p>
Novější verze programu Word už umí obrázky otáčet. Funkce
<i>Kreslení\Otočit či překlopit</i> nebo u obrázků umístěných samostatně
je možno ve vlastnostech obrázku zadat úhel otočení. Někdy toto pole
bývá šedivé, pak funguje první možnost. Některé druhy obrázků se při
otočení pokazí, pak je lépe otočení provést externě.
</p>
<h3> Seznam součástí </h3>
<p>

@@ -620,24 +531,10 @@

Seznam součástí je nejlepší vložit jako dvě tabulky v jedné tabulce o
dvou buňkách. Pak nejsou potíže s výškou řádek v levé a pravé části
seznamu. Nezapomeňte mezi jednotlivé reference (R1, R2, ...) vložit
mezeru.
mezeru, aby mohlo docházet k automatickému zalamování textu.
</p>
<h2> Tvorba výstupů </h2>
<h3> Tvorba výstupů PDF </h3>
<p>
<em>Dopsat.</em>
</p>
<h3> Tvorba výstupů HTML </h3>
<p>
Vytvoření funkční HTML stránky z DOC souboru popisuje samostatný
dokument <a href="../../../DOC2HTML/DOC/HTML/DOC2HTML.cs.html">DOC2HTML.cs.html</a>.
</p>
<h2> Povinné úkony </h2>
<p>

@@ -652,7 +549,6 @@

<li> Obsahuje vyplněnou tabulku parametrů </li>
<li> Obsahuje seznam součástek </li>
<li> Je vygenerovaný .PDF </li>
<li> Je vygenerovaný .HTML </li>
<li> Jsou data uložena v databázi SVN </li>
</ul>

@@ -1016,9 +912,6 @@

„ano“ nebo „v tomto případě záměrně ne“.
</p>
<p>
<em>Sada povinných úkonů se ještě bude rozšiřovat.</em>
</p>
<h3> Vlastní návrh </h3>

@@ -1051,7 +944,7 @@

<h1> Metadata o projektu </h1>
<p>
Metadata v souboru <i>ProjectInfo.xml</i> obsahují tyto hlavní
Metadata v souboru <i>PrjInfo.txt</i> obsahují tyto hlavní
informace
</p>

@@ -1059,30 +952,20 @@

<li> Identifikátor modulu </li>
<li> Lidské jméno modulu </li>
<li> Anotaci v češtině a angličtině </li>
<li> Odkaz na obrázek </li>
<li> Odkaz na dokumentaci </li>
<li> Stav projektu (rozpracovaný, nahrazený a podobně) </li>
<li> Odkaz do e-shopu UST </li>
</ul>
<h2> Editace metadat </h2>
<p>
<em>V sekci údržby webu bude připraven formulář, který umožní založení
i editaci xml popisného souboru. Na zpracování metadat se pracuje.</em>
</p>
<h2> Obrázky k projektu </h2>
<p>
Malé obrázky do přehledu modulů mají rozměr 640 bodů vodorvně při 300dpi.
Zmenšování se provádí postupným střídáním kroků doostřit a převzorkovat
(nezmenšovat na méně než 70% původní velikosti v jednom kroku).
</p>
<p>
Obrázek pro přehled modulů je uložen v souboru <i>XXXX_Small.jpg</i> u
projektu, ke kterému patří. XXX je identifikátor projektu. Existuje-li
jeho velká verze obrázku je uložena v souboru <i>XXX_Big.jpg</i>.
jeho velká verze obrázku je uložena v souboru <i>XXX_Big.jpg</i> a je uložena v adresáři: <i>DOC/SRC/img</i>
</p>
</div>


{COMPARE END}
{FOOTER START}

Poháněno WebSVN v2.1 alpha 1