User:Nnino/ODT2Wiki

From Apache OpenOffice Wiki
< User:Nnino
Revision as of 23:04, 23 February 2010 by Nnino (Talk | contribs)

Jump to: navigation, search

Best Practice on Wikifying ODT Documents (here especially: Writer Guide)

Lessons learned from the Englisch Doc-Project:

  • Use of Wiki-Templates for chapter-internal Navigation: The English Templates had to be localized, the localized (DE-) versions are located under Template:DE/Documentation/Writer...TOC (see first 17 entries of this listing)

For me, the following best practice emerged after some trying:

  1. Open ODT-Document
  2. Export all graphics manually
    • Right click on image -> Save -> enter Name manually (e.g. a1 for graphics no. 1, "a" stands for "Abbildung")
    • alternatively graphics from unzipped ODT folder could be used but for me identifying every image took too long time
  3. Upload images (very helpful: MultipleUpload Wiki Extension)
  4. Export Text with help of MediaWiki Extension (Export ... File Type "Mediawiki (*.txt)")
  5. Manual Revision of the exported Text
    • Mostly, some of the titles had a strange wiki markup which had to be adjusted (e.g. a picture link was inserted into the title instead of thereafter), so I first went through the whole title hierarchy
    • many numbered lists were broken by the filter, they had to be adjusted manually
    • Cautions, Tips, and Notes had to be transformed into wiki markup: the english Templates Template:Documentation/Note, /Tip, /Caution) were used, very helpful for this purpose was TJFrazier's OOoBasic-Macro
    • Enter image names into "Image"-Links with the following Regex (my naming was g1.png, g2.png etc.)
      Search for:Image:\|thumb\|( *'* *Abbildung *)(\d+):
      Replace by:Image:a\2.png|thumb|none|500px|\1\2:

      (where "Abbildung" is the German term for "Image")
    • Adjust "internal" References to other sections (making them clickable links)
  6. Create Chapter-Navigation-Template from Chapter titles (I simply used grep "^=" for extracting all headings)
  7. Create Wikipages for every subchapter (all at once in different firefox tabs) and insert Template call markup into the Pages (copy & paste into every created Page)
  8. Adjust Template calls
    • enter correct Page Name - if using {{DISPLAYTITLE:{{SUBPAGENAME}}}} should do it in most cases
    • enter next/previous Page names
    • enter interwiki link to other language versions of the Page
  9. Enter Chapter text from the .txt file, preview, last fine tuning if necessary
  10. Save Page

Vorgehen beim Übertragen von ODT-Dokumenten (hier auch speziell: des Writer-Handbuches) ins Wiki

Da die englische Doku von OOoAuthors bereits großteils in Wiki-Form vorlag, konnte auf die dabei gemachten Erfahrungen und Vorgehensweisen zurückgegriffen werden. Zum Beispiel die Verwendung von Wiki-Templates für die Kapitel-interne Navigation: Die englischen Templates mussten dabei nur "eingedeutscht" werden und liegen alle unter Template:DE/Documentation/Writer...TOC (siehe die ersten 17 Einträge dieser Liste)

Folgende best practice hat sich nach ein paar Kapiteln herausgeschält:

  1. ODT-Dokument öffnen
  2. sämtliche Bilder manuell exportieren
    • Rechtsklick aufs Bild -> Grafik speichern, Name manuell eintragen (etwa a1 für Abbildung 1)
    • alternativ könnte man auch die Grafiken aus dem entzippten ODT nutzen, das mag bei wenigen Bilder gehen, bei mir ist es bei Kapiteln mit vielen Bildern jedoch deutlich langsamer gegangen, da ich die Bilder erst mal identifizieren musste, um sie dann nach Bedarf umzubenennen.
  3. die Bilder hochladen (Sehr hilfreich: die Extension MultipleUpload)
  4. den Text exportieren
    • mithilfe des eingebauten MediaWiki-Exportfilters unter Exportieren... Dateityp Mediawiki (*.txt)
  5. Text-Export nachbearbeiten
    • In der Regel waren jedes Mal einige Überschriften nicht korrekt gekennzeichnet (etwa weil Bilder darin vorkamen oder vermutlich Absatzformatierungen den Filter irritiert haben), so dass ich in der Regel die gesamte Überschriften-Hierarchie durchgegangen bin
    • auch viele Anleitungslisten (nummerierte Listen) hat der Filter zerschossen, sie mussten daher repariert werden
    • Wandeln der Anmerkungen- / Tipps- / Achtung-Kästchen ins Wikiformat (dafür gibt es die englischen Templates Template:Documentation/Note, /Tip, /Caution) mithilfe des OOoBasic-Macros von TJFrazier
    • Eintragen der Abbildungsnamen in die jeweiligen "Image"-Links mit folgender Regex (ich habe die Bilder immer a1.png, a2.png usw. benannt)
      Suche nach:Image:\|thumb\|( *'* *Abbildung *)(\d+):
      Ersetze durch:Image:a\2.png|thumb|none|500px|\1\2:
    • Anpassen der "internen" Verweise auf andere Kapitel
  6. Erzeugen des Kapitel-Navigations-Templates aus den Kapitel-Überschriften
  7. Anlegen der Wikiseiten für jedes Unterkapitel und Einfügen des Template-Aufrufs für das Navigationstemplate in die Seiten
  8. Anpassen der Template-Aufrufe
    • Eintragen der korrekten Seitennamen, der jew. Vorgänger- und Nachfolger-Seite sowie des Interwiki-Links zur englischen Sprachversion
  9. Einfügen des Kapiteltextes aus der .txt-Datei, Vorschau, ggf. Feinpolitur
  10. Abspeichern der Kapitel
Personal tools