Création d'un document sur le wiki Neogia
Contents
|
Création des pages
Si vous n'avez jamais travaillé sur un wiki, commençez par lire la documentation pour les rédacteurs de mediaWiki
La première étape pour créer un nouveau document est l'internationalisation des pages. Elle consiste à créer la page française puis la page Anglaise et de faire le lien entre ces deux pages afin de voir apparaître les petits drapeaux.
Internationalisation des pages
- Créer une nouvelle page en anglais avec un nom international
par ex: English Name - Y ajouter la balise (modèle) : {{ReferencePage|English Name|English}}
- Créer ensuite une nouvelle page en version française avec un nom parlant :
par ex : Nom Francais
Ce nom sera utilisé dans le titre de la page et permetra un meilleur référencement. - Ajouter à cette page la balise : {{ReferencePage|English Name|Français}}
- L'étape suivante consiste à lier la page anglaise à la page française afin d'afficher les petits drapeaux :
- Créer une nouvelle page avec pour nom le nom de la page anglaise et avec la terminaison "/fr" :
par ex: English Name/fr - Dans cette page faire une redirection vers la page avec le nom en français en y insérant la balise :
#REDIRECT [[Nom Français]]. Cettebalise doit être la seul balise présente pour cette page
- Créer une nouvelle page avec pour nom le nom de la page anglaise et avec la terminaison "/fr" :
- La dernière étape consiste à réinitialiser le système de cache :
- Charger la page francaise :
- ajouter dans l'url "?action=purge" et cliquer sur "entrer"
- Charger la page anglaise:
- ajouter dans l'url "?action=purge" et cliquer sur "entrer"
- Charger la page francaise :
Classement de la page, category
Il est possible de regrouper des pages sur des sujets similaires ou dans des états similaires grace aux catégorie (category en anglais).
Pour ajouter une page dans une catégorie il suffit de mettre dans son contenu [[category:NomDeLaCatégorie]], habituellement nous le mettons au début du texte.
Merci d'essayer de la faire pour toutes les créations de pages ou chaque fois que vous modifiez une page et que sa ou ses catégories ne sont pas indiqué.
Les catégories utilisé actuellement sont:
- Etat de l'article
- [[category:To_Write/fr]] : à écrire
- [[category:A_Relire]] : pour demander une relecture, celui qui a relu l'article enléve la catégorie
- [[category:A Traduire]] : Pour ne pas oublier que la page n'existe pas en anglais ou qu'elle n'existe pas en Français.
- Sujet de l'article, les catégories sont contituées de 2 éléments, le composant et le type d'usage (ou de destination)
- Composant
- Commun
- Technique
- Acteur
- Article
- Commande
- CRM
- Stock
- Production
- Qualité
- Comptabilité
- Contenu
- Type d'usage
- Commerciale : pour aider à vendre
- Fonctionnel : pour aider à utiliser
- Technique : pour aider à personaliser ou à développer
- Amélioration : les analyses en attente de réalisation
- Aide en ligne : par rapport à un écran précis
- Exemple
- [[category:Acteur Commerciale]]
- [[category:Production Technique]]
- [[category:Comptabilité Amélioration]]
- Composant
Disposition de la page
L'étape suivante consiste à créer la structure de votre page en choisissant le nombre de colonne présente sur votre document:
Disposition des éléments de la page : détermination du nombre de colonne
Chaque page est constituée d'éléments invariants qui sont le haut de page (logo + menu) et le bas de page. Vous avez donc à votre disposition le centre de la page.
Vous pouvez ne pas utiliser de colonne. Dans ce cas, il est inutile de lire ce qui suit.
le modèle pageLayout
Le centre de la page peux être divisé en colonne. Pour ce faire, vous devez utiliser le modèle "PageLayout" : "{{PageLayout|type=XXX|left-template=XXX|right-template=XXX}}" ou "{{PageLayout|type=XXX|left-content=XXX|right-content=XXX}}"
Les arguments du modèle PageLayout:
- type : détermine la disposition des colonnes dans la page. Il peut avoir les valeurs :
- left-column-and-article-and-right-column : 3 colonnes
- left-column-and-article : 2 colonnes dont une petite à gauche (classiquement pour le sous-menu)
- article-and-right-column : 2 colonnes dont une petite à droite (classiquement pour de la pub ou des news)
- left-template : nom de la page à inclure dans la colonne de gauche (ajouter ":"en début de nom)
- left-content : contenu de type texte à inclure dans la colonne de gauche
- right-template : nom de la page à inclure dans la colonne de droite (ajouter ":"en début de nom)
- right-content : contenu de type texte à inclure dans la colonne de droite
Incorporation du modèle dans le document
- Modèle à deux colonnes : 1 colonne de gauche étroite + 1 colonne de droite large
- La première colonne contient des élements tels que le menu ou des petites boites
- La colonne de droite contient le corps de l'article
Pour obtenir ce résultat il faut insérer en début de document :
"{{PageLayout|type=left-column-and-article|left-template=nom_du_modèle|right-template=nom_du_modèle}}" ou "{{PageLayout|type=left-column-and-article|left-content=texte|right-content=texte}}"
- Modèle à deux colonnes : 1 colonne de gauche large + 1 colonne de droite étroite
- La première colonne contient le corps de l'article
- La colonne de droite contient des élements tels que le menu ou des petites boites
Pour obtenir ce résultat, il faut insérer en début de document :
"{{PageLayout|type=article-and-right-column|left-template=nom_du_modèle|right-template=nom_du_modèle}}" ou "{{PageLayout|type=article-and-right-column|left-content=texte|right-content=texte}}"
- Modèle à trois colonnes : 1 colonne de gauche étroite' + 1 colonne au centre large + 1 colonne de droite étroite
- La première colonne contient des élements tels que le menu ou des petites boites
- La seconde colonne contient le corps de l'article
- La dernière colonne contient des élements tels que le menu ou des petites boites
Pour obtenir ce résultat, il faut insérer en début de document :
"{{PageLayout|type=left-column-and-article-and-right-column|left-template=nom_du_modèle|right-template=nom_du_modèle}}" ou "{{PageLayout|type=left-column-and-article-and-right-column|left-content=texte|right-content=texte}}"
Inserer du contenu
Une fois la structure de votre page déterminée il est temps de passer à son contenu. Avant tout chose, vous devez indiquer que le document est en cours de rédaction ou qu'il doit être relu.
Indiquer que le document est à écrire
- Insérer la balise : [[category:To Write/fr]]
Indiquer que le document est en cours de rédaction
Afin d'indiquer qu'un document est en cours de réalisation et afin d'éviter que deux personnes n'éditent le même document, il est indispensable d'insérer cette balise en entête de document ou au niveau de la section que vous êtes en train de rédiger : {{:WorkInProgress | lang=fr | party=Nom_De_La_Personne_Qui_Rédige_Le_Document}}
Indiquer que le document est à relire
Une fois la rédaction du document terminée, si vous voulez que d'autres personnes relisent le document que vous venez de rédiger, vous devez :
- insérer cette balise en en-tête de document : [[category:A_Relire]]
- insérer cette balise en en-tête de document ou au niveau de la section que vous venez de rédiger : {{:WorkInProgress_TobeValidated | lang=fr}}
- faire un message sur la liste de diffusion
Indiquer que le document est à traduire
Si vous voulez que d'autres personne traduisent le document que vous venez de rédiger, vous devez sur les pages de la langue à traduire :
- insérer cette balise en en-tête de document : [[category:A_Traduire]]
- Mettre un message sur cette page depuis quelle langue faire la traduction
Ex : http://neogia.org/Stock_Functions
Elément de référence de la page
A la fin de la plupart des pages, il est indiqué 3 éléments de la manière suivante
objet : menu de documentation langue de la page de référence : Français auteur : xxxxx
- objet
- Décrit succintement l'objectif de cette page
- langue de la page de référence
- indique quelel est la page qui est sensée être la plus complète. Si vous faites un ajout (pas une traduction) dans la page de la langue qui n'est pas la référence, il faut ajouter dans celle de référence les mêmes éléments (au besoin non traduit). Si la langue de référence n'est pas précisée, c'est l'anglais qui est pris par défaut.
- auteur
- précise les personnes ayant participé à cette page, trés souvent cet élément disparait dès qu'il y a plus de deux noms
Blocs de texte prédéfinis ré-utilisables
Il existe des éléments prédéfinis qui peuvent être insérés directement dans une page. Ce sont des éléments tels que les publicités, les annonces, la revue de presse ... Il en existe toute une série que nous regroupons ici :
Bloc de publicité
Bloc d'information sur l'avancement de la rédaction du document
- en Cours de rédaction : à utiliser avec le paramètre lang et le paramètre party pour signaler qui est en train de travailler{{:WorkInProgress | lang=fr}}
- En attente de relecture : à utiliser pour qu'une seconde personne relise (avant d'enlever le préembule) {{:WorkInProgress_TobeValidated | lang=fr}}
Il faut alors ajouter la category A_Relire, pour que cette page apparaisse dans la liste des pages à relire [[category:A_Relire]]
Bloc pour les pages Menu
- {{DocumentationBox|Title = LeTitreDeLaBoite | ContentPage = Le_contenu_de_la_boite}} : affiche une boite avec un lien au niveau du titre qui est la page qui s'affiche dans la boite.
Il faut créer une page, nommé Le_contenu_de_la_boite, pour mettre les liens à faire apparaitre dans la boite. - {{DocumentationBox1|Title = LeTitreDeLaBoite | ContentPage = La_page_à_afficher_si_on_click_sur_title| ContentLink =Le_contenu_de_la_boite}} : affiche une boite avec un lien au niveau du titre qui est différent de celui qui s'affiche dans la boite, souvent c'est la première page qui contient elle-même en sous-menu avec au moins les liens de la boite.
Le_contenu_de_la_boite peut être soit directement des liens soit un include de page {{:Submenu_Product_Functional_Manual/fr}} par exemple - {{DocumentationBox2|Title = LeTitreDeLaBoite | ContentPage = La_page_à_afficher_si_on_click_sur_title| ContentLink =Le_contenu_de_la_boite}} : affiche une boite avec un lien au niveau du titre qui est différent de celui qui s'affiche dans la boite, souvent c'est la première page qui contient elle-même en sous-menu avec au moins les liens de la boite.
Ce lien est aussi utilisé pour le + d'info qui apparait en bas de la boite.
Le_contenu_de_la_boite peut être soit directement des liens soit un include de page {{:Submenu_Product_Functional_Manual/fr}} par exemple
Bloc Google traduction
- insérer dans votre page le gadget de traduction google :
<GoogleTranslate>language=fr</GoogleTranslate>
- la valeur de language est la langue dans laquelle estécrite le texte à traduire
- voici le rendu :
Bold textlivre de poche
Bloc Navigation diaporama
Modèles prédéfinis
Modèle de menus
Modèles de niveau difficulté
Pour chaque tache vous trouverez une indication du niveau de connaissance nécessaire afin d'aborder cette tache :
- Developpement_level_easy
(niveau débutant) : Contributeur sans connaissance particulière
- Developpement_level_confirmed
- (niveau confirmé) : Contributeur ayant réalisé différente tache de niveau débutant et ayant de bonnes connaissance du framework ofbiz
- Developpement_level_expert
- (niveau expert) : Contributeur ayant une bonne maitrise du framework ofbiz et de l'architecture de Neogia
