Upload
phungdan
View
214
Download
0
Embed Size (px)
Citation preview
Osnovna priporočila
Priročnik za delo
Help v.6Dopolnjeno: maj 2016
Sandra Kavčič univ. dipl. ekon.
LIST d.o.o.Tehnološki park 241000 Ljubljana01/620 34 40
Priročnik za uporabo Help-a
Kazalo vsebine
1. Uvod...............................................................................................................................................1
1.1. Predhodno je potrebno..........................................................................................................1
1.2. Na svojem računalniku moraš nastaviti...................................................................................1
1.2.1. Spelling...........................................................................................................................1
1.2.2. Gledanje Help iz aplikacije Hipokrat (F1).........................................................................2
1.3. Stili pisav (Style)......................................................................................................................2
2. Kako začeti?....................................................................................................................................4
2.1. Odpiranje projekta..................................................................................................................4
2.1.1. Urejanje projekta............................................................................................................4
2.2. Spremembe v verziji...............................................................................................................5
2.2.1. Nastavitev nove teme spremembe v verziji....................................................................5
2.2.2. Dopisovanje sprememb v verziji.....................................................................................5
2.3. Vsebina...................................................................................................................................5
2.3.1. Uporaba linkov................................................................................................................5
3. Splošna navodila.............................................................................................................................7
3.1. Slike........................................................................................................................................7
3.1.1. Urejevalnik slik................................................................................................................7
3.2. Opcija Topic has a separate header........................................................................................8
3.3. Uporaba Snippet-ov (še dopisujem)........................................................................................8
3.3.1. Hipokrat Snippets in Topics.............................................................................................9
3.4. Uporaba Toggle (še dopišem)...............................................................................................10
4. KC – kreiranje skupnega projekta..................................................................................................10
4.1. Tema je ista na obeh projektih, manjša razlika v besedilu....................................................10
4.2. Celotna tema spada le v en projekt......................................................................................11
4.3. Kako narediti nov Skupni podprojekt?..................................................................................13
4.3.1. Ustvariš projekt.............................................................................................................13
4.3.2. Vključiš projekt v drug projekt......................................................................................14
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docxi
Priročnik za uporabo Help-a
1. UvodPrehajamo na novo različico orodja Help & Manual v.6.Kdor še nima instaliranega orodja na svojem računalniku, naj se pozanima pri Trajčetu.Še vedno veljajo osnovna vodila, ki jih je zapisala Mirjam 23.8.2002: R:\Vbrazvoj\Help\helposnove.doc
1.1. Predhodno je potrebno Določiti datum in/ali verzijo, s katero v celoti preidemo na novo verzijo Help-a. @Berni, - od
28.4.2014 dalje se vse vnaša v novi Help Prenesti/pretvoriti vse projekte v novi Help @Trajče - prenešeno Preklikati vsebino in preveriti delovanje linkov (zunanjih, med projekti), menijev…@Sandra,
@Katarina v delu Definirati obstoječe stile pisave oziroma pripraviti nove (glej spodaj - Stil pisave (Style)) @vsi Za požarni zid registriraj: HHReg v1.3 - HTML Help Registration Utility\HHReg.exe. V
zavihku 'General security' postavi vrednost na '1 - local intranet zone'.
1.2.Na svojem računalniku moraš nastaviti
1.2.1. Spelling1. Iz R:\Vbrazvoj\Help\Setup\Help + Manual 6 skopiraj dict-si.oxt na svoj računalnik v C:\
Program Files (x86)\HelpAndManual6\Dictionaries (taka je pot datoteke pri meni, preveri pri sebi, kje imaš HelpAndManual6).
Help verzija 7: C:\Program Files (x86)\EC Software\HelpAndManual7\Dictionaries
2. V Helpu, na zavihku Project izberi Spelling – Configure SpellChecker3. Zavihek User Preferences – obkljukaj možnost Ignore words in UPPERCASE4. Zavihek Dictionaries – obkljukaj slovenščina. v Custom Spell Check Dictionaries dodaj R:\
Vbrazvoj\Help\DictionaryList.adu, in da potem izberi tudi v naslednjem polju (glej sliko spodaj).
Zakaj? Tu notri bomo dodajali razne kratice, strokovne besede (KZZ, ZZZS, MedZZ…), da nam jih ne bo več podčrtavalo.
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx1
Priročnik za uporabo Help-a
1.2.2. Gledanje Help iz aplikacije Hipokrat (F1)Če iz Hipokrata s tipko F1 ne vidiš Helpa, potem moraš nastaviti naslednje:
Na R:\Vbrazvoj\Help\HHReg v1.3 - HTML Help Registration Utility zaženi exe in v zavihku General Security izberi 1.
V C:\HipoWin si skopiraj .chm file iz projekta R:\Vbrazvoj\Help\Projekti
1.3.Stili pisav (Style)
Za potrebe izvoza, pretvarjanja, izpisovanja….je najbolj primerno, da uporabimo že obstoječe Help stile – vsi so že preneseni v HelpRepisitory in vključeni na vseh projektih. Za enkrat se mi zdijo najbolj primerni stili, navedeni v spodnji tabeli. Če je/bo potrebno, bomo centralno spremenili stil, kar se bo odražalo na vseh projektih.Prav tako je/bo Trajče pretvoril obstoječe stile pisave v nove (glej tabelo spodaj). Ker do sedaj ni bilo vse pisano z uporabo stila, pri pregledu teme, ki jo obravnavaš, nujno tudi popravi in oblikuj besedilo!
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx2
Priročnik za uporabo Help-a
Oranžno obarvani stili so najbolj pogosto in jih uporabljaj pri pisanju! Če bo potrebno, bomo določen stil prilagodili.
Style (ime) Prej Namen uporabe
Osnovna definicija
Bližnjica
Vizualno
Normal (Standard)
Normalno besedilo
Arial, size 11
Body Text Tekst Normalno besedilo
Arial, size 10
F3 S klikom na ikono
Heading 1 (Standard)
Naslov Glavni naslov – za glavo teme (tisti na vrhu strani)
Tahoma, size 14
F8
Heading 2_atoc
Podnaslov naslov poglavja (2 nivo) - podnaslov
Arial, size 14, moder, črta čez celo stran
F7
Body Text Purpose
Namen Poudarjen tekst pod glavnim naslovom
Arial, size 10,krepko
Alt+F3 Funkcija je namenjena naročanju
Heading3 Underline_atocs_
Spremembe v verziji – naslovi tem
Arial, size 11, podčrtano čez celo stran
Shift + F6
Uporabniki in gesla:
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx3
Priročnik za uporabo Help-a
Body Text How To
Opis teme – vsebina besedila podnaslova
Arial, size 11, zamik desno
Shift+F3
S klikom na ikono
How to Bulleted
Za alineje (style uporabiš zaradi zamika prve vrstice in potem še izbereš tip alineje)
Arial, size 11
Ctrl+Shift+B
S klikom na ikono S klikom na ikono S klikom na ikono
How to Numbered
Za oštevilčenje (style uporabiš zaradi zamika prve vrstice in potem še izbereš tip oštevilčenja)
Arial, size 11
Ctrl+Shift+N
1. S klikom na ikono2. S klikom na ikono3. S klikom na ikono
Heading How to_atoc
Naslov poglavja (ko uporabiš funkcijo toggle – da je vsebina skrita in jo prikažeš z znakom + in ima siv okvirček)
Verdana, size 13, krepko, v sivem okvirčku
F4
Heading3_atocs_
naslov poglavja (3 nivo)
Arial, size 12, moder,krepko
F6 V primeru, da bolnik p
Image Caption (Standard)
Opis slike Verdana, size 9
Slika prikazuje
Link Link povezave (npr za Kvadratek z linki)
Verdana 11, moder, podčrtan
Ř Naročanje Ř Koledar
2. Kako začeti?2.1.Odpiranje projekta
Zaženeš Help in v File ->open project, oziroma z ikono odpreš projekt, ki ga želiš urejati. Projekti se nahajajo v R:\Vbrazvoj\Help\Projekti oziroma R:\Vbrazvoj\Help\Projekti\Skupni podprojekti, odpreš datoteko Hipokrat.hmxp.
2.1.1. Urejanje projektaNa levi strani se odprejo poglavja, ki jih projekt vsebuje. Sivo obarvana poglavja in teme, ki so
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx4
Priročnik za uporabo Help-a
označene z ikono , so del drugega/skupnega projekta in so Read-only, urejaš jih lahko le v skupnem projektu.S klikom na temo se odpre vsebina, ki jo lahko urejaš. Dokler sprememba ni shranjena, je tema
označena z ikono in je zaklenjena za urejanje za druge uporabnike. Pri že obstoječih temah preveri, če:
je besedilo ustrezno oblikovano, če linki funkcionirajo (imajo pravo ciljno povezavo), če je vsebina besedila ustrezna in primerna.
2.2.Spremembe v verziji
2.2.1. Nastavitev nove teme spremembe v verzijiPostaviš se na Spremembe v novih verzijah , desni klik in izbira Add Child Topic.V polje Topic Heading vpišeš naslov verzije (smiselno sledi prejšnjim verzijam – za KC se piše tudi iz dne DDMMYYYY)V polju Topic template izberi ponujeni template, ki je že pripravljena predloga za vnos sprememb.
2.2.2. Dopisovanje sprememb v verzijiOdpreš si spremembe v verziji, ki jih želiš urejati in dopišeš besedilo. Pri tem pridno uporabljaš dogovorjene stile pisave, slike shranjuješ kot embedded pictures, za slike gumbov pa uporabljaš slike ikon, ki so na voljo v VBRazvoj, oz. DotNetRazvoj.
2.3.VsebinaNovo temo dodaš na isti način, kot pri spremembah v verziji – desni klik in izbira Add … topic.
2.3.1. Uporaba linkovLink dodaš na naslednji način:
Lahko označiš besedilo in ga oblikuješ v link - desni klik -> insert LinkCaption (ime linka) je v tem primeru tvoja označena beseda, določiš Target - kam naj skoči ob kliku linka. lahko izbiraš znotraj istega projekta, oziroma v možnosti Help File izbereš, v katerem projektu se tvoj cilj nahaja.
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx5
Priročnik za uporabo Help-a
Lahko enostavno klikneš Link v orodni vrstici (Write -> Insert), oziroma desni klik -> insert -> Link in v področju Target izbereš cilj linka, ter z desnim klikom na cilj izbiraš med opcijama Assign topic title to link caption oz. Assign Topic title to tooltip
Če ustvarjaš link povezavo na naslov, ki ima spredaj sidro (Anchor), v področju Target lahko tudi določiš na katero sidro naj skoči link povezava
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx6
Priročnik za uporabo Help-a
Link je dokument v drugem projektu: v polju Help File izbereš projekt, v katerem se nahaja dokument, ki ga želiš »polinkat«. Nato v Target izbereš pravo temo…
PAZI – v Help File moraš izbrati .hmxp projekt!
Internetni link ustvariš tako, da v Link izbereš opcijo Internet Link in v polje Adress vneseš URL naslov
2.4.Odpiranje novega projekta Ustvariš mapo za nov projekt v R:\Vbrazvoj\Help\Projekti\ File – New Project – odkljukaš ZIP – da bo format .hmxp Nastaviš vse Common Properties (Title, …števec za ID…) File – Repository Manager – povežeš novi projekt na repository
3. Splošna navodila Poglejte si Get Started področje, ki s kratkimi opisi in slikami prikazuje osnovne
funkcije. V Help ne vpisuj le novosti, temveč tudi vse spremembe, na katere naletiš pri
testiranju ali programiranju -> kar pomeni, da je vedno potrebno pregledati celotno temo v Help-u in posodobiti vsebino, linke, ikone, ter dodati novosti.
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx7
Priročnik za uporabo Help-a
Sproti (pri testiranju lista) dopolnjuj Spremembe v verziji
3.1.Slike Shranjevanje slik v formatu .PNG!!! Sličice gumbov dodajaš na naslednji način: Desni klik->Insert->Image (ali Ctrl+P) in jo izbereš
v R:\Vbrazvoj\slike oziroma R:\DotNetRazvoj\Slike če je že po novem. Slike PrintScreen-ov (Copy – Paste) obvezno dodajaš na način Convert Embedded Image in jo
shraniš v R:\Vbrazvoj\SlikeZaHelp Poti do slik so že nastavljene na vseh projektih Sliko (printscreen) poimenujte smiselno vsebinsko, ne puščajte imen kot so Clip001…
3.1.1. Urejevalnik slikZavihek Project – Image editor – malo si poglejte Help za editor, kjer so opisane vse krasne funkcije, kot so dodajanje raznih oblačkov, označevanje, posebni printscreeni,…
3.2.Opcija Topic has a separate header Če obkljukaš to možnost, se glavni naslov prestavi v posebno področje na vrhu strani in je potem (glede na izbrano temo) prikazan v poudarjenem/obarvanem področju.
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx8
Priročnik za uporabo Help-a
3.3.Uporaba Snippet-ov (še dopisujem)Snippet in Topic so majhne, že pripravljene teme (template-i) v repozitoriju, ki jih lahko pripravimo, urejamo in uporabljamo pri gradnji Help-a. vstavljanje je možno z desnim klikom -> Insert -> Snippet
v orodni vrstici v področju Write -> Insert Object -> Izbereš možnost From Repository (če želiš prazno predlogo), lahko tudi From Topic (če želiš vključiti že obstoječo temo). Popraviti moraš tekst, linke, ker gre za vzorčno predlogo.
3.3.1. Hipokrat Snippets in Topics Vsebina_kvadratek_z_linki (doda kvadratek, v katerega lahko skopiraš linke do vsebine)
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx9
Priročnik za uporabo Help-a
Nevidna tabela (vstavi tabelo, ki ima nevidne obrobe in služi za lepo poravnavo besedila, ko npr. opisujemo ikone…)
Tabelo urejaš preko možnosti desni klik -> Table -> Properties (ni tako fleksibilna, kot recimo v Word-u)
Opozorilo (doda kvadratek za vnos posebnih opozoril, za katere želiš, da jih uporabniki takoj opazijo).
Pomembne informacije (doda kvadratek za povzetek glavnih informacij)
Nasvet za boljšo produktivnost (doda kvadratek za vnos nasvetov boljšo produktivnost)
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx10
Priročnik za uporabo Help-a
3.4.Uporaba Toggle (še dopišem)
4. KC – kreiranje skupnega projektaKončni namen je doseči, da za KC ne bosta več dva ločena projekta, pač pa se bo postopoma vse prestavilo iz HipoGinKC v HipoKC in se bo znotraj posamezne teme označevalo besedilo, ki bo specifično le za GIN, oziroma kar celotna tema.
4.1.Tema je ista na obeh projektih, manjša razlika v besediluKako veš, da je tema ista? Poleg istega naziva teme lahko vidiš tudi v Topic Options, da je Topic ID in Help Context isti.
Primer: Obisk -> Obisk bolnika – tema je ista v obeh projektih, besedilo je tudi skorajda enako. To pomeni, da ne rabimo prenašati iz Gin še enkrat, pač pa na projektu HipoKC popraviš vse teme tako, da bo vse veljalo za oba projekta, izjeme pa označiš z možnostjo IF.
Ko želiš, da se določeno besedilo vidi le na izbranem projektu, ga »oviješ« v pravilo IF – možnost v orodni vrstici Write - > Insert Object -> IF. Izbereš Type IF in projekt, za katerega želiš, da se prikazuje to besedilo. Vneseš besedilo in na koncu dodaš še END (na isti način, kot IF, izbereš ENDIF).
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx11
Priročnik za uporabo Help-a
Lahko ubereš tudi kontra pot in poveš kateri del besedila naj se NE vidi na določenem projektu.
Na KC nastavi naslednje Builde v Configuration -> Common properties - > Custom Builds
4.2.Celotna tema spada le v en projektV HipoKC sta že določena 2 nova Builda – HipoKC in HipoKCGinKo veš, da je celotna tema aktualna le za en projekt, ko jo npr. prestaviš iz projekta Gin, potem označi možnost (desni klik na temo) Include in Builds -> HipoKCGin. Če ima tema označeno, da je vključena npr. le v HipoKC, se to vidi izpisano na desni strani teme. To pomeni, da če si v HipoKCGin, ti ta tema ni vidna.Imena Buildov naj bodo povsod enotna in sicer: HIPOBOL, HIPOGIN, HIPOGINKC, HIPOKC, HIPOKRAT, HIPOKRS, HIPOZOB, ZD.
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx12
Priročnik za uporabo Help-a
***če delaš nov projekt, si moraš nastaviti, da projekt uporablja HipoRepository. Stojiš na projektu, greš v File -> Repository Manager in nastaviš, da ta projekt uporablja HipoRepository
4.3.Kako narediti nov Skupni podprojekt?
4.3.1. Ustvariš projekt
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx13
Priročnik za uporabo Help-a
Greš v R:\Vbrazvoj\Help\Projekti\Skupni podprojekti in ustvariš folder z imenom projekta. Nato v Helpu izbereš Create new Help project in izbereš Create empty new project
Določiš mu Project title (to bo glavno ime teme, ki se bo videlo v Kazalu (naj bo isto, kot folder v Skupni podprojekti) in Output file –Izberi pravilen projekt in sam napiši ime helpa.hmxp. Nato izbereš gumb Create (na desni strani).
Projekt nujno poveži s HipoRepository (***če delaš nov projekt, si moraš nastaviti, da projekt uporablja HipoRepository. Stojiš na projektu, greš v File -> Repository Manager in nastaviš, da ta projekt uporablja HipoRepository) in mu nastavi poti do folderjev s slikami (Configuration – Common Properties – Project Search Paths
4.3.2. Vključiš projekt v drug projekt
V projektu, kamor vključuješ novi skupni projekt, moraš najprej v Configuration – Merged Projects dodati projekt, ki ga želiš vključiti.
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx14
Priročnik za uporabo Help-a
Nato Projekt dodaš še v kazalu z opcijo Add Child topic (ali Add after selected topic,…) in izbereš opcijo Include Help Project – izberi Project File (poiščeš projekt, ki ga boš vključil) in OK.
5. Projekti eNaročanjaZa eNaročanje je nastavljena posebna predloga, ki se uporablja pri izvažanju v PDF direktno iz orodja za Help. Narejena je po zahtevah MZ (glava MZ, eZdravje….). Predloga 'Standard_manual_eRecept.mnl' in 'Standard_manual_eNarocanje.mnl' sta shranjeni v R:\Vbrazvoj\Help\Projekti\Skupni podprojekti\HipoRepository\Templates
Narediš tako: V urejevalniku izbereš temo (najbolj nadrejeno raven), ki jo želiš izvoziti v PDF in izbereš gumb
Publish v orodni vrstici 'Project' Publish format : Adobe PDF Select print manual template: 'Standard_manual_eRecept.mnl' oziroma
'Standard_manual_eNarocanje.mnl' (odvisno od projekta) na mestu R:\Vbrazvoj\Help\Projekti\Skupni podprojekti\HipoRepository\Templates
Customize PDF format: izberi PDF font Embedding in preveri, da slučajno NI pisava Arial na seznamu 'Do NOT embed these fonts' (v tem primeru jo izloči iz seznama) in skrajno spodaj preveri, da je CIF Font Mode 'Unicode' (drugače ti ne bo šumnikov OK prikazovalo)
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx15
Priročnik za uporabo Help-a
Greš ponovno na Publish in obkljukaš še 'Publish selected TOC items only' (to pomeni, da ti bo samo izbrano temo naredilo, ne celega projekta)
Če nisi spreminjal lokacije, ti ustvari PDF na lokaciji, kjer imamo tudi .chm za izbrani projekt.
SEZNAM PROJEKTOV (*.chm)
Hipokrat - splošni HipokratHipoZob - zobna HipoBol - bolnica Sežana, oddelki pri zasebnikihHipoGin - bolnica PostojnaHipoKRS - KRS
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx16
Priročnik za uporabo Help-a
HipoKC - KC vsi razen GinekoHipoGinKC - KC Gineko
Posebni projekti (ki niso vključeni v redne verzije):
Anatomija - Medicinska fakultetaDokumentacijaHipokrat - KC za potrebe Mojce PaulinHemCit - KC HematologijaHipoNMP - NMPHipoReh - ZRIHipoVet - veterinaHipoUre - ZD CerknicaListPrenos - prenosKCGinLab - KC Gineko, stara citologijaKRSMP - KRS materialno poslovanjemHipokrat - tabliceSekcija - KC HematologijaZdravje - NadstandardZdravnik - Zdravniška zbornica
/tt/file_convert/5b8435317f8b9ae0498bc003/document.docx17