Commit d3b80928 authored by Gael Picot's avatar Gael Picot
Browse files

add doc.html au dépot

parent 43efe1f7
libraries/plugins/druphal/plugin copy.js
libraries/data/doctype.bak.json
libraries/data/instance.bak.json
doc/doc.html
vendor/*
old_test/*
doc/doc_full.html
......
<h1 id="druphal">drupHal</h1>
<h2 id="table-des-matières">Table des matières</h2>
<ul>
<li><a href="#pres">Présentation</a></li>
<li><a href="#filter-conf">Ajout du filtre et plug-in CkEditor</a></li>
<li><a href="#use-plugin">Utilisation du plug-in CkEditor</a></li>
<li><a href="#qery-parameter">Paramètres des requêtes</a></li>
<li><a href="#template">Templates</a></li>
<li><a href="#qery-parameter">Formulaire de gestions des templates
préconfigurer</a></li>
</ul>
<h2 id="pres">Présentation</h2>
<p>DrupHal est un module permétant d’affiché les résultats d’une requête
dans Hal.</p>
<h3 id="contenue">Contenue</h3>
<p>Ce module contient:</p>
<ul>
<li>le filtre Hal Filter qui permet de remplacé les balise
[hal](…)[/hal] par le résultat de la requête Hal correspondante,</li>
<li>le plugin CkEditor permetant d’éditer visuelement les balises
[hal](…)[/hal],</li>
<li>le formulaire d’ajout et de modification de la liste des templates
d’affichage préenregistrer,</li>
<li>le service LastPubService qui permet d’executé les requêtes.</li>
</ul>
<h2 id="filter-conf">Ajout du filtre et plug-in CkEditor</h2>
<p>dans Configuration &gt; Rédaction de contenu &gt; Formats de texte et
éditeurs, entrez dans la configuration du format de texte voulue.</p>
<p>Pour activer le plugin CkEditor, il suffit d’ajouté l’icone de
DrupHal (logo de Hal en noire et blanc) dans la bar d’outil de votre
choix.</p>
<p>Pour activer le filtre Hal Filter il suffit de cocher la case Hal
Filter dans la liste des filtres activés.</p>
<p>Options plugin CkEditor :</p>
<ul>
<li>Activation jQuery Editable Select : modifie le widget de selection
du portail en utilisant :
https://indrimuska.github.io/jquery-editable-select/,</li>
<li>Portail par défaut : portail par défaut,</li>
<li>Mise à jour des données : Permet de télécharcher les dernière
version de la liste des portails et type de document à partir du serveur
de Hal.</li>
</ul>
<h2 id="use-plugin">Utilisation du plug-in CkEditor</h2>
<p>Le plug-in CkEditor permet de généré les balise [hal](…)[/hal] en
utilisant une interface graphique.</p>
<p>Les champs des formulaire corresponde aux paramètres de la <a
href="#qery-parameter">requête</a> effectuer.</p>
<h3 id="paramétre-daffichage">Paramétre d’affichage</h3>
<p>Permet de choisir le moteur de rendu et d’écrire ou d’utilisé un
template existant. La liste des templates préconfigurer permet de
choisir un des template préconfigurer grâce au formulaire de gestions
des templates préconfigurer.</p>
<p>le choix du moteur de rendu détermine les <a
href="#template">options</a> accessible.</p>
<h3 id="onglet-auteurrices">onglet : auteur·rice·s</h3>
<p>Permet de faire une requête pour un·e/des auteur·rice·s.</p>
<h3 id="onglet-structure">onglet : structure</h3>
<p>Permet de faire une requête pour une structure.</p>
<h3 id="onglet-requête">onglet : requête</h3>
<p>Permet de faire une requête de recherche personnaliser sur Hal. La
documentation de l’API est disponible <a
href="https://api.archives-ouvertes.fr/docs/search/">ici</a>.</p>
<p>Vous ne devez pas ajouter les champs de retoure (fl) dans les
paramètres de la requête.</p>
<h2 id="qery-parameter">Paramètres des requêtes</h2>
<p>Les Paramètres des requête Hal sont enregistrer sous la forme d’une
chaine JSON présent entre les balise [[hal](…)[/hal].</p>
<p>Les Paramètres non présent, on leurs valeurs par défault.</p>
<p>Seulement un des trois champs de requête (author, structure ou query)
doit être renseigné.</p>
<h3 id="auteurrices-author">auteur·rice·s (author)</h3>
<p>Valeur par défaut : vide</p>
<p>Créé une requête sur un·e ou plusieurs auteur·rice·s.</p>
<p>Pour séparé les diférent·e·s auteur·rice·s, le caractère ‘+’ est
remplacé par un AND et ‘,’ par un OR.</p>
<h3 id="structure">structure</h3>
<p>Valeur par défaut : vide</p>
<p>Créé une requête sur la ou les structures renseignées par le
champ.</p>
<h3 id="requêt-query">requêt (query)</h3>
<p>Valeur par défaut : vide</p>
<p>Permet d’utiliser une requête personnalisée.</p>
<h3 id="portail">portail</h3>
<p>valeur par défaut : selon le paramètre choisie dans la configuration
CkEditor</p>
<p>permet de renseigné le portail Hal utilisé pour la requête.</p>
<h3 id="types-de-document-doctypes">Types de document (doctypes)</h3>
<p>Valeur par défaut : vide</p>
<p>Liste des document à afficher.</p>
<h3 id="année-de-dabut-min_year">Année de dabut (min_year)</h3>
<p>Valeur par défaut : vide</p>
<p>Années de début de la requête.</p>
<h3 id="année-de-fin-max_year">Année de fin (max_year)</h3>
<p>Valeur par défaut : vide</p>
<p>Années de fin de la requête.</p>
<h3 id="nombre-de-retour-rows">nombre de retour (rows)</h3>
<p>Valeur par défaut : 100</p>
<p>Nombre maximum de résultats affichés.</p>
<h3 id="ordonner-par-sort">ordonner par (sort)</h3>
<p>Valeur par défaut : date de production (producedDate_s)</p>
<p>Ordre de trie des résultats de la requête.</p>
<h3 id="direction-sort_type">direction (sort_type)</h3>
<p>Valeur par défaut : desc</p>
<p>direction de trie des résultats de la requête.</p>
<h2 id="form">formulaire de gestions des templates DrupHal
préconfigurer</h2>
<p>Accessible dans configuration -&gt; Développement -&gt; Gestion des
templates DrupHal préconfigurés, ce formulaire permet d’ajouter, de
supprimer et de modifier les templates préconfigurer. Il est aussi
possible de réinitialiser la liste par défault.</p>
<p>En selectionnant une préconfiguration de template, vous pouvez la
supprimer ou la modifier. Si vous modifier le nom, alors cela en créra
un nouveau ou selectionnera celui correspondant.</p>
<p>Le bouton de réinitialisation permet de remetre la liste de template
par défaut.</p>
<p>Le bouton “Enregistrer la configuration” permet ou soit de créé une
nouvelle préconfiguration ou soit de modifier celle en cours.</p>
<h2 id="template">Template</h2>
<p>Pour personnaliser le rendu, on peut utiliser l’un des moteurs de
rendu. Les options disponible dépende du moteur de rendu choisi.</p>
<p>Les moteurs de rendu disponible sont :</p>
<ul>
<li>Citation Style Language (CSL)</li>
<li>Twig</li>
</ul>
<h3 id="citation-style-language">Citation Style Language</h3>
<p>Pour rendre les feuilles de style CSL, druphal utilise <a
href="https://github.com/seboettg/citeproc-php">citeproc-php</a>. Seul
les fauilles de styles prèinstallé peuvent être utiliser.</p>
<h4 id="localisation">localisation</h4>
<p>La localisation renvoi à un fichier disonible sur <a
href="https://github.com/citation-style-language/locales">le dépot
dédier au CSL</a>. Il doit être écrit au format standart langue-pays.
Par exemple, pour la france, fr-FR ou les états-units : en-US</p>
<h4 id="nom-de-fichiers-template">nom de fichiers template</h4>
<p>La liste des fichiers templates disponiblece trouve sur <a
href="https://github.com/citation-style-language/styles">ce dépot</a>.
Vous devez préciser le nom d’un des fichier existant.</p>
<h3 id="twig">Twig</h3>
<h4 id="champs-de-retour-result_fields">Champs de retour
(result_fields)</h4>
<p>Champs Hal (<a
href="https://api.archives-ouvertes.fr/docs/search/?schema=fields#fields">liste
compléte</a>) retourner par la requête.</p>
<p>Les champs doivent être séparé par des virgule sans espace.</p>
<h4 id="template-1">Template</h4>
<p>Template Twig de mise en forme du résultat de la requête.</p>
<p>La documentation de Twig est disponible <a
href="https://twig.symfony.com/doc/3.x/">ici</a>.</p>
<p>Le Template reçoit en paramètre le tableau items contenant tous les
résultats avec les champs renvoyer par la requête (soit défini par le
paramètre champs ou le champ fl de la requête personnalisé).</p>
<p>Les champs Hal de type multivalué sont retourné sous forme de
tableau.</p>
<p>Exemples de Template :</p>
<p>Avec les champs citationFull_s,authFullName_s pour l’affichage des
co-auteur·rice·s.</p>
<pre><code>{% for item in items%}{{ item.citationFull_s|raw }}&lt;br /&gt;&lt;br /&gt;
Co-auteur·rice·s :
{% for authFullName_s in item.authFullName_s%}
{% if not loop.first %}, {% endif %}{{ authFullName_s }}
{% endfor %}&lt;br /&gt;&lt;br /&gt;
{% endfor %}</code></pre>
<p>Avec les champs citationFull_s,abstract_s pour l’affichage de la
première version de l’abstract.</p>
<pre><code>{% for item in items%}{{ item.citationFull_s|raw }}&lt;br /&gt;&lt;br /&gt;
{{ item.abstract_s|first }}&lt;br /&gt;&lt;br /&gt;
{% endfor %}</code></pre>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment