Offline-Doku pflegen

Allgemeine Diskussionen, sonstige Fragen und Plauder-Ecke

Offline-Doku pflegen

Beitragvon Framik » 28.08.2008 13:29

Hallo,

würde gerne mal eure Meinung zu folgendem Thema wissen:
Ich muss immer wieder offline-Dokumentationen als HTML-Dateien verfassen. Die Dokumentationen bestehen zum Teil aus immer wieder gleichen Abschnitten aber zum Teil auch aus individuell angepassten Abschnitten. Außerdem ist die Dokumentation zweisprachig ausgelegt. (Jede Datei existiert also 1x auf deutsch und 1x auf englisch)

Bisher nutzte ich Phase5, seit einigen Monaten Scriptly.
ich würde jetzt gerne den Pflegeaufwand irgendwie reduzieren, da es auch immer wieder vorkommt das in einer Sprache ein Abschnmitt vergessen wird bzw. nicht angepasst wird.

Hat jemand vorschläge wie man das möglichst einfach machen könnte?
Framik
 

Advertisement



Registrieren Sie sich, um diese Anzeige nicht mehr zu sehen!
 

Beitragvon Ray » 29.08.2008 10:20

Werden die Abschnitte bei den veränderten Abschnitten in einer Sprache vergessen oder bei denen, die immer wieder vorkommen?

Zum Einen würde ich mir Textbausteine anlegen, aus denen ich immer wieder die gleichen Sachen kopieren würde.

Zum Anderen würde ich bei Veränderung/nach Fertigstellung der beiden Dateien die veränderten Zeilen farbig markieren. Dann beide in zwei Fenstern nebeneinander stellen und vergleichen, ob die farbigen Markierungen auf beiden Seiten zu sehen sind.
Dem ist nichts hinzuzufügen!
Der RAY.
Ray
Sehr engagiertes Mitglied
 
Beiträge: 272
Registriert: 29.03.2007 13:04
Wohnort: Köln

Beitragvon Benedikt Loepp » 06.09.2008 18:18

Hoi,

das klingt irgendwie nicht sonderlich praktisch, die Hilfe direkt so als HTML zu schreiben, wenn ich das richtig verstehe. Da würd ich mir ja überlegen, ob ich nicht ein irgendwie geartetes System davorschalten könnte, dass mir die HTML-Dateien einfach fertig generiert.

Ansonsten wenn du weiterhin rein HTML-basiert arbeiten möchtest/musst, könnte dich das Include-System von Scriptly (ist das gleiche wie bei Phase5) evtl. unterstützen für die gleichen Elemente der HTML-Dateien. Ansonsten kann ich Ray nur zustimmen!

Wobei @Ray: Das was du mit dem Datei-Vergleichen schreibst, klingt eher wie ein Fall für ein automatischen Dateivergleich, wie es den z.B. im Scriptly oder in diversen Versionsverwaltungssystemen gibt? Oder meinst du was anderes? Ansonsten sei an dieser Stelle auch nochmal auf den Dateivergleicher im Scriptly hingewiesen :mrgreen:

MfG Benedikt Loepp
Benedikt Loepp
Administrator
 
Beiträge: 2729
Registriert: 17.06.2005 18:30
Wohnort: Lünen

Beitragvon Ray » 07.09.2008 18:30

Eigentlich dachte ich an den Vergleich der deutschen mit der englischen Version. Da bringt natürlich ein Dateivergleicher nix ;)
Dem ist nichts hinzuzufügen!
Der RAY.
Ray
Sehr engagiertes Mitglied
 
Beiträge: 272
Registriert: 29.03.2007 13:04
Wohnort: Köln

Beitragvon Benedikt Loepp » 07.09.2008 19:36

Achso, dann hatte ich das falsch verstanden - hät mich auch etwas gewundert ;)
Nichtsdestotrotz bleibt das, erst recht mit mehreren Sprachen, ein aufwendiges Unterfangen wenn man direkt HTML-Dateien schreibt...
Benedikt Loepp
Administrator
 
Beiträge: 2729
Registriert: 17.06.2005 18:30
Wohnort: Lünen

Beitragvon framik » 08.09.2008 08:36

Danke für eure Meinung.
Leider muss ich bei reinem HTML bleiben. Ist so Vorgabe.
Auch kann ich kein CMS nutzen da ich kein PHP usw auf dem Rechner installieren kann/darf.

Die Include-Funktion ist auch so ziemlich das einzige was mir eingefallen ist. Evtl. wäre auch die neue Funktion bei den Snippetseingabe interessant (Parametereingabe über Dialog). Leider habe ich diese Funktion aber in der aktuellen Testversion noch nicht zum funktionieren gebracht...

Das Problem mit der 2-sprachigen Doku lässt sich aber auch mit den Includes nicht lösen. Wenn man ein Include vergisst, dann fehlt es halt in der Sprache auch wenn es in der anderen vorhanden ist.

Scheint so als ob ich da doch eine Indivíduele Lösung programmieren muss... :-(
framik
Interessiertes Mitglied
 
Beiträge: 19
Registriert: 02.09.2008 09:32

Beitragvon Benedikt Loepp » 08.09.2008 21:25

Das stimmt, für das zweisprachige helfen dir auch die Includes wenig - die könnten dir höchstens hilfreich sein, dass drumrum im HTML-Code immer einheitlich zu halten.

Das du dass nicht zum laufen gebracht hast ist klar :mrgreen: Das gabs da noch gar nicht :) Aber morgen kommt die neue Version in der es drin sein wird. Ob das allerdings dabei unbedingt hilft, ist wieder eine andere Sache.

Das effektivste und praktischste ist wahrscheinlich eine selbstprogrammierte Lösung, wie du schon sagst - du gibst die zweisprachigen Inhalte ein, diese werden intern gespeichert, und kannst dir außerdem direkt dass HTML-Generieren lassen.
Benedikt Loepp
Administrator
 
Beiträge: 2729
Registriert: 17.06.2005 18:30
Wohnort: Lünen

Beitragvon Gast » 23.09.2008 13:47

Mir ist doch noch ein Bastel-Lösung eingefallen.

Ich Plege die Texte für beide Sprachen in die gleiche Include-Datei ein. Dabei kennzeichne ich deutschen Text mit der CSS-Klasse "gr" und englischen Text mit der CSS-Klasse "uk".
Jetzt kann ich ganz einfach über die CSS-Datei festlegen welcher Text angezeigt wird.
Mit einem JS-Styleswitcher lässt sich das ggf. sogar dynamisch machen.

Sicher nciht die beste Lösung, aber eine funktionierende Lösung ;-)
Gast
 

Beitragvon framik » 24.09.2008 07:25

Der Gast war natürlich ich 8)
framik
Interessiertes Mitglied
 
Beiträge: 19
Registriert: 02.09.2008 09:32


Zurück zu Off-Topic



Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast

cron