Durchsuchbare Dokumentation aufrufen
Zurück zur Dokumentationsübersicht
Mit Sprachen im Dokumentationssystem arbeiten
Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plug-ins. Aktualisieren Sie das hier beschriebene Plug-in, um die Dokumentation verwenden zu können.
Im Abschnitt Sprache des Dokumentationssystems können Sie verschiedene Sprachen anlegen und verwalten, um Dokumentationen multilingual anzubieten.
Sprachen verwalten
Eine Sprache anlegen
Sie können aus einer Vielzahl an definierten Sprachen wählen und diese anlegen.
- Klicken Sie im Abschnitt Sprache auf Sprachen verwalten.
- Klicken Sie auf
. - Wählen Sie eine Sprache aus der Liste.
Eine Sprache anlegen
Besitzt eine Sprache mehrere Varianten, etwa Englisch (Vereinigtes Königreich) - en_GB und Englisch (Kanada) - en_CA und benötigen Sie nur eine Dokumentation in englischer Sprache, wählen Sie die einfache Variante Englisch - en. - Wählen Sie, ob die Sprache als Standard gelten und Aktiv sein soll.
Haken „Standard“ gesetzt
Wenn Sie den Haken bei Standard setzen und beim Erstellen oder Bearbeiten einer Dokumentation im Abschnitt Sprache den Eintrag Keine Sprache wählen, nimmt das System automatisch diese Sprache als Standard.
Haken „Aktiv“ gesetzt
Wenn Sie den Haken bei Aktiv setzen, erscheint diese Sprache in der Dokumentationsansicht zur Auswahl (siehe Abbildung Eine Sprache in der Dokumentationsansicht wählen), nachdem das System nachts die Übersichten erzeugt hat.
Eine Sprache in der Dokumentationsansicht wählenTipp: Wenn Sie den Haken bei Aktiv nicht setzen, können Sie die Dokumentation anschauen, indem Sie auf die Schaltfläche Anschauen im Dokumentationseditor klicken und den Bereich und die passende Version wählen. Voraussetzung dafür ist, dass das System die Übersicht für die Version nachts erzeugt hat.
- Speichern Sie.
Ergebnis: Das System erstellt die neue Sprache.
• Die zu einer Sprache zugehörige Dokumentation erscheint in der Dokumentationsansicht erst zur Auswahl, nachdem das System nachts die Übersichten erzeugt hat.
• Sie können die Übersicht pro Version und Sprache mit
beim Verwalten von Versionen auch manuell erzeugen.
Hinweis: Wenn Sie einen Link zu einer anderen Dokumentation einfügen und diese Dokumentation nicht in der gleichen Sprache existiert wie die Dokumentation, von der aus Sie verlinken, kann das System den Link zu dieser Dokumentation nicht darstellen.
Beispiel
-
Ihre öffentliche Dokumentation existiert in den Sprachen Deutsch, Englisch und Französisch.
-
Sie wählen die französische Dokumentation aus und fügen dort einen Link zur Dokumentation Utiliser la documentation ein.
-
Die Dokumentation Utiliser la documentation existiert nicht in französischer Sprache.
Ergebnis: Das System kann den Link zu dieser Dokumentation nicht darstellen:
Eine Sprache löschen
Benötigen Sie eine Sprache nicht mehr, können Sie sie löschen. Voraussetzung ist, dass keine Dokumentation mehr in dieser Sprache existiert.
- Klicken Sie im Abschnitt Sprache auf Sprachen verwalten.
- Klicken Sie bei der zu löschenden Sprache auf
.
Das System informiert Sie, wenn zu der zu löschenden Sprache noch Dokumentationen existieren. Speichern ist dann nicht möglich. - Speichern Sie die Änderungen.
Eine Dokumentation in einer bestimmten Sprache anlegen
Nachdem Sie Ihre Sprachen angelegt haben, können Sie Ihre Dokumentation in einer dieser Sprachen anlegen.
- Klicken Sie im Abschnitt Versionen auf Neue Version erstellen.
- Wählen Sie eine Version sowie eine Sprache.
- Klicken Sie auf OK.
Ergebnis: Das System erstellt die Dokumentation in der gewählten Version und Sprache.
• Damit die Dokumention auch in der Dokumentationsansicht für andere Leser zu sehen ist, warten Sie den nächtlichen Automatismus ab, der die Übersichten erzeugt.
• Sie können die Übersicht pro Version und Sprache mit beim Verwalten von Versionen auch manuell erzeugen.
• Das System übersetzt die Dokumentation nicht automatisch. Sie selbst müssen die Dokumentation in die jeweilige Sprache übersetzen, also den Inhalt in der Sprache pflegen.