Beschreibung zum Hilfe-Review
Modifizierung der Anzeige der Hilfe-Texte
Zur Korrektur und Überarbeitung der Hilfe ist es notwendig, einen Hilfe-Text so zu beschreiben, dass dieser eindeutig identifiziert werden kann. Dann ist es möglich, ohne großen Aufwand Korrekturen und Änderungen vorzunehmen.
Dazu ist es notwenig, mittels dreier Dateien die Hilfe-Dateien so zu verändern, dass immer erkennbar ist, in welcher Datei und welchem Absatz man sich gerade befindet.
Die dafür benötigten Dateien gehören zum Issue 56321, welches hier eingesehen werden kann: http://qa.openoffice.org/issues/show_bug.cgi?id=56321 mit den dazugehöhrigen Anhängen.
- main_transform.xsl
Diese Datei gehört in das Verzeichnis "<Programmverzeichnis>/help".
Diese ermöglicht es, dass von jeder Hilfedatei der eindeutige Dateiname zu erkennen ist.
- default.css
- Außerdem muss noch die Datei "default.css" in das Verzeichnis "help/de" kopiert werden. Diese ermöglicht eine farbige Darstellung der zusätzlichen Informationen.
- allfiles.tree
In das Verzeichnis "help/de" gehört die Datei allfiles.tree. Die Datei "allfiles.tree" muss regelmäßig aktualisiert werden. Auf "ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/680/<version>/Build-<X>/HelpQA" kann die jeweils aktuelle Version der Datei heruntergeladen werden.
Die Datei erzeugt in der Inhaltsübersicht ein zusätzliches Verzeichnis, in dem dann alle Dateien so aufgelistet werden, dass ein strukturiertes Lesen möglich ist.
Wiki
Das Wiki, in das wir die Ergebnisse eintragen, befindet sich unter http://wiki.services.openoffice.org/wiki/DE/ReviewOnlineHelp.
Das Wiki ist unentbehrlich für die Zusammenarbeit aller an dem Review Beteiligten. Man kann den aktuellen Stand des gemeinsamen Projektes erfahren und nachsehen, welche Hilfedateien noch nicht bearbeitet wurden.
Einige nützliche Informationen
Hier sind noch ein paar Informationen, die zum größten Teil von Regina stammen und die Arbeit am Review erleichtern können.
Die Verzeichnisangaben beziehen sich auf die Linux-Version und sind unter Windows ähnlich.
- Um festzustellen, welche Datei sich unter der Bezeichnung EMB versteckt, ist es hilfreich, die Hilfedateien im Quelltext (Format ist XML) vorliegen zu haben. Diese liegen in openoffice.org2.0/help/de als *.jar Dateien vor. Es sind gezippte Dateien, die unter allen Betriebssystemen entpackt werden können.
- Unter unixoiden Betriebssystem (z.B. GNU/Linux) kann mit folgender Codezeile, die von Guido Ostkamp stammt, beispielsweise danach gesucht werden, wo
text/shared/02/02050000.xhp
embedded wird:
grep -r 'text/shared/02/02050000.xhp' . | grep embed | cut -f1 -d':'
- Ein weitere Punkt sind die Symbolleisten. auch die sind in einer Datei gezippt und zwar openoffice.org2.0/share/config/images.zip. Dort findet man dann die einzelnen Icon-Dateien, die man sich mit einem Bildbetrachter anschauen kann.
Außerdem kann man auf spec.openoffice.org eine Datei herunterladen, die Toolbar_content_spec.sxw heißt.
Darin steht dann, welche Icons in welcher Symbolleiste in der Standardeinstellung zu finden sein sollten.
Diese Liste kann gerne weiter ergänzt werden.