PDA

Archiv verlassen und diese Seite im Standarddesign anzeigen : Tool um Dokumentation komfortabel lokalisieren zu können


puntarenas
2006-10-03, 11:16:18
Moin,

ich arbeite zur Zeit an einer Benutzer-Dokumentation zu einer Software und ausgehend von dieser Originalfassung soll das ganze dann zunächst ins Englische und davon dann wiederum in zahlreiche andere Sprachen übersetzt werden.

Da die Doku möglichst problemlos zugänglich sein soll, habe ich angefangen das ganze in plain-html zu verpacken. Ich habe zwar keine Ahnung von html, aber es soll ja auch kein Feuerwerk der Designeffekte werden, ich beschränke mich ganz bewusst auf die allernötigsten Tags.

Dennoch scheint mir das umfangreicher zu werden als zunächst gedacht und ich will gar nicht an die armen Schweine denken, die den Salat nacher übersetzen sollen. Noch ist aber wohl Zeit und ich habe mich gefragt, ob mir nicht jemand ein Tool (wie gettext oder ähnliches) für meine Zwecke empfehlen kann:

Die Dokumentation beeinhaltet:

- Links
- Bilder (Screenshots, die daher entsprechend variieren)
- einfache Layouttags wie <img>, <ul>, <li>, <em>, <br> und <h1> bis <h4>, womit IIRC auch schon alle aufgezählt wären.
- Text (später im Zeichensatz aller Herren Länder), wobei ich selbst die deutschen Umlaute schonmal als html-Entitäten schreibe, die Datei ist aber (noch?) wie üblich utf8 codiert.

Das Toll sollte bieten:

Den Textkörper auf einfache Weise vom html-Gerüst zu trennen. Natürlich bin ich bereit mich einzuarbeiten, aber es sollte doch leicht beherrschbar ein, ich möchte kein Studium diesbezüglich absolvieren. Ich möchte hauptsächlich unter Linux arbeiten, was für ein Betriebssystem bei späteren Übersetzungen zum Einsatz kommt, kann ich aber nicht sagen.

Idealerweise sollten sich Dinge wie Dateinamen der Bilder ebenfalls automatisiert anpassen lassen, obwohl ich dafür auch ein Skript über die Datei laufen lassen kann.

Momentan schreibe ich noch alles in eine einzelne html-Datei, aber da das Ganze noch in einem frühen Stadium ist und ich nur deutsch und maximal noch die englische Version bearbeite, läßt sich natürlich auch dies mit Rücksicht auf spätere Übersetungen noch ändern.

Im Moment schreibe ich das ganze mit Vim, insofern wäre ein passendes Plugin natürlich auch denkbar.

Gruß
puntarenas

piepre
2006-10-04, 09:48:54
Eventuell solltest Du dir mal DocBook (http://de.wikipedia.org/wiki/DocBook) angucken.

puntarenas
2006-10-04, 15:07:11
Danke, DocBook sieht wirklich vielversprechend aus und ist Freie Software. Ich hatte bereits überlegt, auf Latex auszuweichen, aber mit Rücksicht auf Windowsanwender unter den späteren Übersetzern habe ich den Gedanken verworfen (Ich weiß, dass Latex für Windows verfügbar ist).

DocBook liefert wirklich schöne Ergebnisse und macht mich nicht von einem einzelnen Dokumentenformat abhängig. Lediglich bezüglich i18n der Dokumentation habe ich aufgrund meiner Suchmaschinenlegasthenie nichts wirklich hilfreiches gefunden. Da aber große Projekte wie Gnome DocBook nutzen und diese ihre Dokus in unzähligen Sprachen bereitstellen, müsste es doch eigentlich einen empfehlenswerten Weg geben.

Mit Hilfe von XInclude oder Externen Entitäten (http://www.goshaky.com/docbook-tutorial/ch01s04s05.html) lassen sich Texte komfortabel aus einzelnen, simpel gehaltenen XML-Dateien laden und zur erstellung einer spezifischen Sprache der Doku im Zielformat schiebe ich DocBook dann einfach die jeweilig übersetzte Version unter, das geht auch von Hand ohne großen Aufwand.

Falls mir jemand einen Königsweg nennen kann oder aus Erfahrung bereits schmerzhaft gelernt hat, sagt mir bitte Bescheid, ansonsten konvertiere ich mein html-Fragment jetzt nach DocBook und gebe den Übersetzern später die Module zum Austoben.

Jetzt schaue ich mich mal noch nach geeigneten Vim-Scripts um, ansonsten eben JEdit (http://www.jedit.org/)

BTW: Ich könnte schwören, ich habe vorhin schonmal auf diesen Beitrag geantwortet. Vieleicht habe ich ja auch aus Versehen einen anderen Thread zugespammt... :D