Line 34: | Line 34: | ||
There are two kinds of documentation of categories, and so two kinds of treatment: | There are two kinds of documentation of categories, and so two kinds of treatment: | ||
* A short description on just about one line: | * A short description on just about one line: | ||
− | # | + | *# Copy this command in your new page: <pre>{{subst:CategoryShortDesc}}</pre> |
− | # | + | *# Save this page immediately with that one line. |
− | # | + | *# Reopen this saved page: it will contain the minimum skeleton to continue your work. |
* The description is long, over 5 lines, may be because you add rules: | * The description is long, over 5 lines, may be because you add rules: | ||
− | # | + | *# Copy this command in your new page: <pre>{{CategoryTab}}</pre> |
− | # | + | *# Save this page immediately with that one line. |
− | # | + | *# Click on one of the tabs to open your language and create a new page. Follow the instructions to initialize a non-existent translation (see below). '''Please, do not change the name of pages documenting the categories given by that templates.''' |
− | + | ||
==== Template documentation ==== | ==== Template documentation ==== | ||
− | The description of ''' '' template '' ''' is usually longer and complex than a ''' '' category '' '''. | + | The description of ''' '' template '' ''' is usually longer and more complex than a ''' '' category '' '''. |
− | * Start by adding the following lines at the beginning or end of the template replacing '"foo"' | + | * Start by adding the following lines at the beginning or the end of the template replacing '' "foo" '' with the appropriate categories: |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<pre> | <pre> | ||
<nowiki><noinclude>{{{{FULLPAGENAME}}/Documentation}} | <nowiki><noinclude>{{{{FULLPAGENAME}}/Documentation}} | ||
[[Category:foo]]</noinclude></nowiki> | [[Category:foo]]</noinclude></nowiki> | ||
</pre> | </pre> | ||
− | * | + | * Next: |
− | *# | + | *# In the blank page of the documentation of a ''' ''Template'' ''' (''Template:<name_of_the_template_to_describe>/documentation''), copy this <pre>{{subst:Template Documentation}}</pre> |
− | *# | + | *# Save this page immediately with that one line. |
− | *# | + | *# Reopen this page search: it will contain the "Templates" for continuing the work of documentation. Indeed there is a ready template for each language. For the French it was: <pre>{{subst:Template FR Documentation}}</pre> |
− | *# | + | *# Save this page again to "insert" the contents of <nowiki>{{</nowiki>[[Template:Template EN Documentation|Template EN Documentation]]}} instead that matches it. This template pre-formats a documentation page of templates in English. |
− | === | + | === Nonexistent translation === |
− | + | When a document page already exists always in at least one of the 5 languages of Ryzom, it remains to translate it into the others. | |
− | ==== | + | ====Documentation page==== |
− | + | The document pages have on the top 5 language tabs created by the ''' ''<nowiki>{{</nowiki>[[Template:TabLang|TabLang]]}}'' '''. | |
− | + | By default, until the page has not been translated, there is at the top of the original page something like: | |
− | : ''' ''<nowiki>{{</nowiki>TabLang|FR|DE | + | : ''' ''<nowiki>{{</nowiki>TabLang|FR|DE|<nowiki>{{</nowiki>FULLPAGENAME}}|ES|FR|RU}}'' '''. |
− | + | The indications " '' ... | DE | EN | ES | ... | RU'' " show the missing translations, and clicking on the language tab, we are led to a page like ''' ''[[:FR]]'' '''. Follow the instructions on this page to create a new translation. | |
− | + | When all the pages are translated should find something like: | |
− | :<big><nowiki>{{</nowiki>TabLang|FR|Mein Titel|My title|Mi título| | + | : ''' ''<big><nowiki>{{</nowiki>TabLang | FR | Mein Titel | My title | Mi título | My title | Мое название}}'' '''</big>. |
− | + | The only rule to choose a documentation page title is not to take unfortunately the same name as another page in any language. This rule is less flexible for the categories and templates because of the associated automations. (See: '[[WikiRF]]') | |
− | ==== | + | ==== Category ==== |
− | + | The categories are unique: they gather '''all''' the documents in '''all''' languages except for categories of languages themselves: "[[:category: DE]]", "[[:category: EN]]", "[[:category: ES]]", "[[:category: FR]]" and "[[:category: RU]]". | |
− | + | Their name should be as neutral as possible, that is to say often ''[http://en.wikipedia.org/wiki/Basic_English basic English]''. | |
− | + | The documents of the categories are always formated in the same manner to ensure the operation of bots: XX_YYY, where XX is the two-letter language and YYY the exact name of the category. | |
==== Template documentation ==== | ==== Template documentation ==== | ||
− | |||
− | + | More than for the categories, the best and wiser is to no create templates in different languages. Only documentation should be translated. On the other hand, documentation template is often ''embedded'' in the template itself, and especially this documentation should not change the behavior of the template. It goes without saying that inside the templates common to the 5 language, it is written as "neutral" as possible. | |
− | # | + | |
− | ## | + | Open the document page of the template: |
− | ## | + | # It contiend in red the missing documentation <nowiki> {{</nowiki>Template: Template documentation}} XX where XX is the two-letter language of the translated text. |
− | # | + | ## Start by translating the documentation for your language of competence. You will only to do it once. |
+ | ## Save again this page to "insert" the contents of <nowiki> <nowiki>{{</nowiki>Template:Template XX Documentation}}. This template pre-formats a chapter of the template documentation page in XX. Then go the next step: | ||
+ | # Your chapter is pre-formated: complete / edit the associated paragraphs. | ||
==FAQ== | ==FAQ== | ||
− | === | + | === How to prevent user to work on a page that Iam writing and that is not yet ready to share? === |
− | + | Put at the top of the page the banner template [[Template:WIP|WIP]] | |
<pre>{{WIP}}</pre> | <pre>{{WIP}}</pre> | ||
− | === | + | |
+ | === How to prevent images overflow in the following paragraphs? === | ||
<div style="overflow: hidden"> | <div style="overflow: hidden"> | ||
[[File:Outsider2.png|32px|thumb|left|Une image très longue]] | [[File:Outsider2.png|32px|thumb|left|Une image très longue]] | ||
− | + | The most ''clean'' way is to ''frame'' the image within a paragraph like this. You just create a container with the tag <nowiki><</nowiki>div> like this. | |
− | |||
<pre> | <pre> | ||
<div style="overflow: hidden"> | <div style="overflow: hidden"> | ||
− | [[File: | + | [[File:Your pix|200px|thumb|left|The name of the image]] |
− | + | Your text here... | |
</div> | </div> | ||
</pre> | </pre> | ||
+ | But still sometimes, one needs juggle to do something elegant. A wiki is not a SPIP by example and we are not experts in desktop publishing;). | ||
</div> | </div> | ||
− | ===Je | + | |
+ | {{WIP}} | ||
+ | ===Je voudrais que mon texte soit traduit=== | ||
Il faut mettre en haut de la page la bannière le modèle [[Template:toTrad|toTrad]] | Il faut mettre en haut de la page la bannière le modèle [[Template:toTrad|toTrad]] | ||
<pre>{{toTrad| Une langue précise si nécessaire |Un commentaire si nécessaire}}</pre> | <pre>{{toTrad| Une langue précise si nécessaire |Un commentaire si nécessaire}}</pre> | ||
Line 136: | Line 128: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<Pre> | <Pre> | ||
<Div style = "overflow: hidden"> | <Div style = "overflow: hidden"> |
The EN How2 is the page of how to do something in the Ryzom Forge Wiki.
If you're not familiar with wikis and, more specifically with Mediawiki, editing and creating pages may seem complex. Good news: we use a wiki engine that is well documented in every language.
As a user, the most useful information is available here: http://www.mediawiki.org/wiki/User_hub and more precisely here: Mediawiki FAQ.
MediaWiki is used by Wikipedia, which has lots of very good tutorials. Getting the Wikipedia introduction page is a great way to understand what a wiki is and how to begin.
To write the Wiki markup is very complete, and the Cheat Sheet help you to quickly find the most rules used.
Finally, you may also read the [[Introduction to wiki] which is a summary adapted to our Ryzom wiki. In addition, there are several "[category: template | Templates]" to initialize pages, especially including multilingual mode, as you can see in the next paragraphs.
All features available on MediaWiki / Wikipedia is not available on this wiki: some need to be added by an administrator. If you are missing something, contact one and ask him nicely. You can also use the page Wiki_on_Work (reaction time variable depending on the time). Be free to write in it in your language: it is easier for us to have only one page.
{{subst:EN Page}}
When a category appears in red in the bottom of a page, you can document that category explaining what is in it and with what associated rules if necessary. Remember that the text of the Category is not a documentation page itself.
There are two kinds of documentation of categories, and so two kinds of treatment:
{{subst:CategoryShortDesc}}
{{CategoryTab}}
The description of template is usually longer and more complex than a category .
<noinclude>{{{{FULLPAGENAME}}/Documentation}} [[Category:foo]]</noinclude>
{{subst:Template Documentation}}
{{subst:Template FR Documentation}}
When a document page already exists always in at least one of the 5 languages of Ryzom, it remains to translate it into the others.
The document pages have on the top 5 language tabs created by the {{TabLang}} .
By default, until the page has not been translated, there is at the top of the original page something like:
The indications " ... | DE | EN | ES | ... | RU " show the missing translations, and clicking on the language tab, we are led to a page like FR . Follow the instructions on this page to create a new translation.
When all the pages are translated should find something like:
The only rule to choose a documentation page title is not to take unfortunately the same name as another page in any language. This rule is less flexible for the categories and templates because of the associated automations. (See: 'WikiRF')
The categories are unique: they gather all the documents in all languages except for categories of languages themselves: "category: DE", "category: EN", "category: ES", "category: FR" and "category: RU".
Their name should be as neutral as possible, that is to say often basic English.
The documents of the categories are always formated in the same manner to ensure the operation of bots: XX_YYY, where XX is the two-letter language and YYY the exact name of the category.
More than for the categories, the best and wiser is to no create templates in different languages. Only documentation should be translated. On the other hand, documentation template is often embedded in the template itself, and especially this documentation should not change the behavior of the template. It goes without saying that inside the templates common to the 5 language, it is written as "neutral" as possible.
Open the document page of the template:
Put at the top of the page the banner template WIP
{{WIP}}
WIP
in Arbeit -
work in progress -
trabajo en curso -
travaux en cours -
незавершенное
Il faut mettre en haut de la page la bannière le modèle toTrad
{{toTrad| Une langue précise si nécessaire |Un commentaire si nécessaire}}
Par défaut {{toTrad}} indique que l'article est à traduire et est ajouté à la catégorie ToTrad:
Il peut être utile aux participant de Ryzom de savoir quelles sont vos compétences linguistiques, techniques... Vous pouvez utilier pour cela deux infobox:
Vous pouvez utiliser une boite un peu spéciale pour alerter: Template:Banner