MediaWiki API Result

You are looking at the HTML representation of the XML format.
HTML is good for debugging, but is unsuitable for application use.
Specify the format parameter to change the output format.
To see the non HTML representation of the XML format, set format=xml.
See the complete documentation, or API help for more information.
<?xml version="1.0"?>
<api>
  <query-continue>
    <allpages gapcontinue="Replace_Language" />
  </query-continue>
  <query>
    <pages>
      <page pageid="982" ns="0" title="RefererTagging">
        <revisions>
          <rev contentformat="text/x-wiki" contentmodel="wikitext" xml:space="preserve">[[Category:Extensions]]
{{ExtInfo
| Dev=trilobit GmbH
| ExtVersion=1.0.0 stable
| Version=2.9.5 bis 2.10 stable
| ERLink=http://www.contao.org/erweiterungsliste/view/RefererTagging.10000009.de.html
}}

=Was ist ein Referer?=
Der Referer gibt an, woher der Besucher Ihrer Seite kommt. Diese Angabe bezieht sich immer auf die derzeit aktive Session. Wichtig in diesem Zusammenhang ist, dass immer nur der erste Referer einer Session gespeichert wird. Wenn Sie also die Seite über Google besuchen und nachher über ein Suchergebnis bei Bing, werden Sie nur den Aufruf von Google sehen. Es sei denn der Browser wurde daziwschen geschlossen.

Das Wissen um den Referer können Sie neben statistischen Auswertungen auch dazu nutzen, dem Besucher individuelle Inhalte anzuzeigen. Kommt er von einer Suchmaschine, ist er vielleicht neu und benötigt Hilfestellung. Oder möchten Sie &quot;Neulingen&quot; ein besonderes Angebot in Ihrem Shop machen? Hat eine Webseite die Lösung zu Ihrem Gewinnspiel veröffentlicht, können Sie Benutzer von dieser Seite auch markieren und später bei der Ziehung nicht berücksichtigen. Viele weitere Einsatzgebiete sind denkbar. 

=Was bietet die Erweiterung RefererTagging?=
RefererTagging kann über das Contao-Repository installiert werden. Es bietet die Möglichkeit, Referer zu erkennen und mit einem Session-Cookie zu taggen, d.h. Sie können konfigurieren, dass bei einem Referer mit ''bing.com'' im Namen, das Cookie ''suchmaschine'' auf ''bing'' gesetzt wird.

=Einstellungen=
Sobald diese Erweiterung über den Erweiterungskatalog in Contao installiert ist, stehen das Modul im Abschnitt ''System'' unter dem Namen ''RefererTagging'' zur Verfügung.

[[Datei:referertagging-layout.jpg|frame|center|Layout]]

Folgende Werte können konfiguriert werden

* '''Pattern'''
** Auf diesen regulären Ausdruck wird der Referer geprüft.
** Beispiele:
*** ''google'' trifft auf ''google.de'' und ''plus.google.com'' zu, aber auch auf ''http://trilobit.de/google.html''.
*** ''bing.com'' trifft auf ''http://www.bing.com'' zu, allerdings auch auf ''bingocom.de''. Das hat damit zu tun, dass der Punkt ein spezielles Zeichen bei den regulären Ausdrücken ist und als Platzhalter für ein beliebiges Zeichen steht. Korrekt wäre daher das Muster bing\.com.
*** ''google\.(de|com)\/'' prüft, ob der Referer ''google'' gefolgt von einem Punkt und dann ''de'' oder ''com'' enthält. Danach muss ein &quot;/&quot; kommen. Klammern zeigen also Alternativen auf.
*** Möchte man ganz sicher gehen, dass es sich um die richtige Domain handelt, sollte man diese samt Protokoll abprüfen, z.B. ''^https:\/\/trilobit.de\/''  Durch das Dach muss am Anfang des Referers ''https://trilobit.de/'' stehen.
** Eine Hilfestellung zu regulären Ausdrücken bietet beispielsweise [http://www.drweb.de/magazin/php-schnellreferenz-regulare-ausdrucke/ Dr. Web].
* '''Tag Name'''
** Name des Eintrags, der bei positivem Abgleich des Referers mit Pattern in die Session geschrieben wird. Ein gleichnamiges Cookie wird gesetzt.
* '''Tag Wert'''
**   Wert des Eintrags, der bei positivem Abgleich des Referers mit Pattern in die Session geschrieben wird. Ein Cookie mit diesem Wert und Tag Name wird gesetzt.

Es werden alle Einträge nacheinander durchgegangen, so dass auch mehrere Tags und Cookies gesetzt werden können.


=Hinweise zum Internet Explorer=
Beim Internet Explorer (Versionen 8, 9) wird nicht in allen Fällen der Referer gesetzt. Folgendes Verhalten bei der Verlinkung auf eine andere Seite gibt es:

*''&lt;a href=&quot;http://www.trilobit.de&quot;&gt;trilobit GmbH&lt;/a&gt;''
**Mausklick auf den Link
***der Referer wird korrekt gesetzt
***die Seite wird im selben Fenster bzw Tab geöffnet
*''&lt;a href=&quot;http://www.trilobit.de&quot; target=&quot;_blank&quot;&gt;trilobit GmbH&lt;/a&gt;''
**Mausklick auf den Link
***der Referer wird korrekt gesetzt
***die Seite wird in einem neuen Fenster bzw Tab geöffnet
*''&lt;a href=&quot;http://www.trilobit.de&quot; onclick=&quot;window.open(this.href); return false;&quot;&gt;trilobit GmbH&lt;/a&gt;''
**Diese Version wird von Contao verwendet, wenn die Option &quot;in neuem Fenster öffnen&quot; gesetzt ist
**Mausklick auf den Link
***der Referer wird '''nicht''' gesetzt
***die Seite wird in einem neuen Fenster bzw Tab geöffnet
*''&lt;a href=&quot;http://www.trilobit.de&quot; ... &gt;trilobit GmbH&lt;/a&gt;''
**Mausklick auf den Link '''mit gedrückter [Strg]-Taste'''
***der Referer wird korrekt gesetzt (egal, ob target oder onclick Attribute gesetzt sind)
***die Seite in einem neuen Fenster bzw Tab geöffnet

=Mehr Infos=
Bei Fragen und Anregungen zu der Erweiterung stehen wir natürlich gerne zur Verfügung. Weitere Infos gibt es auch auf [http://trilobit.de/referertagging unserer Homepage].</rev>
        </revisions>
      </page>
      <page pageid="526" ns="0" title="Registered (R) hochstellen">
        <revisions>
          <rev contentformat="text/x-wiki" contentmodel="wikitext" xml:space="preserve">[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]
{{AppliesTo
|TLVersion=ab 2.6
|Version=ab 2.9
}}
Beim Arbeiten mit Produkten, z.B. in Katalogen, kommt es häufiger vor, dass man das Registered(R)-Symbol verwenden muss. Für die Auftraggeber ist ein einfaches Weglassen des Zeichens keine Alternative, da diese Markenrechte viel Geld gekostet haben und es jeder sehen soll, dass das Produkt markenrechtlich geschützt ist.

=Aufgabenstellung=
Da das ® relativ zur Schrift meist hochgestellt verwendet wird, muss es bei jeder Eingabe extra formatiert werden. In HTML wird es dazu in die &amp;lt;sup&amp;gt;®&amp;lt;/sup&amp;gt;-Tags eingeschlossen. Bei der Eingabe von laufendem Text ist das sehr lästig. Wenn das Zeichen beispielsweise in Titelfeldern im Backend verwendet wird, ist es normalerweise gar nicht möglich, HTML-Tags einzugeben, da Contao diese beim Speichern automatisch entfernt. Das kann man zwar mit Einträgen in der dcaconfig.php anpassen, es soll aber eine einfachere Möglichhkeit geben.

=Lösungansätze=
Hier mein Dank an die Kollegen aus dem [[Chat HowTo|IRC-Chat]] für die zahlreichen Ideen und Anregungen.

===Kleines JavaScript===
Ein JavaScript würde nach dem Aufbau der Webseite hingehen und nachträglich die ® mit dem &amp;lt;sup&amp;gt;-Tag umschließen. Voraussetzung ist dabei, dass beim Betrachter im Browser JavaScript aktiviert ist.

===Über den Ausgabe-Hook mit einer kleinen Erweiterung===
Diese Variante verspricht am meisten Erfolg, da hier die Webseite '''vor''' der Auslieferung entsprechend manipuliert werden kann. Es kostet natürlich etwas Überwindung, dafür eine Erweiterung zu schreiben, aber man wird weiter unten sehen, dass es gar nicht so schlimm ist.

===Bei der Eingabe im Backend modifizieren===
Man könnte auch das Backend derart modifizieren, dass eine Speicher-Callback-Routine die Aufgabe ausführt. Dann muss man aber dafür sorgen, dass auch beim Laden über einen Load-Callback die Anpassung erstmal herausgenommen wird, da der Save-Callback sie ja dann wieder einbaut. Außerdem wären diese Callbacks für viele Felder in vielen Modulen notwendig. Diesen Ansatz kann man also auslassen.

=Erstellung eines kleinen Contao-Moduls=
Es hört sich erstmal schwierig an, doch diese einfache Erweiterung macht nicht so viel Aufwand.

===Man baut die Verzeichnispfade auf===
* Dazu legt man im Verzeichnis '''system/modules''' ein Verzeichnis '''registeredR''' an.
* In diesem Verzeichnis legt man das Verzeichnis '''config''' an, was dann die Modulkonfiguration definiert.
* In das config-Verzeichnis kopiert man aus einem Backend-Modul eine .htaccess-Datei, die für die Sicherheit des Moduls wichtig ist. Die .htaccess überwacht, dass nur das PHP-Script zugreifen darf, ein direkter Zugriff aus den Web bleibt ausgesperrt.


Der Dateibaum des Moduls wird später so aussehen:

[[Datei:RegisteredR1.gif|center|frame|Dateibaum RegisteredR-Erweiterung]]


===Konfigurationsdatei config.php erstellen===
In einem UTF-8-fähigen Editor erstellt man die Datei '''config.php''' mit dem folgenden Inhalt und speichern sie im config-Verzeichnis ab.

&lt;source lang=&quot;php&quot;&gt;
&lt;?php if (!defined('TL_ROOT')) die('You can not access this file directly!');

/**
 * Contao Open Source CMS
 * Copyright (C) 2005-2010 Leo Feyer
 *
 * Formerly known as TYPOlight Open Source CMS.
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, please visit the Free
 * Software Foundation website at &lt;http://www.gnu.org/licenses/&gt;.
 *
 * PHP version 5
 * @copyright  Leo Feyer 2005-2010
 * @author     Leo Feyer &lt;http://www.contao.org&gt;
 * @package    Backend
 * @license    LGPL
 * @filesource
 */

/**
 * -------------------------------------------------------------------------
 * HOOKS
 * -------------------------------------------------------------------------
 *
 * Hooking allows you to register one or more callback functions that are 
 * called on a particular event in a specific order. Thus, third party 
 * extensions can add functionality to the core system without having to
 * modify the source code.
 * 
 *   $GLOBALS['TL_HOOKS'] = array
 *   (
 *       'hook_1' =&gt; array
 *       (
 *           array('Class', 'Method'),
 *           array('Class', 'Method')
 *       )
 *   );
 * 
 * Use function array_insert() to modify an existing hooks array.
 */
$GLOBALS['TL_HOOKS']['outputFrontendTemplate'][] = array('ModuleRegisteredR', 'registeredR');

?&gt;
&lt;/source&gt;
Ganz wichtig ist, dass in der Datei vor dem &amp;lt;?php und nach dem ?&amp;gt; keine Zeichen oder Zeilenumbrüche stehen, da es sonst zu PHP-Fehlern in der Ausgabe kommt.

Das wichtige in dieser Datei ist die Zeile ganz unten:

&lt;source lang=&quot;php&quot;&gt;
$GLOBALS['TL_HOOKS']['outputFrontendTemplate'][] = array('ModuleRegisteredR', 'registeredR');
&lt;/source&gt;

Damit meldet man das Programm '''registeredR''' aus der PHP-Klasse '''ModuleRegisteredR''' beim outputFrontendTemplate-HOOK an.


===Moduldatei ModuleRegisteredR.php erstellen===
Es ist ja klar, dass das registrierte Programm auch zur Verfügung stehen muss. Daher wird jetzt das Modulprogramm mit folgendem Inhalt erstellt:
&lt;source lang=&quot;php&quot;&gt;
&lt;?php if (!defined('TL_ROOT')) die('You can not access this file directly!');
/**
 * Contao Open Source CMS
 * Copyright (C) 2005-2010 Leo Feyer
 *
 * Formerly known as TYPOlight Open Source CMS.
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, please visit the Free
 * Software Foundation website at &lt;http://www.gnu.org/licenses/&gt;.
 *
 * PHP version 5
 * @copyright  Leo Feyer 2005-2010
 * @author     Leo Feyer &lt;http://www.contao.org&gt;
 * @package    Backend
 * @license    LGPL
 * @filesource
 */


/**
 * Class ModuleRegisteredR
 *
 * @copyright  Softleister 2010-2011
 * @author     Hagen Klemp &lt;http://www.softleister.de&gt;
 * @package    Controller
 */
class ModuleRegisteredR extends Backend
{
    public function registeredR($strContent, $strTemplate)
    {
        $pos = strpos( $strContent, '&lt;body' );
        return substr($strContent, 0, $pos) . str_replace( '&lt;sup&gt;&lt;sup&gt;®&lt;/sup&gt;&lt;/sup&gt;', 
                      '&lt;sup&gt;®&lt;/sup&gt;', 
                      str_replace('®', '&lt;sup&gt;®&lt;/sup&gt;', substr($strContent, $pos)) );
    }
}

?&gt;
&lt;/source&gt;

Auch hier muss wieder darauf geachtet werden, dass die Datei in UTF-8 gespeichert wird.

Der Kern der Datei ist eine kleine Programmdefinition passend zum HOOK:
&lt;source lang=&quot;php&quot;&gt;
class ModuleRegisteredR extends Backend
{
    public function registeredR($strContent, $strTemplate)
    {
        $pos = strpos( $strContent, '&lt;body' );
        return substr($strContent, 0, $pos) . str_replace( '&lt;sup&gt;&lt;sup&gt;®&lt;/sup&gt;&lt;/sup&gt;', 
                      '&lt;sup&gt;®&lt;/sup&gt;', 
                      str_replace('®', '&lt;sup&gt;®&lt;/sup&gt;', substr($strContent, $pos)) );
    }
}
&lt;/source&gt;

Hier wird die Klasse '''ModuleRegisteredR''' definiert, die in der config-Datei dem HOOK angemeldet wurde. In dieser Klasse, die die vorhandene Klasse Backend erweitern soll, ergänzt man nur eine Funktion '''registeredR'''. Die Aufruf-Parameter der Funktion sind durch die Definition des [http://www.contao.org/hooks-verwenden.html HOOK in Contao] vorgegeben und beschrieben.

Man bekommt in der Variablen ''$strContent'' die komplette Webseite und muss im ''return'' den veränderten Inhalt an Contao zurückgeben. Die Aufgabe ist nur das Umschließen des ® mit &amp;lt;sup&amp;gt;-Tags, also kann man mit der PHP-Funktion str_replace einfach das Zeichen ® auf der gesamten Webseite gegen einen String mit sup und Zeichen austauschen und den veränderten String zurückgeben.

'''EDIT:''' Die Ersetzung muss im HTML-Header verhindert werden, da hier der &lt;sup&gt;-Tag nicht zulässig ist.


===CSS für die bessere Darstellung===
Eigentlich kann HTML das ® jetzt allein formatieren, da es bei der Ausgabe durch den &amp;lt;sup&amp;gt;-Tag hochgestellt ist. Durch eine kleine zusätzliche CSS-Definition läßt sich aber noch mehr eigener Einfluss auf die Darstellung erreichen.

&lt;source lang=&quot;css&quot;&gt;
sup
{
	font-size:.8em;
	line-height:1em;
}
&lt;/source&gt;

Hinweis von [[Benutzer:Datenkind|Datenkind]]:
Durch ein geschicktes CSS läßt sich sogar der Zeilenabstand im Fließtext konstant halten, der eigentlich durch das Hochstellen vergrößert wird. (Der Selektor _vertical-align soll den IE6 besänftigen)


&lt;source lang=&quot;css&quot;&gt;
sup
{
	height:0;
	bottom:0.5em;
	position:relative;
	vertical-align:baseline;
	_vertical-align:bottom;
	font-size:.8em;
	line-height:1;
}
&lt;/source&gt;

[http://www.adobe.com/cfusion/communityengine/index.cfm?event=showdetails&amp;postId=5341&amp;productId=1 Quelle]


&lt;span style=&quot;font-size:1.3em; font-weight:bold;&quot;&gt;Das war's - doch nicht so schwierig, wie gedacht&lt;/span&gt;

=Das registeredR gibt es jetzt als Erweiterung im Repository=
Da doch inzwischen einiges Interesse an dem Skript zusammen gekommen ist, habe ich ein kleine Erweiterung daraus gemacht. Die Installation ist so sehr einfach und geht schnell. Viel Spaß damit ... [http://www.contao.org/erweiterungsliste/view/registeredR.html Erweiterung registeredR]
----

-- [[Benutzer:do_while|do_while]] - 2010-08-14 / 2011-01-06 / 2011-02-13</rev>
        </revisions>
      </page>
    </pages>
  </query>
</api>