The Document Foundation Wiki
 

Konzept für die Handbucherstellung

From The Document Foundation Wiki

< DE | Doku
Jump to: navigation, search

Contents

Konzept bzw. Vorgehensweise (Kurzfassung)

Die Erstellung deutschsprachiger Handbücher ist folgendermaßen geregelt:


Konzept bzw. Vorgehensweise (Langfassung)

Einstellen eines neuen Dokuments ins Wiki

Mal so eine Frage in den Raum gestellt: Benutzt eigentlich einer von euch die Wiki-Publisher Extension, die von Sun erstellt wurde? Das dürfte (denke ich mir mal) doch verschiedene Sachen vereinfachen, oder?


Dokument vorbereiten:

Dokument als Textdatei speichern und schließen (dabei gehen alle Bilder und Formatierungen verloren, was aber so gewollt ist).

Textdokument schließen, (in Writer) neu öffnen und weiter bearbeiten:

Textdokument ins Wiki kopieren

Feingranulierte Multiautoren-Übersetzung im Wiki

Wie erkennt man Abschnitte, die noch nicht übersetzt worden sind?

Abschnitte, die noch nicht übersetzt worden sind, werden mit "(Überschrift)" versehen. Damit kann man erkennen, dass für diesen Abschnitt eine Übersetzung ansteht.


Aufruf des Abschnittes, der übersetzt werden soll

Zur Übersetzung/Bearbeitung bitte den Absatz über den "Bearbeiten-Button" rechts neben der Überschrift des jeweiligen Absatzes aufrufen (nicht die für die ganze Seite), damit andere an anderen Absätzen parallel arbeiten können).


Kenntlichmachung, dass ein Absatz gerade bearbeitet wird

Translation in Progress! - Dokument/Abschnitt wird gerade übersetzt!
Bitte abwarten oder - in Absprache - mithelfen, aber nicht einfach dazwischenfunken ;)

Mit diesem Vorgehen ist sichergestellt, dass


Dokumentation des Fortschritts der Übersetzung durch farbliche Kodierung der Absätze

Die Absätze der vier Spalten sind farblich kodiert, um den Fortschritt der Übersetzung farblich kenntlich zu machen:

Jedes Mal, wenn Du einen Absatz bearbeitet hast, musst Du die Farbkodierung eine Stufe weiter setzten.

In die Kopfzeile eines jeden Absatzes musst du Deinen Namen eintragen, es muss jeder Absatz von drei verschiedenen Leuten übersetzt und kontrollgelesen werden.

Englischer Originaltext

Der Englischer Originaltext wird in der jeweiligen Übersertzungs-Wikiseite eingestellt.

Der Originaltext bleibt unterhalb der Übersetzung so lange stehen, bis die erste Kontrolllesung stattgefunden hat, danach wird er mit <!-- (Text des Absatzes) --> auskommentiert (nicht gelöscht!).

Mitarbeit protokollieren

Und nicht vergessen: Jeder, der an dieser Übersetzung mitgewirkt hat, sollte sich in die Tabelle der Übersetzer eintragen, damit sein Engagement auch gewürdigt wird.
Dabei bitte darauf achten, dass die Liste alphabetisch sortiert nach den Nachnamen bleibt.

Unklarheiten bzgl. der Übersetzung

Im Zweifelsfall werden mehrere Möglichkeiten ins Wiki gestellt bzw. auf der de-discuss-ML besprochen.

ODT-Erstellung auf ODFAuthors

Die deutschsprachige Benutzerdokumentation wird unter Nutzung der Plattform www.odfauthors.org erstellt. (Hinweis: Die Webseite bzw. das CMS liegt auf einem Server von OOoDeV/TDF.)

Die verwendete Dokumentvorlage für die Benutzerdokumentation findet sich hier: Kapitelvorlage.

Vorgehen bei der ODT-Erstellung im Einzelnen:

  1. Öffnen der LibO3_3_Kapitelvorlage
  2. Anpassen der Meta-Daten (ist in der Vorlage beschrieben, wie das geht!)
  3. Einfügen der Beteiligten
  4. Referenz zum englischen Original und OOo-Dokument

Nach dem Inhaltsverzeichnis:

  1. Einfügen der einzelnen Abschnitte (Absätze) mit STRG+C, STRG+ALT+Shift+V (unformatierter Text). Alternativ funktioniert bei mir auch ein Mittelklick (Drücken des Mausrads) für das Einfügen von unformatiertem Text.
  2. Zuweisen der entsprechenden Formatierungen
  3. Wenn der gesamte Text drin ist, einmal kurz drüberlesen, ob noch irgendwelche offensichtlichen Rechtschreibfehler enthalten sind.

Danach:

  1. Anfertigen der Screenshots
  2. Einfügen der Screenshots (mit Bildbeschriftungen!)
  3. Hochladen des Dokumentes nach ODFAuthors
  4. Review-Prozess anstoßen


Review- bzw. Änderungs-Prozess auf odfauthors

  1. Auf http://www.odfauthors.org gehen und einloggen
  2. zu Libreoffice/Deutsch/Arbeitsordner/Entwurf/Dokumente navigieren
  3. auf den Namen des Kapitels klicken und die Datei damit herunterladen. (Die aus Wiki-Bearbeitungen hervorgegangenen Entwürfe befinden sich zur Zeit im Ordner "Wiki")
  4. In der grünen Menüleiste auf Actions (Aktionen?) klicken und Checkout anwählen.
    Das "sperrt" die Datei so dass andere Benutzer sehen, dass jemand daran arbeitet. Wenn alle Korrekturen eingearbeitet wurden, wird das Dokument wieder hochgeladen.

    Hierzu geht ihr wie folgt vor:
  5. Auf den Eintrag des heruntergeladenen Kapitels gehen und in der grünen Menüleiste "Edit" (Bearbeiten) anklicken. Den Beschreibungstext anpassen und "Replace with new file" (Durch neue Datei ersetzen) auswählen. Natürlich nicht vergessen, die Datei auf eurem Computer auszuwählen. Bitte den Namen beibehalten, Plone hat ein Versionierungssystem (wie in einem Wiki) eingebaut.
    Evtl. noch eine Kommentar zu den vorgenommenen Änderungen eingeben und Speichern.
  6. die Sperrung wieder aufheben indem ihr in der grünen Menüleiste wieder auf "Actions" (Aktionen) klickt und "Checkin" auswählt.

Alternative Anleitung (Stand: 13.09.2011):

Namensschema der einzelnen Handbücher

Das Namensschema der einzelnen Handbücher setzt sich aus Bereich, Kürzel für Bereich, Kapitelnummer, Kapitelbezeichnung sowie LO-Version zusammen.

Erklärung am Beispiel "01ES_01LibreOfficeEinführung_V33":


Screenshot-Erstellung


Screenshot (und andere Bilder) Einfügen

Nachdem erin Screenshot erstellt ist, muss er richtig in das Dokument eingefügt werden. Am besten geht man wie folgt vor:


Am Ende sollten also folgende Einstellungen vorliegen:

Icon/Symbol-Erstellung

Veröffentlichung und nochmalige Veröffentlichung

Nach Abschluss der Review-Runde auf ODF-Authors kann das Dokument veröffentlicht werden.

ODT-Dokument für Veröffentlichung vorbereiten

ODT- und PDF-Dokument hochladen bzw. veröffentlichen

Zusammenfassung der einzelnen Kapitel zum Gesamtdokument

(Kochrezept laut Christian)

  1. Globaldokument anlegen
  2. LibO Vorlage übernehmen
  3. Vorspann rein kopieren
  4. Deckblatt einfügen
  5. Bereiche in den Kapiteln so definieren, sodass Copyright, Inhaltsverzeichnis etc. ausgeblendet werden können
  6. Titel und Untertitel in ohne Feldbefehl ändern
  7. Kapitel zu Globaldokument hinzufügen
  8. Autoren etc. aus Einzelkapiteln zusammenführen
  9. Variable setzten, um Bereiche auszublenden
  10. drüber scrollen, ob alles richtig aussieht
  11. Verzeichnis aktualisieren
  12. Veröffentlichungsdatum setzen
  13. als ODT exportieren
  14. Verknüpfungen lösen
  15. als PDF exportieren
  16. veröffentlichen

Kenndaten: Mitwirkende und englische Dokumente

Nur für Kapitel, die noch nicht in ODFAuthors eingestellt sind.
Bei diesen finden sich die Angaben auf der Erledigt-Seite (siehe DE/Doku/Handbucherstellung_(erledigte_Punkte)

Erste Schritte Handbuch

Einführung Kapitel 13 (Einführung in Makros)

Buchtitel Erste Schritte
Kapitel Kapitel 13 - Einführung in Makros
Mitwirkende

Ralf Albrecht
Erhardt Balthasar
Christian Kühl ()
Nino Novak
Jochen Schiffers
Klaus-Jürgen Weghorn (k-j)

englisches Original

Ron Faile Jr.

OpenOffice.org Original

Andrew Pitonyak
Jean Hollis Weber

Writer Handbuch

Writer Kapitel 01 (Einführung in Writer)

Buchtitel Writer Handbuch
Kapitel Kapitel 01 - Einführung in Writer
Mitwirkende

Erhardt Balthasar
Christian Kühl ()
Klaus-Jürgen Weghorn (k-j)
Jochen Schiffers
Sigrid Carrera

englisches Original

Barbara Duprey
John M. Długosz
Ron Faile Jr.
Hal Parker

OpenOffice.org Original

Agnes Belzunce
Daniel Carrera
Laurent Duperval
Stefan A. Keel
Peter Kupfer
Carol Roberts
Joe Sellman
Gary Schnabl
Janet M. Swisher
Jean Hollis Weber
Linda Worthington
Michele Zarri

Writer Kapitel 02 (Writer-Einstellungen)

Buchtitel Writer Handbuch
Kapitel Kapitel 02 - Writer-Einstellungen
Mitwirkende

Erhardt Balthasar
Klaus-Jürgen Weghorn (k-j)
Andreas Gärtner

englisches Original

John M. Długosz
Ron Faile Jr.
Hal Parker

OpenOffice.org Original

Jean Hollis Weber
Agnes Belzunce
Daniel Carrera
Peter Hillier-Brook
Stefan A. Keel
Gary Schnabl
Janet M. Swisher
Michele Zarri
Jared Kobos

Writer Kapitel 03 (Arbeiten mit Text)

Buchtitel Writer Handbuch
Kapitel Kapitel 03 - Arbeiten mit Text
Mitwirkende

Erhardt Balthasar
Klaus-Jürgen Weghorn (k-j)
Andreas Gärtner

englisches Original

John M. Długosz
Ron Faile Jr.
Hal Parker

OpenOffice.org Original

Jean Hollis Weber
Agnes Belzunce
Daniel Carrera
Peter Hillier-Brook
Laurent Duperval
Katharina Greif
Michael Kotsarinis
Peter Kupfer
Iain Roberts
Gary Schnabl
Barbara M. Tobias
Michele Zarri
Sharon Whiston

Writer Anhang A (Tastaturkürzel)

Buchtitel Writer Handbuch
Kapitel Anhang A Tastaturkürzel
Mitwirkende

Erhardt Balthasar
Jochen Schiffers
Klaus-Jürgen Weghorn (k-j)

englisches Original

Ron Faile Jr.
Barbara Duprey

OpenOffice.org Original

Magnus Adielsson
Peter Hillier-Brook
Peter Kupfer
Jean Hollis Weber
Michele Zarri
Alexander Noël Dunne

Calc Handbuch

Calc Kapitel 01 (Einführung in Calc)

Buchtitel Calc Handbuch
Kapitel Kapitel 01 - Einführung in Calc
Mitwirkende

Erhardt Balthasar
Klaus-Jürgen Weghorn (k-j)
Andreas Gärtner

englisches Original

Barbara Duprey
Hal Parker

OpenOffice.org Original

Rick Barnes
Nicole Cairns
Peter Kupfer
Jean Hollis Weber
Krishna Aradhi
Andy Brown
Alexandre Martins
Anthony Petrillo
Gary Schnabl
Barbara M Tobias

Impress Handbuch

Impress Kapitel 01 (Einführung in Impress)

Buchtitel Impress Handbuch
Kapitel Kapitel 01 - Einführung in Impress
Mitwirkende

Klaus-Jürgen Weghorn (k-j)

englisches Original

Michele Zarri
T. Elliot Turner
Jean Hollis Weber
Chad D. Lines
Low Song Chuan
Muhammad Sufyan Zainalabidin
Jaimon Jacob

OpenOffice.org Original

Michele Zarri
Jean Hollis Weber
Dan Lewis
Agnes Belzunce
Peter Hillier-Brook
Gary Schnabl
Claire Wood
Rachel Kartch
Hazel Russman
Linda Worthington

Tim Kampa, Charles Fannan, and Dana Oliver, students in the Technical and Professional Writing Program at San Francisco State University, wrote a previous version of this document for OpenOffice.org 1.1 (copyright Tim Kampa).


Draw Handbuch

Draw Kapitel 01 (Einführung in Draw)

Buchtitel Draw Handbuch
Kapitel Kapitel 01 - Einführung in Draw
Mitwirkende

Klaus-Jürgen Weghorn (k-j)

englisches Original

Martin Fox
John Cleland
Jean Hollis Weber

OpenOffice.org Original

This chapter is based on an original French document written for OpenOffice.org 1.x by Michel Pinquier (translated into English by Alex Thurgood) and previous content revised by Jim Taylor. The chapter was revised for OpenOffice.org 2.0 by Linda Worthington, Daniel Carrera, Jean Hollis Weber, and Agnes Belzunce, and later translated into German by Wolfgang Uhlig. The German revisions were then translated into English and revised for OpenOffice.org 3.3 and LibreOffice 3.3 by Martin Fox. Other contributors included Peter Hillier-Brook, Hazel Russman, Gary Schnabl, and Claire Wood.

Bewertung des Konzeptes bzw. der Vorgehensweise

Vorteile

Nachteile

Schätzung des Arbeitsaufwandes

Nr. Arbeitsschritt Zeitaufwand Bemerkungen Kommentare (mit Namen)
1 englisches Original-ODT besorgen kurz
2 Originaltext ins Wiki stellen 1 Stunde pro Kapitel
  • Workaround vorhanden (s.u.)
3 Übersetzen der Abschnitte ca. 5-30 min/Abschnitt Nino: ist mir zu feingranuliert, ich verliere den Überblick
Jochen: finde Farblösung ideal, gebe aber zu, dass "Farbspiel" und Aufteilung persönliche Geschmacksache sind. Vorschlag: Personen, die damit nicht zurecht kommen, übersetzen separat und posten Text an de-discuss-ML oder per PM an Personen, die den Text im Wiki einpfelgen.
Kü: @Nino: Halte ich nicht für sinnvoll. Besser mehrere Abschnitte in Folge mit Template versehen und dann auf einmal abarbeiten (aber auch in überschaubarer Zeit (einige Stunden) dann erledigen).
4 Korrekturlesen 1 5-20 Minuten pro Abschnitt
  • Originaltext auskommentieren
Jochen: 5 Minunten bei einem einfachen Sachverhalt bzw. 20 Minunten bei einem schwierigen Sachverhalt.
5 Korrekturlesen 2 5-10 Minunten pro Abschnitt
6 Abschließen der Übersetzung
  • Fertigstellung hier vermerken
  • E-Mail an Mailingliste
Hm, was ist denn damit gemeint? Ich habe auf der Mailingliste gefragt, ob die Übersetzung fertig ist und als ich da ein "Ja" hörte, habe ich damit angefangen, den Text in die .odt-Vorlage zu kopieren.
Genau das: Ob wir sozusagen "explizite Freigabebedingungen zum Übertragen" festlegen wollen, etwa (Vorschlag): "Wenn alle Abschnitte grün sind, kann mit der Übertragung begonnen werden". Dann kann die Kommunikation in der Liste auf die Mitteilung "Kapitel X: Übertragung begonnen" reduziert werden, eine Rückfrage ist quasi nicht mehr nötig. (Hintergedanke: Je expliziter wir die Prozesse festlegen, und je simpler diese Festlegungen sind, desto flüssiger läuft der Gesamtprozess)
Nino 2011-07-04T14:26:18 (CEST)
7 Vorbereiten des ODT aus Vorlage 5 Minuten
  • E-Mail an Mailingliste
  • Beginn hier vermerken
  • Vorlage öffnen, Eigenschaften bearbeiten, abspeichern
  • Auf ODF-Authors hochladen, um Eintrag zu erstellen
8 Übertragen der übersetzten Abschnitte ins ODT ca. 5 Minuten pro Abschnitt
  • Text abschnittsweise als unformatierten Text einfügen
Ich hab das beim Kapitel 3 jetzt mal "auf einmal" versucht, also nicht Abschnitt für Abschnitt, sondern die gesamte Wikiseite auf einemal markiert und ins Dokument gepastet. Das ging im Prinzip gut, aber ich weiss nicht, wie empfehlenswert das ist, kann mich auch nicht mehr erinnern, ob dabei was zu beachten ist (ich habs einfach "unbewusst" so gemacht, ohne deine Vorgehensweise hier im Einzelnen durchgelesen zu haben). Bestimmt bringt Christian noch eine weitere Variante ein ;-)
Nino 2011-07-04T14:26:18 (CEST)
9 Screenshots erstellen und einfügen mit Bildbeschriftungen ca. 10 - 15 Minuten pro Bild
  • Hinweise für Screenshots beachten
Hängt davon ab, wie aufwändig das Bild nachbearbeitet werden muss (Pfeile einfügen um auf spezielle Icons hinzuweisen, usw.)
10 Reviewrunde in ODFAuthors 1 - (viele) Stunden Hängt davon ab, wie umfangreich das Dokument ist, wie intensiv man sich damit beschäftigt und wie gut das Dokument schon vorbereitet ist.
11 PDF-Erstellung und Veröffentlichung 30 Minuten
  • Datum setzen
  • PDF erstellen
  • ODT und PDF nach ODFAuthors in Sektion "Veröffentlicht" hochladen
  • ODT und PDF ins Wiki hochladen
  • Wiki mit Dateien verknüpfen (hier)
  • Auf der LibreOffice Webseite Links einfügen


Ideen und Verbesserungsvorschläge

Generell

Klärung, wie am besten ein odf-Dokument für Alle bearbeitbar im Netz eingestellt werden kann

Verworfen wurden folgende Ideen:

Nino Novak (20.06.2011)

Stefan Haas (20.06.20011)

Ich würde bei der Wiki-Erstellung folgende Änderung vorschlagen:

Kommentar:


Friedrich Strohmaier (23.06.20011)

Mich hat die Frage beschäftigt, wie man den Export nach odt einfach halten und gleichzeitig mit wenig Aufwand die übersetzte Wikiseite als Onlineversion des Handbuchs stehen lassen kann. Ist doch eigentlich schade drum, wenn die getane Arbeit dafür nicht genutzt werden kann.

Ich habe es auf folgende Weise versucht und den Wikitext - äh - versachlicht: http://wiki.documentfoundation.org/index.php?title=DE/Doku/Allgemein/01_Einf%C3%BChrung&oldid=27376

Antwort von Jochen:
IMHO ist Deine Idee sehr gut.
Das Einzige, was ich anders machen würde, wäre Folgendes: Die von Dir "gelöschte" Tabellenstruktur (Einsteller des englischen Originaltextes, Übersetzer etc.) hat zwei Ziele:

IMHO ist die Struktur (fast) genial und sollte weiter so behalten werden. Ich denke hier v.a. an Anpassung der Handbücher an kommende LO-Versionen. Mein Vorschlag ist:

Dies klingt Alles kompliziert. Ist es vielleicht auch. Aber dass die Erstellung von (deutschsprachigen) Handbüchern nicht einfach ist, hat ja die diesbezügliche ausführliche Diskussion auf dieser ML gezeigt. IMHO haben wir jetzt einen Weg gefunden, die Erstellung von (deutschsprachigen) Handbüchern zu realisieren und zwar so, dass 1) "jeder" mitmachen kann, 2) häppchenweise vorgegangen werden kann - sowohl die Übersetzung als auch die Implementierung in ODFAuthor und 3) ein völlige Transparenz vorliegt.

Sigrid Carrera (20.06.2011)

Wollen wir die fertigen Dokumente im Wiki haben? Also als "Wiki-Text" nicht nur als verlinktes odt- oder pdf-Dokument? Ich erinnere mich, dass die englische Gruppe für OOo das versucht hat, hat aber wieder damit aufgehört, weil es doch sehr aufwändig ist. Meine Meinung ist daher:


Andreas Mantke (23.06.2011)

Wenn tatsächlich alle gemeinsam an einem Dokument arbeiten wollten (glaube ich erst, wenn ich es sehe ;-), dann geht so etwas nach meiner Kenntnis nur mit einem etherpad (oder Derivat). Zum Ausprobieren gibt es da Installationen im Netz. Sofern das wirklich das Tool der Wahl sein sollte, müsste ein Admin das auf einer TDF-Resource aufsetzen.


Jochen Schiffers (25.06.2011)

ich habe noch einen Vorschlag bzgl. der gemeinsamen Erstellung der Handbücher im odt-Format - und zwar: Dropbox. Ich benutze Dropbox für berufliche Zwecke genau das zu machen, über das wir diskutieren - nämlich gemeinsame Bearbeitung von Dokumenten über das Internet. Wenn jemand an einem Test Interesse hat, bitte mir Bescheid geben, damit ich das Dokument freigeben kann. Ich würde dann eine Einladung versenden. Hinweis: ein Account bei Dropbox ist nötig. Dieser ist bis 2 GB kostenlos und kann bis 8 GB durch Einladungen erhöht werden.

Kommentar von Erich Christian:

Kommentar von Stefan Haas:


Personal tools
Namespaces
Variants
Actions
Wiki
Navigation
Toolbox
donate