Lionwiki-t2t


Read this help in English.

Lire l'aide sur la syntaxe complète.

Lionwiki-t2t est un système de type wiki pour la création et l'administration de sites Web.

Les pages Lionwiki-t2t ont le même aspect et fonctionnent comme des pages Web ordinaires, sauf qu'elles possèdent un lien pour « Éditer » ce qui permet de modifier ou d'ajouter facilement des pages à un site, en utilisant les règles d'édition de base (tout comme le fait le site http://fr.wikipedia.org)

Ce système contient quelques extensions pratiques et une syntaxe simplifiée et customisable.

Présentation

L'édition des pages peut être réalisée par plusieurs auteurs. Pour éditer une page, cliquez simplement sur « Éditer » qui existe quelque part dans la page, habituellement dans l'en-tête ou le pied de page. Quelques pages peuvent être protégées par mot de passe, en fonction de la politique de sécurité, mais beaucoup de sites permettent la libre édition de pages.

Le mot de passe par défaut de cette version du wiki est « demo », sauf si vous l'avez défini vous-même lors d'une installation de type YunoHost. Vous pouvez modifier le mot de passe après l'installation (voir plus bas).

Lorsque vous éditez une page, vous voyez les balises qui décrivent le contenu de la page. Le rendu final, avec le formatage choisi, ne s'affiche que lorsque la page est enregistrée.

Les règles de base pour le balisage de la page sont très simples :

Mais le plus simple, est d'utiliser la fonction d'attachement de fichiers (voir plus bas)

De façon générale, vous pouvez également sélectionner votre texte à formater, et utiliser la barre d'outil pour vous aider dans la rédaction.

les images peuvent être mises en place soit en les copiant dans le dossier uploads, soit en les téléchargeant individuellement avec la méthode du dessus.

Syntaxe de base

Entête titre titre 2 titre 3
table cellule 2 cellule 3
table cellule 2 cellule 3

Installation

Linux / Unix

Lionwiki s'installe très simplement : pas besoin de base de données sql, un serveur web (type Apache, Lighttpd ou Nginx) + php sera donc suffisant.

Voici une procédure possible pour son installation :

(retirez -minimal de l'adresse plus haut pour avoir la version complète, avec tous les thèmes et les extensions)

Windows

On windows system, get an HTTP server, such as XAMPP

Android

Si vous êtes sur Android et que vous souhaitez utiliser votre tablette / téléphone / androidtv comme serveur, vous pouvez utiliser cette application qui est un serveur web gratuit. Installez le plugin php, et copiez les fichiers du wiki dans /sdcard/paw/html. Ensuite, visitez http://localhost:8080/lionwiki-t2t à partir de votre système android.

YunoHost

Dans Yunohost, vous pouvez l'installer en cherchant "lionwiki" dans le magasin d'applications.

Pour plus de contrôle vous pouvez également l'installer par ftp avec l'application "MyWebApp", et gérer vous-même les mises à jour.

Docker

Allez dans le dossier infra/docker et tapez "make run" pour construire l'image et déployer un nouveau container. Plus d'info dans la doc dans le dossier infra/.

Utilisation et configuration

Configuration de Txt2tags

Le fichier config.t2t est appelé depuis le fichier principal index.php, et donc tous les remplacements et configurations qu'il contient concernera l'ensemble du wiki. Vous pouvez consulter le manuel de txt2tags pour savoir comment utiliser les directives preproc et postproc.

D'une manière générale, les preproc servent à personnaliser la syntaxe du wiki (ajout de nouvelles balises), et les postproc servent à ajouter des éléments html et css supplémentaires.

Supposons que vous souhaitez ajouter les en-têtes markdown dans le wiki (c'est déjà implémenté, allez voir config.t2t à la racine de l'installation de lionwiki-t2t) :

Alors nous ajoutons dans config.t2t cette syntaxe :

  %!preproc : '^# (.* ?)$' '= \1 ='

cela signifie qu'il traitera tout le texte (.* ?) commençant par un # en début de ligne (^), jusqu'à la fin de la ligne ($) et le remplacera par le balisage txt2tags pour les titres de niveau 1 (= heading =).

Maintenant, supposons que vous souhaitiez ajouter la nouvelle balise @@SLIDER@@ dans votre site web, alors ajoutez cette ligne dans config.t2t :

  %!postproc : '@@SLIDER@@' '<input type="range" min="1" max="100" class="slider">'

il en résultera :

Vous pourriez également affiner le balisage en ajoutant les valeurs min et max avec @@SLIDER@@@1/100@@ ce qui donnerait plus de sens. Voir l'exemple de la "progress bar" dans config.t2t pour un cas similaire.

Vous pouvez également définir un ensemble de règles disponibles uniquement pour une page. Créez un fichier newrule.t2t à la racine de l'installation. Puis incluez-le dans la page avec :

  %!includeconf:newrule.t2t

Pour le moment, il y a :

Templates

Les modèles définissent le placement général des éléments de votre wiki (menu en haut, "éditer" à droite du menu, ou en bas à la place, etc.)

Ils utilisent des éléments HTML simples, que vous pouvez modifier vous-même. Les crochets sont pour les éléments spéciaux de lionwiki-t2t, comme {EDIT}, {CONTENT}, {HOME}. En déplaçant ces éléments ailleurs, vous pouvez redéfinir le modèle.

Comme indiqué ci-dessus, vous pouvez sélectionner le modèle par défaut dans le fichier config.php. Les modèles se trouvent dans le dossier templates/. Vous pouvez les tester et les explorer. Vous pouvez également sélectionner un modèle par défaut sur la page admin, mais il ne sera modifié que localement (dans votre navigateur).

Le dossier templates contient également des thèmes CSS que vous pouvez personnaliser davantage (voir ci-dessous).

Quelques modèles notables (avec plusieurs schémas de couleurs) :

D'autres modèles peuvent être téléchargés sur https://github.com/farvardin/lionwiki-templates

Thèmes

La plupart des modèles contiennent un fichier .less qui définit l'apparence générale (schéma de couleurs, taille et définition de la police, taille...). Ils chargent également un fichier .less temporaire qui peut changer les couleurs de premier plan (@fg) et d'arrière-plan (@bg), ainsi que les liens et les titres, et la police par défaut. Ce fichier temporaire .less est alimenté par les fichiers de définition du dossier templates/css/ et génère également des fichiers .css dans le dossier de son modèle, en utilisant le fichier makefile associé.

Par exemple pour le template newspaper, vous pouvez facilement changer :

  1. templates/newspaper/newspaper.html pour mettre le lien {EDIT} en haut plutôt qu'en bas (ou en plus du bas)
  2. templates/newspaper/newspaper.less pour modifier la largeur du texte principal, la hauteur des lignes et les marges.
  3. templates/css/newspaper_theme01.less pour changer les couleurs et la police par défaut.

puis générez le nouveau thème avec "make newspaper_theme01" dans le dossier /templates/newspaper (lessc est nécessaire). newspaper.less importe le fichier "newspaper_temp.less". Ensuite, newspaper.less est appelé à l'intérieur du modèle newspaper.html. Vous pouvez remplacer cette génération dynamique (qui sera légèrement moins optimisée qu'un fichier .css statique) en supprimant le script less.js, le lien newspaper.less de newspaper.html, et en appelant un lien vers newspaper_theme01.css à la place, par exemple.

Index

Vous pouvez créer un index de toutes vos pages en rajoutant {INDEX_LIST} sur une page (voir page list|page_list). Pour surligner certaines pages importantes, vous pouvez indiquer dans le titre :

Dans le cas où un lien interne avec un tel titre ne fonctionnerait pas, veuillez remplacer les # par %23, par exemple page%23CY%23 au lieu de page#CY#

Synchronisation

Pour son utilisation dans un contexte multi-appareils, il est possible de rajouter ceci :

Exporter en tant que PDF

Vous pouvez exporter certaines des pages de votre wiki en pdf, et ainsi l'utiliser comment un traitement de texte ou un générateur de documents. Nous utilisons textallion pour cela. Install textallion in your server (installed by default in /usr/share/textallion/), copy the content of /usr/share/textallion/contrib/latexlib/* into /var/www/lionwiki-t2t/export_pdf/. Uncomment in /var/www/lionwiki-t2t/menu.php the part related to "Generate pdf". If textallion is correctly setup, you should be able to render a pdf document from the content of the "textallion" page from your wiki. You can edit /var/www/lionwiki-t2t/export_pdf/lionwiki.t2t to add more pages.

Si cela ne fonctionne pas comme prévu, lancez /var/www/lionwiki-t2t/export_pdf/run.php et tracez les erreurs à partir de là. Lorsque l'application est correctement configurée, vous devriez pouvoir le faire à partir de n'importe quel navigateur qui peut accéder à votre installation de lionwiki-t2t.

Avantages

Quelques avantages de ce système :

Astuces

Bogues connus