Code Styling Project » WordPress Plugin: Codestyling Localization

WordPress Plugin: Codestyling Localization

WordPress Version:	WordPress 2.5 oder höher
PHP Version:	PHP 4.4.2 oder höher
getestete Browser:	IE \| FireFox \| Opera \| Safari \| Google Chrome
nicht unterstützte Browser:	derzeit keine bekannt

Wenn man sich mit WordPress näher beschäftigt, fällt einem auf, das man im Auslieferungszustand alles in englisch bekommt. Um WordPress an seine eigene Muttersprache anzupassen, kann man WordPress Sprachdateien zur Verfügung stellen. Diese werden dann dazu benutzt, die in englisch vorgegebenen Textfragmente während der Seitenerzeugung zu ersetzen.
Diese Übersetzungfähigkeiten basieren auf der Verwendung der gettext Funktionalität, die in sehr vielen Open Source Projekten zum Einsatz kommt. Die Grundlagen zum gettext System können unter Free Software Foundation (FSF) - GNU Project - gettext nachgelesen werden.

Die Basis bilden sogenannte Sprachdateien im *.po Format (portable) bzw. *.mo Format (machine object), mit deren Hilfe sich Systeme automatisch lokalisieren lassen.
Die *.po Dateien sind reines Textformat, die einer speziellen Spezifikation unterliegen, maschinell ausgewertet und übersetzt werden können. Normalerweise benutzt man dazu entweder einen Texteditor oder einen speziell dafür vorgesehen Editor wie PoEdit, den man lokal installieren muss. Mit Hilfe eines solchen Editors kann die *.po Datei übersetzt und als *.mo Datei abgespeichert werden. Alle auf gettext beruhenden Systeme können im Live-Betrieb nur mit der *.mo Datei umgehen.

Mir persönlich war jedoch der Aufwand, den man betreiben muss, um zum Beispiel ein Plugin zu lokalisieren, viel zu hoch. Denn man benötigt das Plugin auf dem lokalen Rechner und den installierten PoEditor. Man übersetzt dann die Fragmente, muss eine Datei erzeugen und diese dann auf die Domain hochladen. Nach Ansicht stellt man dann fest, das etwas nicht stimmt, muss den Fehler mühevoll suchen, neu übersetzen und dann erneut hochladen.

Dieser sich wiederholende Vorgang ist kontraproduktiv und zeitraubend, deswegen habe ich eine Lösung geschaffen, dies online in der Administrationsoberfläche von WordPress machen zu können ohne einen speziellen Editor zu benötigen. Dies hat auch noch den Vorteil, dass man das Ergebnis mit dem Browser (in einem neuen Tab) bereits begutachten kann und sofortige Kontrolle hat.

Die Plugin Hauptseite - der Einstieg

Wenn man das Plugin installiert und aktiviert hat, bekommt man einen neuen Eintrag im Menüpunkt “Verwalten” der mit “Lokalsierung” beschriftet ist. Wenn man diesen Unterpunkt auswählt, erscheint die komplette Übersicht über alle Komponenten von WordPress, die gettext fähig sind bzw. schon Sprachdateien mitbringen.
Das Plugin untersucht WordPress selbst, alle vorhandenen Plugins und ebenfalls alle vorhanden Themes auf deren gettext Fähigkeit. Es werden nur die Teile aufgelistet, die nach Analyse auch gettext Übersetzungen verstehen.

Man kann dann pro analysierter Komponente (WP | Plugin | Theme) mehrere angebotene Aktionen durchführen. Sollte die Komponente bereits Sprachdateien besitzen, werden die bereits gefundenen Sprachen aufgelistet. Weiß gekennzeichnete Dateien sind nicht vorhanden ist.
Kennzeichnungen in rot symbolisieren, dass diese Datei Lese-Zugriff erlaubt und somit schreibgeschützt ist.
Dateien in grüner Farbe symbolisieren, dass die Datei gelesen und geschrieben werden kann.
Die schreibgeschützten Dateien können durch eine Klick auf das rote Symbol schreibfähig gemacht werden. Dies geschieht stufenweise. Es wird erst versucht die Berechtigungen auf rw-/r–/r– zu setzen. Falls dies zum Schreiben nicht reicht, wird erst rw-/rw-/r– und schliesslich rw-/rw-/rw- versucht. Sollte dies alles nicht funktionieren, bekommt man eine Fehlermeldung. Diese Funktion steht nur für schreibgeschützte Dateien zur Verfügung.

Die Plugin Hauptseite - Neue Sprache hinzufügen

Steht die gewünschte Sprache noch nicht zur Verfügung, kann man sie sehr einfach hinzufügen. Es öffnet sich ein Dialog, der alle unterstützten Sprachen auflistet und bereits existierende Sprachen ausblendet. Nach Eingabe der Übersetzer-Kennzeichnung (wird standardmäßig vom angemeldeten Benutzer genommen und vorausgefüllt) und der Auswahl der Sprache wird eine neue *.po Datei im entsprechenden Ordner erstellt. Die Sprache erscheint dann in der Auflistung und kann weiter bearbeitet werden. Die neu erstellte *.po Datei enthält allerdings noch keine Textfragmente sondern ist bis auf den korrekt erstellten Datei-Header leer.

Die Plugin Hauptseite - Einlesen der PHP Quelldateien

Um übersetzbare Textfragmente der entsprechenden Komponente zu bekommen, müssen erst einmal die zu Grunde liegenden PHP Dateien analysiert werden, wie man es vom PoEditor her kennt. Jedoch führt das Plugin eine intelligente Suche durch, die nur die tatsächlich betroffenen Dateien einliest und untersucht.

Wenn man zum Beispiel WordPress selbst neu einlesen lassen möchte, dann bekommt man beim PoEditor auch alle bereits installierten Themes und Plugins mit die Sprachdatei aufgenommen. Nicht so hier: Im Falle von WordPress selbst werden die Theme und Plugin Ordner ausgelassen und nur Akismet und die im Lieferumfang enthaltenen Basisthemes mit gelesen. Somit ist sichergestellt, das auch nur WordPress spezifische Texte aufgenommen werden und nicht noch zusätzliche, die ein Plugin XY enthält.

Dieser Vorgang kann einige Sekunden bis Minuten dauern, je nach Anzahl der Dateien oder der Geschwindigkeit der Verbindung. Der Fortschritt wird dabei visuell dokumentiert bis alles eingelesen ist. Nach erfolgreichem Einlesen enthält nun die *.po Datei alle gefunden Textfragmente, die durch die gettext Funktionalität übersetzbar sind. Führt man den Einlesevorgang auf einer existierenden *.po Datei aus, wird deren bisheriger Inhalt mit den neu gefunden Fragmenten abgeglichen und geupdated. Anschließend ist die Datei dann auf dem neuesten Stand.

Die Plugin Hauptseite - Löschen einer Sprache

Löschen einer Sprache bedeutet auch wirklich physikalisches Löschen! Deshalb wird eine Sicherheitsabfrage per Dialog erscheinen, die bestätigt werden muss. Nach Bestätigung wird die ausgewählte *.po und *.mo Datei vom Datenträger entfernt. Man kann jedoch diesen Dialog oben recht abbrechen, wenn man irrtümlich auf Löschen geklickt hat.

Die Plugin Hauptseite - Starten des Übersetzungseditors

Wenn man auf “Bearbeiten” der entsprechenden Sprache klickt, wird die Ansicht in den Übersetzungseditors umgeschaltet. Dieser eingebaute Editor ermöglicht die Anpassung und Übersetzung der Textfragmente und die Erzeugung der passenden *.mo Datei.

Der Übersetzungseditor

Der Editor ist so komfortabel wie möglich ausgelegt und erlaubt die Bearbeitung der kompletten Sprachdatei. Nach dem Start zeigt der Editor standardmäßig die ersten 100 Einträge der *.po Datei an. Sowohl die Anzahl der pro Seite anzuzeigenden Einträge als auch die Seite selbst können einfach eingestellt werden.

Jeder Eintrag der Sprachdatei wird in einer Zeile dargestellt. Die linke Spalte stellt maximal 2 Informationen bereit:

PHP Symbol - zeigt die Referenzstellen im PHP Code an und öffnet die entsprechende Datei zur Ansicht
Kommentar Symbol - falls es in der *.po Datei einen Kommentar zum Eintrag gibt, wird der angezeigt.

Die folgenden beiden Spalten zeigen den Originaltext bzw. den übersetzten Text an. Die letzte Spalte enthält alle angebotenen Aktionen, derzeit ist nur “Bearbeiten” verfügbar.
Wenn man einen Eintrag zur Bearbeitung auswählt, öffnet sich einer von 2 möglichen Bearbeitungsdialogen. Die gettext Funktionalität unterstützt einerseits einfache Texte, für die es eine 1:1 Beziehung zwischen Original und Übersetzung gibt. Andererseits werden aber auch Pluralformen unterstützt, die eine 2:n Beziehung haben. Die englische Basissprache kennt Einzahl und Mehrzahl. Es gibt aber Zielsprachen, die anhand einer gegebenen Anzahl nicht nur zwischen Einzahl und Mehrzahl unterscheiden, sondern entweder Mehrzahl gar nicht kennen (2:1) oder aber je nach Zahl bis zu 4 Varianten benutzen (2:4). Deshalb wird dafür auch ein spezieller Plural Dialog gezeigt, der die zu Grunde liegende Formel mit anzeigt.

Wie man in den Screenshots der Dialoge bereits sieht, ist auch eine Übersetzung per Google Translate API eingebaut, die jedoch nur dann eingeblendet wird, wenn die entsprechenden Zielsprache auch von Google unterstützt wird. Klickt man auf den Link, wird der Originaltext per Google Translate API übersetzt und im Übersetzungsfeld eingetragen. Dies sollte man als Vorschlag sehen, denn er ist in den meisten Fällen nachzubearbeiten.

Obwohl Google Translate die enthaltenen HTML Tags während der Übersetzung nicht antastet, kommt es sehr oft vor, dass Google Translate Formatierer wie %s auseinanderreist und ein Leerzeichen einfügt. Dies gefährdet aber die Verwendung in WordPress, da dies nicht korrekt von Formatierungsfunktionen benutzt werden kann, die noch Parameter in den Text während der Ausgabe einfügen wollen. Gleiches gilt für mit Backslash maskierte Zeichen, bei denen es zu einer Vermehrung der Backslashes kommt. Beides sollte im Falle des Einsatzes kontrolliert werden.

Die beiden Suchfelder im Tabellenkopf durchsuchen die jeweilige Spalte nach einer exakten Übereinstimmung mit der Eingabe. Schon während des Eintippens reduziert sich der Umfang der angezeigten Einträge gemäß der Eingabe. Die Suche findet immer in allen Textfragmenten der Sprachdatei statt und listet somit alle Teffer auf.

Wenn man den Knopf “erstelle mo-Datei” drückt, wird die bisherige Übersetzung in einer entsprechenden *.mo Datei zusätzlich gespeichert. Eine schon vorhandene Datei wird dabei überschrieben. Der Editor zeigt im Erfolgsfall nun ein (neues) Änderungsdatum daneben an.
Wenn man jetzt einen neuen, zusätzlichen Tab im Browser mit dem zu übersetzenden Ziel öffnet, kann man bereits überprüfen, ob die Übersetzung korrekt greift. Dies ist sehr sinnvoll zu Kontrolle, ob die gewählte Übersetzung den verfügbaren Platz in der Breite “sprengt” und geändert werden müsste. Dies kann umgehend erfolgen und wieder kontrolliert werden.

Alle eingegebenen Übersetzungen werden bereits beim Betätigen des “Speichern” Knopfes in der *.po Datei abgelegt, sodass keine Änderungen verloren gehen. Somit kann man eine Übersetzung auch zu einem späteren Zeitpunkt einfach wieder fortsetzen.

Limitierungen

Das Plugin unterstützt momentan nur Sprachen, die in einer internen Definition erfasst sind. Dies hat den Hintergrund, sicherzustellen, dass die zur Sprache passende Pluralform automatisch gewählt oder angepasst wird. Es werden auch nur Sprachdateien unterstützt, die sowohl Sprach- als auch Landeskennung enthalten (locale) und dem Format xx_XX entsprechen. Demzufolge funktionieren beispielsweise Sprachdateien mit diesen Kennungen nicht:

sitemap-ja.po
sitemap-ja_JA.UTF-8.po
sitemap-ja_SJIS.po

Dies wird erst in nachfolgenden Versionen des Plugins eine Unterstützung finden.

Ebenfalls problematisch sind Plugins, die noch keine Sprachdatei besitzen und zusätzlich ihre Sprachdateien in einem Unterordner erwarten. Dies kann nicht automatisch erkannt werden und erfordert das Hochladen einer leeren *.po Datei in den entsprechenden Pfad. Sobald eine Sprachdatei existiert, wird der korrekte Pfad daraus abgeleitet und weitere Sprachen korrekt dort abgelegt. Auch dies soll in einer der nächsten Versionen durch eine Auswahl des Ordners während der Erstellung der Sprachdatei ergänzt werden.

Bei einigen Plugins ist auch die Textdomain nicht ohne weiteres zu erkennen, denn diese wurde dann weder als Text noch als Konstante sondern als Funktion oder Variable codiert. Dies lässt sich nicht maschinell auswerten. In diesen Fällen wird derzeit angenommen, das die Sprachdatei so heißt, wie die Plugin-Datei, die WordPress kennt (nur ohne .php) und wird im Pluginordner direkt erzeugt. Hierfür gibt es derzeit noch keine Alternative.

Installation

Entpacke das Plugin nach dem Download und lade den kompletten Ordner csp-po-edit also Unterordner in /wp-content/plugins/ hoch. In der Administrationsoberfläche steht nun unter der Menüpunkt “Plugins” das neue Plugin Codestyling Localization zur Aktivierung bereit.
Während der Aktivierung prüft das Plugin, ob die erforderliche WordPress bzw. PHP Version vorhanden ist. Wenn mindestens einer der Tests fehlschlägt, lässt sich das Plugin nicht aktivieren und meldet das mit korrekten Angaben wie im Screenshot zu sehen ist.

Das Plugin benötigt keine weitere Konfiguration, legt auch keine neuen Tabellen an und kommt ganz ohne eigene Werte in der wp_option Tabelle aus.

Versionshistorie

2008-06-21	0.10	start of coding
2008-08-25	0.95	Beta Release (1st closed test)
2008-08-26	0.96	Beta Release (2nd closed test) Valid XHTML 1.0 Transitional switching to editor now shows loading indicator
2008-08-27	0.97	Beta Release (3rd closed test) Bugfix: simple plugin analysis runs recursive over total plugin path Bugfix: language file naming convention was wrong Bugfix: missing escapement of names breaks javascript Bugfix: avoid deprecated constant usage Bugfix: fix table size avoid using full screen width at adminimize plugin
2008-08-28	0.98	RC1 release extended to use Google translate API
2008-08-30	0.99	RC2 release Bugfix: remove accidentally usage of global $file, breaks plugin and theme editor Bugfix: plugins, that are gettext ready but textdomain can’t be detected, will be handled with their plugin filename as textdomain by default plugin activation checks now required versions (WordPress / PHP) and reports qualified messages at fail case
2008-09-02	1.0	1st public release Bugfix: version control has been done too strictly, WP 2.6.0 doesn’t exist, reduced to 2.6 Bugfix: locale definitions accidentally states, that zu_ZU (isiZulu) will be supported by Google translate, disabled
2008-09-03	1.01	release Bugfix: potential modified plugin path using constants has not been respected
2008-09-05	1.02	release Feature: downgrade code, runs now with WordPress 2.5 and above
2008-09-07	1.1	release Bugfix: backslahed po-file header values causes IE to stop reponding during editor launch Bugfix: special path detection doesn’t recognize deep folder structure related textdomain loading Bugfix: stylesheet doesn’t show file/comment tooltip inside visble client area Bugfix: scrolling to source line number fails with script error, if .po file is outdated and line exceeds total count Feature: “X-Poedit-Basepath” and “X-Poedit-SearchPath-0″ at .po file header will be relativized during read Feature: now supports file permission display and change capability Feature: collects multiple plugins at same textdomain as childs at first occurance Feature: show error message using thickbox instead of alert() except Google Translate errors
2008-09-11	1.2	release published at wordpress.org/extend/plugins/
2008-09-11	1.21	release Bugfix: stylesheet now only gets loaded at plugins pages, backward compatibility support has broken thickbox styles at other pages Italian translation by Gianni has been added
2008-09-14	1.30	release Feature: supports now PHP 4, tested with PHP 4.4.2 and higher Feature: provides a copy action at each row, that makes original persistent as translation
2008-09-15	1.51	release Feature: language attached, Traditional Chinese Taiwan by Gary SVN version number fix
2008-09-23	1.55	release Bugfix: WordPress 2.7-hemorrhage introduces WP_ADMIN set additional during DOING_AJAX (ajax requests)
2008-12-02	1.60	release Bugfix: CSS style at WP 2.7 has been changed, minor adaption to be able to display dialogs correctly Bugfix: empty WordPress main language directory forces new file creation at wrong folder Bugfix: none existing WordPress main languages directories (US version) leads to error display Bugfix: prevent directory listing of plugin by .htaccess file attached to package Feature: none existing WordPress main languages directory can be created by plugin Feature: WPMU plugin support, detection of normal and WPMU version and ability to translate mu-plugins
2008-12-08	1.65	release Bugfix: einscannen von WPMU Plugins produzierte Warnungen in des Ausgabe Bugfix: verschiedene Plugins/Themes wurden nicht erkannt, weil Leerzeichen im Funktionsaufruf enthalten sind Bugfix: falsch benannte oder positionierte Sprachdateien wurden angezeigt, konnten aber nicht bearbeitet werden Feature: erste Integration in das WordPress 2.7 Hilfe System, um Plugin spezifische Hilfen anzubieten Feature: anzeigen des neuen Tools Icon von WordPress 2.7 in der Pluginseiten-Kopfzeile

aktueller Download

Wichtiger Hinweis: Mit der Version 1.2 des Plugins hat sich durch die Veröffentlichung über wordpress.org und dem Autoupdate der Ordner des Plugins ändern müssen. Bitte das alte Plugin < v1.2 deaktivieren, den Ordner entfernen und das neue einspielen. Von diesem Zeitpunkt an funktionieren dann auch die automatischen Updates!

Plugin Version: codestyling-localization-v1.99.25.zip (12599 downloads)

Support

Es ist zukünftig geplant, ein Bug-Trac einzurichten und ggf. ein Benutzerforum zu betreiben. Aus Zeitgründen kann ich beides noch nicht zur Verfügung stellen. Deshalb ist Support derzeit exklusiv per E-Mail möglich (sofern nötig), kann aber etwas Verzögerung in der Antwortzeit haben.

Hinweis: Weil immer mal wieder Frage auftauchen, warum der Plugin die Textdomain nicht erkennt, dies liegt meistens daran, dass sie als Variable benutzt wird. Wenn man das als Konstante definiert und verwendet, findet sie der Parser auch. Beispiel:

PHP
1
define('MEINE_TEXTDOMAIN', 'meins');
timing: 0.028s

PHP
1	define('MEINE_TEXTDOMAIN', 'meins');
timing: 0.028s

261 Antworten Schreib einen Kommentar

Oliver Schlöbe

31.08.2008 | 20:07

Sehr sehr schön.

Bei getesteten Browsern kannst du FF 3.0.1 hinzufügen, auch da läuft es wie am Schnürchen.

Planst du, es auf http://wordpress.org/extend/plugins/ zu setzen? Damit hast du ein größeres Publikum, nette SVN-Features und es würde auch über die autom. Plugin-Aktualisierung updatebar sein.

Grüße, Oli

PHP
1	load_theme_textdomain('theme-name',TEMPLATEPATH . '/lang');
timing: 0.029s

PHP
1	'<strong>Pages:</strong> ', 'after' => '', 'next_or_number' => 'number')); ?>
timing: 0.034s

PHP
1	'<strong>'(__('Pages:', 'textdomain'))'</strong> ', 'after' => '', 'next_or_number' => 'number')); ?>
timing: 0.028s

PHP
1	'<strong>' . __('Pages:', 'textdomain') . '</strong> ', 'after' => '', 'next_or_number' => 'number')); ?>
timing: 0.028s

PHP
1	add_action('init', create_function('', 'load_plugin_textdomain(\'cforms\');') );
timing: 0.031s

PHP
1 2	$flutter_domain = 'flutter'; load_plugin_textdomain($flutter_domain, '/'.PLUGINDIR.'/'.dirname(plugin_basename(__FILE__)).'/languajes', basename(dirname(__FILE__)).'/languages');
timing: 0.032s

PHP
1 2 3 4 5	</head> ... <?php load_theme_textdomain("st09"); ?> <?php wp_head(); ?> </head>
timing: 0.031s

PHP
1 2 3 4	/* Text Domain: die-text-domain Domain Path: /language-file-folder */
timing: 0.038s

PHP
1 2	// Load theme textdomain load_theme_textdomain(YHL, TEMPLATEPATH.'/languages');
timing: 0.033s

PHP
1 2 3	load_plugin_textdomain(PLUGINNAME, LANGUAGEDIR);
timing: 0.040s

PHP
1	define('FLUTTER_TEXTDOMAIN', 'flutter');
timing: 0.030s

PHP
1	<h2><?php _e('Suche:','st09') ?></h2>
timing: 0.030s

PHP
1	define ('WPLANG', 'de_AT');
timing: 0.031s

PHP
1	load_plugin_textdomain('meine_frei_erfundene_textdomain', false, 'myplugin/languages')
timing: 0.033s

PHP
1 2 3 4 5 6	//vorher echo "Dies ist ein Text der im Plugin steht" //nachher echo __("Dies ist ein Text der im Plugin steht");
timing: 0.040s

PHP
1 2	// Prototype breaks dragging and dropping, I need it gone wp_deregister_script( 'prototype' );
timing: 0.039s

WordPress Plugin: Codestyling Localization

Die Plugin Hauptseite - der Einstieg

Die Plugin Hauptseite - Neue Sprache hinzufügen

Die Plugin Hauptseite - Einlesen der PHP Quelldateien

Die Plugin Hauptseite - Löschen einer Sprache

Die Plugin Hauptseite - Starten des Übersetzungseditors

Der Übersetzungseditor

Limitierungen

Installation

Versionshistorie

aktueller Download

Support

261 Antworten Schreib einen Kommentar

Paul83

Paul83

Alexander

Alexander

jtoth

hussong

Cammino

Dieter

Dieter

Dieter

Thomas

Thomas

Thomas

Plew

jwqlb

Pete

Ferdi

Ferdi

Ferdi

Ferdi

Heike

Jost

21cdb

jwqlb

Arno Nyhm

21cdb

Ferdi

Sascha

Micha

Van

Jörg