Ryzom
Technischer Wiki-Leitfaden

Aus Ryzom Wiki

Wechseln zu: Navigation, Suche
de:Technischer Wiki-Leitfaden
en:Wiki Technical Guide
es:Guía Técnica de la Wiki
fr:Guide Technique du wiki
ru:Техническое руководство по Вики
Under Construction Panel.png Übersetzungs Status Under Construction Panel.png
De.png Im Übersetzung im GangeGb.png TranslatedEs.png Traducción requeridaFr.png OriginalRu.png Непереведено
Es sind mommentan immernoch 96 Artikel in Übersetzung oder Korrekturlesen in der Kategorie "TIP"

Ein kurzer technischer Leitfaden für erfahrene Mitarbeiter und Dokumentationsmanager. Siehe Schreibanleitung für grundlegende Wiki-Kenntnisse.

Arbeiten als Team

Vergiss niemals, dass jedes Dokument (außer geschützte Seiten, die nur zugänglich durch Administratoren sind) jederzeit von jedem bearbeitet werden kann. Schaue unter Technischer Wiki-Leitfaden#Bearbeitung und Technischer Wiki-Leitfaden#Inhaltsvalidierung) um bewährte Praktiken zu befolgen.

Diskussionsseiten

Es ist oft nützliche, bequem oder auch notwendig eine Nachricht für jemanden zu hinterlassen. Für diesen Zweck wird jedem Dokument eine Diskussionsseite zugeordnet, wenn es erstellt wird. Zum Beipiel hier: Talk:Technischer Wiki-Leitfaden [[Talk:{{FULLPAGENAME}}]].

Auf jeden Fall musst du versuchen in einer lesbaren Schreibenstill pflegen. Jedes Thema beginnt mit einem Titel ===Titel des Themas==. Es ist besser 50 kleine und seperate Themen, jedes mit einem Titel versehen, zu haben, als ein Paket mit 50 Themen. Dies verhindert benachteiligte Antworten bei der Berücksichtigung, Umsetzung, usw.

Am Ende des Betreffs unterschreibe immer mit ~~~~. Das lässt jeden sofort nachvollziehen, wer und wann die Nachricht geschrieben hat.

In der Regel erfolgen Antworten durch Einrückungen wie in Emails. Das wird durch das Setzen eines : in einem neuen Absatz. Natürlich wird jede Nachricht unterschrieben. Das is sehr nützlich für jemanden, der später die gleichen Fragen stellen wird und diese Diskussion als Teil einer Wissensdatenbank sieht.

Schließlich kann es nützlich sein ein Vorlage:OK deinem Titel anzuhängen, das zeigt, dass das Thema geschlossen ist ==Titel des Themas {{OK}}==. Falls das Thema wieder geöffnet wurde, dann kann das Vorlage:OK mit Vorlage:KO ersetzt werden {{KO}}.

Leider werden die von der Frage Betroffenen nicht unbedingt informiert (die Anzahl der Artikel, die überwacht werden, und damit die Wahrscheinlichkeit, dass die Änderung gemeldet werden, ist begrenzt, um die Datenbank nicht zu vergrößern. Denken auch darüber nach die Person oder Personen, die betroffen sind durch Diskussion oder durch das Hinweisen mit einem Link zu der Diskussion zu benachrichtigen. Nochmals: Titel und Unterschriften, auch wenn sehr kurz, sind willkommen.

Förderung

Auf den ersten Blick wird man feststellen, dass die Wiki, auch wenn es einfach ist, dort zu schreiben, es sehr aufwändig ist, diese zu verwalten, mit all den Regeln der Geselligkeit und Effizenz und deren Traditionen, die auf Erfahrungen der Vorgänger aufbauen. Das ist weil die Wiki auch ihre "Lore" (mündliche Tradition) hat.

Willst du dich wirklich an der Wiki beteiligen? Dann zögere nicht gefördert zu werden, ohne Verlegenheit, Schüchternheit oder Schamgefühl... Wir haben alle unsere Einführung gehabt und vielleicht, hoffentlich, wird es für dich auch eine Zeit geben, ein Förderer sein zu dürfen. Du kennst niemanden? Versuche "Alumni" zu kontaktieren auf https://chat.ryzom.com/channel/pj-ryzom_wiki oder kontaktieren jemanden auf Special:ActiveUsers.

Übersetzungen

Es gibt vier Regeln, die nebeneinander existieren:

Forge (Entwicklungsteil), Spiel-Gewohnheits-Tabelle, Grafik-Tabelle, grundlegende Kategorien
  • alles muss ins Englische übersetzt werden, damit es für so viele Menschen wie möglich verfügbar ist, dessen Mehrheit mehr oder weniger geschriebenes Englisch verstehen.
Im-Spiel Verhaltenstabelle, Grafik-Tabelle, Wiki-Verwaltungsvorlagen, grundlegende Kategorien
  • alles muss in alle Sprachen übersetzt werden.
Lore, Chroniken, öffentliche Events
  • alles muss zumnindest in die drei Muttersprachen Ryzom's übersetzt werden: DE, EN und FR;
Der Rest und besonders der Rollenspiel-Teil
  • da gibt es keine Regeln, nur Anliegen von Spielern und Übersetzern haben Vorrang.

Bearbeitung

Mit Ausnahme der archivierten Dokumente und der Dokumente mit dem offizellen Status "Finales Dokument" (Lore, Chroniken), kann alles verbessert werden und das ist eines der reichsten der Wikis.

Andereseits müssen bestimmte Regeln der konstrutkitven Geselligkeitrespektiert werden.

Dazu ist es notwendig zu beurteilen, ob die Änderungen wesentlich sind oder nicht. Es gibt keine Regeln und ist mehr ein Gefühl. Aber wenn es drastisch verändert wird, ist es weise, sich die Versionshistorie (Button neben "Bearbeiten".) anzuschauen. Falls der Inhalt (nicht die Form, Aussehen, Schreibweise...) einige Zeit nicht verändert wurde, kann man davon ausgehen, dass der Autor es so belassen hat und dass das Dokument möglicherweise veraltet ist und aktuallisiert werden muss. Ein Beispiel ist nebenstehend abgebildet.

Eine Aktualisierung kann als drastisch betrachtet werden, wenn es Absätze oder sogar Zeilen löscht, die grundlegend für die Entweicklung des Themas sind. In der Zusammenhang ist es sinnvoll eine Nachricht in der “Benutzer:Diskussion:xyz”-Seite zu hinterlassen. Während man auf die Antwort warte (eine Woche?), ist es ratsam, in der modifizierte Seite den Originaltext als Kommentar zu hinterlassen. Der einfachste Weg einen Text als Kommentar zu übermitteln, ist es mit <!-- einzuleiten und mit --> abzuschließen. Aber es gibt manchmal Probleme, besonders wenn es schon andere Kommentare gibt. In dem Fall können Hammer und Meißel benutzt werden, indem der Text mit <noinclude><includeonly> und </includeonly></noinclude> umrahmt wird. Warum solch eine Komplikation? Weil es immer nötig ist die Texte des Autors zu respektieren und seine intellektuelle Urheberschaft, sogar in der Welt der freien Software. Anderfalls laufen wir in Gefahr, dass ein:

Berabeitungskrieg (Edit-War)

Auszug aus der Wikipedia Edit-War


Das sollte nicht mit einen Bearbeitenskonflikt vertauscht werden. Auszug aus der Wikipedia [Bearbeitungskonflikt]:


(siehe Wikipedia Bearbeitungskonflikt für mehr Informationen)

Arbeite in Gelassenheit

Natürlich werden solche Zwischenfälle und Unschicklichkeiten nicht zu 100% vermieden werden können, also ist es am sinnvollsten den folgenden Empfehlungen zu folgen ( von Wikipedia Bearbeitungskonflikten vorbeugen):

"Um Versionskonflikte zu meiden, ist es der einfachste Weg, lange Änderungen zu vermeiden.

Dies is jedoch nicht immer möglich. Das ist der Grund, warum es empfohlen wird, wenn eine Seite in der Tiefe modifiziert wird, zuerst den Banner {{WIP|~~~~}} hinzuzufügen, wie folgt angezigt wird:


 
Dummy.png
Under Construction Panel.png !!! Arbeit im Gange !!! Under Construction Panel.png
Es sind derzeit noch 15 Artikel in Vorbereitung unter der Kategorie "WIP"
Artikel in Vorbereitung. Bitte lassen Sie den Autor es beenden, bevor Sie es ändern.
Die letzte Bearbeitung war von Heernis am 01.07.2019. -- Zo'ro-Argh Woren Siloy 28 mai 2019 à 14:19 (CEST)


Sobald die Seite mit dem Banner veröffentlicht wird, kannst du es jedeszeit ändern. Begrenzen die Anzahl der Änderungen, indem du die Vorschau verwendest, um Anpassungen vorznehmen (das spart Zeit und vermeidet eine Unordnung der Seite "Letzte Änderungen".)

Wenn du fertig bist, vergiss nicht die Vorlage zu entfernen {{WIP}}.”


(siehe Wikipedia Bearbeitungskonflikt für mehr Informationen)

Der Entwurf

Ein andere Art und Weise in Frieden zu arbeiten, ist die Arbeit in deinem eigenen Benutzerbereich. Dieser Bereich ist [[Benutzer:Heernis/Entwurf/...]]'

Die Dokumente, die du dort vorbereitest, sind für die Suchmaschinen nicht verfügbar (außer du makierst die Seite explizit mit ) Nicht einmal Google sollte dahin gehen.

Inhaltsvalidierung

Gewöhnlich sind in Ryzom alle Seiten frei bearbeitbar, solange es keinen Vanadalismus gibt. Dennoch können Spieler möglicherweise zuverlässige Dokumente benötigen. Das betrifft im Wesentlichen:

  • Der Ryzom Verhaltenscodex des gesamten Spiels, inklusive der Wiki.
  • Die Lore', die die grundlegenden Merkmale des Spiels festlegt (Homins sprechen kein Klingonisch, Karavans fliegen nicht auf Feuerdrachen und Kami tauchen nicht aus eine Öllampe auf). Diese Merkmale sind im [[Portal:Lore| Portal Lore] detailliert beschrieben. Hier werden diese kurz beschrieben, um ihre Existenz anzudeuten.

Andere Dokumente können als empfindlich für die Wartung gesehen werden, wie zum Beispiel die häufig genutzten Vorlagen, die das Aussehen und sogar die Lesbarkeit der Dokumente verändern können.

Schließlich können die Mitwirkende, ob Entwickler, Spieler (RP oder nicht), Animatoren oder andere, es nützlich finden die Validierung ihrer Arbeit anzufragen.

>Ein Dokument, dass durch die Loristen, die offizellen Komunikationsoffiziere oder der Administratoren validiert wurde, ist geschützt gegen jede Modifikation, die nicht ausdrücklich genehmigt wurde.

Die Lore

Zusammenfassung der spezifischen Behandlung von Dokumenten der Lore

Offizelle Kopie

Von den Loristen geschriebene Texte, transkribiert oder übersetzt von Encyclopatysten. Ganz oben auf der Seite ist das Lore Logo angebracht {{Official Lore}}, welches als Bild angezeigt wird Rubber-Stamp-Lore choix Vert.png

Kreation von Nicht-Lorist

Um eine Validierung vom Lore-Team anzufordern, füge ganz oben auf der Seite das Banner {{Lore Validation Request}} hinzu, welcher wie folgt angezeigt wird:

Vorlage:Lore Validation Request

Validierung

Ein Lorist bringt, falls das nicht schon getan wurde, das Lore Logo an, und löscht jedes Banner, das möglicherweise für eine Validierungsanfrage genutzt wurde. Dann schützt der Lorist (der diese Aufgabe als Administrator delegieren kann) die Seite. Das Lore Logo wird dann zu: Rubber-Stamp-Lore choix H.png.

Kategorien

Alle Daten, Artikel, Bilder, Vorlagen, Portale, usw., müssen kategorisiert werden.

Verwendung der Kategorien

Kategorien sind sehr nützlich zur Katalogisierung von Dokumenten und erleichtern die Suche. Es muss verstanden werden, dass eine Kategorie einem Set im mathematischen Sinne des Ausdrucks ähneltm in anderen Worten:

  • ein Artikel can mehreren Sets angehören
  • ein Set eines Artikels can völlig in einem Anderen beinhaltet sein
  • Es ist nicht notwendig einen Artikel, der zwei Sets angehört, zu deklarieren, falls einer von beiden von dem anderen komplett einbezogen wurde.

Beispiel: rote Socke kann Socke, rote Objekte, rote Kleidung, Kleidung angehören. Normalerweise genügt es, wenn man erklärt, dass die Socke zu den rote Kleider gehört. Aber man könnte auch sagen, dass die Socke zu den roten Objekte gehört ohne sich auf rote Kleider zu bezieht. In beiden Fällen ist es sinnlos zu erklären, dass es zu Kleider gehört.

Die Auswahl der Kategorien kann manchmal mit Werkzeugen verlinkt werden, die es erlauben in einer Kategorie zu suchen und die oft in Portalen angezeigt werden. Zum Beispiel:

Portal …

There are for now 19 pages …

Das wird erreicht durch Es gibt jetzt{{Number of pages}} Seiten auf …

Natürlich scheint es aus dem vorherigen Beispiel, dass es Ausnahmen geben kann, die hauptsächlich mit der Ergonomie der Forschung zusammenhängen. Tatsächich erfordert die automatische Suche (zufällige Suche, um einen Gegenstand einzubeziehen, schaue zum Beipiel Spotlight on unten) in Kategoriebäumen viel Zeit und Energie. Daher ist es vorzuziehen {{Number of pages}} zu nutzen, was nicht in Unterkategorien fällt.

The main categories of this wiki

Wikis, linked to the Ryzom universe, are supposed to share data common to the basic languages of the game. These common data are grouped in four trees detailed in the article Categorization. Only the “big branches” are detailed to leave the freedom to organize the data to each linguistic group. But these trunks and their “big branches” are essential, especially for translators who want to easily navigate between groups of articles.


6 wikis, 6 category systems, all images in common
—• Six wikis, six category systems, all images in common •—

Template

Translated excerpt from Wikipédia Aide:Modèle

A template is used to reproduce the same message, or the same layout, on several pages, sometimes according to parameters.

It is a pre-written element, more or less complex, intended to be embedded in a page in order to instantly obtain the desired visual result (formatting, display of specific elements, etc.). The banners at the top of the articles, the infoboxes, the centuries display… are templates.”

(see Wikipedia Help:Template for further information)

Visual aspect and graphic charter

The visual aspect must recall the identity of the game. For example: “infoboxes” remind us of “memory ambers” (RP) or interfaces of the Karavan (OOC). Icons in general refer more or less clearly to the game world.

A graphic charter has two functions (at least):

  • an identification function, recalling the spirit of the site (for example by using the emblematic colours of nations, factions);
  • an ergonomic function, by avoiding the “element of surprise”, i.e. avoiding differences of behaviour between pages or between translations.

For these two reasons, it should be adhered to as much as possible.

Banners, seals and indicators in header

Header or paragraph templates are used to alert the reader on the way the page they are consulting should be interpreted (obsolescence, in the process of being written, etc.) and to highlight important announcements regarding the article.

Banners, navigation, time stamps

Footer templates are used to provide the reader with additional information that may be of interest after reading the page.

Page body

Page body templates are used to complete or highlight information related to the current page. Highlightings can be diverse, such as large inserts or various typographic layouts.

Naming your Template

Some rules for naming templates.

All templates

Warning : not exactly the same for all languages, but let us try to harmonize them as much as possible.

All templates are placed in the Category:Templates whose tree view is explained in the document Categorization#The_Wikipatys

Portal

Portals in our wiki serve as home pages for the various major areas of interest in the game. They are listed in the panel {{Portal bottom}}

Spe labs.png

Haupt-Portale der Ryzom Wiki

Ryzom: Die LoreDas Spiel OOC
Atys: Die Welt von AtysFloraFauna
Nationen: FyrosMatisTrykerZoraï
Fraktionen: KamiKaravanMarodeureRangerTrytonisten
Enzyklopädie: Atys ChronikenDie Große BibliothekMysterien OOC


All portals have a similar structure, but their appearance varies according to the complexity of the data they present. In general, a portal contains, from top to bottom:

  • several tabs of sub-themes, the general home page positioning the reading on the first of them; in some cases, there may be a second row of tabs;
  • the number of articles concerned and categorized (see Associated categories) ;
  • a summary;
  • information (on the left the Doc of the day, on the right a Bulletin board);
  • the panel summarizing the main portals of the Ryzom Wiki ({{Portal bottom}}).

Portals have not been built in a day and therefore their design has been refined over time. In general, we try to include documents in them using the template {{:DOCNAME}} where DOCNAME=Name of the document to include.

Doc of the day

It is sometimes pleasant to have documentation that gives an overview of the themes presented under the portal. This can be done as follows:

A different document included ENGLISH FRENCH
When necessary {{:Featured article/...}} {{:Lumière sur/...}}
Every day of the week {{:Featured article/GBA/Week/{{CURRENTDOW}}}} {{:Lumière sur/.../Jour/{{CURRENTDOW}}}}
Every day of the month {{:Featured article/GBA/Month/{{CURRENTDAY2}}}} {{:Lumière sur/.../Mois/{{CURRENTDAY2}}}}

Bulletin board

Bulletin boards contain information about both readers and contributors. This can range from simple information to emergencies, “To do” lists and “Tips and Tricks”.

Associated categories

All relevant pages

To associate an article to a portal, just add at the bottom of the text of the said article a block of instructions of the following type:

{{clear}}{{Last version link}}
<noinclude>{{Portal|xxx}}
[[Category:yyyy]]</noinclude>

where:

  • the “clear” ensures that the navigation bar to the portal is well above the last image;
  • the “last version link” allows you to time stamp the page and adds a discreet tab to find the origin of an inclusion;
  • the “noinclude” can be put in so as not to pollute the inclusion.

On the front page

Adding the navigation banner to the portal also places the article in “hidden” categories, categories that would not be shown to the reader because they are not relevant, but are indicated by a [+] located after the last displayed category. The random choice technique has been rejected by Mediawiki as too expensive. Currently, it is preferred a restricted choice (day of the week or month). This requires you to create one redirection at a time to the page you want to highlight. Thus, for example, the “Featured article/GBA/Day/3” page (3rd of the month or Wednesday) is redirected to “Primes Raider”.

What if the article is too long to be included, or if only some of its sections are worthwhile?

The wisest way is to signal the sections to be displayed or hidden in the future inclusion by marking them up in the source article.

  • <noinclude> and </noinclude></noinclude> tags allow to exclude the parts they frame from the future inclusion.
  • <onlyinclude> and </onlyinclude> tags allow to include only the parts they frame in the future inclusion.
  • <includeonly> and </includeonly> tags allow to include only the parts they frame in the future inclusion, while masking them in the original article (to be handled carefully in a template).
This latter markup is used, for example, to hide in the original article the “To be continued…” ({{read more|<<the original article>}} displayed below) but displays it in the inclusion.


Home page

Home pages are “specific” because they are those that appear by default when you log in to the wiki. These pages are not editable and can contain many HTML (and Java) tricks. This implies that only seasoned contributors can modify them on community consensus or communication imperatives.


Other advanced commands

Other usefull links



Last version 2019-07-01•