<li><ahref="https://forge.chapril.org/Fab_Blab/freeDatas2HTML"target="_blank"title="accéder au dépôt GIT"rel="noopener"class="badge success sm-12 col">Git</a></li>
</ul>
</nav>
</header>
<articleid="content">
<h2>Documentation FreeDatas2HTML</h2>
<h3>Installation FreeDatas2HTML</h3>
<p>Pour l’instant FreeDatas2HTML n’est pas disponible sur NPM.<br/>
Vous devez donc en récupérer une copie sur <ahref="https://forge.chapril.org/Fab_Blab/freeDatas2HTML"rel="noopener"target="_blank">le dépôt GIT du projet</a>.<br/>
Si vous travaillez en TypeScript, vous pouvez directement utiliser les fichiers présents dans le répertoire <ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src"rel="noopener"target="_blank">/src</a> et ignorer le sous-répertoire /build.<br/>
Si vous travaillez en JavaScript, vous devez au contraire utiliser les scripts présents dans le répertoire <ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/build"rel="noopener"target="_blank">/src/build</a>.</p>
<h3>Importation de la classe principale</h3>
<p>Une fois les scripts présents dans le répertoire de votre projet, vous pouvez les importer comme n’importe quel module:<br/>
<code>import { FreeDatas2HTML } from "./modules/FreeDatas2HTML";</code></p>
<p>À supposer que les scripts soient situés dans le sous-répertoire <em>FreeDatas2HTML</em> du répertoire <em>modules</em> de votre projet.</p>
<p>Suivant ce que vous souhaitez faire, vous aurez peut-être besoin d’importer d’autres classes, comme indiqué plus loin.</p>
<h3>Instanciation de la classe principale</h3>
<p>Ensuite, dans votre script, vous pouvez créer votre instance de manière classique:<br/>
<p>Le premier argument du constructeur est obligatoire et vous permet d’indiquer le format des données à parser, avec trois options possibles: <em>«CSV»</em>, <em>«JSON»</em>, <em>«HTML»</em>.</p>
<h3>Fournir directement les données à parser</h3>
<p>Si vous avez déjà les données à parser sous la main, vous pouvez les fournir en deuxième argument du constructeur sous forme d’une chaîne de caractère:<br/>
En fait, il sera accepté une instance de n’importe quelle classe validant l’interface RemoteSources que vous pouvez retrouver déclarée dans le script <ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts"rel="noopener"target="_blank">interface.ts</a>.</p>
<p>Vous pouvez fournir des entêtes pour l’appel à la source de données distantes:<br/>
L’élément doit exister dans la page, sans quoi le <em>setter</em> générera une erreur.</p>
<h3>Parser les données</h3>
<p>Pour lancer le parsage, utilisez la méthode <em>run()</em> qui est asynchrone:<br/>
<code>await myConverter.run();</code></p>
<p>En cas de succès du parsage, si l’id de l’élément du DOM devant recevoir les données est connu, elles seront automatiquement affichées dans la page.</p>
<p>Dans tous les cas, une fois le parsage finalisé avec succès, vous pouvez accéder aux noms de champs et aux données trouvées:<br/>
<code>const fields=myConverter.fields; // format de sortie: string[], exemple: ["fistname", "name"]<br/>
const datas=myConverter.datas; // format de sortie : {[index: string]:string}[], exemple: [{firstname:"Janie", name:"Doe"}, {firstname:"John", name:"Doe"}];</code><br/>
Les formats de sortie sont les mêmes, quel que soit le format des données parsées.</p>
<h4>Tolérance aux erreurs de parsage</h4>
<p>Le parseur peut rencontrer certaines erreurs ne le bloquant pas, mais correspondant à des anomalies, par exemple, une colonne en trop dans des données CSV.<br/>
Si vous souhaitez bloquer la suite quand cela arrive, il vous faut l’indiquer avant de lancer le parsage:<br/>
<h4>Ne pas afficher tous les champs disponibles</h4>
<p>Si vous ne souhaitez pas afficher tous les champs trouvés dans votre fichier, vous pouvez indiquer ceux à garder:<br/>
<code>myConverter.fields2Rend=[0,2]; // n’affichera que le 1ᵉʳ et le troisième champ, la numérotation commençant à zéro.</code></p>
<p>Ce setter provoquera une erreur si vous fournissez un numéro de champ n’existant pas les données parsées.<br/>
Vous pouvez par contre le déclarer à tout moment, pour prise en compte dès le prochain affichage.</p>
<p>Pour de nouveau afficher tous les champs (situation par défaut), il suffit de passer un tableau vide:<br/>
<code>myConverter.fields2Rend=[];</code></p>
<h4>Adapter le code HTML généré pour l’affichage des données</h4>
<p>Pour spécifier le code HTML à générer, vous devez créer une instance de la classe <em>Render</em> ou d’une autre classe validant l’interface <em>DatasRenders</em> déclarée dans le script <ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts"rel="noopener"target="_blank">interface.ts</a>.<br/>
Dans le cas de la classe <em>Render</em>, il faut commencer par l’importer:<br/>
<code>import { FreeDatas2HTML, Render } from "./modules/FreeDatas2HTML";</code></p>
<p>Puis l’instancier:<br/>
<code>const myRender=new Render();</code><br/>
Et utiliser l’attribut <em>settings</em> pour décrire ce que vous souhaitez obtenir:<br/>
<code>myRender.settings=<br/>
{<br/>
allBegining:"<h4>Moi je préfère les listes aux tableaux !</h4>",<br/>
Dans ce cas la configuration par défaut est écrasée par la valeur de settings.<br/>
<ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts"rel="noopener"target="_blank">Consulter le type <em>DatasRendersSettings</em></a> pour voir tous les attributs disponibles.</p>
<p>Si vous souhaitez simplement modifier un des attributs, vous pouvez le faire ainsi:<br/>
<h4>Besoin d'un rendu complexe, fusionnant plusieurs champs?</h4>
<p>Il est possible d’obtenir un rendu plus complexe, mixant les données venant de plusieurs champs. C’est par exemple le cas si vous souhaitez créer un lien dont l’URL se trouve dans un champ et l’ancre dans un autre.</p>
<p>Ceci est possible via l’extension <strong><em>MixedFieldsRender.ts</em></strong>. Cette documentation ne présente pas l’usage de cette extension pour l’instant, mais vous pouvez vous inspirer <ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/demo/exampleWithMixedFields.ts"rel="noopener"target="_blank">du code utilisé de l’exemple d'usage de ce site de démonstration</a> ou encore <ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/integrations/src/segal.ts"rel="noopener"target="_blank">du code utilisé sur le site d’une association</a> pour lister ses partenaires à partir d’un fichier <em>CSV</em>.</p>
<h3>Affichage d’un compteur</h3>
<p>Si vous souhaitez afficher quelque part le nombre d’enregistrements, il vous suffit de fournir l’id de l’élément de votre page devant recevoir cette information :<br/>
<p>Ce compteur sera ensuite mis à jour à chaque actualisation des données. Il prend en compte les filtres activés par l’utilisateur, mais ignore la pagination qui n’est qu’une commodité de navigation.</p>
<p>Si vous souhaitez vous-mêmes actualiser ce compteur, utilisez cette méthode:<br/>
<code>myConverter.datasCounter2HTML();</code></p>
<h3>Proposer des filtres pour les données</h3>
<p>Les filtres sont des éléments <em>SELECT</em> listant, de manière classée et dédoublonnée, toutes les valeurs disponibles pour un champ. Le classement se fait par ordre «naturel», c’est-à-dire par ordre alphabétique ignorant la casse pour les chaînes. De même pour les nombres, «02» ne sera pas avant «1», bien que «0» précède «1»… Pour des besoins particuliers, il vous est possible d’utiliser votre propre fonction de classement, ce qui sera expliqué plus loin.</p>
<p>Si plusieurs filtres sont proposés à l’utilisateur final, seuls les enregistrements validant tous les choix de l’utilisateur seront affichés.</p>
<p>Pour ajouter un filtre, commencer par l’inclure dans votre script:<br/>
<code>import { FreeDatas2HTML, Selector } from "./modules/FreeDatas2HTML";</code></p>
<p>Les trois premiers paramètres sont obligatoires:</p>
<ul>
<li>le premier est votre instance de FreeDatas2HTML</li>
<li>le deuxième correspond au numéro du champ utilisé pour ce filtre</li>
<li>le troisième est l’id de l’élément HTML dans lequel sera injecté la liste <em>SELECT</em>.</li>
</ul>
<p>Un quatrième paramètre est facultatif, mais permet d’indiquer un séparateur, qui vous sera utile si un champ contient plusieurs valeurs pour un même enregistrement.<br/>
Par exemple, à supposer que vous souhaitiez créer un filtre sur le 3ᵉ champ (donc le numéro 2!) contenant des mots-clés séparés par des point virgule, voici le code à utiliser:<br/>
<p>Attention, <strong>vous devez d’abord avoir parsé vos données avant de créer votre instance de Selector</strong>, car l’existence du champ fourni en paramètre est testé à cette étape.</p>
<p>Une fois votre instance créée, en attribut supplémentaire permettra à l’utilisateur de sélectionner plusieurs valeurs dans la liste:<br/>
<code>myFilter2.isMultiple=true;</code><br/>
Ce n’est pas le cas par défaut. Si le choix multiple est permis, tout enregistrement valide pour au moins une des valeurs sélectionnées sera affiché.</p>
<p>L’instanciation va aussi récupérer les données distinctes à proposer dans la liste. Vous pouvez récupérer cette liste de valeurs, via le code suivant:<br/>
Il sera en fait acceptée toute instance d’une classe respectant l’interface Filters <ahref="https://forge.chapril.org/Fab_Blab/FreeDatas2HTML/src/branch/master/src/interfaces.ts"rel="noopener"target="_blank">décrite dans le script interface.ts</a>.</p>
<p>Un moteur de recherche est en fait un filtre comme les autres ou presque!</p>
<p>Effectivement, dans les deux cas il est proposé à l’utilisateur final de filtrer les données suivant son choix, qu’il aura effectué librement dans un moteur de recherche ou de manière contrainte dans une liste de sélections.</p>
<p>Il s’agit d’ailleurs d’un exemple concret d’utilisation des interfaces, car les deux classes <em>Filter</em> et <em>SearchEngine</em> implémentent l’interface <em>Filters</em>, déjà citée plus haut. Toute instance d’une classe validant cette interface sera acceptée par FreeDatas2HTML comme filtre.</p>
<p>Bref pour ajouter un moteur de recherche, il faut de nouveau inclure la classe:<br/>
<code>import { FreeDatas2HTML, SearchEngine } from "./modules/FreeDatas2HTML";</code></p>
<p>Les deux premiers paramètres sont obligatoires:</p>
<ul>
<li>le premier est de nouveau votre instance de FreeDatas2HTML</li>
<li>le second correspond à l’id de l’élément de votre document dans lequel le moteur de recherche sera injecté.</li>
</ul>
<h4>Définir les champs à utiliser pour votre recherche</h4>
<p>Un troisième paramètre vous permet de préciser la liste des champs dans lesquels la saisie de l’utilisateur sera recherchée, par exemple pour limiter la recherche aux troisième et quatrième champs:<br/>
<p>Par défaut la recherche se fait donc dans tous les champs présents dans les données, qui ne sont pas forcément affichés (cf plus haut).<br/>
Il peut ainsi être intéressant d’avoir dans votre fichier un champ contenant des mots-clés utiles à votre moteur de recherche, sans pour autant les afficher dans la page…</p>
<h4>Personnaliser l’apparence du moteur de recherche</h4>
<p>Vous pouvez ensuite personnaliser l’apparence de votre moteur de recherche via certains attributs.</p>
<p>Le texte du <em>label</em> du champ de saisie:<br/>
<code>mySearch.label="Votre recherche :"; // par défaut vide, il n’y aura alors pas de <label></code></p>
<p>Le texte du bouton lançant la recherche:<br/>
<code>mySearch.btnTxt="Va chercher !"; // par défaut : Search</code></p>
<p>Ou encore le <em>placeholder</em> s’affichant dans le champ de saisie:<br/>
<code>mySearch.placeholder="Saisir votre recherche"; // par défaut vide ou "Please enter at least NB characters.", s’il y a un nombre minimum de caractères pour lancer la recherche automatique.</code></p>
<h4>Lancement automatique de la recherche?</h4>
<p>D’autres attributs permettent d’adapter le comportement du moteur de recherche.</p>
<p>Pour lancer la recherche dès la saisie:<br/>
<code>mySearch.automaticSearch=true; // par défaut false</code><br/>
En fixant éventuellement au nombre minimum de caractères:<br/>
<code>mySearch.nbCharsForSearch=2; // si l’option précédente est à «true», par défaut la recherche sera lancée dès le premier caractère saisi. Ici il faut en saisir deux. Les espaces entourant la saisie sont ignorés.</code></p>
<p>Ce nombre de caractères minimum ne concerne pas le bouton lançant la recherche.<br/>
En mode recherche automatique lorsque le champ de saisie est vidé par l’utilisateur, l’affichage est actualisé pour ne plus prendre en compte ce filtre.</p>
<h4>Recherche stricte ou «lâche»?</h4>
<p>Ensuite, sachez que par défaut la recherche de la valeur se fait de manière «lâche», c’est-à-dire en ignorant la casse, les accents ou encore les caractères spéciaux.<br/>
Par ailleurs, si plusieurs expressions séparées par des espaces sont saisies, elles sont cherchées séparément dans les enregistrements, mais doivent toutes être trouvées pour qu’un enregistrement soit affiché en résultat.</p>
<p>En effet, les utilisateurs prennent rarement la peine de saisir l’orthographe exacte de ce qu’ils cherchent.<br/>
Mais cela peut créer des faux positifs et si vous souhaitez une recherche plus stricte, l’attribut «searchMode» vous permet de préciser votre besoin:</p>
<ul>
<li><code>mySearch.searchMode.accentOff=true; // la recherche prendra en compte les accents.</code></li>
<li><code>mySearch.searchMode.caseOff=true; // la recherche prendra en compte la casse.</code></li>
<li><code>mySearch.searchMode.separatedWords=false; // même si elle contient des espaces, l’expression saisie sera cherchée en entier.</code></li>
<li><code>mySearch.searchMode.specialCharsOff=true; // la recherche prendra en compte les éventuels caractères spéciaux (*) saisis.</code></li>
<li><code>mySearch.searchMode.specialCharsWhiteList="#@%"; // dans le cas où l’option précédente est à «false», les caractères listés dans la chaîne fournie seront néanmoins pris en compte, c’est-à-dire ici "#", "@" et "%".</code></li>
</ul>
<p>(*) Seuls les caractères de l’alphabet latin (a, b…z) et les 10 chiffres de la base décimale (0, 1…9) sont considérés comme des caractères non spéciaux. Donc, par défaut, tout autre caractère saisi sera ignoré.</p>
<p>Évidemment toutes les options précédentes peuvent être passées en une seule fois:<br/>
<h3>Permettre de classer les données affichées</h3>
<p>Un dernier outil va donner la possibilité à vos utilisateurs de classer les données affichées via le champ de son choix. Pour ce faire, il faut que le rendu que vous avez choisi propose des entêtes de colonnes, ce qui est typiquement le cas des tableaux HTML contenant des balises <TH>. L’utilisateur pourra ainsi cliquer sur l’entête d’une colonne pour s’en servir pour classer les données dans un sens, puis de nouveau cliquer pour les classer dans l’autre sens.</p>
<p>Pour utiliser cet outil, comme d’habitude, il vous faut commencer par inclure sa classe:<br/>
<code>import { FreeDatas2HTML, SortingField } from "./modules/FreeDatas2HTML";</code></p>
<p>Puis l’instancier, pour chaque colonne que vous souhaitez rendre cliquable:<br/>
<p>Le premier paramètre est votre instance de FreeDatas2HTML et le deuxième le numéro du champ concerné, qui doit évidemment être affiché dans la page…<br/>
Un troisième paramètre facultatif, vous permet de désigner le sélecteur CSS à utiliser pour trouver les entêtes dans votre code HTML (par défaut, «TH»):<br/>
<p>Il est préférable de les transmettre avant le 1ᵉʳ affichage, car c’est FreeDatas2HTML qui s’occupera de rendre ses éléments cliquables.<br/>
Dans le cas contraire, vous pouvez toujours actualiser l’affichage après coup:<br/>
<code>myConverter.refreshView();</code></p>
<p>Une fois les liens de classement installés, vous n’avez pu à vous en occuper, les données seront classées alternativement dans le sens ascendant, puis descendant suivant les clics de l’utilisateur final.</p>
<p>Toutefois si vous souhaitez intervenir, l’attribut <em>order</em> est disponible:<br/>
<code>mySortingField1.order="desc"; // accepte "asc", "desc" ou undefined.</code></p>
<p>À noter qu’une extension est proposée pour vous permettre de créer des liens de classement, même quand vous n’avez pas prévu d’entêtes dans le rendu de vos données. Il s’agit de la classe <i>SortingFieldsStandAlone</i> qui n’est pas documentée ici pour l’instant. Mais vous pouvez <ahref="https://forge.chapril.org/Fab_Blab/freeDatas2HTML/src/branch/master/src/demo/exampleWithUL.ts"target="_blank">étudier le code de la page de démonstration l’utilisant</a>.</p>
<h3>Personnaliser la façon de classer les données</h3>
<p>Comme indiqué précédemment, par défaut les classements se font de manière «naturelle», c’est-à-dire par ordre alphabétique ignorant la casse pour les chaînes de caractère. Pour les nombres, l’éventuel «0» initial sera ignoré, etc.</p>
<p>Toutefois, la façon de classer certaines données doit être explicitée. C’est par exemple le cas de la 4ᵉ colonne <ahref="/withCSV.html"target="_blank"title="accéder à cette page">de la page de démonstration listant des éléments chimiques</a>. Vous y trouver des textes «Inexistant», «Traces» ou encore des opérateurs de comparaison comme « > 1 et < 100000». Comment faire pour trier ces données?</p>
<p>Dans ce cas, il vous faut fournir une fonction personnalisée de classement à votre instance de FreeDatas2HTML. Cette fonction doit <ahref="https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/Array/sort"rel="noopener"target="_blank"title="Documentation sur MDN">être compatible avec la fonction sort() de JavaScript</a>.<br/>
Voici par exemple, la fonction utilisée dans page de démonstration:<br/>
<p>Il est important de les associer à votre instance avant de déclarer toute autre fonctionnalité en ayant besoin: filtres <em>SELECT</em>, colonnes de classement…</p>
