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 95 Help+Manual V7.3 Erweiterungskurs

3 INHALT 1 Versionskontrolle (Source Control) Grundlagen Versionskontrolle Topic-Historie Topic-Historie aktivieren Version aus Topic-Historie wiederherstellen Funktionsprinzip Versionskontrolle Besonderheiten beim Inhaltsverzeichnis Help+Manual-Projekt an Versionskontroll-System anbinden Projekt importieren - Lokale Arbeitskopie erstellen Neueste Version einer Datei abrufen Topic auschecken Topic einchecken Help+Manual-Projekt von Versionskontroll-System lösen 21 2 Import Grundlagen Import Microsoft HTML Help (*.chm) importieren Vorbereitung Word-Import RTF-Dateien (*.rtf) importieren Nacharbeiten Word-Import in Help+Manual 31 3 Qualitätssicherung Grundlagen Berichte (Reports) Bericht erstellen Grundlagen Rechtschreibprüfung (Spelling) Rechtschreibung prüfen Rechtschreibprüfung konfigurieren Wörterbuch für Rechtschreibung ergänzen Silbentrennung für die Druckausgabe aktivieren 42 4 Mergen Grundlagen Mergen Projekte mergen 47 5 Übersetzung (Translation) von Help+Manual-Projekten Grundlagen Übersetzung Übersetzungsrelevante Dateien Sprachabhängige Projekteinstellungen Help+Manual-Projekt übersetzen XML-Code bereinigen (Tidy XML) 62 6 Kontextsensitive Hilfe (Context-sensitive Help, CSH) Grundlagen Kontextsensitive Hilfe Anker-ID hinzufügen Anker-ID exportieren oder importieren Anker-ID löschen Kontextsensitive Hilfe in der Software nutzen 71 7 Word-Vorlagen (Word Templates) Grundlagen Word-Vorlagen 74 Help+Manual V7.3 Erweiterungskurs Seite 3 von 95

4 Wissen dokumentieren. 7.2 Word-Vorlage hinzufügen Word-Vorlage öffnen Word-Vorlage umbenennen Word-Vorlage verschieben Word-Vorlage verwenden Word-Vorlage löschen 78 8 Skins Grundlagen Skins Skin hinzufügen Skin öffnen Skin gestalten Skin umbenennen Skin verschieben Skin verwenden Skin löschen 87 9 Abbildungs- und Tabellenverzeichnis Grundlagen Abbildungs- und Tabellenverzeichnis Abbildungen und Tabellen nummerieren Formatvorlage für Verzeichnisse anlegen Index 92 Seite 4 von 95 Help+Manual V7.3 Erweiterungskurs

5 1 Versionskontrolle (Source Control) 1 Versionskontrolle (Source Control) 1.1 Grundlagen Versionskontrolle Topic-Historie Topic-Historie aktivieren Version aus Topic-Historie wiederherstellen Funktionsprinzip Versionskontrolle Besonderheiten beim Inhaltsverzeichnis Help+Manual-Projekt an Versionskontroll-System anbinden Projekt importieren - Lokale Arbeitskopie erstellen Neueste Version einer Datei abrufen Topic auschecken Topic einchecken Help+Manual-Projekt von Versionskontroll-System lösen 21 Help+Manual V7.3 Erweiterungskurs Seite 5 von 95

6 Wissen dokumentieren. 1.1 Grundlagen Versionskontrolle Eine Versionskontrolle ermöglicht die Versionierung und das Multi Authoring. Beim Versionieren wird für jede geänderte Datei eine neue Version angelegt. Unter Multi-Authoring versteht man, dass mehrere Personen zeitgleich am selben Projekt arbeiten können, ohne in Konflikt mit der Arbeit der anderen zu geraten. Help+Manual kann an folgende Versionskontroll-Systeme angebunden werden: Subversion Microsoft Team Foundation Server (TFS) Microsoft Visual SourceSafe HINWEIS: Die Versionierung ist auch mit jedem anderen Versionskontroll-System möglich, das XML-Dateien versionieren kann. Speicherpfad Help+Manual verfügt über eine Topic-Historie, also eine integrierte Versionierung. Die Topic-Historie wird Abschnitt Konfiguration > Verschiedene Optionen des Projekts hinterlegt. Versionierte Topics werden im Ordner _history im jeweiligen Projekt abgelegt. Die Anbindung an ein externes Versionskontroll-System wird im Abschnitt Versionskontrolle hinterlegt. Die Angaben zum Versionskontroll-System werden in der jeweiligen Help+Manual- Projektdatei (*.hmxp) gespeichert. Einsatzmöglichkeiten Bei jeder Änderung einer Datei wird automatisch eine neue Version angelegt, dadurch kann auf ältere Versionen zugegriffen werden (Rollback). Durch eine Protokollierung können die Änderungen jederzeit nachvollzogen werden. Dadurch ist ersichtlich, wer wann welche Datei geändert hat. Multi-Authoring ist mit Help+Manual grundsätzlich auch ohne Anbindung an ein Versionskontroll-System möglich. Allerdings ist in diesem Fall nicht sichtbar, ob eine Datei bereits in Bearbeitung ist. Notizen Seite 6 von 95 Help+Manual V7.3 Erweiterungskurs

7 10 Index 10 Index A Abbildung nummeriern 90 Abbildungsverzeichnis 88 Formatvorlage 91 Grundlagen 89 aktivieren Silbentrennung 42 Topic-Historie (integrierte Versionierung) 8 Alias-Datei siehe CSH-Datei 65 Anbindung Versionskontrolle 14 Anker-ID hinzufügen 67 importieren oder exportieren 69 löschen 71 anlegen Wortliste für Silbentrennung 42 anzeigen Topic-Historie 10 Arbeitskopie Subversion 16 Arten Bericht 34 auschecken Topic 19 B bearbeiten Skin 83 bereinigen XML-Code 62 Bericht Arten 34 erstellen 36 Berichte Erweiterter Bericht 34 C Grundlagen 34 Hartformatierter Text 35 Komplettbericht 35 Kurzer Bericht 34 Langer Bericht 34 Nicht in TOC 35 Stichwörter 35 CHM Import 25 Context-sensitive Help siehe Kontextsensitive Hilfe 65 CSH siehe Kontextsensitive Hilfe 65 D Datei relevant für Übersetzung 53 E einchecken Topic 20 Einstellungen Projekt (sprachabhängig) 55 erstellen Bericht 36 exportieren Anker-ID 69 F Formatvorlage Abbildungs- und Tabellenverzeichnis 91 Funktionsprinzip Versionskontrolle 11 Help+Manual V7.3 Erweiterungskurs Seite 92 von 95

8 Wissen dokumentieren. G gestalten Skin 83 Grundlagen Abbildungs- und Tabellenverzeichnis 89 Berichte 34 Import 24 Kontextsensitive Hilfe 66 Mergen 46 Multi-Authoring und Versionierung 6 Rechtschreibprüfung 37 Skin 80 Übersetzung 52 Word-Vorlagen 74 H Header-Datei siehe CSH-Datei 65 hinzufügen Anker-ID 67 Skin 82 Word-Vorlage 75 I Import 23 Grundlagen 24 Microsoft HTML Help (*.chm) 25 RTF bzw. Word 29 Word-Datei Nacharbeiten 31 Word-Datei vorbereiten 28 importieren Anker-ID 69 Inhaltsverzeichnis Besonderheiten Versionskontrolle 13 K Konfiguration Rechtschreibprüfung Kontextsensitive Hilfe 65 Grundlagen 66 in Software nutzen 71 L List of figures siehe Abbildungsverzeichnis 88 List of tables siehe Tabellenverzeichnis 88 löschen Anker-ID 71 Skin 87 Word-Vorlage 78 M mergen 45 Grundlagen 46 Projekte 47 Microsoft HTML Help (CHM) Import 25 Multi-Authoring Grundlagen 6 N Nacharbeiten Word-Import 31 Neu Anker-ID 67 Skin 82 Word-Vorlage 75 nummerieren Abbildungen und Tabellen 90 O öffnen Skin 83 Word-Vorlage 76 P Projekt Einstellungen (sprachabhängig) 55 mergen 47 neueste Version einholen 18 übersetzen 57 Seite 93 von 95 Help+Manual V7.3 Erweiterungskurs

9 10 Index prüfen Rechtschreibprüfung 38 Q Qualitätssicherung 33 R Rechtschreibprüfung Grundlagen 37 Rechtschreibung konfigurieren prüfen 38 RTF Import 29 S Silbentrennung aktivieren 42 Wortliste anlegen 42 Skin 79 gestalten 83 Grundlagen 80 hinzufügen 82 löschen 87 öffnen 83 umbenennen 85 verschieben 85 verwenden 86 Software-Hilfe kontextsensitiv aufrufen 71 Source Control siehe Versionskontrolle 5 sprachabhängig Projekteinstellungen 55 Subversion Anbindung Versionskontrolle 14 Anbindung Versionskontrolle lösen 21 Arbeitskopie 16 T Tabelle nummerieren 90 Tabellenverzeichnis 88 Formatvorlage 91 Grundlagen 89 Template Word 73 Tidy XML siehe XML-Code bereinigen 62 Topic auschecken 19 einchecken 20 Topic-Historie 8 aktivieren 8 Version wiederherstellen 10 Translation siehe Übersetzung 51 U übersetzen Grundlagen 52 Projekt 57 relevante Dateien 53 Übersetzung 51 umbenennen Skin 85 Word-Vorlage 76 V verschieben Skin 85 Word-Vorlage 76 Versionskontrolle 5 aktivieren (Topic-Historie) 8 Anbindung 14 Anbindung lösen 21 Besonderheiten Inhaltsverzeichnis 13 Funktionsprinzip 11 Grundlagen 6 lokale Arbeitskopie erstellen 16 neueste Version abrufen 18 Topic auschecken 19 Topic einchecken 20 Topic wiederherstellen (integrierte Help+Manual V7.3 Erweiterungskurs Seite 94 von 95

10 Wissen dokumentieren. Versionierung) 10 verwenden Skin 86 Word-Vorlage 77 Verzeichnis Abbildungen und Tabellen 88 Vorbereitung Word-Import 28 W wiederherstellen Topic-Historie (integrierte Versionierung) 10 Word-Datei Import 29 Word-Import nacharbeiten in Help+Manual 31 vorbereiten 28 Word-Vorlage 73 Grundlagen 74 hinzufügen 75 löschen 78 öffnen 76 umbenennen 76 verschieben 76 verwenden 77 Wortliste Silbentrennung anlegen 42 X XML-Code bereinigen 62 Z zuweisen HTML5-Skin im Ziel 86 PDF-Vorlage 77 Web Help-Skin im Ziel 86 Seite 95 von 95 Help+Manual V7.3 Erweiterungskurs