Guide de rédaction (wiki)
De Wiki1000
(Différences entre les versions)
(→Contenu) |
|||
| (14 révisions intermédiaires par un utilisateur sont masquées) | |||
| Ligne 1 : | Ligne 1 : | ||
| + | __TOC__ | ||
| + | |||
==Contenu== | ==Contenu== | ||
| + | {{IfSage| | ||
'''Ce wiki est destiné aux partenaires et aux clients.''' | '''Ce wiki est destiné aux partenaires et aux clients.''' | ||
| − | * Ne pas inclure d' | + | * Ne pas inclure d'informations confidentielles. |
| − | * Ne pas inclure d' | + | * Ne pas inclure d'informations de développement. |
* Ne pas documenter des fonctions qui n'existent pas. | * Ne pas documenter des fonctions qui n'existent pas. | ||
* Ne pas supposer que le lecteur est un expert ou un abruti. | * Ne pas supposer que le lecteur est un expert ou un abruti. | ||
| + | }} | ||
| + | * Ecrire en français | ||
* Vérifier l’orthographe. | * Vérifier l’orthographe. | ||
| Ligne 12 : | Ligne 17 : | ||
* Le nom de la page doit inclure la rubrique | * Le nom de la page doit inclure la rubrique | ||
: Exemple : Paquet métier (model) | : Exemple : Paquet métier (model) | ||
| − | * Toutes les pages doivent être dans au moins une catégorie. | + | * '''Toutes les pages doivent être dans au moins une catégorie.''' |
* Ajouter les catégories à la fin de la page | * Ajouter les catégories à la fin de la page | ||
* Eviter les pages énormes | * Eviter les pages énormes | ||
| Ligne 20 : | Ligne 25 : | ||
* Ne pas inclure de titre principale reprenant le nom de la page | * Ne pas inclure de titre principale reprenant le nom de la page | ||
| − | ==Images et | + | ==Images et vidéos== |
===Utiliser les templates=== | ===Utiliser les templates=== | ||
<pre> | <pre> | ||
| Ligne 33 : | Ligne 38 : | ||
===Utiliser le upload mediawiki=== | ===Utiliser le upload mediawiki=== | ||
* Possible pour les images mais pas pour les vidéos. | * Possible pour les images mais pas pour les vidéos. | ||
| + | |||
| + | ===Encodage des images=== | ||
| + | * Encoder les images en PNG. | ||
| + | |||
| + | ===Encodage des vidéos=== | ||
| + | * Utiliser un codec LoosLess pour l'enregistrement. | ||
| + | |||
| + | Exemple : [http://camstudio.org/ CamStudio] options : | ||
| + | |||
| + | {{#images:image1.png|guide-redaction}} | ||
| + | |||
| + | * Encoder les vidéos en h264 et sortie flash en utilisant [http://www.ffmpeg.org/ ffmpeg] | ||
| + | |||
| + | Exemple : | ||
| + | |||
| + | ffmpeg -i %1.avi -qscale 10 -vcodec libx264 %1.flv | ||
==Nouveauté version== | ==Nouveauté version== | ||
| Ligne 39 : | Ligne 60 : | ||
<pre> | <pre> | ||
__TOC__ | __TOC__ | ||
| − | {{new| | + | {{new|650}} |
... | ... | ||
| − | [[ | + | [[Category:Version650]] |
</pre> | </pre> | ||
| Ligne 47 : | Ligne 68 : | ||
* Ajouter une entrée dans la page récapitulative de la version | * Ajouter une entrée dans la page récapitulative de la version | ||
| − | * Ajouter un pictogramme de version dans le corps du texte avec le template du nom de la version | + | * Ajouter un pictogramme de version dans le corps du texte avec le template du nom de la version {{Version650}} |
| + | |||
Exemple : | Exemple : | ||
| + | |||
<pre> | <pre> | ||
| − | * | + | * {{P650|Importation de documents (import)|Importation de documents}} |
</pre> | </pre> | ||
| + | |||
| + | qui est équivalent à : | ||
| + | |||
| + | <pre> | ||
| + | * [[Importation de documents (import)|Importation de documents]] {{Version650}} | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | Ne pas écrire le nom de version dans le corps de texte. | ||
| + | |||
| + | {{IfSage| | ||
| + | ===Dernière version (Latest)=== | ||
| + | Lors de la rédaction du wiki le nom de la version n'est pas forcément connu. | ||
| + | |||
| + | Utilisez les templates Latest pour référencer cette dernière version. | ||
| + | |||
| + | Pour inclure du texte conditionné par la version : | ||
| + | |||
| + | <pre> | ||
| + | {{IfLatest| | ||
| + | ... | ||
| + | }} | ||
| + | </pre> | ||
| + | |||
| + | Pour inclure un lien dans une page référençant un élément de la dernière version : | ||
| + | |||
| + | <pre> | ||
| + | {{IfLatest| | ||
| + | * {{PLatest|nom de page|description du lien}} | ||
| + | }} | ||
| + | </pre> | ||
| + | |||
| + | Pour inclure des lignes conditionnelles dans un tableau : | ||
| + | <pre> | ||
| + | |- | ||
| + | {{IfLatest| | ||
| + | {{!}}[[queueRef (TStereotypeClassQueue)|queueRef]] | ||
| + | {{!}}Référence vers un objet associée à cet objet. | ||
| + | }} | ||
| + | </pre> | ||
| + | |||
| + | ===Masquer une catégorie=== | ||
| + | La catégorie Sage est privé et automatiquement masquée aux utilisateurs qui n'appartiennent pas au groupe Sage. | ||
| + | |||
| + | Pour masquer une catégorie autre que Sage : | ||
| + | * Placer la catégorie dans la catégorie Sage | ||
| + | :Ceci permet de masquer le contenu de la catégorie | ||
| + | |||
| + | * Ajouter la catégorie à la variable $wgCategoryPermissions du fichier extensions\rabcg\groups.php | ||
| + | :Ceci permet de masquer le contenu des pages appartenant à la catégorie. | ||
| + | |||
| + | ===Contenu Sage=== | ||
| + | Si vous souhaitez introduire du contenu visible que des utilisateurs du groupe Sage utilisez le template IfSage : | ||
| + | |||
| + | <pre> | ||
| + | {{IfSage| | ||
| + | .... | ||
| + | }} | ||
| + | </pre> | ||
| + | |||
| + | }} | ||
Version actuelle en date du 19 avril 2013 à 10:56
Sommaire |
Contenu
- Ecrire en français
- Vérifier l’orthographe.
Pages
- Le nom de la page doit être significatif et compréhensible
- Le nom de la page doit inclure la rubrique
- Exemple : Paquet métier (model)
- Toutes les pages doivent être dans au moins une catégorie.
- Ajouter les catégories à la fin de la page
- Eviter les pages énormes
Titres
- Commencer à H2 ==
- Ne pas inclure de titre principale reprenant le nom de la page
Images et vidéos
Utiliser les templates
{{#images:nom_fichier|répertoire}}
{{#videos:nom_fichier|répertoire|Titre de la vidéo}}
{{#flashs:nom_de_fichier|répertoire|Titre de la vidéo}}
- Tous les noms de fichier et répertoire doivent être en minuscule (impératifs).
- Ne pas utiliser d'accents dans les noms de fichier et répertoire.
Utiliser le upload mediawiki
- Possible pour les images mais pas pour les vidéos.
Encodage des images
- Encoder les images en PNG.
Encodage des vidéos
- Utiliser un codec LoosLess pour l'enregistrement.
Exemple : CamStudio options :
- Encoder les vidéos en h264 et sortie flash en utilisant ffmpeg
Exemple :
ffmpeg -i %1.avi -qscale 10 -vcodec libx264 %1.flv
Nouveauté version
- Inclure le template new pour afficher une image "nouveauté"
Exemple :
__TOC__
{{new|650}}
...
[[Category:Version650]]
- Inclure la page dans la catégorie de la version
- Ajouter une entrée dans la page récapitulative de la version
- Ajouter un pictogramme de version dans le corps du texte avec le template du nom de la version
Exemple :
* {{P650|Importation de documents (import)|Importation de documents}}
qui est équivalent à :
* [[Importation de documents (import)|Importation de documents]] {{Version650}}
Ne pas écrire le nom de version dans le corps de texte.
