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 }

Snippets mit Topic-abhängigen Variablen

 
Neues Thema eröffnen   Neue Antwort erstellen    Help+Manual-Forum von HelpDesign • Jörg Ertelt Foren-Übersicht -> Wunschliste (Feature Request)
Vorheriges Thema anzeigen :: Nächstes Thema anzeigen  
Autor Nachricht
lavienetzwerk



Anmeldungsdatum: 30.04.2014
Beiträge: 19

BeitragVerfasst am: Mo Jul 14, 2014 13:34    Titel: Snippets mit Topic-abhängigen Variablen Antworten mit Zitat

Hallo,

unser Problem: Wir haben sehr viele Standardtexte, die sich nur in einem Wort unterscheiden. Diese Texte würden wir gerne in ein Snippet auslagern, können das aber nicht tun, weil die Texte nicht 1:1 identisch sind. Gibt es die Möglichkeit, eine Variable einzufügen, die dann je nach Topic variiert?

Beispiel:
1) Enter the name of xxx here.
2) Enter the name of yyy here.

==> xxx bzw. yyy müsste dann im Snippet durch eine Variable (oder ähnliches) ersetzt werden und beim Kompilieren dann durch einen im Topic festgelegten Begriff ersetzt werden.

Vielen Dank,

lavie
Nach oben
Benutzer-Profile anzeigen Private Nachricht senden
Jörg Ertelt
Moderator


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

BeitragVerfasst am: Mo Jul 14, 2014 18:55    Titel: Antworten mit Zitat

Guten Tag lavie,

Hier Bedarf es keines Featurerequests, denn das gewünschte Feature ist schon lange verfügbar.

Die Umsetzung geht so:
1. Eine Variable anlegen unter Konfiguration > Allgemeine Einstellungen > Textvariablen
2. Ein Snippet anlegen unter Projektdateien > Topic-Dateien > Topics und im Snippet an der gewünschten Stelle die angelegte Variable einfügen
3. Das Snippet in beliebig viele Topics einfügen
4. Die Topicvariablen in den Topics definierten: Ein Topic mit dem Snippet öffnen > Topic Eigenschaften > im Abschnitt Topicabhängige Variablen auf + klicken > Variable wählen > OK > in der Spalte Wert den gewünschten Wert eingeben.
5. Schritt 4 für alle weiteren Topics mit diesem Snippet und anderen Variablenwerten wiederholen.

Das Ganze ist übrigens auch in der HuM-Hilfe beschrieben.
_________________
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
Sisyphos



Anmeldungsdatum: 22.09.2009
Beiträge: 23

BeitragVerfasst am: Fr Feb 26, 2016 16:58    Titel: Variblen und Wortvarianten Antworten mit Zitat

Hallo,

auch wenn das Thema etwas älter ist, würde ich mich gerne zu der Frage äußern, da ich sehr gerne mit Snippets arbeite. Snippets haben für mich nicht nur den Vorteil, dass ich Text wiederverwenden kann, sondern helfen mir auch bei der Qualität: Wenn sich in der von mir beschriebenen Software etwas ändert (z.B. nur der Namen einer Funktion), kann ich bei konsequenter Nutzung von Snippets sicherstellen, dass ich alle Bereiche meiner Hilfe und Handbücher erwische. Außerdem hilft es mir auch bei der Durchsetzung von Sprachregeln... hier stoße ich aber an Grenzen mit H&M.

Die von Herrn Ertelt beschriebene Vorgehensweise wende ich mittlerweile sehr häufig an. Ich finde, dass sie wunderbar passt, wenn man nur ein Wort austauschen muss. Ich bin aber nicht zufrieden, wenn es um mehr als ein Wort geht, oder ich eine längeres Snippet verwenden will, bei dem nicht nur das Wort, sondern auch der Artikel geändert wird. Beispiel:

Code:
1. Klicken Sie im Menü auf [A]. [Das A] öffnet sich.
2. Ändern Sie die Einstellung [des A], indem Sie auf die Schaltfläche Z klicken.


Da ich in diesem Fall brauche ich drei Variablen für A. In meinem Fall sind die Snippets viel länger, aber der Begriff muss mit unterschiedlicher Deklination und Artikel geändert werden. Hinzu kommen Positionen im Text (Satzanfang oder Ende) oder andere Verben. Das kann auch dazu führen, dass ich mal einen einzelnen Satz ändern muss. Ab einer gewissen Häufigkeit von Wortvariationen finde ich die Definition von Variablen dann nicht mehr produktiv, was mich immer etwas wurmt, da ich eigentlich bis auf die Wortvarianten 95 Prozent oft recht langer Snippets wiederverwenden könnte. Ich helfe mir so, dass ich viele Snippets definiere, aber die Struktur meiner Snippets wird dadurch nicht übersichtlicher und Vieles lässt sich dann mit Snippets nicht mehr machen.

Ideal fände ich Platzhalter, die ich im Zieltopic ausfüllen kann. Beispiel:

Code:
1. Klicken Sie im Menü auf [Platzhalter1]. [Platzhalter2] öffnet sich.
2. Ändern Sie die Einstellung [Platzhalter3], indem Sie auf die Schaltfläche [Platzhalter4] klicken.


Oder ich könnte im Snippet Bedingungen für Zeiltopics definieren:

Code:
1. Klicken Sie im Menü auf [if-topicid=topic_a then "A"][if-topicid=topic_b then "B"]. [if-topicid=topic_a then "Das Fenster A"][if-topicid=topic_b then "Die Maske B"] öffnet sich.
2. Ändern Sie die Einstellung [if-topicid=topic_a then "im Fenster A"][if-topicid=topic_b then "der Maske B"], indem Sie auf die Schaltfläche [if-topicid=topic_a then "A ändern"][if-topicid=topic_b then "B anpassen"] klicken.


Die Variante, das Snippet einfach als Kopie einzufügen finde ich nicht befriedigend, da ich bei der Pflege, dann alle Stellen in der Hilfe suchen muss.

Vielleicht gibt es ja in H&M eine Möglichkeit, so etwas zu erreichen? Vielleicht geht es ja ganz anders.... Manchmal sieht man ja den Wald vor lauter Bäumen nicht... Oder brauchen wir für so ein Szenario ein anderes Tool? Wenn ja welches?

Gruß, Benjamin Brücker
Nach oben
Benutzer-Profile anzeigen Private Nachricht senden
Jörg Ertelt
Moderator


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

BeitragVerfasst am: So Feb 28, 2016 13:38    Titel: Antworten mit Zitat

Guten Tag Herr Brücker,

==
Ich bin aber nicht zufrieden, wenn es um mehr als ein Wort geht, oder ich eine längeres Snippet verwenden will, bei dem nicht nur das Wort, sondern auch der Artikel geändert wird.
==

Nun, das ist eine grundsätzliche Herausforderung in der technischen Redaktion und hat mit dem verwendeten Tool nichts zu tun.
Außerdem betrifft das nicht nur die deutsche Sprache, sondern vermutlich alle Sprachen.
Abgesehen davon: m.E. steht der Aufwand zur Pflege solcher Sachverhalt in keinem Verhältnis zu einem wie auch immer gearteten Nutzen.

Ich empfehle die Kürzung des Sachverhalts auf das Wesentliche. Dann braucht es i.d.R. weder Variablen noch Snippets, ggf. nur noch Variablen und selbst die würde ich in diesem Sachverhalt nur in homöopathischen Dosen verwenden.

Statt:
1. Klicken Sie im Menü auf [A]. [Das A] öffnet sich.
2. Ändern Sie die Einstellung [des A], indem Sie auf die Schaltfläche Z klicken.

Vielleicht:
1. Menü: Klick [A].
2. Einstellungen ändern: Klick Z. (oder: Z klicken).

Die direkte Ansprache wird in diesen Fällen m.E. überschätzt.

==
1. Klicken Sie im Menü auf [if-topicid=topic_a then "A"][if-topicid=topic_b then "B"]. [if-topicid=topic_a then "Das Fenster A"][if-topicid=topic_b then "Die Maske B"] öffnet sich.
2. Ändern Sie die Einstellung [if-topicid=topic_a then "im Fenster A"][if-topicid=topic_b then "der Maske B"], indem Sie auf die Schaltfläche [if-topicid=topic_a then "A ändern"][if-topicid=topic_b then "B anpassen"] klicken.
==

Wer soll das verwalten? Und wozu? Hilft das dem Leser bei der Umsetzung seiner Anforderungen? Lösung eines Problems? Verständnis eines Sachverhalts? Und: wie sieht es mit Übersetzungskosten aus? Und wie mit dem Pflegeaufwand? Und der Lesbarkeit im Editor?

==
Manchmal sieht man ja den Wald vor lauter Bäumen nicht
==

Na ja, die Sache mit den Topic-Variablen habe ich im Beitrag beschrieben. Das geht in diese Richtung.

Ansonsten: Keep it simple an clean.

==
Oder brauchen wir für so ein Szenario ein anderes Tool?
==

Nein. Andere Tools kochen in dieser Hinsicht ebenfalls nur mit Wasser.
_________________
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 -> Wunschliste (Feature Request) 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