Commit c7d54492 authored by merlinofchaos's avatar merlinofchaos
Browse files

German translation of full advanced help. Finally a proof of concept of fully...

German translation of full advanced help. Finally a proof of concept of fully translating the help in place exists!
parent 60bcd869
; $Id$
[using-advanced-help]
title = Erweiterte Hilfe verwenden
weight = -10
[translation]
title = Erweiterte Hilfe übersetzen
[ini-file]
title = Format der .ini-Hilfedatei
line break = TRUE
[why-advanced-help]
title = Erweiterte Hilfe - warum?
line break = TRUE
<!-- $Id$ -->
Die Konfigurationsdatei der erweiterten Hilfe hat ein einfaches ini-Dateiformat, unterteilt in Bereiche für jede Hilfedatei sowie einen optionalen Bereich für globale Einstellungen, die für jede Hilfedatei vererbt werden können
Die erste Zeile einer ini-Datei der erweiterten Hilfe sollte ;$Id$ sein, was ein Kommentar mit dem CVS-Identifier für die Datei darstellt. Das ; stellt ein Kommentarzeichen dar. Alles nach dem ; wird ignoriert.
Globale Einstellungen können in einem Abschnitt mit dem Namen <strong>[advanced help settings]</strong> abgelegt werden -- dies bedeutet, dass dieser Name reserviert ist und it cannot be a help file in any module. Die folgenden Einstellungen können in diesem Abschnitt eingestellt werden:
<dl>
<dt><strong>line break</strong></dt>
<dd>Wenn auf irgendeinen Wert gesetzt, wird der Zeilenumbruchfilter auf alle Hilfedateien angewendet, die durch dieses Modul definiert sind, solange diese Hilfedatei nicht ausdrücklich anders eingestellt ist. Standardmäßig wird der Zeilenumbruchfilter nicht angewendet; Hilfedateien können aber einfacher zu schreiben sein, wenn der Zeilenumbruchfilter eingeschaltet ist.</dd>
<dt><strong>navigation</strong></dt>
<dd>Wenn auf wahr gesetzt, wird die Navigation am ende des Hilfethemas angezeigt: vorheriges Thema, nächstes Thema und untergeordnete Themen.</dd>
<dt><strong>CSS</strong></dt>
<dd>Es kann eine CSS-Datei (einschließlich der Erweiterung .css) angegeben werden, die für alle Hilfedateien verwendet wird (wenn sie nicht ersetzt wird). Diese CSS-Datei muss im Hilfe-Verzeichnis zusammen mit den HTML-Dateien vorhanden sein und wird von der Übersetzung nicht beeinflusst.</dd>
<dt><strong>name</strong></dt>
<dd>May be set to override the module name as displayed in both the module index as well as the navigation and breadcrumb trail. In general this does not need to be set, but a few modules may want to use a more friendly name than appears in the .info file.</dd>
<dt><strong>index name</strong></dt>
<dd>This may be set to change the name of the module in the module index. It overrides the 'name' setting above, as well as the module name in its .info file.</dd>
</dl>
Jeder Abschnitt danach bezieht sich auf eine einzelne Hilfedatei, und jede davon kann die folgenden Einstellungen haben:
<dl>
<dt><strong>title</strong></dt>
<dd>Der Titel des Themas, das dem Benutzer angezeigt und in Links verwendet wird. Wenn es besondere Zeichen im Titel gibt müssen sie mit in Anführungszeichen gesetzt werden.</dd>
<dt><strong>file</strong></dt>
<dd>Der Dateiname ohne die Erweiterung .html, der für das Thema verwendet wird. Dies ist optional; wenn er nicht angegeben wird, ist der Name des Themas der Dateiname.</dd>
<dt><strong>weight</strong></dt>
<dd>Die Gewichtung, die für das Sortieren von Themen auf der Verwaltungsseite verwendet wird. Standardmäßig 0 wenn nicht angegeben. Elemente mit der gleichen Gewichtung werden alphabetisch sortiert.</dd>
<dt><strong>parent</strong></dt>
<dd>The topic ID to use in a hierarchy; children will be listed beneath parents in the topic list, and will have the parent in their breadcrumb trail. You may parent this topic to another module's topic by using module%topic as the identifier. For example, 'views%display' will make this a child of the 'display' topic in the 'views' module.</dd>
<dt><strong>line break</strong></dt>
<dd>Wenn auf wahr gesetzt, werden Zeilenumbrüche automatisch in br- und p-Tags konvertiert. Wenn nicht angegeben, ist der Standard AUS. Kann auf 0 gesetzt werden um den Filter zu deaktivieren, falls er in den globalen Einstellungen eingeschaltet ist.</dd>
<dt><strong>css</strong></dt>
<dd>Es kann eine CSS-Datei angegeben werden, die für diese Datei verwendet wird. Diese CSS-Datei muss im Hilfe-Verzeichnis zusammen mit den HTML-Dateien vorhanden sein. Dies überlagert eine CSS-Datei, die im globalen System hinzugefügt wurdeThis will override any .css file added by the global system.</dd>
<dt><strong>popup width</strong></dt>
<dd>Die Breite des Popup-Fensters in Pixel. Standardmäßig 500 wenn nicht angegeben.</dd>
<dt><strong>popup height</strong></dt>
<dd>Die Höhe des Popup-Fensters in Pixel. Standardmäßig 500 wenn nicht angegeben.</dd>
</dl>
Hier ist zum Beispiel eine Version der Datei <strong>advanced_help.help.ini</strong>:
<pre>
[using-advanced-help]
title = "Using advanced help"
weight = -10
[translation]
title = Translating advanced help
[ini-file]
title = Help .ini file format
line break = TRUE
</pre>
\ No newline at end of file
<!-- $Id$ -->
<p>Um die erweiterte Hilfe zu übersetzen muss zuerst ein Verzeichnis <b>translations/help/$language</b> im Modulverzeichnis erstellt werden. Dann müssen die INI-Datei und alle HTML-Dateien aus dem Verzeichnis help kopiert werden. </p>
<p>Die INI-Datei muss nur die Titel beinhalten; diese sollten übersetzt werden. Der Rest der Daten in der INI-Datei kann weggeworfen oder ignoriert werden.</p>
<p>Jede Datei sollte dann an dieser Stelle übersetzt werden.</p>
\ No newline at end of file
<!-- $Id$ -->
<p>Das System der <em>erweiterten Hilfe</em> ist ein modulares System, das erweiterte Hilfemöglichkeiten für Drupal und seine Module bereitstellt. Obwohl die erweiterte Hilfe selbst keine allgemeine Hilfe bereitstellt, stellt es ein mächtiges und einfaches Rahmenwerk zur Verfügung, das Module verwenden können, um ihre eigene Hilfe bereitzustellen.
</p>
<p>
Module die die <em>erweiterte Hilfe</em> verwenden sollten ein Unterverzeichnis 'help' innerhalb des Modulverzeichnisses bereitstellen. Die Datei MODULENAME.help.ini muss in diesem Unterverzeichnis platziert werden, formatiert entsprechend dem nachfolgenden Beispiel:
</p>
<pre>
[buses]
title = "How buses are tied into the system"
file = buses
[TOPIC_ID]
title = "Title of topic".
file = filename of topic, without the .html extension.
weight = How important the topic is on the index page.
parent = The optional topic parent to use in the breadcrumb,
either topic or module%topic.
</pre>
<p>
Alle Themen werden durch das Modul, das die Hilfe bereitstellt, und die Themen-ID adressiert. Um Links einzubetten muss das folgende Format verwendet werden:
</p>
<code>
$output .= theme('advanced_help_topic', $module, $topic);
</code>
<p>Innerhalb der Hilfedatei können andere Hilfethemen durch Verwendung des Formats <strong>&lt;a href=&quot;topic:module/topic"&gt;</strong> verlinkt werden. Dieses Format stellt sicher, dass der Popup-Status konsistent bleibt, wenn zwischen Links umgeschaltet wird.</p>
<p>Mit <strong>&lt;a href=&quot;path:example.jpg"&gt;</strong> können Elemente innerhalb des Hilfe-Verzeichnisses referenziert werden wie z.B. Bilder, die im Hilfetext eingebettet werden sollen.</p>
<p>Mit <strong>&lt;a href=&quot;base_url:admin/settings/site-configuration"&gt;</strong> kann jeder normale Pfad der Website referenziert werden.</p>
<p>Wenn das Modul Search aktiviert ist, werden die Inhalte des Hilfesystems von Cron indexiert. Wenn neue Module aktiviert werden und der Hilfetext sofort indexiert werden soll, muss "Verwalten -> Berichte -> Statusreport" aufgerufen und der Link "Cron von hand starten" aufgerufen werden.</p>
<p>Beispiel: <a href="path:nowhere.jpg">Nicht anklicken!</a></p>
<p>Siehe: <a href="topic:advanced_help/ini-file">ini file format</a></p>
<p><strong>Hinweis: </strong> In älteren Versionen der erweiterten Hilfe war es nicht erforderlich &amp;'s wrapped around the topic:, path:, and base_url: links. Dies wird momentan noch unterstützt, wird in einer zukünftigen Version aber möglicherweise entfernt. Durch das Hinzufügen der &'s sind diese Token jetzt nicht auf href=""- and src=""-Paramater begrenzt.</p>
Das System der erweiterten Hilfe wurde entworfen um das Original-Hilfesystem von Drupal zu ersetzen, das mehrere FLAWS hat die es erschweren, neue Hilfe zu erstellen und existierende Hilfen zu pflegen und es besonders erschweren, auf die Hilfe zuzugreifen.
Das primäre Ziel ist daher, die Zugänglichkeit der Hilfe zu verbessern, was die Fähigkeit sowohl für den Benutzer als auch den Hilfetext-Autor die Fähigkeit bedeutet, auf die erforderlichen Werkzeuge zuzugreifen um die Hilfe zu verwenden, zu erstellen, zu pflegen und zu übersetzen.
Dieses System ist völlig getrnnt von Drupals hook_help(). In Drupal 6 koexistiert es damit; in Zukunft wird es hoffentlich hook_help() vollständig ersetzen, so dass es abgekündigt und ersetzt werden kann.
Nachrichten am Anfang der Seite sind oft keine echte Hilfe. Oft sind diese Meldungen eine Einleitung in ein Formular oder EINE KURZE BLURB DIE dem Benutzer sagt was mit einer bestimmten Seite erledigt werden soll. Das Problen ist, dass diese Meldungen immer erscheinen, sie werden leicht ignoriert und sie erscheinen vor der eigentlichen Seite. Im Allgemeinen wollen Benutzer, wenn sie lernen, die Seite zuerst sehen und dann Fragen stellen. Die umgekehrte Reihenfolge is much less conducive to actually teaching a user how to use something. Durch die Möglichkeit, Hilfe auf Anfrage bereitzustellen, passt es mehr zur Arbeitsweise der meisten Personen.
<h3><strong>Die erweiterte Hilfe ist nach Themen organisiert</strong></h3>
Mit der hook_help()-Methode ist der Hilfetext nach dem URL-Pfad organisiert. Dies ist gut wenn der Hilfetext beschreibt, wie eine bestimmte Seite zu verwenden ist oder was eine bestimmte Seite tut, es ist aber letztlich einschränken, weil Handbücher und Dokumentationen gewöhnlich nach Themen gruppiert sind und diese Themen vom Material selbst bestimmt werden.
Die erweiterte Hilfe ermöglicht dem Autor einer Dokumentation, Themen nach eigener Vorstellung zu organisieren; die wirklich einzige Einschränkung ist, dass jeder individuelle CHUNK OF TEXT als eigenes Thema STANDS ON.
Des weiteren können Module ihre Themen in die Hierarchie eines anderen Moduls einfügen. Dies würde dem Drupal-Kern ermöglichen, eine aufgabenbasiertes Hilfenavigationssystem zu erstellen, das Modulen erlaubt fließend Themen in diese Navigation einzufügen. Dies ermöglicht MOdulen, ihre Systeme getrennt zu halten und doch sich in das Hauptsystem zu integrieren.
<h3><strong>Advanced help topics are processed HTML in their own files</strong></h3>
Diese Trennung vereinfacht das Finden und Anpassen. Momentan ist alles LUMPED TOGETER in hook_HELP() in PHP-Zeichenketten die durch t() laufen und es eine größere Menge PHP-Code in diesem System erforderlich, that actually gets in the way of writing good, explanatory text.
In fact, requiring a documentation author to understand PHP at all is a detriment. The idea that documentation writers need to have PHP development as a skill seriously reduces the number of available contributors. HTML, on the other hand, is a much more common skill, is relatively easy to learn, and the amount of HTML needed to write documentation is only a little bit more than the HTML used in forum posts.
Ein anderer Vorteil, PHP nicht zu verwenden ist dass die Dateien selbst sicher sind. Sie enthalten sehr wahrscheinlich keinen schädlichen PHP-Code der auf dem Server schlimme Dinger anrichtet. Dies bedeutet dass diese Dateien relativ einfach auf drupal.org-Hardware verwendet werden kann, so dass die Hilfedateien eines MOduls sofort verfügbar gemacht werden können ohne das Modul herunterladen zu müssen. Es bedeutet auch, dass Beschreibungen des Moduls auf drupal.org erstellt werden können, die VERSION AWARE sind, in CVS einfach mit Patches korrigiert werden können, aber auch zusammen mit dem Modul verfügbar gemacht werden können, so dass drupal.org nicht benötigt wird.
Dies bedeutet, dass - falls gewünscht - die drupal.org-Handbücher oder eine Teilmenge davon, direkt in eine Drupal-Distribution oder ein Drupal-AddOn gepackt werden können, so dass Drupal-Administratoren ohne einen Besuch von Drupal.org Hilfe erhalten können. Dies kann in abgeschotteten Firmenumgebungen oder in Flugzeugen wertvoll sein. Aber noch wichtiger, die Handbücher können einfacher VERSION AWARE gemacht werden als die momentane Methode auf drupal.org.
Die Kehrseite dieser Methode ist, dass diese Bücher nicht einfacch dynamisch gemacht werden können. Though the use of alter hooks could allow a module to make modifications to the help as needed, doing this could make the help files less useful when you take them out of context.
<h3><strong>Die Dateien der weiterten Hilfe werden als Datei übersetzt</strong></h3>
Es ist momentan nicht einfach, Dokumente als Zeichenketten zu übersetzen, besonders wenn die verwendete Sprache sich sehr von Englisch unterscheidet. Beim Übersetzen eines Dokuments kann sich der Satzaufbau tatsächlich deutlich ändern. Es ist auch eine Last für die CPA, dies zu tun, da sehr lange Zeichenketten indiziert werden.
Übersetzer haben es sehr viel einfacher, das Dokument als Einheit zu übersetzen, weil der gesamte Kontext gegenwärtig ist.
<h3><strong>Die erweiterte Hilfe hat ihr eigenes Navigationssystem</strong></h3>
Mit Hilfe eines in einer INI-Datei angegebenen Navigationssystems (das kein PHP-Code ist daher sicher auf *.drupal.org -Websites verwendet werden kann), kann die Hilfe wie ein Buch strukturiert werden, wass typisch für Online-Handbücher ist. Dies ist Benutzern vertraut, kann organisiert (und umorganisiert) werden und ermöglicht einem Modul deutlich reichhaltigeren Text zu beinhalten ohne den PHP-Code damit zu überlasten, unnötig Hilfe zu laden.
Durch dieses Buch kann auch hierarchisch navigiert werden, was es einfacher macht, aufeinander bezogene Themen miteinander zu verbinden.
<h3><strong>Die erweiterte Hilfe wird von der Suche-Engine indexiert</strong></h3>
Ein wichtige Ziel dieses Systems war, die Hilfe durchsuchbar zu machen. Die Fähigkeit, Schlüsselwörter in die Suchmaske einzugeben und relevante Themen zu finden, erhalten wir ein System das RESEMBLES die Art von Hilfe die mit vielen Betriebssytemen geliefert wird. Dies ist sehr wertvoll, wenn Handbücher danach durchsucht werden müssen, wie etwas bestimmtes gemacht wird.
Diese Suche ist hilfespezifisch, was bedeuetet, dass die Hilfe nicht mit der globalen Suche in Beiträgen vermischt wird. Dies kann sowohl als Vorteil als auch als Nachteil betrachtet werden. Dieses Hilfesystem soll meistens Hilfe für Website-Administratoren bereitstellen, und Suchen in Inhalt soll sie nicht finden. Der Nachteil ist natürlich, dass sie nicht als Hilfe für Endanwender verwendet werden kann.
<h3><strong>Eingebettete Hilfe kann via Popups aufgerufen werden</strong></h3>
Zusätzlich zur handbuchartigen hierarchischen Navigation kann die erweiterte Hilfe auch zusätzliche kontextsensitive Hilfe mittels Popup bereitstellen. Während Popups kontrovers betrachtet werden, ist das Argument für die Verwendung, dass die Hilfe erscheint während ein Formular angezeigt wird <i>und das Popup nicht die Daten des Benutzers verwirft</i>. Browser sind nicht sehr bedienerfreundlich bei der Eingabe von Formularen, wenn sie nicht gespeichert werden, und das Wegnavigieren von einem Formular kann gefährlich sein. Es gibt verschiedene andere Lösungen dieses Problems, aber jede hat ein DRAWBACK. DRAWBACKs von Popups sind recht bekannt, aber meistens irritiert es, ein neues Fenster zu erhalten. Wenn Hilfe angeforder wird ist ein Popup aber meistens erwünscht. Hilfe soll nicht den Vorgang stören, den der Benutzer abschließen möchte. Es unterscheidet sich wesentlich von einem unerwünschten Popup, das normalerweise Anzeigen oder Popups aufruft, die Benutzer vom Verlassen einer Website abhalten soll
Diese Popus können einer Seite hinzugefügt werden mit Text- oder Icon-Links.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment