Rev 3239 Rev 3241
Line 338... Line 338...
338 <tr> 338 <tr>
339 <th> 339 <th>
340 HDL 340 HDL
341 </th> 341 </th>
342 <td> 342 <td>
343 <i>XXX</i> zdrojové soubory popisující hardware (VHDL) 343 zdrojové soubory popisující hardware (VHDL)
344 </td> 344 </td>
345 </tr> 345 </tr>
346 <tr> 346 <tr>
347 <th> 347 <th>
348 CAM_AMA 348 CAM_AMA
Line 393... Line 393...
393 </table> 393 </table>
394   394  
395 <h1> Tvorba dokumentace </h1> 395 <h1> Tvorba dokumentace </h1>
396   396  
397 <p> 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 kterého se generuje PDF podoba dokumentace a HTML stránky. Dokument je 399 kterého se generuje PDF podoba dokumentace a HTML stránky. Dokument je
400 připraven tak, aby pokud možno vyhovoval tisku v podobě knížečky formátu 400 připraven tak, aby pokud možno vyhovoval tisku v podobě knížečky formátu
401 A5 (oboustranný tisk na listy A4 jako brožura). Tomu se snažíme 401 A5 (oboustranný tisk na listy A4 jako brožura). Tomu se snažíme
402 přizpůsobit počet stran textu (násobek 4). 402 přizpůsobit počet stran textu (násobek 4).
403 </p> 403 </p>
404   404  
405 <h2> Šablona MS Word </h2> 405 <h2> Šablony dokumentů </h2>
406   406  
407 <p> 407 <p>
408 Dokumenty se vytvářejí na základě šablony projektu uložené v souboru 408 Dokumenty se vytvářejí v LaTEXu, LibreOffice Writer, nebo Wordu, na základě šablon uložených v
409 <a href="../../../../../Library/Templates/DOC/MLAB_Šablona.dot">MLAB_Šablona.dot</a>. 409 <a href="http://www.mlab.cz/WebSVN/listing.php?repname=MLAB&path=%2FLibrary%2FTemplates%2F#_Library_Templates_">databázi MLAB</a>.
410 </p> 410 </p>
411   411  
412 <p> 412 <p>
413 Je velmi vhodné použít šablonu tak, jak je, bez větších formátovacích 413 Je velmi vhodné použít šablonu tak, jak je, bez větších formátovacích
414 zásahů do textu. Zejména je vhodné vyvarovat se individuálních změn 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í 415 formátování textu. Nedodržení této zásady komplikuje proces jakékoli úpravy dokumentu.
416 HTML podoby dokumentu. -  
417 </p> 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 <p> 420 <p>
422 V hlavičce vlevo je vložen název dokumentu, který se bere z vlastností 421 V hlavičce vlevo je vložen název dokumentu, který se bere z vlastností
423 dokumentu z pole „Název“ (<i>Soubor/Vlastnosti/Název</i>). 422 dokumentu z pole „Název“ (<i>Soubor/Vlastnosti/Název</i>).
424 Je tam vložen jako automatické pole. 423 Je tam vložen jako automatické pole.
Line 430... Line 429...
430 části pak číslo strany a celkový počet stran dokumentu. 429 části pak číslo strany a celkový počet stran dokumentu.
431 Jméno autora se bere z vlastností souboru z pole „Autor“ 430 Jméno autora se bere z vlastností souboru z pole „Autor“
432 (<i>Soubor/Vlastnosti/Autor</i>) 431 (<i>Soubor/Vlastnosti/Autor</i>)
433 </p> 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 <h3> Titul </h3> 434 <h3> Titul </h3>
444   435  
445 <p> 436 <p>
446 Titul je krátký lidský název modulu, konstrukce nebo článku. Je vložen 437 Titul je krátký lidský název modulu, konstrukce nebo článku. Je vložen
447 do odstavce typu <i>Titul</i>. 438 do odstavce typu <i>Titul</i>.
Line 472... Line 463...
472   463  
473 <p> 464 <p>
474 Nezapomeňte obrázku nastavit alternativní text pro Web. 465 Nezapomeňte obrázku nastavit alternativní text pro Web.
475 </p> 466 </p>
476   467  
477 <h3> Seznam </h3> 468 <h3> Obsah </h3>
478   469  
479 <p> 470 <p>
480 Pokud je dokument delší, bývá na svém začátku doplněn o seznam. Seznam 471 Pokud je dokument delší, bývá na svém začátku doplněn o obsah. (není povinný)
481 není povinný. -  
482 </p> 472 </p>
483   473  
484 <h3> Nadpisy </h3> 474 <h3> Nadpisy </h3>
485   475  
486 <p> 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 U dokumentace standardního modulu je první nadpis umístěn pod 477 U dokumentace standardního modulu je první nadpis umístěn pod
493 ilustrativním obrázkem a obsahuje pouze tabulku základních parametrů 478 ilustrativním obrázkem a obsahuje pouze tabulku základních parametrů
494 modulu. To vše by se mělo vejít na první stranu dokumentu. Viz 479 modulu. To vše by se mělo vejít na první stranu dokumentu. Viz
495 připravená šablona. 480 připravená šablona.
496 </p> 481 </p>
497   482  
498 <h3> Vlastní text </h3> 483 <h3> Vlastní text </h3>
499   484  
500 <p> 485 <p>
501 Text se píše stylem normálního odstavce. Samostatných modifikací 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 </p> 488 </p>
504   489  
505 <h3> Přehled doporučených stylů </h3> 490 <h3> Přehled doporučených stylů </h3>
506   491  
507 <p> 492 <p>
Line 512... Line 497...
512 <i>Tučné</i> a <i>Italika</i> pro zvýraznění (podtržení nepužíváme) <br> 497 <i>Tučné</i> a <i>Italika</i> pro zvýraznění (podtržení nepužíváme) <br>
513 <i>Tabulky</i> pro tabelární data (nemíchat do jedné buňky nesouvisející informace) <br> 498 <i>Tabulky</i> pro tabelární data (nemíchat do jedné buňky nesouvisející informace) <br>
514 <i>Puntíkaté seznamy</i> pro seznamy, i vnořené <br> 499 <i>Puntíkaté seznamy</i> pro seznamy, i vnořené <br>
515 </p> 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ý&nbsp;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 <h2> Psaní dokumentu </h2> 502 <h2> Psaní dokumentu </h2>
578   503  
579 <h3> Doporučená osnova pro standardní popis modulů </h3> 504 <h3> Doporučená osnova pro standardní popis modulů </h3>
580   505  
581 <p> 506 <p>
Line 587... Line 512...
587   512  
588 <p> 513 <p>
589 Bitmapové obrázky (fotografie) pro vložení si připravíme jako samostatné 514 Bitmapové obrázky (fotografie) pro vložení si připravíme jako samostatné
590 soubory (oříznutí, zmenšení datové velikosti, nastavení 300DPI a podobně). 515 soubory (oříznutí, zmenšení datové velikosti, nastavení 300DPI a podobně).
591 </p> 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 <h3> Seznam součástí </h3> 518 <h3> Seznam součástí </h3>
608   519  
609 <p> 520 <p>
610 Seznam součástí vkládáme jako tabulku: 521 Seznam součástí vkládáme jako tabulku:
611 </p> 522 </p>
Line 618... Line 529...
618   529  
619 <p> 530 <p>
620 Seznam součástí je nejlepší vložit jako dvě tabulky v jedné tabulce o 531 Seznam součástí je nejlepší vložit jako dvě tabulky v jedné tabulce o
621 dvou buňkách. Pak nejsou potíže s výškou řádek v levé a pravé části 532 dvou buňkách. Pak nejsou potíže s výškou řádek v levé a pravé části
622 seznamu. Nezapomeňte mezi jednotlivé reference (R1, R2, ...) vložit 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 </p> 535 </p>
625   536  
626 <h2> Tvorba výstupů </h2> -  
627   -  
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   537  
641 <h2> Povinné úkony </h2> 538 <h2> Povinné úkony </h2>
642   539  
643 <p> 540 <p>
644 Zkontrolujte toto: 541 Zkontrolujte toto:
Line 650... Line 547...
650 <li> Obsahuje text dle doporučené osnovy </li> 547 <li> Obsahuje text dle doporučené osnovy </li>
651 <li> Obsahuje obrázek </li> 548 <li> Obsahuje obrázek </li>
652 <li> Obsahuje vyplněnou tabulku parametrů </li> 549 <li> Obsahuje vyplněnou tabulku parametrů </li>
653 <li> Obsahuje seznam součástek </li> 550 <li> Obsahuje seznam součástek </li>
654 <li> Je vygenerovaný .PDF </li> 551 <li> Je vygenerovaný .PDF </li>
655 <li> Je vygenerovaný .HTML </li> -  
656 <li> Jsou data uložena v databázi SVN </li> 552 <li> Jsou data uložena v databázi SVN </li>
657 </ul> 553 </ul>
658 554
659 <h1> Technologické výstupy </h1> 555 <h1> Technologické výstupy </h1>
660   556  
Line 1014... Line 910...
1014 Seznam povinných úkonů slouží pro rychlé ověření, že se na nic 910 Seznam povinných úkonů slouží pro rychlé ověření, že se na nic
1015 důležitého nezapomnělo. Na všechny otázky by se mělo odpovědět buď 911 důležitého nezapomnělo. Na všechny otázky by se mělo odpovědět buď
1016 „ano“ nebo „v tomto případě záměrně ne“. 912 „ano“ nebo „v tomto případě záměrně ne“.
1017 </p> 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 <h3> Vlastní návrh </h3> 916 <h3> Vlastní návrh </h3>
1024   917  
1025 <ul> 918 <ul>
1026 <li> Je deska <i>okótovaná</i> ? </li> 919 <li> Je deska <i>okótovaná</i> ? </li>
Line 1049... Line 942...
1049 </ul> 942 </ul>
1050   943  
1051 <h1> Metadata o projektu </h1> 944 <h1> Metadata o projektu </h1>
1052   945  
1053 <p> 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 informace 948 informace
1056 </p> 949 </p>
1057   950  
1058 <ul> 951 <ul>
1059 <li> Identifikátor modulu </li> 952 <li> Identifikátor modulu </li>
1060 <li> Lidské jméno modulu </li> 953 <li> Lidské jméno modulu </li>
1061 <li> Anotaci v češtině a angličtině </li> 954 <li> Anotaci v češtině a angličtině </li>
1062 <li> Odkaz na obrázek </li> -  
1063 <li> Odkaz na dokumentaci </li> 955 <li> Odkaz do e-shopu UST </li>
1064 <li> Stav projektu (rozpracovaný, nahrazený a podobně) </li> -  
1065 </ul> 956 </ul>
1066   957  
1067 <h2> Editace metadat </h2> -  
1068   -  
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   958  
1074 <h2> Obrázky k projektu </h2> 959 <h2> Obrázky k projektu </h2>
1075   960  
1076 <p> 961 <p>
1077 Malé obrázky do přehledu modulů mají rozměr 640 bodů vodorvně při 300dpi. 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 </p> 963 </p>
1081   964  
1082 <p> 965 <p>
1083 Obrázek pro přehled modulů je uložen v souboru <i>XXXX_Small.jpg</i> u 966 Obrázek pro přehled modulů je uložen v souboru <i>XXXX_Small.jpg</i> u
1084 projektu, ke kterému patří. XXX je identifikátor projektu. Existuje-li 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 </p> 969 </p>
1087   970  
1088 </div> 971 </div>
1089   972  
1090 <!-- AUTOINCLUDE START "Page/Footer.cs.ihtml" DO NOT REMOVE --> 973 <!-- AUTOINCLUDE START "Page/Footer.cs.ihtml" DO NOT REMOVE -->