Help+Manual-Forum von HelpDesign • Jörg Ertelt Foren-Übersicht Help+Manual-Forum von HelpDesign • Jörg Ertelt
Erstes deutschsprachiges Help& Manual-Forum
 
 ProfilProfil   LoginLogin 
 FAQFAQ   SuchenSuchen  RegistrierenRegistrieren 
 HelpDesign { Seminare und Support | Testlizenz anfordern | Neue Lizenzen kaufen / Lizenzen upgraden }

Identischen Text in mehreren Kapiteln verwenden

 
Neues Thema eröffnen   Neue Antwort erstellen    Help+Manual-Forum von HelpDesign • Jörg Ertelt Foren-Übersicht -> Allgemeine Themen
Vorheriges Thema anzeigen :: Nächstes Thema anzeigen  
Autor Nachricht
koeln_68



Anmeldungsdatum: 22.10.2007
Beiträge: 11

BeitragVerfasst am: Fr Sep 26, 2008 15:25    Titel: Identischen Text in mehreren Kapiteln verwenden Antworten mit Zitat

Hallo zusammen,



ich bin neu hier und komme an einer Stellen nicht richtig weiter:



Ich erstelle gerade eine Version, aus der später sowohl eine pdf- als auch eine browser-based help-Version erstellt werden soll.



So, jetzt zum Problem: Es gibt bei unserer Software Effekte, die auf mehreren Oberflächen zum Tragen kommen und daher an mehreren Stellen einen immer gleichlautenden Kommentar erforderlich machen.



Lösung wäre, den Dokumentationstext hierzu einmal zu schreiben und dann irgendwie zu verlinken. Auf diese Weise kann es auch nicht - wie derzeit - zu redundanten Datenbständen kommen. Gibt es eine solche Möglichkeit? Wenn ja, wie heißt das Stichwort hierzu?



Ich wäre für Ihre/Eure Hinweise wirklich dankbar!



Danke und Grüße!
Nach oben
Benutzer-Profile anzeigen Private Nachricht senden
Jörg Ertelt
Moderator


Anmeldungsdatum: 22.12.2005
Beiträge: 2532
Wohnort: 73240 Wendlingen

BeitragVerfasst am: Fr Sep 26, 2008 20:26    Titel: Antworten mit Zitat

Guten Tag koeln_68,



==

Lösung wäre, den Dokumentationstext hierzu einmal zu schreiben und dann irgendwie zu verlinken. Auf diese Weise kann es auch nicht - wie derzeit - zu redundanten Datenbständen kommen. Gibt es eine solche Möglichkeit? Wenn ja, wie heißt das Stichwort hierzu?

==



Das Stichwort heißt Snippet. Ein Snippet ist nichts anderes als ein Topic, der in andere Topics eingefügt wird.



Und so gehts:

1. Im Project Explorer unter Project Files > Files einen Topic anlegen

2. Topic mit Inhalt füllen

3. Einen anderen Topic öffnen, in den der im ersten Schritt angelegte Topic eingefügt werden soll

4. Im Topic Rechtsklick > Insert > Snippet > From Topic

5. Topic wählen > Snippet is linked > OK

6. Das ganze für andere Topics wiederholen



Fazit: Der im Schritt 1 angelegte Topic ist nciht im Inhaltsverzeichnis vorhanden, wird aber in beliebig viele andere Topics eingefügt. Dadurch lassen sich Redundanzen wunderbar vermeiden. Wird der Topic inhaltlich geändert, wird der Inhalt in allen Topics geändert, in denen der Topic verlinkt ist.
_________________
Viele Grüße

Jörg Ertelt

HELP+MANUAL
:: Testlizenz anfordern
:: Neue Lizenzen kaufen / Lizenzen upgraden
:: Offene und Firmenseminare

SUPPORT
:: Help+Manual-Forum
:: Help+Manual-Knowledgebase

HelpDesign • Jörg Ertelt
Ulrichstraße 1
D-73240 Wendlingen am Neckar
www.helpdesign.eu

Nach oben
Benutzer-Profile anzeigen Private Nachricht senden E-Mail senden Website dieses Benutzers besuchen
koeln_68



Anmeldungsdatum: 22.10.2007
Beiträge: 11

BeitragVerfasst am: Mo Sep 29, 2008 13:42    Titel: Antworten mit Zitat

Guten Tag Herr Ertelt,



erstmal vielen Dank für die prompte Antwort am Freitagabend!



Nach dem Stöbern im Forum hatte ich vor einiger Zeit schon einmal das Stichwort "Snippets" gelesen und dann in der Hilfe eingegeben. Dabei wurde mir die Option Insert/Hyperlink/Script/Makro vorgeschlagen, die mir aber nicht hilfreich erschien, denn ich hatte nicht vor, mit Makros zu arbeiten.



Das von Ihnen erwähnte Kontextmenü verfügt in der mir vorliegenden Version 4 über keinen Menüeintrag Snippet. Ist das in Version 5 einfacher? Wenn nicht, werde ich das einfach wie gehabt weiter umsetzen.



Grüße aus Köln!
Nach oben
Benutzer-Profile anzeigen Private Nachricht senden
Jörg Ertelt
Moderator


Anmeldungsdatum: 22.12.2005
Beiträge: 2532
Wohnort: 73240 Wendlingen

BeitragVerfasst am: Mo Sep 29, 2008 13:46    Titel: Antworten mit Zitat

Guten Tag koeln_68,



in der Tat: In Version 4 gibt es keine Snippets, aber ähnliches: Embedded Topics. Damit kann jeder Topic in andere Topics eingebettet werden, was vom Effekt das Selbe wie ein Snippet ist. Allerdings geht das Snippet-Konzept über die Möglichkeiten des Konzept mit den embedded Topics hinaus, z.B. mit dem Aufbau einer Snippet-Bibliothek, die von beliebig vielen anderen Projekten verwendet werden kann.



Makros helfen hier nicht. Dieses sind nur sinnvoll im Zusammenhang mit der WinHelp.
_________________
Viele Grüße

Jörg Ertelt

HELP+MANUAL
:: Testlizenz anfordern
:: Neue Lizenzen kaufen / Lizenzen upgraden
:: Offene und Firmenseminare

SUPPORT
:: Help+Manual-Forum
:: Help+Manual-Knowledgebase

HelpDesign • Jörg Ertelt
Ulrichstraße 1
D-73240 Wendlingen am Neckar
www.helpdesign.eu

Nach oben
Benutzer-Profile anzeigen Private Nachricht senden E-Mail senden Website dieses Benutzers besuchen
koeln_68



Anmeldungsdatum: 22.10.2007
Beiträge: 11

BeitragVerfasst am: Mo Sep 29, 2008 14:32    Titel: Antworten mit Zitat

Guten Tag Herr Ertelt,



ich bin beeindruckt, wie schnell Sie sich um die gestellten Fragen kümmern!



Um auf Ihren Beitrag zurückzukommen: "Mein" Problem wird sich mit der vorliegenden Version wahrscheinlich weder mit Ebedded Topics noch mit Multiple References lösen lassen.





Die von mir erstellte Dokumentation (derzeit 120 MB, 939 Einzeldateien) hat beispielhaft folgenden Aufbau:



=Kapitel Beschreibung Oberflächengruppe 1

==Unterkapitel 1 ***

==Unterkapitel 2



=Kapitel Beschreibung Oberflächengruppe 2

==Unterkapitel 1

===Unterkapitel 1.1

==Unterkapitel 2 ***

==Unterkapitel 3



...

...



Diese Oberflächen sind miteinander verknüpft und verhalten sich bei Vorliegen bestimmter Konfigurationseinstellungen bzw. Auslieferungsstände anders.



Damit der Benutzer hierauf aufmerksam gemacht wird, muss an bestimmten Stellen im Text/Page Editor, nicht auf der TOC-Seite eine *** Erklärung/Definition hinterlegt werden, die aus einem kurzen Textabschnitt (5-Zeiler) besteht.



Die Vorschläge gehen meiner Ansicht nach immer davon aus, dass bestehende Topics, sprich, solche, die in demselben Dokument bereits vorhanden sind, referenziert werden. Dies ist aber hier nicht der Fall.



Wenn sich das Problem aber mit Version 5 lösen läßt, werde ich anregen, dass wir uns diese Version zulegen.



Ich bedanke mich nochmals für Ihre schnelle Reaktion!



Gruß aus Köln!
Nach oben
Benutzer-Profile anzeigen Private Nachricht senden
Jörg Ertelt
Moderator


Anmeldungsdatum: 22.12.2005
Beiträge: 2532
Wohnort: 73240 Wendlingen

BeitragVerfasst am: Mo Sep 29, 2008 18:38    Titel: Antworten mit Zitat

Guten Tag koeln_68,



ich bin nicht sicher, ob ich das Problem durchdrungen habe.



==

Damit der Benutzer hierauf aufmerksam gemacht wird, muss an bestimmten Stellen im Text/Page Editor, nicht auf der TOC-Seite eine *** Erklärung/Definition hinterlegt werden, die aus einem kurzen Textabschnitt (5-Zeiler) besteht.

==



Das bedeuter doch, dass dieser 5-Zeiler X-Mal in unterschiedlichen Topics vorkommt und zwar immer mit idemtischem Inhalt. In diesem Fall wird unter Invisible Topics ein Topic angelegt, der diesen 5-Zeiler enthält. Dieser Invisible Topic wird dann in die Topics eingebettet, in denen er enthalten sein soll.



==

Die Vorschläge gehen meiner Ansicht nach immer davon aus, dass bestehende Topics, sprich, solche, die in demselben Dokument bereits vorhanden sind, referenziert werden.

==



Gut, mea culpa. Da habe ich mich zu undifferenziert ausgedrückt. Wichtig ist, dass der Topic mit dem 5-Zeiler ein Invisible Topic ist. Damit wird er nicht im TOC angezeigt.
_________________
Viele Grüße

Jörg Ertelt

HELP+MANUAL
:: Testlizenz anfordern
:: Neue Lizenzen kaufen / Lizenzen upgraden
:: Offene und Firmenseminare

SUPPORT
:: Help+Manual-Forum
:: Help+Manual-Knowledgebase

HelpDesign • Jörg Ertelt
Ulrichstraße 1
D-73240 Wendlingen am Neckar
www.helpdesign.eu

Nach oben
Benutzer-Profile anzeigen Private Nachricht senden E-Mail senden Website dieses Benutzers besuchen
Beiträge der letzten Zeit anzeigen:   
Neues Thema eröffnen   Neue Antwort erstellen    Help+Manual-Forum von HelpDesign • Jörg Ertelt Foren-Übersicht -> Allgemeine Themen Alle Zeiten sind GMT + 1 Stunde
Seite 1 von 1

 
Gehe zu:  
Sie können keine Beiträge in dieses Forum schreiben.
Sie können auf Beiträge in diesem Forum nicht antworten.
Sie können Ihre Beiträge in diesem Forum nicht bearbeiten.
Sie können Ihre Beiträge in diesem Forum nicht löschen.
Sie können an Umfragen in diesem Forum nicht teilnehmen.


Powered by phpBB © 2001, 2005 phpBB Group
Deutsche Übersetzung von phpBB.de