Créer le manuel d'un module et le soumettre

Créer un module c'est bien, fournir un mode d'emploi: c'est mieux 

 

Qu'est-ce qu'une page de manuel ?

Une page de manuel est simplement une page HTML qui peut comprendre des images.

Pour soumettre un manuel il faut créer un fichier Zip contenant la page html et les images associées.

	Nom du fichier	Exemple pour le module news
Fichier Zip	doc-[NomDuModule].zip	doc-news.zip
Page HTML	zp_module_[NomDuModule].txt	zp_module_news.txt
images*	zp_module_[NomDuModule][NoSeq].png	zp_module_news1.png zp_module_news2.png
* les images peuvent aussi être incorporées directement dans la page html si elle sont d'une taille raisonnable

Que doit contenir la page ?

Un titre de page suivi de section.

Le titre de page utilise le tag H1 (c'est le style Titre1 de tinymce)

Le nom de section utilise le tag H2 souligné, le texte qui suit sur la ligne le TAG H2 (c'est le style Titre2 de tinymce)

Le corps de section n'utilise pas de coprs particulier (c'est le style paragraphe de tinymce)

Les sections obligatoies:

• Nom du Module
• Auteur
• Licence
• Description

• Utilisation
• Configuration
• Exemples
• Installation

Comment soumettre le manuel ?

Tout simplement en envoyant le fichier zip ainsi créé à l'auteur de ZitePlus via le forum bien connu.

Vous pouvez aussi l'envoyer à l'adresse ziteplus@giausserand.fr

Merci aux auteurs qui ont pris le temps de rédiger une page de manuel