Entwicklung/Codedoku - Versionsgeschichte

Following: /* Funktionsweise */

2015-09-15T09:53:01Z

Funktionsweise

← Nächstältere Version		Version vom 15. September 2015, 09:53 Uhr
Zeile 440:		Zeile 440:
	=== Funktionsweise ===		=== Funktionsweise ===

	Der OC-Code ist mehrsprachig und ~~frei~~ übersetzbar, mit Ausnahme		Der OC-Code ist mehrsprachig und vollständig übersetzbar, mit Ausnahme des Garmin-Download-Dialogs ({{Codepath2\|htdocs\|garmin.php}}), dessen untere Hälfte es teils nur in Englisch und teils in Deutsch und Englisch gibt (siehe {{Codepath\|htdocs/resource2/ocstyle/js/GarminDisplay.js}}).
	* der Benachrichtigungs-Emails, die es bislang nur in Deutsch gibt (-> http://redmine.opencaching.de/issues/141)
	* des Garmin-Download-Dialogs ({{Codepath2\|htdocs\|garmin.php}}), dessen untere Hälfte es nur in Deutsch und Englisch gibt (siehe {{Codepath\|htdocs/resource2/ocstyle/js/GarminDisplay.js}})~~; teils nur auf Englisch~~
	* der Fehler-Platzhalter für nicht darstellbare Bilder (-> http://redmine.opencaching.~~de/issues/184)~~

	Übersetzungen und Lokalisierungen befinden sich an folgender Stelle:		Übersetzungen und Lokalisierungen befinden sich an folgender Stelle:
	* {{Codepath\|htdocs/doc/sql/static-data/data.sql}}: Tabellen countries_list_default, helppages, languages, languages_list_default, search_ignore (z.Zt. nur Deutsch)~~, <u>sys_trans</u>~~, <u>sys_trans_text</u>		* {{Codepath\|htdocs/doc/sql/static-data/data.sql}}: Tabellen countries_list_default, helppages, languages, languages_list_default, search_ignore (z.Zt. nur Deutsch), <u>sys_trans_text</u>
	* {{Codepath\|htdocs/templates2/ocstyle/articles}}		* {{Codepath\|htdocs/templates2/ocstyle/articles}}
	* {{Codepath\|htdocs/config2/locale.inc.php}}		* {{Codepath\|htdocs/config2/locale.inc.php}}
	* ''htdocs/config2/settings.inc.php'': Städteauswahl für die kleine Cachekarte, domainabhängige Einstellungen		* ''htdocs/config2/settings.inc.php'': Städteauswahl für die kleine Cachekarte, domainabhängige Einstellungen
	* {{Codepath\|htdocs/lang/de/ocstyle/email}}~~, {{Codepath\|htdocs/util/notification}} und -{{Codepath\|htdocs/util/watchlist\|watchlist}}: lib1-Email-Templates für Benachrichtigungen, noch nicht übersetzbar~~		* {{Codepath\|htdocs/lang/de/ocstyle/email}}
	* {{Codepath\|htdocs/resource2/ocstyle/images/thumb}}~~, noch nicht übersetzbar~~		* {{Codepath\|htdocs/resource2/ocstyle/images/thumb}}
	~~(weitere bitte ergänzen)~~

Following: /* Stolperfallen */

2015-09-02T16:59:44Z

Stolperfallen

← Nächstältere Version		Version vom 2. September 2015, 16:59 Uhr
Zeile 479:		Zeile 479:

	Bei der Einbettung in JavaScript sind Texte zu escapen; dies geht mit dem Smarty-Modifizierer <code>escape=js</code>. Es gibt jedoch Spezialfälle in denen dies nicht im Template möglich ist; in dem Fall sind HTML-Entities (' " &) in data.sql ''doppelt'' zu escapen, z.B. ''Didn\\\'t find'' für den String ''Didn't find''. Das erste Escaping wird beim SQL-Import von data.sql aufgelöst, das zweite verhindet Kollissionen mit der JavaScript-Stringsyntax.		Bei der Einbettung in JavaScript sind Texte zu escapen; dies geht mit dem Smarty-Modifizierer <code>escape=js</code>. Es gibt jedoch Spezialfälle in denen dies nicht im Template möglich ist; in dem Fall sind HTML-Entities (' " &) in data.sql ''doppelt'' zu escapen, z.B. ''Didn\\\'t find'' für den String ''Didn't find''. Das erste Escaping wird beim SQL-Import von data.sql aufgelöst, das zweite verhindet Kollissionen mit der JavaScript-Stringsyntax.

			Beim Aufruf von <code>$translate->t(...)</code> muss der zu übersetzend String in ''einfachen'' Kochkommata (<nowiki>''</nowiki>) stehen. Doppelte Hochkommata würden von ''translate.php -> Quelltexte durchsuchen'' nicht erkannt.

	== Fehlerbehandlung ==		== Fehlerbehandlung ==

Following: /* Funktionsweise */ erg.

2015-08-27T17:22:04Z

Funktionsweise: erg.

← Nächstältere Version		Version vom 27. August 2015, 17:22 Uhr
Zeile 442:		Zeile 442:
	Der OC-Code ist mehrsprachig und frei übersetzbar, mit Ausnahme		Der OC-Code ist mehrsprachig und frei übersetzbar, mit Ausnahme
	* der Benachrichtigungs-Emails, die es bislang nur in Deutsch gibt (-> http://redmine.opencaching.de/issues/141)		* der Benachrichtigungs-Emails, die es bislang nur in Deutsch gibt (-> http://redmine.opencaching.de/issues/141)
	* des Garmin-Download-Dialogs ({{Codepath2\|htdocs\|garmin.php}}), dessen untere Hälfte es nur in Deutsch und Englisch gibt (siehe {{Codepath\|htdocs/resource2/ocstyle/js/GarminDisplay.js}})		* des Garmin-Download-Dialogs ({{Codepath2\|htdocs\|garmin.php}}), dessen untere Hälfte es nur in Deutsch und Englisch gibt (siehe {{Codepath\|htdocs/resource2/ocstyle/js/GarminDisplay.js}}); teils nur auf Englisch
	(~~weitere noch nicht lokalisierbare Module bitte ergänzen!~~)		* der Fehler-Platzhalter für nicht darstellbare Bilder (-> http://redmine.opencaching.de/issues/184)

			Übersetzungen und Lokalisierungen befinden sich an folgender Stelle:
			* {{Codepath\|htdocs/doc/sql/static-data/data.sql}}: Tabellen countries_list_default, helppages, languages, languages_list_default, search_ignore (z.Zt. nur Deutsch), <u>sys_trans</u>, <u>sys_trans_text</u>
			* {{Codepath\|htdocs/templates2/ocstyle/articles}}
			* {{Codepath\|htdocs/config2/locale.inc.php}}
			* ''htdocs/config2/settings.inc.php'': Städteauswahl für die kleine Cachekarte, domainabhängige Einstellungen
			* {{Codepath\|htdocs/lang/de/ocstyle/email}}, {{Codepath\|htdocs/util/notification}} und -{{Codepath\|htdocs/util/watchlist\|watchlist}}: lib1-Email-Templates für Benachrichtigungen, noch nicht übersetzbar
			* {{Codepath\|htdocs/resource2/ocstyle/images/thumb}}, noch nicht übersetzbar
			(weitere bitte ergänzen)

	Die ~~Lokalisierung~~ je nach gewählter Sprache erfolgt grundsätzlich mit folgenden Mechanismen:
			Die Übersetzung je nach gewählter Sprache erfolgt grundsätzlich mit folgenden Mechanismen:
	* In Templates über die Smarty-Tags <code>{t}English Text{/t}</code>. Hierbei können auch Variablen eingesetzt werden, z.B.		* In Templates über die Smarty-Tags <code>{t}English Text{/t}</code>. Hierbei können auch Variablen eingesetzt werden, z.B.
	*:<code>{t 1=$cachename 2=$username}The geocache %1 has been found by %2{/t}</code>		*:<code>{t 1=$cachename 2=$username}The geocache %1 has been found by %2{/t}</code>

Following: /* Stolperfallen */

2015-08-25T18:23:12Z

Stolperfallen

← Nächstältere Version		Version vom 25. August 2015, 18:23 Uhr
Zeile 467:		Zeile 467:
	Die Funktionen "Quelltext durchsuchen" und "IDs neu sortieren" im Übersetzungsinterface (translate.php) mit anschließendem Datenexport können umfangreichen Merge-Konflikten zur Folge haben. Nur verwenden wenn nötig und möglichst in Abstimmung mit anderen Entwicklern.		Die Funktionen "Quelltext durchsuchen" und "IDs neu sortieren" im Übersetzungsinterface (translate.php) mit anschließendem Datenexport können umfangreichen Merge-Konflikten zur Folge haben. Nur verwenden wenn nötig und möglichst in Abstimmung mit anderen Entwicklern.

	~~Bei der Einbettung~~ in ~~JavaScript sind ' und " ''doppelt'' zu escapen, z~~.B. ~~''Didn\\\'~~t ~~find'' für den String ''Didn'~~t ~~find''~~. ~~Das erste Escaping wird beim SQL-Import von data~~.~~sql aufgelöst, das zweite verhindet Kollissionen mit der JavaScript-Stringsyntax~~.		Satzzeichen sollten wann immer möglich in den übersetzten Texten enthalten sein. Beispielsweise müssen bei Französisch Leerzeichen von :;?! eingefügt werden. (Für Letzteres kann man alternativ auch <code>{t}#colonspace#{/t}</code> (in HTML) oder <code>{$opt.format.colonspace}</code> (in plain text) verwenden.)

	~~Satzzeichen sollten wann immer möglich~~ in ~~den übersetzten Texten enthalten sein. Beispielsweise müssen bei Französisch Leerzeichen von :~~;~~?! eingefügt werden. (Für Letzteres kann man alternativ auch~~ <code>~~{t}#colonspace#{/t}~~</code> (in HTML) ~~oder <code>{$opt~~.~~format~~.~~colonspace}</code> (in plain text) verwenden~~.)		Bei der Einbettung in JavaScript sind Texte zu escapen; dies geht mit dem Smarty-Modifizierer <code>escape=js</code>. Es gibt jedoch Spezialfälle in denen dies nicht im Template möglich ist; in dem Fall sind HTML-Entities (' " &) in data.sql ''doppelt'' zu escapen, z.B. ''Didn\\\'t find'' für den String ''Didn't find''. Das erste Escaping wird beim SQL-Import von data.sql aufgelöst, das zweite verhindet Kollissionen mit der JavaScript-Stringsyntax.

	== Fehlerbehandlung ==		== Fehlerbehandlung ==

Following: /* Übersetzung */ +Stolperfallen

2015-08-25T15:52:30Z

Übersetzung: +Stolperfallen

← Nächstältere Version		Version vom 25. August 2015, 15:52 Uhr
Zeile 438:		Zeile 438:

	== Übersetzung ==		== Übersetzung ==
			=== Funktionsweise ===

	Der OC-Code ist mehrsprachig und frei übersetzbar, mit Ausnahme		Der OC-Code ist mehrsprachig und frei übersetzbar, mit Ausnahme
Zeile 458:		Zeile 459:

	Opencaching.de gibt es zurzeit in Deutsch, Englisch, Italienisch und Spanisch; Französisch ist in Arbeit. Eine niederländische Übersetzung ist ansatzweise vorhanden (wer mag sie fertigstellen?). Die Übersetzungen werden durch den von Opencaching Deutschland eingesetzten Code Maintainer organisiert.		Opencaching.de gibt es zurzeit in Deutsch, Englisch, Italienisch und Spanisch; Französisch ist in Arbeit. Eine niederländische Übersetzung ist ansatzweise vorhanden (wer mag sie fertigstellen?). Die Übersetzungen werden durch den von Opencaching Deutschland eingesetzten Code Maintainer organisiert.

			=== Stolperfallen ===
			Vorsicht bei der Korrektur englischer Originaltexte, siehe oben.

			Die Text-Exportfunktionen im Übersetzungsinterface geben zurzeit die englischen Originale aus der Tabelle ''sys_trans'' aus, die teilweise veraltet sind. '''Dies sollte vor der nächsten Neuübersetzung unbedingt geändert werden.'''

			Die Funktionen "Quelltext durchsuchen" und "IDs neu sortieren" im Übersetzungsinterface (translate.php) mit anschließendem Datenexport können umfangreichen Merge-Konflikten zur Folge haben. Nur verwenden wenn nötig und möglichst in Abstimmung mit anderen Entwicklern.

			Bei der Einbettung in JavaScript sind ' und " ''doppelt'' zu escapen, z.B. ''Didn\\\'t find'' für den String ''Didn't find''. Das erste Escaping wird beim SQL-Import von data.sql aufgelöst, das zweite verhindet Kollissionen mit der JavaScript-Stringsyntax.

			Satzzeichen sollten wann immer möglich in den übersetzten Texten enthalten sein. Beispielsweise müssen bei Französisch Leerzeichen von :;?! eingefügt werden. (Für Letzteres kann man alternativ auch <code>{t}#colonspace#{/t}</code> (in HTML) oder <code>{$opt.format.colonspace}</code> (in plain text) verwenden.)

	== Fehlerbehandlung ==		== Fehlerbehandlung ==

Following: /* Fremdbibliotheken */

2015-08-07T11:54:38Z

Fremdbibliotheken

← Nächstältere Version		Version vom 7. August 2015, 11:54 Uhr
Zeile 81:		Zeile 81:
	* '''[http://htmlpurifier.org/ HTML Purifier]''' dient zum "Säubern" von HTML-Code, den der Benutzer z.B. in Cachebeschreibungen eingeben kann.Er wird (auch in lib1) über die lib2-Klasse ''OcHTMLPurifier'' eingebunden und kann dort angepasst werden.		* '''[http://htmlpurifier.org/ HTML Purifier]''' dient zum "Säubern" von HTML-Code, den der Benutzer z.B. in Cachebeschreibungen eingeben kann.Er wird (auch in lib1) über die lib2-Klasse ''OcHTMLPurifier'' eingebunden und kann dort angepasst werden.

	* '''[http://www.tinymce.com/ TinyMCE]''' ist ein leistungsfähiger JavaScript-Wysiwyg-Texteditor. Er dient zum Bearbeiten von Cachebeschreibungen, Logs und ~~Profiltexten~~. lib1 und lib2 verwenden beide die TinyMCE-Installation in {{Codepath\|htdocs/resource2/tinymce}}. OC-spezifische Konfigurationsdaten gibt es in {{Codepath2\|htdocs/resource2\|tinymce/config}}; außerdem wurden die Einstellunge in {{Codepath2\|htdocs/resource2\|tinymce/themes/advanced/langs}} angepasst. Damit Änderungen am TinyMCE-Source-Code wirksam werden, müssen u.U. die .gz-Cachedateien im tinymce-Verzeichnis gelöscht werden.		* '''[http://www.tinymce.com/ TinyMCE]''' ist ein leistungsfähiger JavaScript-Wysiwyg-Texteditor. Er dient zum Bearbeiten von Cachebeschreibungen, Logs, Profiltexten und Cachelisten-Beschreibungen. lib1 und lib2 verwenden beide die TinyMCE-Installation in {{Codepath\|htdocs/resource2/tinymce}}. OC-spezifische Konfigurationsdaten gibt es in {{Codepath2\|htdocs/resource2\|tinymce/config}}; außerdem wurden die Einstellunge in {{Codepath2\|htdocs/resource2\|tinymce/themes/advanced/langs}} angepasst. Damit Änderungen am TinyMCE-Source-Code wirksam werden, müssen u.U. die .gz-Cachedateien im tinymce-Verzeichnis gelöscht werden.
	</div>		</div>

Following: /* Fremdbibliotheken */

2015-08-07T11:54:13Z

Fremdbibliotheken

← Nächstältere Version		Version vom 7. August 2015, 11:54 Uhr
Zeile 79:		Zeile 79:
	* [http://www.smarty.net/ '''Smarty'''] wird als "Template-Engine" für lib2 verwendet. OC-spezifische Erweiterungen befinden sich in der Klasse ''OcSmarty'' und in {{Codepath2\|htdocs\|lib2/smarty/ocplugins}}. Mehr dazu im Abschnitt [[#Templates\|Templates]].		* [http://www.smarty.net/ '''Smarty'''] wird als "Template-Engine" für lib2 verwendet. OC-spezifische Erweiterungen befinden sich in der Klasse ''OcSmarty'' und in {{Codepath2\|htdocs\|lib2/smarty/ocplugins}}. Mehr dazu im Abschnitt [[#Templates\|Templates]].

	* '''[http://htmlpurifier.org/ HTML Purifier]''' dient zum "Säubern" von HTML-Code, den der Benutzer z.B. in Cachebeschreibungen eingeben kann. lib1 ~~und~~ lib2 ~~verwenden getrennte HTML-Purifier~~-~~Installationen. In lib2 wird er über die~~ Klasse ''OcHTMLPurifier'' eingebunden und kann dort ~~auch~~ angepasst werden.		* '''[http://htmlpurifier.org/ HTML Purifier]''' dient zum "Säubern" von HTML-Code, den der Benutzer z.B. in Cachebeschreibungen eingeben kann.Er wird (auch in lib1) über die lib2-Klasse ''OcHTMLPurifier'' eingebunden und kann dort angepasst werden.

	* '''[http://www.tinymce.com/ TinyMCE]''' ist ein leistungsfähiger JavaScript-Wysiwyg-Texteditor. Er dient zum Bearbeiten von Cachebeschreibungen, Logs und Profiltexten. lib1 und lib2 verwenden beide die TinyMCE-Installation in {{Codepath\|htdocs/resource2/tinymce}}. OC-spezifische Konfigurationsdaten gibt es in {{Codepath2\|htdocs/resource2\|tinymce/config}}.

			* '''[http://www.tinymce.com/ TinyMCE]''' ist ein leistungsfähiger JavaScript-Wysiwyg-Texteditor. Er dient zum Bearbeiten von Cachebeschreibungen, Logs und Profiltexten. lib1 und lib2 verwenden beide die TinyMCE-Installation in {{Codepath\|htdocs/resource2/tinymce}}. OC-spezifische Konfigurationsdaten gibt es in {{Codepath2\|htdocs/resource2\|tinymce/config}}; außerdem wurden die Einstellunge in {{Codepath2\|htdocs/resource2\|tinymce/themes/advanced/langs}} angepasst. Damit Änderungen am TinyMCE-Source-Code wirksam werden, müssen u.U. die .gz-Cachedateien im tinymce-Verzeichnis gelöscht werden.
	</div>		</div>

Following: /* Fremdbibliotheken */

2015-08-07T11:19:26Z

Fremdbibliotheken

← Nächstältere Version		Version vom 7. August 2015, 11:19 Uhr
Zeile 82:		Zeile 82:

	* '''[http://www.tinymce.com/ TinyMCE]''' ist ein leistungsfähiger JavaScript-Wysiwyg-Texteditor. Er dient zum Bearbeiten von Cachebeschreibungen, Logs und Profiltexten. lib1 und lib2 verwenden beide die TinyMCE-Installation in {{Codepath\|htdocs/resource2/tinymce}}. OC-spezifische Konfigurationsdaten gibt es in {{Codepath2\|htdocs/resource2\|tinymce/config}}.		* '''[http://www.tinymce.com/ TinyMCE]''' ist ein leistungsfähiger JavaScript-Wysiwyg-Texteditor. Er dient zum Bearbeiten von Cachebeschreibungen, Logs und Profiltexten. lib1 und lib2 verwenden beide die TinyMCE-Installation in {{Codepath\|htdocs/resource2/tinymce}}. OC-spezifische Konfigurationsdaten gibt es in {{Codepath2\|htdocs/resource2\|tinymce/config}}.

			</div>

	Von lib2-Code verwendete Bibliotheken sind in {{Codepath\|htdocs/lib2}} (PHP) und {{Codepath\|htdocs/resource2}} (JavaScript) abgelegt. Bibliotheken für lib1 befinden sich an verschiedenen Stellen.		Von lib2-Code verwendete Bibliotheken sind in {{Codepath\|htdocs/lib2}} (PHP) und {{Codepath\|htdocs/resource2}} (JavaScript) abgelegt. Bibliotheken für lib1 befinden sich an verschiedenen Stellen.

	</~~div>~~		OC-spezifische Anpassungen sind in {{Codepath\|doc/customized-libs.txt}} dokumentiert.

	== Konfigurationsdateien ==		== Konfigurationsdateien ==

Following: /* Grafiken */ Querverweis Iconliste

2015-07-15T14:38:14Z

Grafiken: Querverweis Iconliste

← Nächstältere Version		Version vom 15. Juli 2015, 14:38 Uhr
Zeile 433:		Zeile 433:
	* {{Codepath\|htdocs/lib/tinymce/plugins/emotions/images}}		* {{Codepath\|htdocs/lib/tinymce/plugins/emotions/images}}
	* {{Codepath\|htdocs/resource2/stdstyle/images}}		* {{Codepath\|htdocs/resource2/stdstyle/images}}

			Siehe auch: [[Übersicht der Opencaching.de-Icons]]

	== Übersetzung ==		== Übersetzung ==

Following: /* Grafiken */

2015-07-07T09:07:35Z

Grafiken

← Nächstältere Version		Version vom 7. Juli 2015, 09:07 Uhr
Zeile 426:		Zeile 426:
	* {{Codepath\|htdocs/resource2/ocstyle/images}} (lib2)		* {{Codepath\|htdocs/resource2/ocstyle/images}} (lib2)

	Hier herrscht etwas Chaos. Manches ist mehrfach vorhanden - auch innerhalb ''einer'' Library - oder inkonsistent abgelegt, die Dateitypen wechseln zwischen GIF und PNG. ~~Glattziehen lässt sich das kaum~~, weil ~~Grafiken~~ auch gerne von anderer Stelle aus verlinkt werden, z.B. aus Cachelistings - teils sogar von anderen Plattformen aus. Schiebt man die Grafiken einfach weg oder ändert das Format, zerstört es unbemerkt Cachebeschreibungen.		Hier herrscht etwas Chaos. Manches ist mehrfach vorhanden - auch innerhalb ''einer'' Library - oder inkonsistent abgelegt, manche der Grafiken werden nicht verwendet; die Dateitypen wechseln zwischen GIF und PNG. Wenn dies glattgezogen werden soll, müssen die alten Versionen der Grafiken stehenbleibem weil sie auch gerne von anderer Stelle aus verlinkt werden, z.B. aus Cachelistings - teils sogar von anderen Plattformen aus. Schiebt man die Grafiken einfach weg oder ändert das Format, zerstört es unbemerkt Cachebeschreibungen.

	Zur Kompatibilität mit alten Cachebeschreibungen und Logs liegen in folgenden Verzeichnissen Grafiken, die anderweitig nicht mehr verwendet werden:		Zur Kompatibilität mit alten Cachebeschreibungen und Logs liegen in folgenden Verzeichnissen Grafiken, die anderweitig nicht mehr verwendet werden: