Difference between revisions of "EN HOW2"

From Ryzom Forge Wiki

Jump to: navigation, search
m
Line 10: Line 10:
  
 
== Contributing to the wiki ==
 
== Contributing to the wiki ==
If you're not familiar with wikis and, more specifically with [http://www.mediawiki.org Mediawiki], editing and creating pages can look trying. Good news: we use a wiki engine that is well documented in every language.
+
If you're not familiar with wikis and, more specifically with [http://www.mediawiki.org 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: [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.
 
{{WIP}}
 
{{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.
 +
 +
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).
 +
 +
 +
 +
 
As a user, most of the useful infos are available here:
 
As a user, most of the useful infos are available here:
 
[http://www.mediawiki.org/wiki/User_hub/fr] and more precisely here:
 
[http://www.mediawiki.org/wiki/User_hub/fr] and more precisely here:

Revision as of 12:04, 17 September 2014

Flag-DE

Übersetzung benötigt, bitte

Flag-EN

Please, check

Flag-ES

Traducción necesitada, 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.

WIP
in Arbeit - work in progress - trabajo en curso - travaux en cours - незавершенное

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.

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



As a user, most of the useful infos are available here: [1] and more precisely here: Faq fr de Mediawiki.

Mediawiki is also used by Wikipedia, where you can find lots of very well built tutorials.

And finaly, we have our own manual guide for the Ryzom Wiki.

Il existe plusieurs "Template" pour initialiser les pages, notamment en mode multilingue:

Page inexistante (dans aucune langue)

Page documentaire

  1. 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 "Votre_Titre" on this wiki!"
  2. Copiez dans votre nouvelle page cette commande adaptée au français:
    {{subst:FR Page}}
  3. Sauvez immédiatement cette page avec cette unique ligne.
  4. 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:
    1. Copiez dans votre nouvelle page cette commande:
      {{subst:CategoryShortDesc}}
    2. Sauvez immédiatement cette page avec cette unique ligne.
    3. Rouvrez cette page sauvegardée: elle contiendra le squelette minimum pour continuer votre travail.
  • Le texte explicatif est long, plus de 5 lignes:
    1. Copiez dans votre nouvelle page cette commande:
      {{CategoryTab}}
    2. Sauvez immédiatement cette page avec cette unique ligne.
    3. 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:
<noinclude>{{{{FULLPAGENAME}}/Documentation}}
[[Category:foo]]</noinclude>
  • Ensuite:
    1. Dans la page vierge de documentation d'un "Template" (Template:<nom_du_template_à_documenter>/documentation), copiez cette commande:
      {{subst:Template Documentation}}
    2. Sauvez immédiatement cette page avec cette unique ligne.
    3. 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:
      {{subst:Template FR Documentation}}
    4. Sauvez à nouveau cette page pour "insérer" le contenu de {{Template FR Documentation}} à la place qui lui correspond. Ce Template préformate une page de documentation des Templates en français.

Traduction inexistante

Lorsqu'une page existe déjà dans une des 5 langues de Ryzom Forge, il reste à la traduire dans les autres.

Page documentaire

Les pages documentaire ont en haut de la page 5 onglets linguistiques créé par le {{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:

{{TabLang|FR|DE|EN|ES|{{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.

Lorsque toute les page sont traduites on devrait trouver quelque chose comme:

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

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)

Catégorie

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.

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.

Documentation de modèle (Template)

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:

  1. Elle contiend en rouge les documentations manquantes {{Template:Template XX Documentation}} où XX sont les deux lettres de la langues du texte traduit.
    1. Commencez par traduire la documentation dans votre langue de compétence. Vous n'aurez qu'un fois à le faire.
    2. Sauvez à nouveau cette page pour "insérer" le contenu de {{Template:Template XX Documentation}}. Ce Template préformate un chapitre de la page de documentation des Templates en XX. Passez à l'étape suivante:
  2. Votre chapitre est préformaté: compléter/éditer les paragraphes associés.

FAQ

Comment empêcher les utilisateur d'intervenir sur une page que je rédige et qui n'est pas prête?

Il faut mettre en haut de la page la bannière le modèle WIP

{{WIP}}

Comment empêcher que les images débordent dans les paragraphes suivants?

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

<div style="overflow: hidden">
[[File:Votre image|200px|thumb|left|titre de l'image]]
Votre texte ici...
</div>

Je voudrait que mon texte soit traduit

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 est possible de limiter la traduction à une seule langue. Par exemple {{toTrad|RU}}.
  • Il est possible de changer le texte par défaut. Par exemple {{toTrad| |Veuillez corriger le paragraphe 3}}.

Mon profil utilisateur

Il peut être utile aux participant de Ryzom de savoir quelles sont vos compétences linguistiques, techniques... Vous pouvez utilier pour cela deux infobox:

  • Template:babylon: (déformation de Babel) cette petit boite donne vos compétence linguistique.
  • Template:QuiSuisJe: Cette boite donne vos compétences technique et votre activité dans le jeu.

Comment ajouter une info importante?

Vous pouvez utiliser une boite un peu spéciale pour alerter: Template:Banner

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


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

  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 " Votre_Titre </ span>" on this wiki " '!
  2. Copy in your new page adapted to this command 'French'
     {{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> {{{{}} FULLPAGENAME / Documentation}} </ 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>
  1. * 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>
  1. * Save this page again to "insert" the contents of <nowiki> {{</ nowiki> 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> 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: <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:

  1. It contiend red missing documentation <nowiki> {{</ nowiki> Template: Template documentation}} XX where XX is the two-letter language of the translated text.
    1. Start by translating the documentation for your language proficiency. You will only have time to do so.
    2. 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:
  2. 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 WIP

<Pre>

WIP
in Arbeit - work in progress - trabajo en curso - travaux en cours - незавершенное

</ pre>

How to prevent images overflow in the following paragraphs?

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>

File:Your picture
image title

Your text here ... </ Div> </ Pre> </ Div>

I would like my text translated

There must be top banner model toTrad

<Pre>
Flag- 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 ToTrad

  • It is possible to limit the translation to a single language. Eg <nowiki>
    Flag- UK

Translation requested, please.

</ nowiki>.
  • You can change the default text. Eg <nowiki>
    Flag-

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:

How to add significant information?

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