Difference between revisions of "EN HOW2"

From Ryzom Forge Wiki

Jump to: navigation, search
m
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TabLang|EN|DE|EN HOW2|ES | FR HOW2 |RU}}
+
{{migrated to|:en:HOW2}}{{TabLang|EN|DE HOW2|EN HOW2|ESHOW2 | FR HOW2 |RU HOW2}}
 +
{{toTrad|DE}}
 +
{{toTrad|ES}}
 +
{{ToTrad|FR|Cette version est améliorée par rapport à la française}}
 +
{{toTrad|RU}}
  
{{ToTrad|DE|Übersetzung benötigt, bitte}}
 
{{ToTrad|EN|Please, check}}
 
{{ToTrad|ES|Traducción necesitada, por favor}}
 
{{ToTrad|FR|Cette version est améliorée par rapport à la française}}
 
{{ToTrad|RU|Перевод нужно, пожалуйста}}
 
 
<!-- ⇩↓⇊⇓⬇ votre texte en dessous ⬇⇓⇊↓⇩ -->
 
<!-- ⇩↓⇊⇓⬇ votre texte en dessous ⬇⇓⇊↓⇩ -->
 
The '''EN How2''' is the page of how to do something in the Ryzom Forge Wiki.
 
The '''EN How2''' is the page of how to do something in the Ryzom Forge Wiki.
Line 14: Line 13:
 
As a user, the most useful information is available here: http://www.mediawiki.org/wiki/User_hub and more precisely here: [http://www.mediawiki.org/wiki/Manual:FAQ Mediawiki FAQ].
 
As a user, the most useful information is available here: http://www.mediawiki.org/wiki/User_hub and more precisely here: [http://www.mediawiki.org/wiki/Manual:FAQ Mediawiki FAQ].
  
MediaWiki is used by Wikipedia, which has lots of very good tutorials. Getting the [http://en.wikipedia.org/wiki/Wikipedia:Introduction Wikipedia introduction page] is a great way to understand what a wiki is and how to begin.
+
MediaWiki is used by Wikipedia, which has lots of very good tutorials. Getting the ''[http://en.wikipedia.org/wiki/Wikipedia:Introduction Wikipedia introduction page]'' is a great way to understand what a wiki is and how to begin.
{{WIP}}
 
To write the syntax is very complete, and the Cheat Sheet page to quickly find the most layouts used.
 
  
Finally, you may also browse the [[Introduction to wiki] which is a summary adapted to our wiki. In addition, there are several "[category: template | Template]" to initialize pages, including multilingual mode.
+
To write the ''[http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup]'' is very complete, and the [http://en.wikipedia.org/wiki/Help:Cheatsheet Cheat Sheet] help you to quickly find the most rules used.
  
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).
+
Finally, you may also read the ''''' "[[Introduction to the Ryzom Forge 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.
  
 +
===Page Not Found (in any language) ===
 +
====Documentation page====
 +
# If there is no page with the title you have chosen, click the title highlighted in red in the message that is at the top of the page «''Search results''»: '''"Create the page "<span style="color: #FF0000;">Your_title</span>" on this wiki!"'''. This action may open a new empty page with your '''Your_title''' as name for it.
 +
# Copy in your new page this command adapted to your language. For instance, for '''English''': <pre>{{subst:EN Page}}</pre>
 +
# Save  immediately this page with this unique line.
 +
# Reopen this page you just have saved: it will contain the minimum skeleton to continue your work.
  
 +
==== Category ====
 +
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.
  
As a user, most of the useful infos are available here:
+
There are two kinds of documentation of categories, and so two kinds of treatment:
[http://www.mediawiki.org/wiki/User_hub/fr] and more precisely here:
+
* A short description on just about one line:
[http://www.mediawiki.org/wiki/Manual:FAQ/fr Faq fr de Mediawiki].
+
*# 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:
 +
*# 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.'''
  
Mediawiki is also used by Wikipedia, where you can find lots of very well built tutorials.
+
==== Template documentation ====
 
+
The description of ''' '' template '' ''' is usually longer and more complex than a ''' '' category '' '''.
And finaly, we have our own '''''[[Introducción to the Ryzom Forge Wiki|manual guide]]''''' for the Ryzom Wiki.
+
* Start by adding the following lines at the beginning or the end of the template replacing '' "foo" '' with the appropriate categories:
 
 
Il existe plusieurs "Template" pour initialiser les pages, notamment en mode multilingue:
 
===Page inexistante (dans aucune langue)===
 
====Page documentaire====
 
# S’il n’y a pas la page avec le titre que vous avez choisi, cliquez sur ce titre marqué en rouge dans le message qui se trouve au début de la page «''Search results''»: '''"Create the page "<span style="color: #FF0000;">Votre_Titre</span>" on this wiki!"'''
 
# Copiez dans votre nouvelle page cette commande adaptée au '''français''': <pre>{{subst:FR Page}}</pre>
 
# Sauvez immédiatement cette page avec cette unique ligne.
 
# Rouvrez cette page sauvegardée: elle contiendra le squelette minimum pour continuer votre travail.
 
 
 
====Catégorie====
 
Lorsqu'une catégorie apparait en rouge, vous pouvez la documenter pour expliquer ce que contient la catégorie et les règles associées si nécessaire. N’oubliez pas que le texte de la catégorie n'est pas une page documentaire en soi. Elle n'est là que pour expliquer ce qu'on y trouve et éventuellement quelles sont les règles de catégorisation.
 
*Le texte explicatif est court, sur à peu près une ligne:
 
*# Copiez dans votre nouvelle page cette commande: <pre>{{subst:CategoryShortDesc}}</pre>
 
*# Sauvez immédiatement cette page avec cette unique ligne.
 
*# Rouvrez cette page sauvegardée: elle contiendra le squelette minimum pour continuer votre travail.
 
*Le texte explicatif est long, plus de 5 lignes:
 
*# Copiez dans votre nouvelle page cette commande: <pre>{{CategoryTab}}</pre>
 
*# Sauvez immédiatement cette page avec cette unique ligne.
 
*# Cliquez sur l'un des onglets linguistique pour ouvrir et créer une nouvelle page. Suivez les consignes pour initialiser une traduction inexistante (cf plus bas). '''Ne changez pas le nom des pages documentant les catégories.'''
 
 
 
====Documentation de modèle (Template)====
 
Autant le description d'une catégorie est en général courte, autant un "Template" peut être plus complexe.
 
*Il faut commencer par ajouter les lignes suivantes en début ou en fin du template en remplaçant '' "foo" '' par les catégories adéquates:
 
 
<pre>
 
<pre>
 
<nowiki><noinclude>{{{{FULLPAGENAME}}/Documentation}}
 
<nowiki><noinclude>{{{{FULLPAGENAME}}/Documentation}}
 
[[Category:foo]]</noinclude></nowiki>
 
[[Category:foo]]</noinclude></nowiki>
 
</pre>
 
</pre>
*Ensuite:
+
* Next:
*# Dans la page vierge de documentation d'un "Template" (''Template:<nom_du_template_à_documenter>/documentation''), copiez cette commande: <pre>{{subst:Template Documentation}}</pre>
+
*# 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>
*# Sauvez immédiatement cette page avec cette unique ligne.
+
*# Save this page immediately with that one line.
*# Rouvrez cette page sauvegardée: elle contiendra les "Templates" nécessaires à la poursuite du travail de documentation. En effet il y a un Template prêt par langue. Pour le français on a: <pre>{{subst:Template FR Documentation}}</pre>
+
*# 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>
*# Sauvez à nouveau cette page pour "insérer" le contenu de <nowiki>{{</nowiki>[[Template:Template FR Documentation|Template FR Documentation]]}} à la place qui lui correspond. Ce Template préformate une page de documentation des Templates en français.
+
*# 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]]}}'' '''.
  
===Traduction inexistante===
+
By default, until the page has not been translated, there is at the top of the original page something like:
Lorsqu'une page existe déjà dans une des 5 langues de Ryzom Forge, il reste à la traduire dans les autres.
+
: ''' ''<nowiki>{{</nowiki>TabLang|FR|DE|<nowiki>{{</nowiki>FULLPAGENAME}}|ES|FR|RU}}'' '''.
====Page documentaire====
 
Les pages documentaire ont en haut de la page 5 onglets linguistiques créé par le ''' ''<nowiki>{{</nowiki>[[Template:TabLang|TabLang]]}}'' '''.
 
  
Par défaut, tant que la page n'a pas été traduite, il y a en haut de la page originale quelque chose comme:
+
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.
: ''' ''<nowiki>{{</nowiki>TabLang|FR|DE|EN|ES|<nowiki>{{</nowiki>FULLPAGENAME}}|RU}}'' '''.
 
  
Les indications " ''...|DE|EN|ES|...|RU'' " montrent les traductions manquantes, et en cliquant sur l'onglet linguistique, on est conduit vers une page comme '''[[:FR]]'''. Suivez les consignes de cette page pour créer une nouvelle traduction.
+
When all the pages are translated should find something like:
 +
: ''' ''<big><nowiki>{{</nowiki>TabLang | FR | Mein Titel | My title | Mi título | My title | Мое название}}'' '''</big>.
  
Lorsque toute les page sont traduites on devrait trouver quelque chose comme:
+
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]]')
:<big><nowiki>{{</nowiki>TabLang|FR|Mein Titel|My title|Mi título|Mon titre|Мое название}}</big>.
 
  
La seule règle pour choisir un titre de page documentaire est de ne pas prendre par hasard le même titre qu'une page dans une autre langue. Cette règle est moins souple pour les catégorie et le modèles (templates) à cause des automatismes qui y sont associés. (cf:'''[[ 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]]".
  
====Catégorie====
+
Their name should be as neutral as possible, that is to say often ''[http://en.wikipedia.org/wiki/Basic_English basic English]''.
Les catégories sont uniques: elles rassemblent '''tous''' les document dans toutes les langues à l’exception des catégories de langues proprement dites: [[:category:DE]], [[:category:EN]], [[:category:ES]], [[:category:FR]] et [[:category:RU]].
 
  
Leur nom doit donc être le plus neutre possible, c'est-à-dire souvent en ''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.
  
Les documents descriptifs des catégories sont toujours formatés de la même manière afin d'assurer le fonctionnement des automates: XX_YYY, où XX sont les deux lettres de la langues du texte et YYY le nom '''exact''' de la catégorie.
+
==== Template documentation ====
  
====Documentation de modèle (Template)====
+
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.
Plus que pour les catégorie il vaut mieux éviter de créer des modèles (templates) différents par langues. Seule la documentation mérite d'être traduite. par contre, la documentation du template est souvent "embarquée" dans le template proprement dit, et surtout cette documentation ne doit pas modifier le comportement du modèle. Il va de soi que l'intérieur des modèles communs au 5 langues est écrit de manière la plus "neutre" possible.
 
  
Ouvrez la page documentaire du template:
+
Open the document page of the template:
# Elle contiend en rouge les documentations manquantes <nowiki>{{</nowiki>Template:Template XX  Documentation}} XX sont les deux lettres de la langues du texte traduit.  
+
# It contiend in red the missing documentation <nowiki> {{</nowiki>Template: Template documentation}} XX where XX is the two-letter language of the translated text.
##Commencez par traduire la documentation dans votre langue de compétence. Vous n'aurez qu'un fois à le faire.
+
## Start by translating the documentation for your language of competence. You will only to do  it once.
## Sauvez à nouveau cette page pour "insérer" le contenu de <nowiki>{{</nowiki>Template:Template XX Documentation}}. Ce Template préformate un chapitre de la page de documentation des Templates en XX. Passez à l'étape suivante:
+
## 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:
# Votre chapitre est préformaté: compléter/éditer les paragraphes associés.
+
# Your chapter is pre-formated: complete / edit the associated paragraphs.
  
 
==FAQ==
 
==FAQ==
===Comment empêcher les utilisateur d'intervenir sur une page que je rédige et qui n'est pas prête?===
+
=== How to prevent user to work on a page that Iam writing and that is not yet ready to share? ===
Il faut mettre en haut de la page la bannière le modèle [[Template:WIP|WIP]]
+
Put at the top of the page the banner template [[Template:WIP|WIP]]
 
<pre>{{WIP}}</pre>
 
<pre>{{WIP}}</pre>
===Comment empêcher que les images débordent dans les paragraphes suivants?===
+
 
 +
=== 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]]
La manière la plus ''propre'' consiste à encadrer l'image à l'intérieur d'un paragraphe comme ici. Pour cela il suffit de créer un conteneur avec les balises <nowiki><</nowiki>div>, mais il faut malgré tout parfois jongler pour obtenir quelque chose d'élégant. Un wiki n'est pas un SPIP par exemple et nous ne sommes pas des experts de PAO ;).
+
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.
En effet, normalement une image de 200px est une bonne mesure moyenne. Parfois on peut agrandir ce chiffre, mais dans ce cas, le mélange texte et image ne se justifie plus, et l'image peut occuper toute a largeur de la page. Ou, ici, l'image est beaucoup trop haute, il faut donc réduire sa taille globale. Il n'est pas recommandable de descendre en dessous de 32px.
 
 
<pre>
 
<pre>
 
<div style="overflow: hidden">
 
<div style="overflow: hidden">
[[File:Votre image|200px|thumb|left|titre de l'image]]
+
[[File:Your pix|200px|thumb|left|The name of the image]]
Votre texte ici...
+
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 voudrait que mon texte soit traduit===
+
=== I would like my text be translated ===
Il faut mettre en haut de la page la bannière le modèle [[Template:toTrad|toTrad]]
+
Put on the top banner template:[[Template:toTrad|toTrad]].
<pre>{{toTrad| Une langue précise si nécessaire |Un commentaire si nécessaire}}</pre>
+
<pre>{{toTrad| A precise language: DE, EN, ES... | Leave a comment if necessary }}</pre>
Par défaut <nowiki>{{toTrad}}</nowiki> indique que l'article est à traduire et est ajouté à la catégorie [[:Category:ToTrad|ToTrad]]:
+
By default <nowiki>{{toTrad}}</nowiki> indicates that the article is to be translated and is added to the category [[:Category:ToTrad|ToTrad]]:
*Il est possible de limiter la traduction à une seule langue. Par exemple <nowiki>{{toTrad|RU}}</nowiki>.
+
*It is possible to limit the translation to a single language. Eg <nowiki>{{toTrad|RU}}</nowiki>.
*Il est possible de changer le texte par défaut. Par exemple <nowiki>{{toTrad| |Veuillez corriger le paragraphe 3}}</nowiki>.
+
*You can change the default text. Eg <nowiki>{{toTrad| |Please correct paragraph 3}}</nowiki>.
===Mon profil utilisateur===
+
 
Il peut être utile aux participant de Ryzom de savoir quelles sont vos compétences linguistiques, techniques...
+
===My user profile===
Vous pouvez utilier pour cela deux infobox:
+
It may be useful for Ryzom wiki contributors to know what are your language, technical skills ...
*[[Template:babylon]]: (déformation de Babel) cette petit boite donne vos compétence linguistique.
+
You can use for this two infobox:
*[[Template:QuiSuisJe]]: Cette boite donne vos compétences technique et votre activité dans le jeu.  
+
*[[Template:babylon]]: (deformation of Babel) this little box gives your languages proficiency.
===Comment ajouter une info importante?===
+
*[[Template:QuiSuisJe]]: This box gives your technical skills and your business in the game.
Vous pouvez utiliser une boite un peu spéciale pour alerter: [[Template:Banner]]
+
=== How to add significant information? ===
 +
You can use a special box to alert: [[Template: Banner]]
 
<!-- ⇧↑⇈⇑⬆ votre texte au dessus ⬆⇧↑⇈⇑ -->
 
<!-- ⇧↑⇈⇑⬆ votre texte au dessus ⬆⇧↑⇈⇑ -->
 +
{{In_Category|Wiki}}
 
{{TPInWikiRyzom}}
 
{{TPInWikiRyzom}}
[[Category:EN]]
+
[[Category:Tutorials]][[Category:Wiki]][[Category:EN]]
 
 
 
 
 
 
The main text is in '' '' '[[Introduction to wiki]]' '' '' which is suitable for this wiki.
 
 
 
There are several "Template" to initialize pages, including multilingual instruction:
 
=== Page Not Found (in any language) ===
 
Page documentary ==== ====
 
# If there is no page with the title you have chosen, click the title highlighted in red in the message that is at the top of the page "'Search results'' '' ''" Create the page "<span style =" color: # FF0000 "> Votre_Titre </ span>" on this wiki "'' '!
 
# Copy in your new page adapted to this command '' 'French' '' <pre> {{subst: FR Page}} </ pre>
 
# Save this page with this unique online immediately.
 
# Reopen this page search: it will contain the minimum skeleton to continue your work.
 
 
 
Category ==== ====
 
When a category appears in red, you can document to explain what's in the class and the associated rules if necessary. Remember that the text of the class is not a documentary page itself. It is only there to explain what is there and what are the possible categorization rules.
 
* The narrative is short on just about a line:
 
# * Copy this page in your new command: <pre> {{subst: CategoryShortDesc}} </ pre>
 
# * Save this page immediately with that one line.
 
* # Reopen this page search: it will contain the minimum skeleton to continue your work.
 
* The narrative is long, over 5 lines:
 
# * Copy this page in your new command: <pre>}} {{CategoryTab </ pre>
 
# * Save this page immediately with that one line.
 
* # Click one of the tabs to open language and create a new page. Follow the instructions to initialize a non-existent translation (see below). '' 'Do not change the name of pages documenting the categories.' "
 
 
 
==== Template documentation (Template) ====
 
Both the description of a class is usually short, as a "template" can be more complex.
 
* Start by adding the following lines at the beginning or end of the template replacing '"foo"' through the appropriate categories:
 
<Pre>
 
<Nowiki> <noinclude> {{{{}} FULLPAGENAME / Documentation}}
 
[[Category: foo]] </ noinclude> </ nowiki>
 
</ Pre>
 
* Next:
 
* # In the blank page of documentation of a "Template" ('Template: <nom_du_template_à_documenter> / documentation'), copy this command: <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: FR Documentation Template}} </ pre>
 
# * Save this page again to "insert" the contents of <nowiki> {{</ nowiki> [[Template: Documentation Template EN | FR Template Documentation]]}} instead that matches it. This template preformatted page Documentation Templates in French.
 
 
 
=== Nonexistent translation ===
 
When a page already exists in one of five languages ​​Ryzom Forge, it remains to translate it into the other.
 
Page documentary ==== ====
 
The document pages have top 5 language tabs created by the '' '' '<nowiki> {{</ nowiki> [[Template: TabLang | TabLang]]}}' '' ''.
 
 
 
By default, until the page has not been translated, there at the top of the original page something like:
 
'' '' '<Nowiki> {{</ nowiki> TabLang | FR | DE | EN | ES |​​ <nowiki> {{</ nowiki>}} FULLPAGENAME | UK}}' '' ''.
 
 
 
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 | My title | Мое название}} </ big>.
 
 
 
The only rule to choose a page title documentary is not to take a chance the same way as a page in another language. This rule is less flexible for the category and models (templates) because of automation associated. (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 '' basic English '.
 
 
 
The documents of the categories are always formatted in the same manner to ensure the operation of PLCs: XX_YYY, where XX is the two-letter language text and YYY the name '' exact '' 'category.
 
 
 
==== Template documentation (Template) ====
 
More than for the category it is best not to create models (templates) in different languages. Only documentation should be translated. by cons, documentation template is often "embedded" in the template itself, and especially this documentation should not change the behavior of the model. It goes without saying that within the common language models 5 is written so the more "neutral" possible.
 
 
 
Open the document page template:
 
# It contiend red 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 proficiency. You will only have time to do so.
 
## Save this page again to "insert" the contents of <nowiki> {{</ nowiki> Template: Documentation Template XX}}. This template preformatted a chapter of the documentation page Templates in XX. Take the next step:
 
# Your chapter is preformatted: complete / edit the associated paragraphs.
 
 
 
FAQ == ==
 
=== How to prevent user to work on a page that I write and that is not ready? ===
 
There must be top banner model [[Template: WIP | WIP]]
 
<Pre> {{WIP}} </ pre>
 
=== How to prevent images overflow in the following paragraphs? ===
 
<Div style = "overflow: hidden">
 
[[File: Outsider2.png | 32px | thumb | left | A very long image]]
 
The way most 'clean' is to frame the image within a paragraph like this. You just create a container with <nowiki> << / nowiki> div>, but still sometimes juggle it takes to get something elegant. A wiki is not a SPIP by example and we are not experts in desktop publishing;).
 
Indeed, normally an image of 200px is a good average measure. Sometimes you can expand that number, but in this case, the text and picture mixing is no longer justified, and the image can occupy the entire width of a page. Or, here, the picture is far too high, so you have to reduce its overall size. It is not advisable to go below 32px.
 
<Pre>
 
<Div style = "overflow: hidden">
 
[[File: Your picture | 200px | thumb | left | image title]]
 
Your text here ...
 
</ Div>
 
</ Pre>
 
</ Div>
 
=== I would like my text translated ===
 
There must be top banner model [[Template: toTrad | toTrad]]
 
<Pre> {{toTrad | A precise language if necessary | Leave a comment if necessary}} </ pre>
 
Default <nowiki>}} {{toTrad </ nowiki> indicates that the article is translated and is added to the category [[: Category: ToTrad | ToTrad]]
 
* It is possible to limit the translation to a single language. Eg <nowiki> {{toTrad | UK}} </ nowiki>.
 
* You can change the default text. Eg <nowiki> {{toTrad | | Please correct paragraph 3}} </ nowiki>.
 
My user profile === ===
 
It may be useful to the participants of Ryzom to know what your language skills, techniques ...
 
You can utilier why two infobox:
 
* [[Template: babylon]] (deformation of Babel) this little box gives your language proficiency.
 
* [[Template: QuiSuisJe]]: This box gives your technical skills and your business in the game.
 
=== How to add significant information? ===
 
You can use a rather special box to alert [[Template: Banner]]
 

Latest revision as of 11:24, 28 October 2018

Migration

Please use the migrated document at URL shown below.

Migrated to en:HOW2 at 2018-10-28

Flag-DE

Übersetzung , bitte.

Flag-ES

Traducción, por favor.

Flag-FR

Cette version est améliorée par rapport à la française

Flag-RU

перевод, пожалуйста.


The EN How2 is the page of how to do something in the Ryzom Forge Wiki.

Contributing to the 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 the Ryzom Forge Wiki" which is a summary adapted to our Ryzom wiki. In addition, there are several "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.

Page Not Found (in any language)

Documentation page

  1. If there is no page with the title you have chosen, click the title highlighted in red in the message that is at the top of the page «Search results»: "Create the page "Your_title" on this wiki!". This action may open a new empty page with your Your_title as name for it.
  2. Copy in your new page this command adapted to your language. For instance, for English:
    {{subst:EN Page}}
  3. Save immediately this page with this unique line.
  4. Reopen this page you just have saved: it will contain the minimum skeleton to continue your work.

Category

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:

  • A short description on just about one line:
    1. Copy this command in your new page:
      {{subst:CategoryShortDesc}}
    2. Save this page immediately with that one line.
    3. 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:
    1. Copy this command in your new page:
      {{CategoryTab}}
    2. Save this page immediately with that one line.
    3. 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

The description of template is usually longer and more complex than a category .

  • Start by adding the following lines at the beginning or the end of the template replacing "foo" with the appropriate categories:
<noinclude>{{{{FULLPAGENAME}}/Documentation}}
[[Category:foo]]</noinclude>
  • Next:
    1. In the blank page of the documentation of a Template (Template:<name_of_the_template_to_describe>/documentation), copy this
      {{subst:Template Documentation}}
    2. Save this page immediately with that one line.
    3. 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:
      {{subst:Template FR Documentation}}
    4. Save this page again to "insert" the contents of {{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 {{TabLang}} .

By default, until the page has not been translated, there is at the top of the original page something like:

{{TabLang|FR|DE|{{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:

{{TabLang | FR | Mein Titel | My title | Mi título | My title | Мое название}} .

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

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:

  1. It contiend in red the missing documentation {{Template: Template documentation}} XX where XX is the two-letter language of the translated text.
    1. Start by translating the documentation for your language of competence. You will only to do it once.
    2. Save again this page to "insert" the contents of <nowiki>{{Template:Template XX Documentation}}. This template pre-formats a chapter of the template documentation page in XX. Then go the next step:
  2. Your chapter is pre-formated: complete / edit the associated paragraphs.

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 WIP

{{WIP}}

How to prevent images overflow in the following paragraphs?

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 <div> like this.

<div style="overflow: hidden">
[[File:Your pix|200px|thumb|left|The name of the image]]
Your text here...
</div>

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;).

I would like my text be translated

Put on the top banner template:toTrad.

{{toTrad| A precise language: DE, EN, ES... | Leave a comment if necessary }}

By default {{toTrad}} indicates that the article is to be translated and is added to the category ToTrad:

  • It is possible to limit the translation to a single language. Eg {{toTrad|RU}}.
  • You can change the default text. Eg {{toTrad| |Please correct paragraph 3}}.

My user profile

It may be useful for Ryzom wiki contributors to know what are your language, technical skills ... You can use for this two infobox:

  • Template:babylon: (deformation of Babel) this little box gives your languages proficiency.
  • Template:QuiSuisJe: This box gives your technical skills and your business in the game.

How to add significant information?

You can use a special box to alert: Template: Banner

13 pages in Wiki

Ryzom Wiki: Ryzom Commons | DE • EN • ESFRRU | Ryzom Forge