Accéder aux codes sources
Index
File Transfer Protocol (FTP)
Prêt à mettre les mains dans le cambouis ?
Les codes sources de votre wiki sont hébergés sur un serveur web. Pour y accéder il est nécessaire de demander à l'administrateur de votre wiki : l'hote, l'identifiant et le mot de passe.
Quel logiciel utiliser ?
Le logiciel libre Filezilla permet d'accéder aux dossiers sur un serveur distant et d'y ajouter de nouveaux fichiers.Dans quel dossier faut-il mettre les templates ?
Les templates personnalisés doivent être placés dans le répertoire :/custom/templates/bazar
Tous les fichiers de ce répertoire seront conservés lors de la prochaine mise à jour de votre wiki.
Attention en aucun cas vous ne devez éditer les fichiers présents dans les autres dossiers !
Ajouter du css personnalisé
Index
Ajouter du css personnalisé
Si vous avez besoin de faire des petites modifications sur le style de votre wiki, il est possible d'ajouter du code CSS en ligne, sans avoir besoin d'accéder au serveur.La page PageCss est chargée après les autres feuilles de style, de ce fait vous pouvez surcharger une classe css ou en déclarer de nouvelles, elles seront prises en compte.
Attention Il est parfois nécessaire de vider le cache de votre navigateur pour que la modification de style soit visible : Ctrl + Maj + R
Avant de faire un template de fiche
Index
Avant de faire un template de fiche
Les templates dynamiques "card" offrent énormément d'options de personnalisation. Explorez les différentes combinaisons possibles : vertical, horizontal, ainsi que différentes informations mises en avant dans les emplacements titre / sous-titre /zone flottante / footer.exemple de page ressource avec card : https://communservice.cc/?FichesExp
Avant de se lancer
Index
Avant de se lancer
La structure de votre formulaire est-elle stable ?
Lorsque vous réalisez un template de fiche il va faire appel à un certain nombre de champs contenus dans votre formulaire. Si la structure de votre formulaire évolue, les nouveaux champs ne seront pas pris en compte.C'est pourquoi il est recommandé de se lancer seulement quand les données sont stabilisées, à moins de pouvoir faire appel très facilement à la personne qui a concu le template.
Quelques astuces pour insérer des éléments de mise en forme
Custom HTML
Le constructeur de formulaire bazar permet d'insérer à l'endroit que vous souhaitez du contenu en html.Utilisez cette possiblité pour ajouter un encadré autour d'un groupe d'informations :
<div class="well">
infos de votre formulaire
date
heure
lieu
</div>
De la même manière, vous pouvez insérer une image, un picto, mettre en colonne...
PageCSS
En inspectant le code de votre page, vous avez la possibilité de voir quelles sont les classes css utilisées dans le rendu de votre formulaire, ainsi vous pouvez surcharger ces classes dans PageCss et modifier la mise en forme.exemples :
pour mettre un fond de couleur au fiches ressource
.id5 {background-color:yellow;}
mettre en forme les titres des fiches bazar
.BAZ_fiche_titre {
color:var(secondary-color-2);
border-bottom:2px solid var(--primary-color);
}
Afficher un texte long en colonnes
.id4 .field-textelong {
column-count: 2;
}
Consulter les données brutes d'une fiche
Index
Extension Json dans le navigateur
Dans l'interface Bazar (Base de données) vous avez défini des identifiants pour chaque champ de votre formulaire. Ces identifiants sont utilisés pour stocker les informations à chaque fois qu'un utilisateur saisi une fiche.Afficher les données brutes
Pour vérifier vos identifiants et voir comment Yeswiki stocke les données, vous avez la possibilité d'afficher les données brutes.Lorsque vous consultez une fiche, ajoutez /raw à la fin de l'url
exemple :
https://pratic-coop.fr/?EcoclouD/raw
Json Lite : Extension firefox pour rendre plus lisible
Les données brutes sont stockées dans Yeswiki au format json, une extension firefox permet de formater l'affichage json : extension Json Lite.Pour installer l'extension dans firefox : Ctrl + Maj + A
Rechercher dans les Add-Ons mozilla le mot clé "Json", sélectionner "Json Lite" et installez.
Une fois l'extension installée, retournez sur votre wiki et consultez les données brutes, ca devrait être plus confortable !
Créer un template de fiche
Index
Créer un template de fiche
Les templates personnalisés sont écrits au format twig. C'est un langage qui permet le formatage en html et l'appel à des données bazar, tout en restant facile à lire.Dans quel dossier du serveur faut-il placer les fichiers ?
Un template de fiche doit être nommé fiche-id.twig (id étant l'identifiant du formulaire).Les templates personnalisés sont chargés depuis le répertoire custom/templates/bazar/.
ATTENTION, toutes les fiches possedant cet ID de formulaire seront avec le look personnalisé plutot que le look proposé par défaut... pour pouvoir réutiliser les templates, il faut enlever fiche-id.twig (ou le renommer avec un .old)
Exemple de code source
Un exemple de template de fiche est fourni dans le code source de votre wiki. Il est disponible en accédant via ftp à votre serveur, dans le dossier/docs/examples/templates/bazar
Pour démarrer, vous pouvez copier ce dossier dans votre dossier custom, puis renommer le fichier avec le numero identifiant de votre formulaire.
Il vous reste ensuite à éditer ce fichier et à construire votre mise en page.
Créer un template de liste
Index
Créer un template de liste
Les templates personnalisés sont écrits au format twig. C'est un langage qui permet le formatage en html et l'appel à des données bazar, tout en restant facile à lire.Dans quel dossier du serveur faut-il placer les fichiers ?
Il n'y a pas de convention de nommage pour votre template .twig .Les templates personnalisés sont chargés depuis le répertoire custom/templates/bazar/.
Structure du code
Code pour un template trombinoscope
{% if fiches|length > 0 %}
<div class="trombi-container ">
{% for fiche in fiches %}
<a class="bazar-entry modalbox bloc-question" data-size="modal-lg" {{ fiche.html_data|raw }}
href="{{ fiche.url}}/iframe" data-iframe="1"
{# add /iframe only for external YesWiki entries #}
title="{{ fiche.bf_titre|raw|e('html_attr') }}">
<div class="caption trombi-content">
<span class="title">{{ fiche.bf_titre }}</span>
</div>
</div>
</a> <!-- / bazar-entry -->
{% endfor %}
</div> <!-- / trombi-container -->
{% endif %}
Anciens templates .tpl.html
Les templates yeswiki ont longtemps été codés en php dans des fichiers de type .tpl.htmlCes templates fonctionnent encore, cependant ils sont petits à petits réécrits en twig pour une meilleure lisibilité et une meilleure compatibilité avec le reste du code Yeswiki.
Un tuto Convertir un template bazar en twig a été écrit sur le site Yeswiki.net pour nous guider sur la réécriture des templates. Il comprend notamment un tableau de correspondance entre les syntaxes php et twig.
Editeur de code
Index
Editeur de code
Les templates peuvent être édités avec n'importe quel éditeur de texte basique, néanmoins il existe des outils de développement qui peuvent apporter un peu de confort en permettant la coloration syntaxique et l'autocomplétion de votre code.Si vous n'avez pas encore d'éditeur de code, je vous conseille d'installer VsCodium
Inspecter le code
Index
Inspecter le code
Les navigateurs proposent d'inspecter le code de n'importe quel site et de modifier en direct le rendu. Dans Firefox, vous pouvez accéder aux Outil de développement web en appuyant sur F12 ou sur Ctrl + Maj + ICet outil permet d'explorer le code HTML ainsi que le style appliqué à chaque objet de la page. Il est possible de sélectionner directement un objet et d'y appliquer des variantes de style pour tester en direct votre modification.
Prototyper
Index
Prototyper
Figma est un outil en ligne qui permet de réaliser des maquettes de vos futures réalisations.Vous avez la possibiliter de partager ces maquettes à votre équipe qui pourra anoter des remarques, ou même proposer des améliorations.
Pour chaque objet on peut extraire le code css facilement, ce qui facilitera le travaiul d'intégration.
Syntaxes twig pour afficher du contenu yeswiki
Index
Syntaxes twig pour afficher du contenu yeswiki
Afficher la valeur brute d'un champ
{{fiche.identifiant}}
Pour le mettre en forme vous pouvez y ajouter les balises html de votre choix :
exemple pour un titre
<h1>{{fiche.bf_titre}}</h1>
Afficher le champ pré-formaté
Pour afficher vos données avec la mise en forme prévue dans yeswiki utilisez la syntaxe suivante :
{{html.identifiant}}
Cette syntaxe est utile pour les champs de type date, mail, liste, fichier, etc...
Fonction displayFieldIfNotEmpty
En copiant le modèle /www/docs/examples/templates/ dans votre dossier custom, vous bénéficiez de fonctions génériques permettant de faciliter le rendu : les helper.entryHelper.displayHtml retourne la/les valeurs d'un champ liste
{{ entryHelper.displayHtml(html.listenom_champ,'optionnal label','optionnal class css') }}
entryHelper.displayHtmlIfNotEmpty retourne le champ formaté précédé par son libellé en gras après avoir vérifié son existence
{{ entryHelper.displayHtmlIfNotEmpty('Libellé','FieldName',html) }}
Formater un champ checkbox ou un champ tag
Ces champs peuvent contenir plusieurs valeurs, elles sont enregistrées sous forme de liste séparés par des virgules, pour les formater, il faut donc traiter la chaine de caractères en isolant chacune des valeurs de la liste pour pouvoir gérer la mise en forme de chaque élément.la fonction split dans twig permet de découper une chaine selon le caractère spécifié (ici ',')
exemple avec tag
{% for tag in fiche.bf_tags|split(',') %}
<div class="trombi-content"> {{tag}} </div>
{% endfor %}
exemple avec checkbox
Pour formater de manière personnalisée les valeurs des checkbox, comme dans l'exemple ci-dessous dans des étiquettes
{% set fieldOptions = (form.prepared|filter(f => f.propertyname == 'checkboxListeViolence')|first).options %}
{% for element in fiche.checkboxListeViolence|split(',')|filter(o => o is not empty) %}
<span class=" label label-primary"> {{fieldOptions[element]|raw}} </span>
{% endfor %}
Afficher une image
Le code ci-dessous permet de redimensionner une image avant de l'afficher.
{% if fiche.imagebf_image is not empty %}
{# you can choose width, height (in px) and mode "fit" or "crop" #}
{% set imageFileAddr = urlImage({fileName:"files/#{fiche.imagebf_image}",width:200,height:200,mode:"crop"}) %}
{% if not(imageFileAddr is same as(false) or imageFileAddr matches '/^\\d+$/') %}
{# imageFileAddr is not false or not integer otherwise error #}
<img
class="center custom-entry"
alt="{{ fiche.bf_titre|e('html_attr') }}"
src="{{ imageFileAddr }}"
/>
{% endif %}
{% endif %}
Utiliser une syntaxe Yeswiki dans le template twig
{{ format('{{include page="' ~ fiche.id_fiche ~ '"}}') }}
Afficher des fiches liées
{{ format('{{bazarliste id="5" template="blog-custom" champ="bf_date" header="false" nb="10" ordre="desc" show_author="1" show_date="1" query="listefiche8=' ~ fiche.id_fiche ~ '"}}')|raw }}
Afficher pour les admins seulement
{# --- Start reserved admins info --- #}
{% if hasAcl("@admins",fiche.id_fiche) %}
<div class="panel panel-warning">
<div class="panel-heading center">
<h4><i class="far fa-hand-point-right"></i> Administration</h4>
</div>
<div class="panel-body">
{{ entryHelper.displayHtml(html.listeListeProjects,'Project','') }}
{{ entryHelper.displayHtml(html.checkboxListeParamsbf_display_params,'Display','') }}
</div>
</div>
{% endif %}