« Aide à la rédaction » : différence entre les versions

De Wiki de la mère Zaclys
Aller à la navigation Aller à la recherche
 
(48 versions intermédiaires par 2 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
= Créer une page =
Il est nécessaire de s'inscrire sur le wiki pour pouvoir y contribuer et seuls les membres de l'équipe peuvent {{zlink|1=http://wiki.zaclys.com/index.php/Sp%C3%A9cial:Connexion/signup|2=créer un compte wiki}}
Il existe plusieurs manières de créer une page, vous pouvez notamment créer un lien depuis une page déjà existante dans le wiki vers la page que vous souhaitez créer, celui-ci apparaîtra en rouge. Cliquez sur ce lien pour arriver sur un message vous informant que la page recherchée n'existe pas et proposant de la créer. Vous accédez alors à la page de modification de l'article, écrivez votre texte et publiez, votre page est créée.
 
Si vous désirez participer à ce projet, venez nous le signaler sur le [https://forum.zaclys.com/viewtopic.php?f=77&t=3779 forum Zaclys], nous serons ravis de vous compter parmi nous. Toute aide, même modeste, est bienvenue.
 
Pour vous inscrire sur la liste de diffusion du wiki, formulez-en la demande [https://www.zaclys.com/Contact,99 ici].
 
== Créer une page ==
Il existe plusieurs manières de créer une page. Vous pouvez notamment créer un lien depuis une page déjà existante dans le wiki vers la page que vous souhaitez créer, celui-ci apparaîtra en rouge. Cliquez sur ce lien et vous arrivez sur un message qui vous informe que la page recherchée n'existe pas et vous propose de la créer. Vous accédez alors à la page de modification de l'article, écrivez votre texte et publiez, votre page est créée.


Cette manière de faire est probablement la meilleure, car ainsi vous êtes sûr que votre nouvelle page est accessible depuis au moins un point du wiki déjà existant. Cela permet aussi d'assurer une certaine cohérence avec la documentation déjà présente.
Cette manière de faire est probablement la meilleure, car ainsi vous êtes sûr que votre nouvelle page est accessible depuis au moins un point du wiki déjà existant. Cela permet aussi d'assurer une certaine cohérence avec la documentation déjà présente.


Il est également possible de créer une page en passant directement par son url. Sur le wiki Zaclys, elles sont de la forme :
Il est également possible de créer une page en passant directement par son url. Sur le wiki Zaclys, elle est de la forme :
*<code><nowiki>http://wiki.zaclys.com</nowiki>/index.php/'''Titre_de_page'''</code>
*<code><nowiki>https://wiki.zaclys.com</nowiki>/index.php/'''Titre_de_page'''</code>
{{Attention|si vous devez renommer une page, assurez-vous de bien activer la redirection depuis l'ancien nom afin que tous les liens qui pointaient vers votre page ne soient pas cassés.}}
{{Attention|si vous devez renommer une page, assurez-vous de bien activer la redirection depuis l'ancien nom afin que tous les liens qui pointaient vers votre page ne soient pas cassés.}}
Voir [https://www.mediawiki.org/wiki/Help:Starting_a_new_page/fr l'aide Mediawiki] pour une information plus complète.<br/><br/>
Voir [https://www.mediawiki.org/wiki/Help:Starting_a_new_page/fr l'aide Mediawiki] pour une information plus complète.
<br/>


= Formatage de base =
== Formatage de base ==
Vous trouverez toutes les informations nécessaires sur le formatage sur l'aide Mediawiki : [https://www.mediawiki.org/wiki/Help:Formatting/fr Formatage] et [https://www.mediawiki.org/wiki/Help:Links/fr Liens]
Vous trouverez toutes les informations nécessaires sur le formatage sur l'aide Mediawiki :  
*[https://www.mediawiki.org/wiki/Help:Formatting/fr Formatage]
*[https://www.mediawiki.org/wiki/Help:Links/fr Liens]
*[https://www.mediawiki.org/wiki/Help:Lists Listes]
*[https://www.mediawiki.org/wiki/Help:Tables/fr Tableaux]


Quelques balises qui vous seront probablement utiles pour commencer :
Voici quelques balises qui vous seront probablement utiles pour commencer :


{| class="wikitable" style="color: black; background-color: white; width: 65%;margin: left;"
{| class="wikitable" style="color: black; background-color: white; width: 65%;margin: left;"
Ligne 36 : Ligne 47 :
|style="text-align:center;"|Titres
|style="text-align:center;"|Titres
|
|
<nowiki>= Titre de niveau 1 =</nowiki><br/>
  <nowiki>== Titre de niveau 2 ==</nowiki><br/>
  <nowiki>== Titre de niveau 2 ==</nowiki><br/>
  <nowiki>=== Titre de niveau 3 ===</nowiki><br/>
  <nowiki>=== Titre de niveau 3 ===</nowiki><br/>
Ligne 46 : Ligne 56 :
==== Titre de niveau 4 ====
==== Titre de niveau 4 ====
===== Titre de niveau 5 =====
===== Titre de niveau 5 =====
{{Note|le titre de niveau 1 est le titre de la page}}
|-
|-
|style="text-align:center;"|Liste de définitions
|style="text-align:center;"|Liste de définitions
Ligne 88 : Ligne 99 :
|style="text-align:center;"|Lien externe
|style="text-align:center;"|Lien externe
|
|
  <nowiki>[http://mediawiki.org MediaWiki exemple]</nowiki>
  <nowiki>[http://mediawiki.org exemple]</nowiki>
|[http://mediawiki.org exemple]
|[http://mediawiki.org exemple]
|}<br/><br/>
|}
<br/>


= Insérer une image =
== Insérer une image ==
Pour utiliser une image, il faut d'abord l'importer sur le serveur. Pour cela cliquer sur '''importer un fichier''' dans le menu '''outils''' de la sidebar du wiki et suivez les instructions :
Pour utiliser une image, il faut d'abord l'importer sur le serveur. Pour cela, cliquer sur '''Téléverser un fichier''' dans le menu '''Outils''' de la sidebar du wiki et suivez les instructions :
:[[Fichier:Import01.png|400px]]
:[[Fichier:Import01.png|400px]]


Ligne 101 : Ligne 113 :
{{Remarque}}Veillez à indiquer le bonne extension du fichier (jpg, png...)
{{Remarque}}Veillez à indiquer le bonne extension du fichier (jpg, png...)


Il est possible de préciser toutes sortes de paramètres, comme la taille de l'image, la présence de bordures, son placement sur la page, etc. Par exemple pour placer une image de 400px de large, saisissez :
Il est possible de définir toutes sortes de paramètres, comme la taille de l'image, la présence de bordures, son placement sur la page, etc. Par exemple, pour placer une image de 400px de large, saisissez :
*<code><nowiki>[[Fichier:Nom_de_l'image.jpg|400px]]</nowiki></code>
*<code><nowiki>[[Fichier:Nom_de_l'image.jpg|400px]]</nowiki></code>
Ou pour afficher une image sans lien :
* <code><nowiki>[[Fichier:Nom_de_l'image.jpg|400px|link=]]</nowiki></code>


Consulter [https://www.mediawiki.org/wiki/Help:Images/fr l'aide de Mediawiki] pour plus d'informations.<br/><br/>
Consulter [https://www.mediawiki.org/wiki/Help:Images/fr l'aide de Mediawiki] pour plus d'informations.
<br/>


= Modèles =
== Modèles ==
Les modèles sont des objets préformatés que vous pouvez intégrer dans votre page. Ils permettent de gagner du temps et favorisent une certaine homogénéité de la mise en page de la documentation.
Les modèles sont des objets préformatés que vous pouvez intégrer dans votre page. Ils permettent de gagner du temps et favorisent une certaine homogénéité dans la mise en page de la documentation.


== Utiliser un modèle ==
=== Utiliser un modèle ===
Pour appeler un modèle il faut saisir :
Pour appeler un modèle il faut saisir :
*<code><nowiki>{{Nom_du_modèle|variable1|variable2}}</nowiki></code>
*<code><nowiki>{{Nom_du_modèle|variable1|variable2}}</nowiki></code>
Certains modèles basiques ne nécessitent pas de variable :
Certains modèles basiques ne nécessitent pas de variable :
*<code><nowiki>{{Nom_du_modèle}}</nowiki></code>
*<code><nowiki>{{Nom_du_modèle}}</nowiki></code>


;Par exemple
;Par exemple
Ligne 122 : Ligne 136 :
|-
|-
|  
|  
  <nowiki>{{Attention|Taper votre texte ici}}</nowiki>
  <nowiki>{{Attention|Tapez votre texte ici}}</nowiki>
|{{Attention|Taper votre texte ici}}
|{{Attention|Tapez votre texte ici}}
|}
|}


;Modèles disponibles
Quelques modèles de base sont déjà disponibles sur le wiki Zaclys :
Quelques modèles de base sont déjà disponibles sur le wiki Zaclys :
*[[:Modèle:Attention]]
*[[Modèle:Attention]]
*[[:Modèle:Note]]
*[[Modèle:Note]]
*[[:Modèle:Remarque]]
*[[Modèle:OwnCloud/Nextcloud]]
*[[:Modèle:InscriptionCloud]]
*[[Modèle:Remarque]]
*[[:Modèle:InscriptionZmail]]<br/>
*[[Modèle:Zlink]]
*[[Modèle:InscriptionCloud]]
*[[Modèle:InscriptionZmail]]
*[[Modèle:InscriptionAlbum]]
*[[Modèle:Serveurs1]]
*[[Modèle:Serveurs2]]
*[[Modèle:Serveurs3]]
*[[Modèle:Webdav]]
*[[Modèle:Webdav_Unity]]
*[[Modèle:Webdav_KDE]]
*[[Modèle:Caldav]]
*[[Modèle:Carddav]]
*[[Modèle:Carddav_Roundcube]]
*[[Modèle:Caldav_principale]]
*[[Modèle:Serveurs_Nextcloud1]]
*[[Modèle:Serveurs_Nextcloud2]]
*[[Modèle:Serveurs_Nextcloud3]]
*[[Modèle:Web_Nextcloud]]


== Créer un modèle ==
=== Créer un modèle ===
Pour créer un modèle, il suffit de créer une page de la forme :
Pour créer un modèle, il suffit de créer une page de la forme :
*<code><nowiki>http://</nowiki>wiki.zaclys.com/index.php/Modèle:Nom_du_modèle</code>
*<code><nowiki>http://</nowiki>wiki.zaclys.com/index.php/Modèle:Nom_du_modèle</code>
Puis d'y créer le modèle en utilisant les variables {{{1}}}, {{{2}}}, etc
Puis d'y créer le modèle en utilisant les variables {{{1}}}, {{{2}}}, etc.


 
=== Documenter le modèle ===
;Documenter le modèle
Lorsque vous créez un modèle, il est important de le documenter, c'est à dire de donner les indications nécessaires à son utilisation.  
Lorsque vous créez un modèle, il est important de le documenter, c'est à dire de donner les indications nécessaires à son utilisation.  
*Ces explications doivent être enregistrées sur la page du modèle, il est donc nécessaire de les encadrer par les balises '''<nowiki><noinclude></nocinclude></nowiki>''' afin qu'elles ne soient pas affichées lors de l'appel du modèle.
*Ces explications doivent être enregistrées sur la page du modèle, encadrées par les balises '''<nowiki><noinclude></nocinclude></nowiki>''' pour ne pas être affichées lors de l'appel du modèle.
*Afin de montrer le code utilisé aux lecteurs du wiki, encadrez-le avec les balises '''<nowiki><nowiki></nowiki></nowiki>'''.
*Afin de montrer le code utilisé aux lecteurs du wiki, encadrez-le avec les balises '''<nowiki><nowiki></nowiki></nowiki>'''.


Pour plus d'informations sur la création des modèles, reportez-vous aux aides suivantes :
Pour plus d'informations sur la création des modèles, reportez-vous aux aides suivantes :
*[https://www.mediawiki.org/wiki/Help:Templates/fr Modèle sur Mediawiki]
*[https://www.mediawiki.org/wiki/Help:Templates/fr Modèle sur Mediawiki]
*[https://www.mediawiki.org/wiki/Help:Tables/fr Tableaux sur Mediawiki]
*[https://fr.wikipedia.org/wiki/Aide:Cr%C3%A9er_un_mod%C3%A8le Wikipedia]
*[https://fr.wikipedia.org/wiki/Aide:Cr%C3%A9er_un_mod%C3%A8le Wikipedia]<br/><br/>


= Organisation et mise en page =
== Organisation et mise en page ==
Soyez libre de présenter votre page à votre goût, mais faite en sorte qu'elle s'intègre de manière cohérente avec le reste du wiki.
Soyez libre de présenter votre page à votre goût, mais faites en sorte qu'elle s'intègre de manière cohérente avec le reste du wiki.


Quelques astuces et recommandations :
Quelques astuces et recommandations :
*Commencez par créer les différentes parties de votre article, elles seront vos '''titres de niveau 1'''. Si votre document comporte trop d'information (plusieurs OS par exemple), envisagez de le répartir sur plusieurs pages.
*Commencez par créer les différentes parties de votre article, elles seront vos '''titres de niveau 2'''. Si votre document comporte trop d'informations (plusieurs OS par exemple), envisagez de les répartir sur plusieurs pages.
*Placez des '''sauts de ligne''' avant chaque nouveaux grands titres afin d'aérer le texte.
*Placez des '''sauts de ligne''' (<nowiki><br/><br/></nowiki>) avant chaque nouveau grand titre afin d'aérer le texte.
*Lors de la description d'étapes successives dans votre tutoriel, privilégiez l'usage des '''listes à puces''', elles favorisent la clarté et rendent souvent l'information plus synthétique.
*Lors de la description d'étapes successives dans votre tutoriel, privilégiez l'usage des '''listes à puces''', elles favorisent la clarté et rendent souvent l'information plus synthétique.
*Évitez d'afficher des images trop grandes, elle nuisent à la fluidité de la lecture et sont gênantes sur les petits écrans. Sur ce wiki, les images au format paysage mesurent généralement '''400px'''.
*Évitez d'afficher des images trop grandes, elles nuisent à la fluidité de la lecture et sont gênantes sur les petits écrans. Sur ce wiki, les images au format paysage mesurent généralement '''400px'''.
*Pour éviter une mise en forme trop monotone, les images de ce wiki sont souvent placées après '''retrait''' (indentation) de manière à ne pas s'aligner avec le texte :
*Pour éviter une mise en forme trop monotone, les images de ce wiki sont souvent placées après un '''retrait''' (indentation) de manière à ne pas s'aligner avec le texte :
:<code><nowiki>:[[Fichier:Exemple.jpg|400px]]</nowiki></code>
:<code><nowiki>:[[Fichier:Exemple.jpg|400px]]</nowiki></code>
*Lorsque vous rédigez un article dans les parties cloud et Zmail, utilisez les modèles '''<nowiki>{{InscriptionCloud}}</nowiki>''' ou '''<nowiki>{{InscriptionZmail}}</nowiki>''' pour rappeler les procédures d'inscription et d'activation du compte. Placez-les en début de page, après une éventuelle petite introduction, au niveau de la table des matières.
*Lorsque vous rédigez un article dans les parties cloud et Zmail, utilisez les modèles '''<nowiki>{{InscriptionCloud}}</nowiki>''' ou '''<nowiki>{{InscriptionZmail}}</nowiki>''' pour rappeler les procédures d'inscription et d'activation du compte. Placez-les en début de page, après une éventuelle petite introduction, au niveau de la table des matières.
*Créez une dernière partie nommée '''"Références"''' dans laquelle vous indiquez vos sources et tout autres liens complémentaires.<br/><br/>
*Créez une dernière partie nommée '''"Références"''' dans laquelle vous indiquez vos sources et tout autre lien complémentaire.
 
== Comment participer ? ==
= Comment participer ? =
Vous vous sentez prêt à nous aidez ? Tant mieux, il y a plein de choses à faire !
 
Vous pouvez :
Vous pouvez :
*corriger les coquilles, les erreurs d'orthographe et les mauvaises tournures de phrases ;
*corriger les coquilles, les erreurs d'orthographe et les mauvaises tournures de phrases.
*faire la chasse aux erreurs techniques, aux informations et captures d'écran obsolètes ;
*faire la chasse aux erreurs techniques, aux informations et captures d'écran obsolètes.
*améliorer la mise en page et la présentation ;
*améliorer la mise en page et la présentation.
*créer de nouveaux tutos, si vous n'avez pas d'idée précise, jetez un œil à notre [[Todo list]] !
*créer de nouveaux tutoriels, si vous n'avez pas d'idée précise, jetez un œil à notre [[Todo list]] !


{{Note|1=Vous avez des doutes, des questions ? Vous souhaitez présenter votre nouvel article ? N'hésitez pas à nous rejoindre sur le [https://forum.zaclys.com/viewtopic.php?f=77&t=3779&start=20 forum Zaclys].}}<br/><br/>
{{Note|1=Vous avez des doutes, des questions ? Vous souhaitez présenter votre nouvel article ? N'hésitez pas à nous rejoindre sur le [https://forum.zaclys.com/viewtopic.php?f=77&t=3779 forum Zaclys].}}


= Références =
== Références ==
'''Sources :'''
'''Sources :'''
*https://www.mediawiki.org/wiki/Help:Formatting/fr
*https://www.mediawiki.org/wiki/Help:Formatting/fr

Version actuelle datée du 15 mars 2022 à 18:15

Il est nécessaire de s'inscrire sur le wiki pour pouvoir y contribuer et seuls les membres de l'équipe peuvent créer un compte wiki

Si vous désirez participer à ce projet, venez nous le signaler sur le forum Zaclys, nous serons ravis de vous compter parmi nous. Toute aide, même modeste, est bienvenue.

Pour vous inscrire sur la liste de diffusion du wiki, formulez-en la demande ici.

Créer une page

Il existe plusieurs manières de créer une page. Vous pouvez notamment créer un lien depuis une page déjà existante dans le wiki vers la page que vous souhaitez créer, celui-ci apparaîtra en rouge. Cliquez sur ce lien et vous arrivez sur un message qui vous informe que la page recherchée n'existe pas et vous propose de la créer. Vous accédez alors à la page de modification de l'article, écrivez votre texte et publiez, votre page est créée.

Cette manière de faire est probablement la meilleure, car ainsi vous êtes sûr que votre nouvelle page est accessible depuis au moins un point du wiki déjà existant. Cela permet aussi d'assurer une certaine cohérence avec la documentation déjà présente.

Il est également possible de créer une page en passant directement par son url. Sur le wiki Zaclys, elle est de la forme :

  • https://wiki.zaclys.com/index.php/Titre_de_page

Warning.png ATTENTION : si vous devez renommer une page, assurez-vous de bien activer la redirection depuis l'ancien nom afin que tous les liens qui pointaient vers votre page ne soient pas cassés.


Voir l'aide Mediawiki pour une information plus complète.

Formatage de base

Vous trouverez toutes les informations nécessaires sur le formatage sur l'aide Mediawiki :

Voici quelques balises qui vous seront probablement utiles pour commencer :

Description Saisie Résultat
Texte en italique 
''Texte en italique''
Texte en italique
Texte en gras 
'''Texte en gras'''
Texte en gras
Texte en gras et en italique 
'''''Texte en gras et en italique'''''
Texte en gras et en italique
Titres 
== Titre de niveau 2 ==

=== Titre de niveau 3 ===

==== Titre de niveau 4 ====

===== Titre de niveau 5 =====

Titre de niveau 2

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5

Note.png Note : le titre de niveau 1 est le titre de la page

Liste de définitions 
 ;Premier point
 :Définition 1
 ;Deuxième point
 :Définition 2-1
 :Définition 2-2
Premier point
Définition 1
Deuxième point
Définition 2-1
Définition 2-2
Liste à puces 
*Liste à puces
**Niveau 2
***Niveau 3
  • Liste à puces
    • Niveau 2
      • Niveau 3
Indentation de texte 
:Indentation
::Niveau 2
:::Niveau 3
Indentation
Niveau 2
Niveau 3
Lien interne 
[[Accueil]]
Accueil
Lien externe 
[http://mediawiki.org exemple]
exemple


Insérer une image

Pour utiliser une image, il faut d'abord l'importer sur le serveur. Pour cela, cliquer sur Téléverser un fichier dans le menu Outils de la sidebar du wiki et suivez les instructions :

Import01.png


Insérer ensuite l'image sur votre page avec :

  • [[Fichier:Nom_de_l'image.jpg]]

Remarque.png Remarque : Veillez à indiquer le bonne extension du fichier (jpg, png...)

Il est possible de définir toutes sortes de paramètres, comme la taille de l'image, la présence de bordures, son placement sur la page, etc. Par exemple, pour placer une image de 400px de large, saisissez :

  • [[Fichier:Nom_de_l'image.jpg|400px]]

Ou pour afficher une image sans lien :

  • [[Fichier:Nom_de_l'image.jpg|400px|link=]]

Consulter l'aide de Mediawiki pour plus d'informations.

Modèles

Les modèles sont des objets préformatés que vous pouvez intégrer dans votre page. Ils permettent de gagner du temps et favorisent une certaine homogénéité dans la mise en page de la documentation.

Utiliser un modèle

Pour appeler un modèle il faut saisir :

  • {{Nom_du_modèle|variable1|variable2}}

Certains modèles basiques ne nécessitent pas de variable :

  • {{Nom_du_modèle}}
Par exemple
Saisie Résultat 
{{Attention|Tapez votre texte ici}}

Warning.png ATTENTION : Tapez votre texte ici


Quelques modèles de base sont déjà disponibles sur le wiki Zaclys :

Créer un modèle

Pour créer un modèle, il suffit de créer une page de la forme :

  • http://wiki.zaclys.com/index.php/Modèle:Nom_du_modèle

Puis d'y créer le modèle en utilisant les variables {{{1}}}, {{{2}}}, etc.

Documenter le modèle

Lorsque vous créez un modèle, il est important de le documenter, c'est à dire de donner les indications nécessaires à son utilisation.

  • Ces explications doivent être enregistrées sur la page du modèle, encadrées par les balises <noinclude></nocinclude> pour ne pas être affichées lors de l'appel du modèle.
  • Afin de montrer le code utilisé aux lecteurs du wiki, encadrez-le avec les balises <nowiki></nowiki>.

Pour plus d'informations sur la création des modèles, reportez-vous aux aides suivantes :

Organisation et mise en page

Soyez libre de présenter votre page à votre goût, mais faites en sorte qu'elle s'intègre de manière cohérente avec le reste du wiki.

Quelques astuces et recommandations :

  • Commencez par créer les différentes parties de votre article, elles seront vos titres de niveau 2. Si votre document comporte trop d'informations (plusieurs OS par exemple), envisagez de les répartir sur plusieurs pages.
  • Placez des sauts de ligne (<br/><br/>) avant chaque nouveau grand titre afin d'aérer le texte.
  • Lors de la description d'étapes successives dans votre tutoriel, privilégiez l'usage des listes à puces, elles favorisent la clarté et rendent souvent l'information plus synthétique.
  • Évitez d'afficher des images trop grandes, elles nuisent à la fluidité de la lecture et sont gênantes sur les petits écrans. Sur ce wiki, les images au format paysage mesurent généralement 400px.
  • Pour éviter une mise en forme trop monotone, les images de ce wiki sont souvent placées après un retrait (indentation) de manière à ne pas s'aligner avec le texte :
:[[Fichier:Exemple.jpg|400px]]
  • Lorsque vous rédigez un article dans les parties cloud et Zmail, utilisez les modèles {{InscriptionCloud}} ou {{InscriptionZmail}} pour rappeler les procédures d'inscription et d'activation du compte. Placez-les en début de page, après une éventuelle petite introduction, au niveau de la table des matières.
  • Créez une dernière partie nommée "Références" dans laquelle vous indiquez vos sources et tout autre lien complémentaire.

Comment participer ?

Vous pouvez :

  • corriger les coquilles, les erreurs d'orthographe et les mauvaises tournures de phrases.
  • faire la chasse aux erreurs techniques, aux informations et captures d'écran obsolètes.
  • améliorer la mise en page et la présentation.
  • créer de nouveaux tutoriels, si vous n'avez pas d'idée précise, jetez un œil à notre Todo list !

Note.png Note : Vous avez des doutes, des questions ? Vous souhaitez présenter votre nouvel article ? N'hésitez pas à nous rejoindre sur le forum Zaclys.


Références

Sources :

Récupérée de « https://wiki.zaclys.com/index.php?title=Aide_à_la_rédaction&oldid=2655 »