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 :

• Mettez une ligne vide entre chaque paragraphe.

• Pour créer une liste d'éléments, commencez chaque ligne avec - pour une liste avec des puces ou + pour une liste numérotée.

• Pour faire des titres de sections, entourez ce titre par des =.

• Pour mettre en valeur du texte, procédez ainsi : //texte// pour la mise en italique ou **texte** pour la mise en gras.

• Pour créer un lien vers une autre page, entourez son nom par des crochets doubles ; par exemple [[nouvelle page]] crée un lien vers cette page. Un lien vers une page inexistante est affiché de façon différente, pour inviter d'autres à créer la page.

• Pour faire un lien vers un autre site, tapez directement son adresse, comme http://www.unsite.fr
  • Et pour faire un lien sur une portion de texte existante, c'est [description du site http://www.site.com]

• Pour faire un lien vers un fichier local, par exemple se trouvant dans le dossier /docs à la racine de l'installation de Lionwiki-t2t, c'est :
  [fichier pdf var/upload/votre-fichier.pdf]
  Ce qui donne :
  • fichier pdf

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.

• Pour rajouter une table des matières, rajoutez à l'emplacement souhaité le code %%toc

• Attacher un fichier :
  1. cliquer sur Upload content
  2. ou rajouter ?action=upload à la fin de n'importe quelle page

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

• **gras** : gras
• //italique// : italique
• __soulignage__ : soulignage
• --barré-- : barré
• titres avec différents = entourant ce titre, suivant le niveau hiérarchique
• - liste
• + liste numérotée
• ``code``
• % commentaire (ce qui suivra le % ne sera pas affiché)
• [http://www.site.org/image.jpg ] : affichage direct d'une image depuis son lien
• [lien vers un site http://www.site.com] : lien vers un site
• || Entête titre | titre 2 | titre 3 | | tableau | cellule 2 | cellule 3 |

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

• Visitez la page de syntaxe lionwiki-t2t complète.

• Visitez le site de txt2tags pour apprendre la syntaxe ou utilisez les boutons pour une mise en forme rapide.

• Markdown : Certaines balises de la syntaxe markdown sont intégrées (titres, liens...), à l'exceptions de celles qui pourraient apporter de la confusion ou des incompatibilités (comme pour l'italique).

Installation

Utilisation et configuration

• Vous pouvez configurer lionwiki-t2t en éditant quelques fichiers de configuration avec l'utilitaire pheditor.php à la racine de l'installation. Le mot de passe par défaut est "admin" et il vous est conseillé de le modifier après l'installation. (sur l'installation de yunohost, le mot de passe est le même que celui choisi lors de l'installation). Si vous pensez qu'il pourrait s'agir d'une faille de sécurité, vous pouvez supprimer cet éditeur de votre installation ou le renommer.
• menu du haut (top menu) : vous pouvez le customiser en éditant le fichier menu.php à la racine du site.
• configuration générale : éditez config.php. Vous pouvez commenter (ignorer) une ligne en la débutant avec //. Ce fichier permet de modifier notamment :
  • le titre du wiki
  • le mot de passe en édition (variable $PASSWORD)
  • le thème par défaut (variable $TEMPLATE). Seule la dernière variable renseignée est prise en compte.
• configuration spécifique, rajout de regex, customisation avancée etc : vous pouvez rajouter tout cela dans le fichier config.t2t qui utilise la syntaxe de txt2tags, et qui sera appelé par lionwiki-t2t (voir plus bas).
  • Vous pouvez regarder la page sandbox_cyoa et son fichier de configuration cyoa.t2t pour un exemple de ce qu'il est possible de faire en utilisant cette fonctionalité.

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

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

%!includeconf:newrule.t2t

Synchronisation

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

• (optionnel) installer nextcloud : https://nextcloud.com/
• (optionnel) partager un des sous-dossier contenant l'installation de lionwiki dans owncloud
• installer foldersync sur l'appareil android et synchronisez vos fichiers textes dans var/pages/ entre votre serveur et votre appareil mobile (tablette, téléphone), en utilisant soit ssh (recommandé) ou owncloud.
• installer 920 editor ou Denkzettel sur l'appareil android et éditez les pages de votre site directement depuis votre appareil mobile !

• Bonus : si vous utilisez Denkzettel, créez une nouvelle page et commencez votre première ligne par #### ou Denkzettel, puis activez l'option "checklist on". Vous pourrez ainsi utiliser votre wiki comme une liste de courses : Les articles sont créés par l'application avec un + devant eux, et désactivés avec un -, et avec un peu de prétraitement dans le config.t2t nous sommes capables de l'afficher correctement dans lionwiki-t2t. Consultez cette page pour voir un exemple dans action. (Les caractères ## sont automatiquement ajoutés par denkzettel pour ajouter une couleur de fond à la note).

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 :

• base de données textuelle, lisible et compréhensible par l'utilisateur et facilement éditable depuis un autre logiciel.
• thème par défaut (minimaxing), simple et sobre. Design CSS Responsive (s'adapte aux smartphones et tablettes). Changement des couleurs de base et des polices de caractères facilité par l'utilisation de less.
• autre thème optionnel utilisant bootstrap, pouvant servir de base pour un autre type de thème moderne.

Astuces

• Si vous souhaitez aligner vos images, retenez ceci :
  • pour aligner à gauche, rajoutez un espace supplémentaire (ou du texte) après la marque de l'image
  • pour centrer, rajouter un espace supplémentaire avant et après la marque de l'image
  • pour aligner à gauche, rajoutez un espace supplémentaire (ou du texte) avant la marque de l'image

• Si vous avez besoin de retravailler le design du css minimaxing, renommez l'appel à minimaxing.css en minimaxing.less, dans le modèle minimaxing.html

• vous pouvez utiliser votre propre police d'écriture, il suffit de la nommer MyManuscript.ttf, de la placer dans le dossier templates/fonts (remplacez la police existante) et de modifier le fichier css/less pour qu'il soit appelé avant les autres polices.

• Vous pouvez également utiliser votre police préférée, la renommer si MyFont.ttf et la placer dans le dossier templates/fonts (remplacez la police existante).

• Sur linux ou mac os x, il ne devrait pas y avoir de problème pour double-cliquer sur un mot et ne faire que le surligner, alors que sur windows, il sélectionnera aussi l'espace blanc après lui, ce qui ne permet pas d'ajouter correctement la syntaxe. Ainsi, sur Windows :
  • soit un simple clic après le dernier caractère du mot et appuyez sur CTRL + MAJ + FLECHE DE GAUCHE
  • ou si vous êtes sur mozilla firefox, dans about:config, il suffit de mettre layout.word_select. et de choisir eat_space_to_next_word à False.

• le dossier var/pages est protégé par .htaccess. N'oubliez pas de l'activer dans vos configurations /etc/apache2/sites-available/default et /etc/apache2/sites-available/default-ssl !

Bogues connus

• si on édite une partie du document au lieu de sa globalité, que l'on sauvegarde, il faut recharger la page (F5) pour éditer une nouvelle partie une nouvelle fois.
• les regex de txt2tags avec caractères de remplacement spécifiques ont des problèmes (entre autres, lionwiki mange les \). À la place, veuillez utiliser un fichier de configuration t2t à la racine du site, et appelez-le avec includeconf. (voir example de sandbox_cyoa qui utilise cela)