Historique : Créer un thème ChuWiki

[ Documentation ]

Avant de commencer

Les thèmes ChuWiki sont des fichiers PHP. Ils seront interprétés par ChuWiki pour générer les pages que vous verrez en consultant votre site. Ces fichiers sont donc la représentation HTML de votre wiki, il est donc important qu'ils vous correspondent. Cependant, ces fichiers sont aussi les fichiers d'un wiki, il faut donc qu'ils respectent quelques règles de base afin que le wiki fonctionne.

Attention, ChuWiki travaille avec l'encodage de caractères UTF-8, par conséquent, veillez à créer vos thèmes dans ce format. La plupart des éditeurs de texte savent éditer en UTF-8 (même Notepad sous Windows). Si votre fichier n'est pas en UTF-8, ChuWiki génèrera une erreur pour vous l'indiquer.

Comment fonctionnent les thèmes ?

Une page d'un thème ne diffère d'une page HTML classique que sur un point : elle possède des valeurs qui seront automatiquement remplacées par ChuWiki pour fonctionner.

Les valeurs de la page

Ces valeurs sont calculées lors du rendu wiki pour vous fournir les informations nécessaires à l'affichage de la page.

&Page.Name;
Nom de la page en cours
&Page.Wiki;
Contenu wiki de la page en cours
&Page.Html;
Rendu HTML de la page en cours
&Page.History;
Disponible uniquement dans l'affichage de l'historique. Contenu de l'historique sous la forme d'une liste de balises <option>. À entourer d'un <select> dont le nom sera « Date ».

Les valeurs de configuration

Il y a 2 types de valeurs, celles définies dans le fichier de configuration, et celles ajoutées dynamiquement par ChuWiki pour vous simplifier la vie.

Les valeurs utiles du fichier de configuration

&Config.Title;
Le titre de votre wiki
&Config.WikiScript;
Le nom du script d'affichage d'une page. Preférez &Config.WikiURI;.
&Config.EditScript;
Le nom du script d'édition d'une page. Preférez &Config.EditURI;.
&Config.HistoryScript;
Le nom du script d'affichage de l'historique d'une page. Preférez &Config.HistoryURI;.

Les valeurs dynamiques supplémentaires

&Config.URI;
L'URI de votre wiki
&Config.Version;
La version de ChuWiki utilisé
&Config.PageSeparator;
Le caractère permettant de séparer le script et la page (/ ou ? selon si PathInfo est activé ou pas).
&Config.WikiURI;
URI du script d'affichage d'une page. Il suffit simplement d'y ajouter le nom de la page. (À préférer à &Config.WikiScript;)
&Config.EditURI;
URI du script d'édition d'une page. Il suffit simplement d'y ajouter le nom de la page. (À préférer à &Config.EditScript;)
&Config.HistoryURI;
URI du script d'affichage de l'historique d'une page. Il suffit simplement d'y ajouter le nom de la page. (À préférer à &Config.HistoryScript;)

Les valeurs de langue

Comme pour les valeurs de configuration, les valeurs de langue sont celles disponibles dans le fichier lang.ini de la langue sélectionnée. Bien utiliser ces valeurs pourra vous garantir que votre thème sera utilisable avec toutes les langues disponibles pour ChuWiki.

Les valeurs du fichier de langue

&Lang.Code;
Code de la lange utilisé. À spécifier dans un attribut lang de votre balise <html>
&Lang.DefaultPage;
Nom de la page d'accueil
&Lang.ListPage;
Nom de la page listant toutes les pages
&Lang.ChangesPage;
Nom de la page des changements récents
&Lang.NoWikiContent;
Contenu wiki d'une page vide
&Lang.WikiTitle;
Titre du script d'affichage (sera suivi du nom de la page)
&Lang.EditTitle;
Titre du script d'édition (sera suivi du nom de la page)
&Lang.HistoryTitle;
Titre du script d'affichage de l'historique (sera suivi du nom de la page)
&Lang.Edit;
Contenu du bouton d'édition
&Lang.History;
Contenu du bouton d'historique
&Lang.Back;
Contenu du bouton de retour à la page
&Lang.Preview;
Contenu du bouton de prévisualisation
&Lang.Save;
Contenu du bouton de sauvegarde
&Lang.Restore;
Contenu du bouton de restauration

Les valeurs supplémentaires

&Lang.Rules;
Le contenu HTML affichant les règles d'édition de ChuWiki située dans le fichier rules.html de la langue sélectionnée.

À ne pas oublier

Il faudra faire attention à quelques points pour que le wiki fonctionne :

Et ensuite ?

Voila.

Toutes ces valeurs ne vous seront bien sûr pas toutes utiles et vous pouvez toujours vous inspirer du thème par défaut afin de vous familiariser avec cette technique.

N'hésitez pas à me soumettre vos créations pour que je les mette en ligne sur ce site.

Bonne création ;-)


Créer un thème ChuWiki quand on ne connait rien !

Bonjour, j'aimerais essayer de développer ChuWiki en créant quelques thèmes mais j'avoue ne pas comprendre tout ce qu'il y a ci-dessus. je suppose qu'il faut quand même d'autres connaissances. Quelqu'un pourrait m'en dire plus ?

Vibe

La seule connaissance nécessaire à l'écriture d'un nouveau thème ChuWiki est le HTML. Si vous ne savez pas écrire une page HTML, je vous conseille de vous rendre sur des sites apprenant à écrire des pages HTML comme OpenWeb.

Une fois que vous connaissez le HTML, il sera simple de vous créer votre page, ou tout simplement de modifier un thème existant.

-- Vincent

Ca y est je viens de commencer en modifiant quelques fichiers css ! Trop cool ! :)

 : C'est aussi comme ça que j'ai créé le nouveau thème par défaut de l'Encyclopédie Chaotique. Ca convient très bien.