Deutsches Help+Manual-Forum:

Transkript

1

2 Wissen dokumentieren. Impressum Copyright 2017, HelpDesign Jörg Ertelt Alle Rechte vorbehalten. Die Weitergabe und Einsicht dieser Publikation an bzw. durch Dritte ist verboten. Nachdruck und Vervielfältigung auch auszugsweise ist verboten. Haftungsausschluss HelpDesign Jörg Ertelt ist bemüht, seine Publikationen nach neuesten Erkenntnissen zu erstellen. Deren Richtigkeit sowie inhaltliche und technische Fehlerfreiheit werden ausdrücklich nicht zugesichert. HelpDesign Jörg Ertelt gibt auch keine Zusicherung für die Anwendbarkeit oder Verwendbarkeit dieser Publikation zu einem bestimmten Zweck. Der Einsatz und Nutzung dieser Publikation fällt ausschließlich in den Verantwortungsbereich des jeweiligen Kunden. Kontakt HelpDesign Jörg Ertelt Ulrichstraße Wendlingen am Neckar joerg.ertelt@helpdesign.eu Büro Bretten: birgit.becker@helpdesign.eu Support Deutsches Help+Manual-Forum: Deutsche Wissensbasis zu Help+Manual: Seite 2 von 208 Help+Manual V7.3 Grundkurs

3 INHALT 1 Einführung in Help+Manual Programmoberfläche Projekt Explorer Topic-Editor 12 2 Help+Manual-Projekte (Projects) Grundlagen Help+Manual-Projekte Projektarten Neues Help+Manual-Projekt anlegen Projekt öffnen Projekt umbenennen Projekt löschen Neue Bibliothek (Repository) anlegen Bibliothek mit Projekt verlinken 27 3 Formatvorlagen (Styles) Grundlagen Formatvorlagen Dialog Formate bearbeiten Formatvorlage hinzufügen Formatvorlage bearbeiten Formatvorlage verwenden Formatvorlage umbenennen Formatvorlage löschen 40 4 Topics Grundlagen Topics Topic hinzufügen Topic öffnen Topic umbenennen Topic verschieben Topic löschen 52 5 Topic-Templates Grundlagen Topic-Templates Topic-Template hinzufügen Topic-Template öffnen Topic-Template löschen 58 6 Topic-Status Grundlagen Topic-Status Topic-Status-Editor Topic-Status hinzufügen Topic-Status kopieren Topic-Status bearbeiten Topic-Status verwenden Topic-Status löschen 66 7 Schnipsel (Snippets) Grundlagen Schnipsel Schnipsel hinzufügen 70 Help+Manual V7.3 Grundkurs Seite 3 von 208

4 Wissen dokumentieren. 7.3 Schnipsel öffnen Schnipsel verwenden Schnipsel in Text umwandeln Schnipsel löschen 76 8 Bilder (Images) Grundlagen Bilder Bild hinzufügen Bild umbenennen Bild verwenden Bild skalieren Klickbares Bild (ImageMap) erstellen Nicht verwendete Bilder finden Bild löschen 88 9 Toggle Grundlagen Toggle Toggle erstellen Toggle bearbeiten Toggle entfernen Tabellen (Tables) Grundlagen Tabellen Tabelle einfügen Tabelle gestalten Tabelle entfernen Links Grundlagen Links Link erstellen Link bearbeiten Link entfernen PDF-Vorlagen (Print Manual Templates) Grundlagen PDF-Vorlagen Handbuchdesigner PDF-Vorlage hinzufügen PDF-Vorlage öffnen PDF-Vorlage gestalten PDF-Vorlage umbenennen PDF-Vorlage verschieben PDF-Vorlage verwenden PDF-Vorlage löschen Variablen (Variables) Grundlagen Variablen Variablen-Editor Variable hinzufügen Variable kopieren Variable importieren und exportieren Variable umbenennen 133 Seite 4 von 208 Help+Manual V7.3 Grundkurs

5 13.7 Variable verschieben und sortieren Variable verwenden Variable löschen Bedingungen (Conditions) Grundlagen Bedingungen Bedingungen-Editor Bedingung hinzufügen Bedingung kopieren Bedingung umbenennen Bedingung verwenden Bedingung löschen Inhaltsverzeichnisse (TOCs) Grundlagen Inhaltsverzeichnisse Inhaltsverzeichnis hinzufügen Inhaltsverzeichnis umbenennen Inhaltsverzeichnis verschieben Inhaltsverzeichnis verwenden Inhaltsverzeichnis löschen Arbeiten mit Inhaltsverzeichnissen Inhaltsverzeichnis-Eintrag hinzufügen Inhaltsverzeichniseintrag umbenennen Inhaltsverzeichniseintrag verschieben Inhaltsverzeichniseintrag löschen Index Grundlagen Index Fenster Index Index aktivieren Arbeiten mit dem Index Indexeintrag hinzufügen Indexeintrag umbenennen Indexeintrag löschen Volltextsuche (Full Text Search) Grundlagen Volltextsuche Volltextsuche aktivieren Exporte (Publish) Grundlagen Exporte Ausgabeformate Einzel-Export (Quick Publish) generieren Batch-Export (Task Manager) anlegen und generieren Exporteinstellungen WebHelp Exporteinstellungen PDF Exporteinstellungen HTML Help (CHM) Exporteinstellungen E-Books Exporteinstellungen kopieren Index 203 Help+Manual V7.3 Grundkurs Seite 5 von 208

6 1 Einführung in Help+Manual 1 Einführung in Help+Manual 1.1 Programmoberfläche Projekt Explorer Topic-Editor 12 Help+Manual V7.3 Grundkurs Seite 7 von 208

7 Wissen dokumentieren. 1.1 Programmoberfläche Anzeige Programmoberfläche ändern: Menü Ansicht Die Programmoberfläche sieht unterschiedlich aus, je nachdem, welche Einstellungen Sie im Menü Ansicht hinterlegen. Sie können beispielsweise verschiedene Farbschemata wählen und ob die Schnellstartleiste über oder unter dem Menüband angezeigt wird. Der Projekt Explorer verhält sich dynamisch, wenn Sie das Symbol Zusätzlich können Sie zahlreiche Einstellungen im Dialog klicken. Benutzereinstellungen vornehmen, den Sie über das gleichnamige Symbol im Abschnitt Einstellungen öffnen. Notizen Seite 8 von 208 Help+Manual V7.3 Grundkurs

8 19 Index 19 Index A aktivieren Index 167 Seitenvorlage 118 Volltextsuche 175 anlegen Batch-Export 183 anzeigen Index 166 Aufklappbarer Text siehe Toggle 92 Ausgabeformat 180 E-Book 199 HTML Help (CHM) 196 PDF 193 WebHelp 188 B Batch-Export anlegen und generieren 183 bearbeiten Formatvorlage 36 Layout Tabelle 35 Link 112 PDF-Vorlage 118 Seitenvorlage 118 Tabelle 102 Tabellen-Formatvorlage 36 Toggle 98 Topic-Status 64 Bedingung 137 Editor 140 Grundlagen 138 hinzufügen 141 kopieren 142 löschen 146 umbenennen 143 verwenden 144 Benutzerdefinierte Builds siehe Bedingung 137 Bibliothek Formatvorlage 30 neu anlegen 26 verlinken 27 Bild 77 hinzufügen 80 löschen 88 nicht verwendet finden 87 skalieren 84 umbenennen 82 verwenden 82 C CHM Exporteinstellungen 196 Condition siehe Bedingung 137 Conditional Text siehe Bedingung 137 D Datei einfügen in Inhaltsverzeichnis 156 deaktivieren Index 167 Seitenvorlage 118 Volltextsuche 175 Dialog Formate bearbeiten 32 dynamisches Textformat Toggle 90 E E-Books Exporteinstellungen 199 Editor Bedingungen 140 Help+Manual V7.3 Grundkurs Seite 203 von 208

9 Wissen dokumentieren. Handbuchdesigner 116 Status 61 Topic 12 Variablen 129 Eigenschaften Tabelle 102 Topic 12 einfügen Bild 82 Datei in Inhaltsverzeichnis 156 Schnipsel 72 Tabelle 101 Variable 134 Einführung Help+Manual 7 entfernen Link 112 Tabelle 103 Toggle 98 Verweis 112 erstellen Klickbares Bild 85 Link 107 Toggle 92 Verweis 107 Export 177 anlegen und generieren Batch-Export 183 generieren (Einzel-Export) 181 Grundlagen 178 Exporteinstellungen E-Books 199 HTML Help (CHM) 196 kopieren 202 PDF 193 WebHelp 188 exportieren Variablen 132 F Fenster Index 166 finden nicht verwendete Bilder 87 Formate bearbeiten 32 Formatvorlage 29 bearbeiten 36 Bibliothek 30 Dialog Formate bearbeiten 32 Grundlagen 30 hinzufügen 33 löschen 40 umbenennen 40 verwenden 38 zuweisen 38 G generieren Batch-Export 183 Einzel-Export 181 gestalten PDF-Vorlage 118 Grundlagen Bedingungen 138 Bilder 78 Exporte 178 Formatvorlagen 30 Index 164 Inhaltsverzeichnis 148 Links 106 PDF-Vorlagen 114 Projekt 18 Schnipsel 68 Tabellen 100 Toggler 90 Topic 42, 56 Topic-Status 60 Variablen 126 Volltextsuche 174 H hinzufügen Bedingung 141 Seite 204 von 208 Help+Manual V7.3 Grundkurs

10 19 Index Bild 80 Formatvorlage 33 Indexeintrag 169 Inhaltsverzeichnis 150 Inhaltsverzeichniseintrag 156 PDF-Vorlage 117 Schnipsel 70 Topic 44 Topic-Status 62 Topic-Template 57 Variable 130 HMSKIN Projektart 20 HMXP Projektart 20 HMXR Projektart 20 HMXZ Projektart 20 HTML Help Exporteinstellungen 196 Hyperlink siehe Link 105 I Image siehe Bild 77 ImageMap siehe Klickbares Bild 85 importieren Bedingungen 142 Exporteinstellungen 202 Topic-Status 62 Variablen Index 163 aktivieren 167 anzeigen 166 Arbeiten mit Index 168 Fenster 166 Grundlagen 164 Kennzeichnung im Topic 164 Indexeintrag hinzufügen 169 löschen 171 umbenennen 170 Inhaltsverzeichnis 147 Arbeiten mit Inhaltsverzeichnissen 155 beim Export zuweisen 151 Grundlagen 148 hinzufügen 150 löschen 153 mergen 151 Projekt Explorer 9 umbenennen 150 verschieben 151 verwenden 151 Inhaltsverzeichniseintrag löschen 160 umbenennen 159 verschieben 160 K Kennzeichnung Indexeintrag im Topic 164 Klickbares Bild erstellen 85 Konfiguration Projekt Explorer 9 kopieren Bedingungen 142 Exporteinstellungen 202 Topic-Status 62 Variablen 131 L Layout Tabelle bearbeiten 35 Link 105 bearbeiten 112 Bibliothek 27 entfernen 112 erstellen 107 Grundlagen 106 Help+Manual V7.3 Grundkurs Seite 205 von 208

11 Wissen dokumentieren. Klickbares Bild 85 löschen Bedingung 146 Bild 88 Formatvorlage 40 Indexeintrag 171 Inhaltsverzeichnis 153 Inhaltsverzeichniseintrag 160 PDF-Vorlage 124 Projekt 26 Schnipsel 76 Tabelle 103 Toggle 98 Topic 52 Topic-Status 66 Topic-Template 58 Variable 136 M mergen Inhaltsverzeichnis 151 MNL-Datei siehe PDF-Vorlage 113 N Neu Bedingung 141 Bibliothek 26 Formatvorlage 33 Indexeintrag 169 Inhaltsverzeichnis 150 Inhaltsverzeichniseintrag 156 PDF-Vorlage 117 Projekt 24 Schnipsel 70 Tabelle 101 Tabellen-Formatvorlage 33 Topic 44 Topic-Template 57 Variable 130 O öffnen PDF-Vorlage 118 Projekt 25 Schnipsel 71 Tabelleneigenschaften 102 Topic 48 Topic-Template 58 P PDF Exporteinstellungen 193 Stil Seitenverweis 193 PDF-Vorlage 113 gestalten 118 Grundlagen 114 Handbuchdesigner 116 hinzufügen 117 löschen 124 öffnen 118 umbenennen 123 verschieben 123 verwenden 123 Print Manual Designer siehe Handbuchdesigner 116 Print Manual Template siehe PDF-Vorlage 113 Programmoberfläche Gesamtansicht 8 Projekt Explorer 9 Topic-Editor 12 Projekt 17 Grundlagen 18 löschen 26 neu anlegen 24 öffnen 25 umbenennen 25 Projekt Explorer 9 Projektarten 20 Projektdateien Projekt Explorer 9 Seite 206 von 208 Help+Manual V7.3 Grundkurs

12 19 Index Publish siehe Export 177 Q Querverweis erstellen 107 R Reference siehe Link 105 Repository siehe Bibliothek 26 S Schnipsel 67 Grundlagen 68 hinzufügen 70 in Text umwandeln 75 löschen 76 öffnen 71 verwenden 72 Seitenverweis Stil PDF 193 Seitenvorlage anlegen, bearbeiten und aktivieren 118 skalieren Bild 84 Snippet siehe Schnipsel 67 sortieren Variable 134 Status siehe Topic-Status 59 Stile Seitenverweise PDF 193 Styles siehe Formatvorlagen 29 Suche siehe Volltextsuche 173, 175 T Tabelle 99 bearbeiten 102 entfernen 103 Grundlagen 100 Layout bearbeiten 35 neu anlegen 101 Tabellen-Formatvorlage bearbeiten 36 hinzufügen 33 löschen 40 Tabelleneigenschaften öffnen 102 Table siehe Tabelle 99 Template PDF 113 Topic 55 Textformat dynamisch, Texterweiterung 90 TOC siehe Inhaltsverzeichnis 147 Toggle 89 bearbeiten 98 entfernen 98 erstellen 92 Grundlagen 90 Topic 41 Editor 12 Eigenschaften 12 Grundlagen 42, 56, 78 hinzufügen 44 Kennzeichnung Indexeintrag 164 löschen 52 öffnen 48 umbenennen 49 Unterschied zum Word-Dokument 43 verschieben 51 Topic-Status 59 bearbeiten 64 Editor 61 Grundlagen 60 Help+Manual V7.3 Grundkurs Seite 207 von 208

13 Wissen dokumentieren. hinzufügen 62 kopieren 62 löschen 66 verwenden 64 Topic-Template 55 hinzufügen 57 löschen 58 öffnen 58 U umbenennen Bedingung 143 Bild 82 Formatvorlage 40 Indexeintrag 170 Inhaltsverzeichnis 150 Inhaltsverzeichniseintrag 159 PDF-Vorlage 123 Projekt 25 Topic 49 Variable 133 Unterschiede Topic und Word-Dokument 43 V Variable 125 Editor 129 exportieren und importieren 132 Grundlagen 126 hinzufügen 130 kopieren 131 löschen 136 umbenennen 133 verschieben und sortieren 134 verwenden 134 verlinken Bibliothek 27 verschieben Inhaltsverzeichnis 151 Inhaltsverzeichniseintrag 160 PDF-Vorlage 123 Topic 51 Variable 134 Verweis siehe Link bzw. Querverweis 105 verwenden Bedingungen 144 Bild 82 Formatvorlage 38 Inhaltsverzeichnis 151 PDF-Vorlage 123 Schnipsel 72 Topic-Status 64 Variable 134 Volltextsuche 173 aktivieren 175 Grundlagen 174 Vorlage Topic 55 W WebHelp Exporteinstellungen 188 X XML-Code Editor 12 Z zuweisen Bedingung 144 Formatvorlage 38 Inhaltsverzeichnis beim Export 151 PDF-Vorlage 123 Seite 208 von 208 Help+Manual V7.3 Grundkurs