o: ActiveSupport::Cache::Entry :@compressedF:@value" °"°
| Articles/HowTo/Rules/DOC/HTML/Rules.cs.html | ||
|---|---|---|
| 340 | 340 |
HDL |
| 341 | 341 |
</th> |
| 342 | 342 |
<td> |
| 343 |
<i>XXX</i> zdrojové soubory popisující hardware (VHDL)
|
|
| 343 |
zdrojové soubory popisující hardware (VHDL) |
|
| 344 | 344 |
</td> |
| 345 | 345 |
</tr> |
| 346 | 346 |
<tr> |
| ... | ... | |
| 395 | 395 |
<h1> Tvorba dokumentace </h1> |
| 396 | 396 |
|
| 397 | 397 |
<p> |
| 398 |
Základní dokumentace se vytváří jako dokument v programu MS Word ze
|
|
| 398 |
Základní dokumentace se vytváří jako dokument ze |
|
| 399 | 399 |
kterého se generuje PDF podoba dokumentace a HTML stránky. Dokument je |
| 400 | 400 |
připraven tak, aby pokud možno vyhovoval tisku v podobě knížečky formátu |
| 401 | 401 |
A5 (oboustranný tisk na listy A4 jako brožura). Tomu se snažíme |
| 402 | 402 |
přizpůsobit počet stran textu (násobek 4). |
| 403 | 403 |
</p> |
| 404 | 404 |
|
| 405 |
<h2> Šablona MS Word </h2>
|
|
| 405 |
<h2> Šablony dokumentů </h2>
|
|
| 406 | 406 |
|
| 407 | 407 |
<p> |
| 408 |
Dokumenty se vytvářejí na základě šablony projektu uložené v souboru
|
|
| 409 |
<a href="../../../../../Library/Templates/DOC/MLAB_Šablona.dot">MLAB_Šablona.dot</a>.
|
|
| 408 |
Dokumenty se vytvářejí v LaTEXu, LibreOffice Writer, nebo Wordu, na základě šablon uložených v
|
|
| 409 |
<a href="http://www.mlab.cz/WebSVN/listing.php?repname=MLAB&path=%2FLibrary%2FTemplates%2F#_Library_Templates_">databázi MLAB</a>.
|
|
| 410 | 410 |
</p> |
| 411 | 411 |
|
| 412 | 412 |
<p> |
| 413 | 413 |
Je velmi vhodné použít šablonu tak, jak je, bez větších formátovacích |
| 414 | 414 |
zásahů do textu. Zejména je vhodné vyvarovat se individuálních změn |
| 415 |
formátování textu. Nedodržení této zásady komplikuje proces vytváření |
|
| 416 |
HTML podoby dokumentu. |
|
| 415 |
formátování textu. Nedodržení této zásady komplikuje proces jakékoli úpravy dokumentu. |
|
| 417 | 416 |
</p> |
| 418 | 417 |
|
| 419 |
<h3> Hlavička a patička a název dokumentu </h3>
|
|
| 418 |
<h3> Hlavička, patička a název dokumentu </h3>
|
|
| 420 | 419 |
|
| 421 | 420 |
<p> |
| 422 | 421 |
V hlavičce vlevo je vložen název dokumentu, který se bere z vlastností |
| ... | ... | |
| 432 | 431 |
(<i>Soubor/Vlastnosti/Autor</i>) |
| 433 | 432 |
</p> |
| 434 | 433 |
|
| 435 |
<p> |
|
| 436 |
V případě změny údajů ve vlastnostech dokumentu je třeba zajistit |
|
| 437 |
aktualizaci automatických polí v hlavičce a patičce. Aktualizace |
|
| 438 |
automatických polí je vůbec obecným problémem MS Wordu autorovi je |
|
| 439 |
poněkud záhadou, proč se automatická pole neaktualizují opravdu |
|
| 440 |
automaticky. |
|
| 441 |
</p> |
|
| 442 |
|
|
| 443 | 434 |
<h3> Titul </h3> |
| 444 | 435 |
|
| 445 | 436 |
<p> |
| ... | ... | |
| 474 | 465 |
Nezapomeňte obrázku nastavit alternativní text pro Web. |
| 475 | 466 |
</p> |
| 476 | 467 |
|
| 477 |
<h3> Seznam </h3>
|
|
| 468 |
<h3> Obsah </h3>
|
|
| 478 | 469 |
|
| 479 | 470 |
<p> |
| 480 |
Pokud je dokument delší, bývá na svém začátku doplněn o seznam. Seznam |
|
| 481 |
není povinný. |
|
| 471 |
Pokud je dokument delší, bývá na svém začátku doplněn o obsah. (není povinný) |
|
| 482 | 472 |
</p> |
| 483 | 473 |
|
| 484 | 474 |
<h3> Nadpisy </h3> |
| 485 | 475 |
|
| 486 | 476 |
<p> |
| 487 |
Nadpisy užíváme obvykle jen do třetí úrovně vnoření protože nepíšeme |
|
| 488 |
vědeckou knihu. |
|
| 489 |
</p> |
|
| 490 |
|
|
| 491 |
<p> |
|
| 492 | 477 |
U dokumentace standardního modulu je první nadpis umístěn pod |
| 493 | 478 |
ilustrativním obrázkem a obsahuje pouze tabulku základních parametrů |
| 494 | 479 |
modulu. To vše by se mělo vejít na první stranu dokumentu. Viz |
| ... | ... | |
| 499 | 484 |
|
| 500 | 485 |
<p> |
| 501 | 486 |
Text se píše stylem normálního odstavce. Samostatných modifikací |
| 502 |
normálního stylu používáme co nejméně.
|
|
| 487 |
normálního stylu nepoužíváme.
|
|
| 503 | 488 |
</p> |
| 504 | 489 |
|
| 505 | 490 |
<h3> Přehled doporučených stylů </h3> |
| ... | ... | |
| 514 | 499 |
<i>Puntíkaté seznamy</i> pro seznamy, i vnořené <br> |
| 515 | 500 |
</p> |
| 516 | 501 |
|
| 517 |
<h3> Aktualizace šablony </h3> |
|
| 518 |
|
|
| 519 |
<p> |
|
| 520 |
Aktualizaci šablony provádí autor projektu tak, aby nedocházelo k |
|
| 521 |
tříštění nastavení šablony. Je žádoucí omezit co nejvíce složitost |
|
| 522 |
šablony a zaváděn jen nezbytná a užitečná rozšíření. |
|
| 523 |
</p> |
|
| 524 |
|
|
| 525 |
<p> |
|
| 526 |
Šablona se postupně rozvíjí dle potřeb autorů a konstrukce webu |
|
| 527 |
(zejména v návaznosti na kaskádové styly a na podporu automatického |
|
| 528 |
generování HTML). |
|
| 529 |
</p> |
|
| 530 |
|
|
| 531 |
<h2> Nastavení programu MS Word </h2> |
|
| 532 |
|
|
| 533 |
<h3> Automatické nastavení přepínání klávesnice </h3> |
|
| 534 |
|
|
| 535 |
<p> |
|
| 536 |
<i>Nástroje\Nástroje\Možnosti\Úpravy</i> |
|
| 537 |
</p> |
|
| 538 |
|
|
| 539 |
<p> |
|
| 540 |
Po nastavení se po přemístění kurzoru na nové místo v dokumentu dojde |
|
| 541 |
současně k přepnutí klávesnice na jazyk, kterým je v daném místě |
|
| 542 |
dokumentu psáno. Česky psané části se píší česky (česká klávesnice |
|
| 543 |
znamená současně i český jazyk), anglické části (i jednotlivá slova) se |
|
| 544 |
píší anglicky. <i>Je vhodné naučit se psát speciální znaky (různé druhy |
|
| 545 |
závorek, menšítka, většíta a podobně) na české klávesnici.</i> |
|
| 546 |
Dělá se to přes <i>pravý alt</i>. Omezí se tak nesmyslné značkování |
|
| 547 |
anglickým jazykem těchto znamének. |
|
| 548 |
</p> |
|
| 549 |
|
|
| 550 |
<h3> Přidání šablony do dostupných šablon </h3> |
|
| 551 |
|
|
| 552 |
<p> |
|
| 553 |
<i>Nástroje\Možnosti\Umístění souborů</i> – <i>Uživatelské šablony</i> |
|
| 554 |
nebo <i>Šablony skupiny</i> |
|
| 555 |
</p> |
|
| 556 |
|
|
| 557 |
<p> |
|
| 558 |
Další možností je přidat odkaz (link) na šablonu do některého adresáře |
|
| 559 |
ve kterém jsou umístěny šablony. |
|
| 560 |
</p> |
|
| 561 |
|
|
| 562 |
<h3> Nastavení UTF-8 pro export </h3> |
|
| 563 |
|
|
| 564 |
<p> |
|
| 565 |
<i>Nástroje\Možnosti\Obecné\Webové možnosti\Kódování</i> - <i>Kódování |
|
| 566 |
Unicode (UTF-8)</i> |
|
| 567 |
</p> |
|
| 568 |
|
|
| 569 |
<p> |
|
| 570 |
Pro export dat do HTML je třeba nastavit výstupní kódování na UTF-8. |
|
| 571 |
Výsledkem je to, že se nekazí speciální znaky. Například znak Ω pro |
|
| 572 |
ohmy se často zkazí na W což působí směšně. Kdo by chtěl odpor 100kW v |
|
| 573 |
SMD provedení, že? |
|
| 574 |
</p> |
|
| 575 |
|
|
| 576 |
|
|
| 577 | 502 |
<h2> Psaní dokumentu </h2> |
| 578 | 503 |
|
| 579 | 504 |
<h3> Doporučená osnova pro standardní popis modulů </h3> |
| ... | ... | |
| 589 | 514 |
Bitmapové obrázky (fotografie) pro vložení si připravíme jako samostatné |
| 590 | 515 |
soubory (oříznutí, zmenšení datové velikosti, nastavení 300DPI a podobně). |
| 591 | 516 |
</p> |
| 592 |
|
|
| 593 |
<p> |
|
| 594 |
Schémata kopírujeme přímo z programu OrCAD. V případě, že je třeba |
|
| 595 |
obrázek otočit lze to udělat například vložením do programu Corel, |
|
| 596 |
otočením a vykousnutím zpátky do schránky (tedy bez ukládání na disk). |
|
| 597 |
</p> |
|
| 598 | 517 |
|
| 599 |
<p> |
|
| 600 |
Novější verze programu Word už umí obrázky otáčet. Funkce |
|
| 601 |
<i>Kreslení\Otočit či překlopit</i> nebo u obrázků umístěných samostatně |
|
| 602 |
je možno ve vlastnostech obrázku zadat úhel otočení. Někdy toto pole |
|
| 603 |
bývá šedivé, pak funguje první možnost. Některé druhy obrázků se při |
|
| 604 |
otočení pokazí, pak je lépe otočení provést externě. |
|
| 605 |
</p> |
|
| 606 |
|
|
| 607 | 518 |
<h3> Seznam součástí </h3> |
| 608 | 519 |
|
| 609 | 520 |
<p> |
| ... | ... | |
| 620 | 531 |
Seznam součástí je nejlepší vložit jako dvě tabulky v jedné tabulce o |
| 621 | 532 |
dvou buňkách. Pak nejsou potíže s výškou řádek v levé a pravé části |
| 622 | 533 |
seznamu. Nezapomeňte mezi jednotlivé reference (R1, R2, ...) vložit |
| 623 |
mezeru. |
|
| 534 |
mezeru, aby mohlo docházet k automatickému zalamování textu.
|
|
| 624 | 535 |
</p> |
| 625 | 536 |
|
| 626 |
<h2> Tvorba výstupů </h2> |
|
| 627 | 537 |
|
| 628 |
<h3> Tvorba výstupů PDF </h3> |
|
| 629 |
|
|
| 630 |
<p> |
|
| 631 |
<em>Dopsat.</em> |
|
| 632 |
</p> |
|
| 633 |
|
|
| 634 |
<h3> Tvorba výstupů HTML </h3> |
|
| 635 |
|
|
| 636 |
<p> |
|
| 637 |
Vytvoření funkční HTML stránky z DOC souboru popisuje samostatný |
|
| 638 |
dokument <a href="../../../DOC2HTML/DOC/HTML/DOC2HTML.cs.html">DOC2HTML.cs.html</a>. |
|
| 639 |
</p> |
|
| 640 |
|
|
| 641 | 538 |
<h2> Povinné úkony </h2> |
| 642 | 539 |
|
| 643 | 540 |
<p> |
| ... | ... | |
| 652 | 549 |
<li> Obsahuje vyplněnou tabulku parametrů </li> |
| 653 | 550 |
<li> Obsahuje seznam součástek </li> |
| 654 | 551 |
<li> Je vygenerovaný .PDF </li> |
| 655 |
<li> Je vygenerovaný .HTML </li> |
|
| 656 | 552 |
<li> Jsou data uložena v databázi SVN </li> |
| 657 | 553 |
</ul> |
| 658 | 554 |
|
| ... | ... | |
| 1016 | 912 |
„ano“ nebo „v tomto případě záměrně ne“. |
| 1017 | 913 |
</p> |
| 1018 | 914 |
|
| 1019 |
<p> |
|
| 1020 |
<em>Sada povinných úkonů se ještě bude rozšiřovat.</em> |
|
| 1021 |
</p> |
|
| 1022 | 915 |
|
| 1023 | 916 |
<h3> Vlastní návrh </h3> |
| 1024 | 917 |
|
| ... | ... | |
| 1051 | 944 |
<h1> Metadata o projektu </h1> |
| 1052 | 945 |
|
| 1053 | 946 |
<p> |
| 1054 |
Metadata v souboru <i>ProjectInfo.xml</i> obsahují tyto hlavní
|
|
| 947 |
Metadata v souboru <i>PrjInfo.txt</i> obsahují tyto hlavní
|
|
| 1055 | 948 |
informace |
| 1056 | 949 |
</p> |
| 1057 | 950 |
|
| ... | ... | |
| 1059 | 952 |
<li> Identifikátor modulu </li> |
| 1060 | 953 |
<li> Lidské jméno modulu </li> |
| 1061 | 954 |
<li> Anotaci v češtině a angličtině </li> |
| 1062 |
<li> Odkaz na obrázek </li> |
|
| 1063 |
<li> Odkaz na dokumentaci </li> |
|
| 1064 |
<li> Stav projektu (rozpracovaný, nahrazený a podobně) </li> |
|
| 955 |
<li> Odkaz do e-shopu UST </li> |
|
| 1065 | 956 |
</ul> |
| 1066 | 957 |
|
| 1067 |
<h2> Editace metadat </h2> |
|
| 1068 | 958 |
|
| 1069 |
<p> |
|
| 1070 |
<em>V sekci údržby webu bude připraven formulář, který umožní založení |
|
| 1071 |
i editaci xml popisného souboru. Na zpracování metadat se pracuje.</em> |
|
| 1072 |
</p> |
|
| 1073 |
|
|
| 1074 | 959 |
<h2> Obrázky k projektu </h2> |
| 1075 | 960 |
|
| 1076 | 961 |
<p> |
| 1077 | 962 |
Malé obrázky do přehledu modulů mají rozměr 640 bodů vodorvně při 300dpi. |
| 1078 |
Zmenšování se provádí postupným střídáním kroků doostřit a převzorkovat |
|
| 1079 |
(nezmenšovat na méně než 70% původní velikosti v jednom kroku). |
|
| 1080 | 963 |
</p> |
| 1081 | 964 |
|
| 1082 | 965 |
<p> |
| 1083 | 966 |
Obrázek pro přehled modulů je uložen v souboru <i>XXXX_Small.jpg</i> u |
| 1084 | 967 |
projektu, ke kterému patří. XXX je identifikátor projektu. Existuje-li |
| 1085 |
jeho velká verze obrázku je uložena v souboru <i>XXX_Big.jpg</i>.
|
|
| 968 |
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>
|
|
| 1086 | 969 |
</p> |
| 1087 | 970 |
|
| 1088 | 971 |
</div> |