Wiki Technical Guide

Translation Status → This page is one of the 25 we would like to see translated into English.

Übersetzt •

Translated •

Traducción requerida •

Original •

Не переведено

A short technical guide for experienced contributors and documentation managers. See Writing Guide for basic wiki knowledge.

1 Working as a team
- 1.1 Talk pages or Discussion pages
- 1.2 Sponsorship
2 Translations
3 Edition
4 Validation of content
- 4.1 The Lore
- 4.2 Displaying the wiki in the game
  - 4.2.1 Example
  - 4.2.2 In summary and in images
5 Categories
- 5.1 On the use of categories
  - 5.1.1 The main categories of this wiki
6 Template
7 Portal
8 Home page
9 Other advanced stuffs

Working as a team

Never forget that any document (except protected pages, accessible only to administrators) can be edited at any time by anyone. See below (Edition puis Content Validation) for good practices to be followed.

When writing with others, it is best to use a PAD. More on File formats#The .pads.

Talk pages or Discussion pages

It is often useful, convenient or necessary to leave a message to someone else. For that purpose a “Talk” page (the tab is named Discussion) is associated with each document when it is created, for example here: Talk:Wiki Technical Guide [[Talk:{{FULLPAGENAME}}]].

In any case, you must try to maintain something readable, so each topic will start with a title ===Title of the topic==. It is better to have fifty small separate subjects, each with a title, than a single package of fifty subjects. This facilitates discriminated responses in their consideration, implementation, etc.

At the end of the subject, always sign with ~~~~. This immediately lets anyone know who posted the message and when.

Usually, responses are made by indenting as in emails. This is done by opening the line with one more : than the previous part. Obviously each answer, each rebound will be signed. This is very useful for someone who will ask the same questions later on and who will thus see this discussion as part of a “Knowledge Base”.

Last, it may be useful to attach to the title a ✓ to indicate that the subject is closed ==Title of the topic {{OK}}==. If the subject has to be reopened, the ✓ can be replaced by a ✗ {{KO}}.

Unfortunately, those concerned by the question are not necessarily informed (the number of articles monitored - and therefore likely to have their changes notified - is capped so as not to blow up the database). So, please notify the ones you think concerned about the talk by adding the link to it in their own user talk page. Again, title and signature, even if very short, are welcome.

Sponsorship

At first glance we will notice that if the Wiki is easy at writing, it is heavy to manage with all its rules of conviviality and efficiency, its traditions built on the experience of its predecessors, etc. This because the wiki also has its “Lore” (oral tradition).

Do you really want to get involved in the wiki? So don't hesitate to be sponsored, without embarrassment, shyness or shame... We have all made our debut, and perhaps, hopefully, it will be up to you to sponsor later on. You don't know anyone? Try to contact “alumni” on https://chat.ryzom.com/channel/pj-ryzom_wiki or contact them from Special:ActiveUsers.

Translations

There are four rules that coexist:

• Forge (development part), Game behaviour chart, Graphic chart, Fundamental categories

everything must be translated into English to be accessible to as many people as possible, whose majority more or less understand written English;

• In-Game Behavior Chart, Graphic Chart, Wiki Management Templates, Fundamental Categories

everything must be translated into all languages;

• Lore, Chronicles, Public events

everything must be translated into at least Ryzom's three “mother tongues”: DE, EN and FR;

• the rest and especially the roleplay parts

there are no rules, only players' and translators' concerns prevail.

For help on translating on this wiki, see Help:Interwiki and the oldier WikiTrad-EN.

Edition

With the exception of archived documents and documents with the official status of “final document” (Lore, Chronicle), everything can be improved and this is one of the riches of wikis.

Nevertheless, certain rules of constructive conviviality must be respected.

First of all, it is necessary to assess whether or not the changes are significant. There are no rules and it's more of a feeling, but if the change is drastic, it's wise to start by looking at the page's history (button next to “Edit”). If the content (not the form, look, spelling…) has not changed for some time, we can assume that its author left it for this and that the document may have aged, that it may need updating. An example is shown opposite.

An update can be considered drastic when it deletes paragraphs or even lines that are fundamental to the development of the topic. In this case it becomes appropriate to leave a message in the “User Discussion:xyz” page. While waiting for his answer (one week?), it is wise to keep in the modified page the original text passed as a comment. The easiest way to pass a text as a comment is to preface it with . But there are sometimes issues, especially if there are already other comments. In this case, the hammer and chisel can be used by framing the text with <noinclude><includeonly> and </includeonly></noinclude>. Why such a complication? Because it is always necessary to respect the writings of an author and his intellectual authorship, even in free software world. Otherwise, we run the risk of an:

Edit war

Excerpt from Wikipedia Edit warring:

“An edit war occurs when editors who disagree about the content of a page repeatedly override each other's contributions. Editors engaged in a dispute should reach consensus or pursue dispute resolution rather than edit warring. Edit warring is unconstructive and creates animosity between editors, making consensus harder to reach. Users who engage in edit wars risk being blocked or even banned. An editor who repeatedly restores their preferred version is edit warring, regardless of whether those edits are justifiable: “But my edits were right, so it wasn't edit warring” is no defense.”

As a last resort, an administrator from outside the debate can protect the page. In this case, since all editors have the same editing rights, those involved in the debate are asked to respect the non-editing rule. It is also reminded that participating in an editing war can lead to a blocking of the contributors involved and that at any time the rule of three revocations applies".

This should not be confused with the edit conflict . Excerpt translated from Wikipedia Aide:Conflit de versions:

“In Wikipedia, a version conflict or edit conflict occurs when two contributors work on the same page at the same time: the second one who records, having worked with an obsolete version of the page, has his modification rejected. Since version 1.3 of MediaWiki, this only happens if the changes cannot be merged automatically.“

(see Wikipedia Help:Edit conflict for further information)

Working in tranquillity

Of course, incidents on the course and clumsiness will never be avoided at 100%, so the wisest thing to do is to follow the following recommendations (from Wikipedia Aide:Conflit de versions) :

“To avoid version conflicts, the easiest way is to avoid long modifications.

However, this is not always possible. This is why it is recommended, when modifying a page in depth, to first add the banner {{WIP|~~~~}} which is displayed as follows:

!!!! WIP !!!!

There are currently still 78 articles in preparation in the category "WIP"

Article in preparation. Please let the author finish it before you modify it.
The last editing was from Craftjenn on 7.11.2024.
-- Zo'ro-Argh ^Woren Siloy 28 mai 2019 à 14:19 (CEST)

Once the page is published with this banner, you can modify it at any time. Limit the number of changes by using the preview to make adjustments (this saves time and avoids cluttering the page with recent changes).

When you are finished, don't forget to remove the template {{WIP}}.”

(see Wikipedia Help:Edit conflict for further information)

The draft

Another way to work in peace is to work in your own user space. This space is [[User:Zorroargh/Drafts/...]].

The documents you prepare there are not available to search engines (except explicitly). Even Google shouldn't go there!

Validation of content

Usually, in Ryzom's wikis all pages are free to be processed as long as there is no vandalism. Nevertheless, players may need reliable documents. This essentially concerns:

The Ryzom code of conduct throughout the game, including this wiki.
The Lore which sets the fundamental characteristics of the game (homins don't speak Klingon, Karavan doesn't fly on fire dragons and Kamis don't emerge from an oil lamp). These characteristics are detailed in the portal of the Lore. Here, they will be briefly described to indicate their existence.

Other documents may be considered sensitive for maintenance, such as the widely used templates that can change the appearance, or even readability, of the documents.

Finally, contributors, whether developers, players (RP or not), animators or others, may find it useful to request validation of their work.

A document validated by the Lorists, the official communications officers or the administrators is protected against any modifications not expressly authorized.

The Lore

Summary of the specific treatment of documents related to the Lore

Official copy

Text written by the Lorists and transcribed or translated by encyclopatysts. At the very top of the page, the Lore logo is affixed {{Official Lore}} wihich will display the picture .

Creation of a non-lorist user

To request a validation from the Lore team, put the banner at the very top of the page {{Lore Validation Request}} which is displayed as follows:

This page is submitted to the Lore staff for validation.

Editing date:...

Validation

A Lorist affixes, if that has not already being done, the Lore logo, and erases any banners that may have been used to request validation. Then the Lorist (who can delegate this task to an administrator) protects the page. The Lore logo then becomes: .

Displaying the wiki in the game

The development team likes to use our documents to display them in-game in order to help, enlighten and animate the player in his quests. Our texts are sometimes a little long to be read in-game, so a tool has been provided to indicate which parts are interesting, or even essential. It also makes it possible to remove all the frills of the wiki that cannot be processed in-game or that make it harder to read.

To display only one or more parts of the wiki page, just use the templates IGstart and IGend. The role of these two models is to display only the part of the text included between {{IGstart}} and {{IGend}}. Everything else being invisible in game.

Example

If we open the page Elyps, we will see its complete page presented in the wikis. Between the translation flags at the top and the portal banner and the associated categories at the bottom, the page brings a lot of information. Now, what interests the player is how to use the Elyps in the game. It doesn't matter for him to know the history, and many other details that must satisfy the curiosity of the player out of the game or for the RP. The image opposite shows this part seen by the player in game.

If we open the Elyps page in modification, we will notice that all the previous text {{IGstart} is not displayed in game. Likewise, all the text that follows {{IGend}} is also not. Only what is displayed between {{IGstart}} and {{IGend}}.

In summary and in images

the player discovers the word "Elyps". So he will click on the word to find out what it is about.
The wiki page is way too long for IG use.
Only the part framed in blue is useful.
But it needs a special treatment, because Ryzom does not interpret neither the HTML nor the Mediawiki code.
This selection and processing work will be carried out by writing in the wiki code before and after the chosen part the pair {{IGstart}} and {{IGend}}.
Which gives the final result.

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.

In order to find them, they are under the category Category:Notice templates - for ex: WIP, Obsolete, Stub...

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.

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

If you create your own templates, thanks to add [[Category:User Templates]] (to see examples Category:User Templates).

Naming your Template

Some rules for naming templates (to discuss and create: Naming Templates).

Thanks to add the category [[Category:User Templates]] to your personal Templates.

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}}

All thematic Portals of Encyclopatys (Ryzom Wiki)

Ryzom: The Lore • The Game ^OOC
Atys: Atys world • Flora • Fauna
Nations: Fyros • Matis • Tryker • Zoraï
Factions: Kami • Karavan • Marauders • Rangers • Trytonists
Encyclopedia: Atys Chronicles • The Great Library • Mysteries ^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.

More on Category:Portal Link (explain the link between categories and portals) and on Help:Transclusion (about noinclude and other include tags, and wiki IG) .

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.

Read more about it...

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 stuffs

API, tips on Special commands, dynamics categories trees, comparison on wikis statistics...

Consult the categories category:Help and (more technical: templates, portals...) category:Wikipatys.
Thanks to use the public RC channel (rather than personal tell very often, the same questions occurs, and you probably get faster a answer) https://chat.ryzom.com/channel/pj-ryzom_wiki
In the pj-ryzom_wiki, there's several topix by themes, with in the title the word FAQ (for help on search in RC, read Chat/RC FAQ#Searching in a channel, RC is very powerful ans lot of features are "underused" D)
- FAQ - common: for questions and answer about Ryzom common (who has all images, for the 5 wikis and images
- FAQ Templates/Modèles: for questions and answer about Templates
- FAQ - backgroud colors: for questions and answer relating to formatting, graphic design... (and the various related models)
- FAQ - category
- FAQ - bot

an array with categories and portals is on https://atys.wiki.ryzom.com/wiki/Ryzom_Wiki_Categories_v_Portals
an array (FR, EN and DE) about main Special pages on Wiki_Technical_Guide/Special_Pages
some notes bout API (give commands to wiki using URL) Wiki Technical Guide/API
Notes about dynamic tree (used in core for categories) 🇫🇷 fr:Utilisatrice:Craftjenn/ArboCaté • 🇬🇧 [#Wiki codes about categories]] • 🇩🇪 and common atys:User:Craftjenn/common categories tree and info‎‎
caution (can be dangerous, reserved to admins) Special:MassEditRegex + https://regex101.com/
on <noinclude>: https://meta.wikimedia.org/wiki/Help:Template https://meta.wikimedia.org/wiki/Migration_to_the_new_preprocessor

Namespaces

What is a name space ? - ns in short

Advanced search options: by default, the search won't search in User:

Pages on a MediaWiki wiki are grouped into collections called “namespaces” which differentiate between the purpose of the pages at a high level. Pages in certain namespaces can also have special properties or behave differently when they interact with other pages.
Namespaces are indicated in page titles by prefixing the page name with <namespace>:. A page whose name is not prefixed by a namespace lies in the mainspace.
More on official help: https://www.mediawiki.org/wiki/Help:Namespaces and more about Search and find on Wikis.
In concrete terms, this means that you can have two different pages (with the same name, but with different content), with the same name, without conflict. For example:
- Help (will be in main space)
- Help:Help (the page name is Help, but in Help: ns)
- Talk:Help (talks about the Help page) - as each name space has its own Talk: namespace :)
For example, your profiles (with personal amber, your drafts and biography) should be, under the namespace User ^[1].
- If in these draft pages, there is no category, then you can work quietly on your writing and drafts (no risk of editing conflict), because by default, the pages of the name space User do not appear in the search results (see image: the User is by default not checked).
- If your draft has categories: an homins can find your draft page, while surfing on categories.

Here are the namespace value and content in our main wikis (because of history, and wikis merge):

see all ns on 🇬🇧 English wiki Wiki Technical Guide/EN ns list
see all ns on 🇫🇷 French wiki fr:Guide Technique du wiki/FR ns liste
See all ns on 🇩🇪 German wiki de:Technischer Wiki-Leitfaden/DE ns list
See all ns on common atys:Help:Common ns list‎

Wiki Technical Guide/Comparaison of lists ns and other has some notes, questions.

Wiki codes about categories

on common, Heernis used <categorytree mode="all" depth="20" showcount"on" hideprefix="never">Wikipatys</categorytree> to get result: Wikipatys, Deutsch, English, Graphic Charter, Hidden categories
The code <categorytree>Foo</categorytree> on a wiki page, will show the contents of category Foo as a dynamic tree on that page.

More on Wiki Technical Guide/Comparaison of lists ns and other#Wiki codes about categories

For tree in French wiki : fr:Utilisatrice:Craftjenn/ArboCaté
atys:User:Craftjenn/common categories tree and info

Special Pages

See an array (FR, DE, EN) with useful special pages on Wiki Technical Guide/Special Pages and Wiki Technical Guide/Statistics on the March 5th 2020

We see that

The French wiki has nearly 3x more pages than the English one.
Most of the Users stats are the same in the 5 wikis (excepts the Registered)

a new wiki account request

For now (2020 April), bureaucrats can see request, but not validate any. Adminstrators (role in wikis) can validate the wiki account requests (later, all user will logon wiki with their game credentials).

You'll see this message ^[2], on Recent updates

A new wiki account request

Erasing content

About a question asked about the [:category:To Delete], "for this category To Delete: I don't understand why it exists."

Answer 1: there could be a link to the deleted page/category on another wiki, a user could via a Trad or TIP link eternally re-create the deleted page. Waiting a bit is therefore more careful (cleaning up on other wikis).

Answer 2 from Zo:

Very important: categories are not pages managed by mediawiki as pages.

It is a "separate object" in the database.

When you don't comment on a category, even if you add a parent category to it, the category deletes itself when it's empty after a certain delay, which my superpowers 😈 allow to make instantaneous.

when you create a page for the category, you sort of impose a double link in the database and the category becomes linked to a page.

But a page, even destroyed remains in the DB!

So, when a category has been whitened and no "element" is included, the category self-destructs thanks to the Mediawiki mechanism. We don't have to do anything. The only thing I can do is to force the purge (thus cleaning the cache) so that this mechanism is triggered faster than expected. And again, the result may not be immediate, because it depends on the workload at that time on the DB.

If someone creates an article or other object referring to this category, it wakes up by itself thanks to the Mediawiki engine.

This awakening is completely disrupted if the category has been voluntarily destroyed manually, because mediawiki monitors the "resurrection" of the destroyed items.

In fact, destroying a category is like creating a zombie to be a RP ( 😉 ).

relationship between categories and templates

Yes almost all banners create the corresponding category. Advantage:

The editor doesn't have to bother with categories or forget about them.
It allows us to edit ALL pages containing this banner at low cost. If we were on a Wikipedia with a thousand articles having this banner, we just have to change the template, to change the categories of this thousand articles.

Patches publication

In November 2024, Ulu changed the way patches are displayed in-game.

Here's help on publishing them on the wiki:

open this page https://app.ryzom.com/app_releasenotes/index.php?output=wiki (and copy its contents)
on the right, there's a COPY WIKI SYNTAX link
paste on a page (use Template:PatchnoteBox)
fill in the previous patch
at the bottom, check categories

From EncyclopAtys

Contents