Deutsche Wissensbasis zu Flare und anderen Produkten:

Transkript

1

2 Wissen dokumentieren. Impressum Copyright 2019, 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 Flare-Forum: Deutsche Wissensbasis zu Flare und anderen Produkten: Seite 2 von 139 Flare 2018 r2 Erweiterungskurs II

3 INHALT 1 Versionskontrolle (Source Control) Grundlagen Versionskontrolle Funktionsprinzip Versionskontrolle Funktionen Versionskontrolle Flare-Projekt an Versionskontroll-System anbinden Projekt importieren Lokale Arbeitskopie erstellen Versionskontrolle konfigurieren Datei sperren (Subversion) Datei einchecken Datei hinzufügen Neueste Version einer Datei abrufen Unterschiede zwischen Dateiversionen anzeigen Target in Versionskontroll-System veröffentlichen Flare-Projekt von Versionskontroll-System lösen 36 2 Projektverlinkung (Project Linking) Grundlagen Projektverlinkung Neue Projektverlinkung anlegen Verlinktes Projekt erneut importieren Projektverlinkung entfernen 44 3 Externe Ressourcen (External Resources) Grundlagen Externe Ressourcen Neue Externe Ressource anlegen Externe Ressource synchronisieren Externe Ressource löschen 50 4 Komponenten-Skins Grundlagen Komponenten Skins Komponenten-Skin-Editor Komponenten-Skin hinzufügen Komponenten-Skin öffnen Komponenten-Skin umbenennen Komponenten-Skin verschieben Komponenten-Skin löschen 61 5 Mergen Grundlagen Mergen WebHelp oder HTML5 mergen CHM-Dateien mergen 67 6 Suche (Search) Grundlagen Suche Boolesche Operatoren Wildcards Stoppwortliste Stoppwortliste anlegen Suchmaschine wählen und einstellen Elasticsearch verwenden 78 Flare 2018 r2 Erweiterungskurs II Seite 3 von 139

4 Wissen dokumentieren. 7 Synonyme Grundlagen Synonyme Synonym-Editor Synonym-Datei hinzufügen Synonym-Datei öffnen Synonyme und Gruppen erstellen Synonym-Datei umbenennen Synonym-Datei verschieben Synonym-Datei löschen 87 8 Konzepte (Concepts) Grundlagen Konzepte Fenster Konzepte Konzepte hinzufügen Konzepte verwenden Konzepte umbenennen Konzepte löschen 98 9 Verbindungstabellen (Relationship Tables) Grundlagen Verbindungstabellen Verbindungstabelle-Editor Verbindungstabelle hinzufügen Verbindungstabelle öffnen Topics zu Verbindungstabelle hinzufügen Verbindungstabelle umbenennen Verbindungstabelle verschieben Verbindungstabelle löschen Zieladressen (Destinations) Grundlagen Zieladressen Zieladressen-Editor Zieladresse hinzufügen Zieladresse öffnen Zieladresse umbenennen Zieladresse verschieben Zieladresse löschen Abbildungs- und Tabellenverzeichnis (List of...) Grundlagen Abbildungs- und Tabellenverzeichnis Formatvorlage für Verzeichnis anlegen Abbildungs- und Tabellenverzeichnis verwenden Lesesequenzen (Browse Sequences) Grundlagen Lesesequenzen Lesesequenz-Editor Lesesequenz hinzufügen Lesesequenz öffnen Lesesequenz umbenennen Lesesequenz verschieben Lesesequenz verwenden 128 Seite 4 von 139 Flare 2018 r2 Erweiterungskurs II

5 12.8 Lesesequenz löschen Arbeiten mit Lesesequenzen Lesesequenzeintrag hinzufügen Lesesequenzeintrag umbenennen Lesesequenzeintrag verschieben Lesesequenzeintrag löschen Index 135 Flare 2018 r2 Erweiterungskurs II Seite 5 von 139

6 Seite 6 von 139 Flare 2018 r2 Erweiterungskurs II

7 1 Versionskontrolle (Source Control) 1 Versionskontrolle (Source Control) 1.1 Grundlagen Versionskontrolle Funktionsprinzip Versionskontrolle Funktionen Versionskontrolle Flare-Projekt an Versionskontroll-System anbinden Projekt importieren Lokale Arbeitskopie erstellen Versionskontrolle konfigurieren Datei sperren (Subversion) Datei einchecken Datei hinzufügen Neueste Version einer Datei abrufen Unterschiede zwischen Dateiversionen anzeigen Target in Versionskontroll-System veröffentlichen Flare-Projekt von Versionskontroll-System lösen 36 Flare 2018 r2 Erweiterungskurs II Seite 7 von 139

8 Wissen dokumentieren. 1.1 Grundlagen Versionskontrolle Die Anbindung an 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. Flare kann an folgende Versionskontroll-Systeme angebunden werden: MadCap Central Subversion Git Perforce 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 Die Anbindung wird in den Projekteigenschaften im Register Quellcodeverwaltung hinterlegt. Die Angaben zum Versionskontroll- Einsatzmöglichkeiten System werden in der Projektdatei *.flprj gespeichert. 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 Flare grundsätzlich auch ohne Anbindung an eine Versionskontrolle möglich. Allerdings ist in diesem Fall nicht erkennbar, ob eine Datei bereits in Bearbeitung ist. Anwendung Die Versionierung in Flare erfolgt über ein externes Versionskontroll- System. Der Anwender ruft die jeweils neuste Version aus dem Versionskontroll-System ab, je nach System werden die Dateien gesperrt Notizen Seite 8 von 139 Flare 2018 r2 Erweiterungskurs II

9 13 Index 13 Index A Abbildungsverzeichnis 117 Formatvorlage 119 Grundlagen 118 verwenden 120 aktivieren Teilwortsuche 71, 76 anlegen Stoppwortliste 75 anzeigen Konzepte 92 Arbeitskopie Subversion 21 B Bildschirmausgabe Konzepte 94 Boolesche Operatoren Suche 73 Browse Sequence siehe Lesesequenzen 121 C CHM mergen 67 Concepts siehe Konzepte 89 D Datei einchecken 28 einfügen in Lesesequenz 131 hinzufügen Versionskontroll-System 30 neueste Version einholen 31 sperren 27 Unterschiede anzeigen 31 Destination siehe Zieladresse 107 Druckausgabe Konzepte 94 E Editor Skin-Komponenten 55 Synonyme 81 Verbindungstabelle 101 Zieladresse 110 einchecken Datei 28 einfügen Datei in Lesesequenz 131 Steuerelement 96 einstellen Suchmaschine 72 entfernen Projektverlinkung 44 erstellen Synonyme und Gruppen 84 External Resources siehe Externe Ressource 45 Externe Ressource 45 Grundlagen 46 löschen 50 neu anlegen Zuordnung entfernen 51 F Fenster Konzepte 92 Filterfunktion Konzepte 94 Formatvorlage Abbildungs- und Tabellenverzeichnis 119 Funktionen Versionskontrolle 12 Funktionsprinzip Versionskontrolle 10 Flare 2018 r2 Erweiterungskurs II Seite 135 von 139

10 Wissen dokumentieren. G Glossareinträge einbeziehen (Suche) 76 Grundlagen Abbildungs- und Tabellenverzeichnis 118 Externe Ressource 46 Konzepte 90 Lesesequenzen 122 Mergen 64 Multi-Authoring und Versionierung 8 Projektverlinkung 40 Skin 54 Suche 70 Synonyme 80 Verbindungstabelle 100 Zieladressen 108 Gruppe erstellen 84 H hinzufügen Datei Versionskontroll-System 30 Komponenten-Skin 57 Konzepte 93 Lesesequenz 124 Lesesequenzeintrag 131 Synonym-Datei 82 Verbindungstabelle 102 Zieladresse 111 HTML5 mergen 65 I Import Projekt 41 K Kennzeichnung Konzeptlink im Topic 90 Komponenten-Skin 53 hinzufügen 57 löschen 61 öffnen 58 umbenennen 59 verschieben 60 Konfiguration Versionierung (Quellcodeverwaltung) 26 Konzepte 89 anzeigen 92 Fenster 92 Grundlagen 90 hinzufügen 93 Kennzeichnung im Topic 90 löschen 98 umbenennen 98 verwenden 94 L Lesesequenz 121 Arbeiten mit Lesesequenzen 130 Editor 123 Grundlagen 122 hinzufügen 124 löschen 129 öffnen 125 Target zuweisen 128 umbenennen 126 verschieben 127 verwenden 128 Lesesequenzeintrag hinzufügen 131 löschen 133 umbenennen 133 verschieben 133 Linking Project Projektverlinkung 39 List of figures siehe Abbildungsverzeichnis 117 List of tables siehe Tabellenverzeichnis 117 löschen Externe Ressource 50 Komponenten-Skin 61 Seite 136 von 139 Flare 2018 r2 Erweiterungskurs II

11 13 Index M Konzepte 98 Lesesequenz 129 Lesesequenzeintrag 133 Synonym-Datei 87 Verbindungstabelle 106 Zieladresse 115 mergen 63 CHM 67 Grundlagen 64 HTML 5 65 WebHelp 65 Multi-Authoring Grundlagen 8 N Neu Externe Ressourcen 47 Komponenten-Skin 57 Konzepte 93 Lesesequenz 124 Lesesequenzeintrag 131 Projektverlinkung 41 Synonym-Datei 82 Verbindungstabelle 102 Verlinktes Projekt 43 xxx 48 Zieladresse 111 O öffnen Komponenten-Skin 58 Lesesequenz 125 Synonym-Datei 83 Verbindungstabelle 103 Zieladresse 113 optimieren Suche 71 Suchmaschine 75 P Phrasensuche 71 Priorisierung Suchergebnisse 71 Projekt importieren 41 Projektverlinkung 39 entfernen 44 Grundlagen 40 neu anlegen 41 neu importieren 43 Q Quellcodeverwaltung siehe Versionskontrolle 7 S Skin Grundlagen 54 Komponenten 53 Skin-Komponenten Editor 55 Source Control siehe Versionskontrolle 7 sperren Datei 27 Steuerelement einfügen 96 Konzepte 94 Stoppwortliste anlegen 75 Suche 74 Subversion Anbindung Versionskontrolle 16 Anbindung Versionskontrolle lösen 36 Arbeitskopie 21 Suche 69 Boolesche Operatoren 73 Grundlagen 70 optimieren 71 Stoppwortliste 74 Flare 2018 r2 Erweiterungskurs II Seite 137 von 139

12 Wissen dokumentieren. Wildcards 74 Suchergebnisse Glossareinträge einbeziehen 76 priorisieren 71 Wichtigkeit einschließen 76 Suchfilter verwenden 97 Suchmaschine einstellen 72 optimieren 75 Synonym-Datei hinzufügen 82 löschen 87 öffnen 83 umbenennen 85 verschieben 86 Synonyme 79 Editor 81 erstellen 84 Grundlagen 80 T Tabellenverzeichnis 117 Formatvorlage 119 Grundlagen 118 verwenden 120 Target in Versionskontroll-System veröffentlichen 34 Teilwortsuche 71 aktivieren 71, 76 Topic Kennzeichnung Konzeptlink 90 U umbenennen Komponenten-Skin 59 Konzepte 98 Lesesequenz 126 Lesesequenzeintrag 133 Synonym-Datei 85 Verbindungstabelle 104 Zieladresse 113 V Verbindungstabelle 99 Editor 101 Grundlagen 100 hinzufügen 102 löschen 106 öffnen 103 umbenennen 104 verschieben 105 verwenden 103 verschieben Komponenten-Skin 60 Lesesequenz 127 Lesesequenzeintrag 133 Synonym-Datei 86 Verbindungstabelle 105 Ziel 114 Versionskontrolle 7 Anbindung 16 Anbindung lösen 36 Datei einchecken 28 Datei hinzufügen 30 Datei sperren 27 Funktionen 12 Funktionsprinzip 10 Grundlagen 8 konfigurieren 26 lokale Arbeitskopie 21 neueste Version einer Datei abrufen 31 Target veröffentlichen 34 Unterschiede anzeigen 31 verwenden Abbildungs- und Tabellenverzeichnis 120 Konzepte 94 Lesesequenz 128 Suchfilter 97 Verbindungstabelle 103 Verzeichnis Abbildungen und Tabellen 117 Seite 138 von 139 Flare 2018 r2 Erweiterungskurs II

13 13 Index W WebHelp mergen 65 Wichtigkeit einschließen Suchergebnisse 76 Wildcards Suche 74 Z Ziel verschieben 114 Zieladresse 107 Editor 110 Grundlagen 108 hinzufügen 111 löschen 115 öffnen 113 umbenennen 113 Zuordnung Externe Ressource entfernen 51 zuweisen Lesesequenz im Target 128 Flare 2018 r2 Erweiterungskurs II Seite 139 von 139