bdumont/csl-clio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Suppression des overfull hbox

Browse Source
This commit is contained in:
Bastien Dumont 2021-03-08 00:15:27 +01:00
parent 8e50ed4124
commit f53960bb87
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation/GUIDE_CSL-Clio.md
View File

@ -318,7 +318,7 @@ CSL ne propose qu'un mécanisme rudimentaire pour les abréviations : la variab
} }
~~~ ~~~
[Pour *Pandoc*](https://pandoc.org/MANUAL.html#specifying-a-citation-style), son utilisation est assez simple : il suffit de reprendre cette structure, d'indiquer les noms de revues ou de collections telles qu'elles apparaissent dans la base de données et d'utiliser l'option `--citation-abbreviations` ou la métadonnée `citation-abbreviations` pour indiquer au programme où se trouve le fichier d'abréviations à utiliser lors de son invocation. Sachant que les noms de revues sont représentés par la variable `container-title`, un fichier court mais complet pourrait ressembler à : [Pour *Pandoc*](https://pandoc.org/MANUAL.html#specifying-a-citation-style), son utilisation est assez simple : il suffit de reprendre cette structure, d'indiquer les noms de revues ou de collections telles qu'elles apparaissent dans la base de données et d'utiliser la métadonnée `citation-abbreviations` ou l'option correspondante pour indiquer au programme où se trouve le fichier d'abréviations à utiliser lors de son invocation. Sachant que les noms de revues sont représentés par la variable `container-title`, un fichier court mais complet pourrait ressembler à :
~~~ ~~~
{ {
@ -372,7 +372,7 @@ Si l'on reprend l'exemple précédent, cela donne :
Pour que le fichier soit pris en compte, il doit être enregistré obligatoirement sous le nom *abbreviations.json* à la racine de votre répertoire de données, dont l'emplacement peut être trouvé via le menu *Édition > Préférences > Avancées > Fichiers et dossiers*. Il faut donc conserver l'ensemble des fichiers d'abréviations avec chacun son titre dans un répertoire distinct ou dans le même répertoire et copier celui que vous voulez utiliser en donnant ce nom à la copie. À la suite de cette opération, *Zotero* doit être redémarré pour que le changement de fichier soit pris en compte. Enfin, dans votre logiciel de traitement de texte, il faut ouvrir les préférences du greffon *Zotero* et cocher la case *Utiliser les abréviations MEDLINE des titres de revues* (voir [@fig:preferences-medline]) ; si cette option n'apparaît pas, c'est que le style n'utilise pas les formes abrégées. Pour que le fichier soit pris en compte, il doit être enregistré obligatoirement sous le nom *abbreviations.json* à la racine de votre répertoire de données, dont l'emplacement peut être trouvé via le menu *Édition > Préférences > Avancées > Fichiers et dossiers*. Il faut donc conserver l'ensemble des fichiers d'abréviations avec chacun son titre dans un répertoire distinct ou dans le même répertoire et copier celui que vous voulez utiliser en donnant ce nom à la copie. À la suite de cette opération, *Zotero* doit être redémarré pour que le changement de fichier soit pris en compte. Enfin, dans votre logiciel de traitement de texte, il faut ouvrir les préférences du greffon *Zotero* et cocher la case *Utiliser les abréviations MEDLINE des titres de revues* (voir [@fig:preferences-medline]) ; si cette option n'apparaît pas, c'est que le style n'utilise pas les formes abrégées.
Quoique je n'aie pas testé d'autres possibilités, d'autres variables peuvent être abrégées, par exemple l'éditeur (variable `publisher`). Si les abréviations que vous avez prévues ne fonctionnent pas, vérifiez que le style CSL que vous utilisez prévoie l'utilisation des formes abrégés (p. ex. `<text variable="container-title" form="short"/>`) : si ce n'est pas le cas, vous pouvez demander de l'aide ou une modification, en fonction de la provenance du style, soit à [*CSL/Clio*](#un-projet-évolutif-et-ouvert-aux-retours-des-utilisateurs), soit à [*Zotero*](#demander-de-laide-et-signaler-des-bugs). Quoique je n'aie pas testé d'autres possibilités, d'autres variables peuvent être abrégées, par exemple l'éditeur (variable `publisher`). Si les abréviations que vous avez prévues ne fonctionnent pas, vérifiez que le style CSL que vous utilisez prévoie l'utilisation des formes abrégées (avec des commandes telles que `<text variable="container-title" form="short"/>`) : si ce n'est pas le cas, vous pouvez demander de l'aide ou une modification, en fonction de la provenance du style, soit à [*CSL/Clio*](#un-projet-évolutif-et-ouvert-aux-retours-des-utilisateurs), soit à [*Zotero*](#demander-de-laide-et-signaler-des-bugs).
![Préférences du document dans le greffon *Zotero* pour *LibreOffice*](preferences-medline.png){#fig:preferences-medline} ![Préférences du document dans le greffon *Zotero* pour *LibreOffice*](preferences-medline.png){#fig:preferences-medline}
@ -512,7 +512,17 @@ Là où vous utilisez les caractères « droits » ASCII (i. e. `"` et `'`),
] : si vous ne les remplacez pas par des apostrophes ASCII (touche 4 du clavier AZERTY), le processeur ne reconnaîtra pas ces titres comme faisant partie de la liste d'abréviations^[ ] : si vous ne les remplacez pas par des apostrophes ASCII (touche 4 du clavier AZERTY), le processeur ne reconnaîtra pas ces titres comme faisant partie de la liste d'abréviations^[
À moins, bien entendu, que vous n'y ayez également introduit ces apostrophes typographiques, auquel cas il faudra qu'elles soient présentes dans tous les enregistrements du titre correspondant dans *Zotero*. À moins, bien entendu, que vous n'y ayez également introduit ces apostrophes typographiques, auquel cas il faudra qu'elles soient présentes dans tous les enregistrements du titre correspondant dans *Zotero*.
]. Heureusement, la différence de forme entre les apostrophes ASCII et les apostrophes typographiques dans la police utilisée par *Zotero* (trait droit contre virgule) aide à repérer les anomalies ; ]. Heureusement, la différence de forme entre les apostrophes ASCII et les apostrophes typographiques dans la police utilisée par *Zotero* (trait droit contre virgule) aide à repérer les anomalies ;
* Dans les titres écrits en langues étrangères, si vous souhaitez que la typographie d'origine soit respectée, vous devez utiliser les caractères correspondants : par exemple `“Semper Vagus”: The Anatomy of a Mobile Monk` et non `"Semper Vagus": The Anatomy of a Mobile Monk`, qui serait rendu ainsi dans un article en français : *« Semper Vagus »: The Anatomy of a Mobile Monk*^[ * Dans les titres écrits en langues étrangères, si vous souhaitez que la typographie d'origine soit respectée, vous devez utiliser les caractères correspondants. Par exemple :
> `“Semper Vagus”: The Anatomy of a Mobile Monk`
et non :
> `"Semper Vagus": The Anatomy of a Mobile Monk`
lequel serait rendu ainsi dans un article en français :
> *« Semper Vagus »: The Anatomy of a Mobile Monk*^[
Le champ *Langue* devrait permettre, dans un futur plus ou moins lointain, de différencier la mise en forme en fonction de la langue de rédaction de l'ouvrage, comme dans [Juris-M](https://juris-m.github.io/). Le champ *Langue* devrait permettre, dans un futur plus ou moins lointain, de différencier la mise en forme en fonction de la langue de rédaction de l'ouvrage, comme dans [Juris-M](https://juris-m.github.io/).
] ; ] ;
* Dans les titres écrits dans la langue dans laquelle vous rédigez, il est préférable d'utiliser les guillemets ASCII de manière à ce qu'ils soient convertis en guillemets intérieurs si le style utilisé place lui-même les titres entre guillemets. * Dans les titres écrits dans la langue dans laquelle vous rédigez, il est préférable d'utiliser les guillemets ASCII de manière à ce qu'ils soient convertis en guillemets intérieurs si le style utilisé place lui-même les titres entre guillemets.
@ -607,7 +617,8 @@ Vous pouvez également cloner et mettre à jour régulièrement le [dépôt du p
> >
> Pour créer une copie locale du dépôt, utilisez la commande : > Pour créer une copie locale du dépôt, utilisez la commande :
> ``` > ```
> git clone 'https://bastien-dumont.onmypc.net/git/bdumont/CSL-Clio.git' > git clone\
> 'https://bastien-dumont.onmypc.net/git/bdumont/CSL-Clio.git'
> ``` > ```
> >
> Pour obtenir la liste des fichiers qui ont été ajoutés ou modifiés sur le dépôt depuis la dernière mise à jour de votre copie locale (et donc, pour les fichiers CSL, ceux que vous devrez [réimporter dans *Zotero*](#fichiers-csl) si vous la mettez à jour) : > Pour obtenir la liste des fichiers qui ont été ajoutés ou modifiés sur le dépôt depuis la dernière mise à jour de votre copie locale (et donc, pour les fichiers CSL, ceux que vous devrez [réimporter dans *Zotero*](#fichiers-csl) si vous la mettez à jour) :
@ -777,7 +788,7 @@ Suivant un principe éprouvé et largement appliqué en programmation, [le code
* Contrairement à l'usage courant dans les fichiers CSL, l'ordre des macros va de la plus générale à la plus précise : ainsi, un coup d'œil sur le début du fichier (macros `citation` et `bibliography`) donne une indication sur la logique d'ensemble, puis la poursuite de la lecture permet d'acquérir une compréhension de plus en plus précise ; * Contrairement à l'usage courant dans les fichiers CSL, l'ordre des macros va de la plus générale à la plus précise : ainsi, un coup d'œil sur le début du fichier (macros `citation` et `bibliography`) donne une indication sur la logique d'ensemble, puis la poursuite de la lecture permet d'acquérir une compréhension de plus en plus précise ;
* Les choix conditionnels et les instructions de mise en forme doivent être reléguées dans les macros de plus bas niveau possible. Par exemple : * Les choix conditionnels et les instructions de mise en forme doivent être reléguées dans les macros de plus bas niveau possible. Par exemple :
* On n'indiquera pas dans la macro `citation` que le titre d'un article doit être indiqué en caractères droits et celui d'un livre en italiques : la macro `citation` contiendra un appel à la macro `publicationTitle`, qui elle-même contiendra ces informations ; * On n'indiquera pas dans la macro `citation` que le titre d'un article doit être indiqué en caractères droits et celui d'un livre en italiques : la macro `citation` contiendra un appel à la macro `publicationTitle`, qui elle-même contiendra ces informations ;
* Dans le fichier `REB.csl`, la macro `publicationReference` appelle `publicationTitle` sans considérer si l'on est dans le cas d'une source pour laquelle la variable `year-suffix` a été renseignée dans le champ _Extra_, indiquant que le titre de la publication est redondant et ne doit pas être affiché. Ce n'est que dans la macro `publicationTitle` qu'apparaît l'instruction selon laquelle il ne faut rien afficher si la variable `year-suffix` est renseignée. Cela permet à la macro `publicationReference` de donner uniquement les informations qu'elle doit donner : dans quel ordre sont affichés, le cas échéant, les différents composants de la citation, et par quels caractères ils sont séparés. * Dans `REB.csl`, la macro `publicationReference` appelle `publicationTitle` sans considérer si l'on est dans le cas d'une source pour laquelle la variable `year-suffix` a été renseignée dans le champ _Extra_, indiquant que le titre de la publication est redondant et ne doit pas être affiché. Ce n'est que dans la macro `publicationTitle` qu'apparaît l'instruction selon laquelle il ne faut rien afficher si la variable `year-suffix` est renseignée. Cela permet à la macro `publicationReference` de donner uniquement les informations qu'elle doit donner : dans quel ordre sont affichés, le cas échéant, les différents composants de la citation, et par quels caractères ils sont séparés.
* Le nom d'une macro doit indiquer précisément ce qu'elle fait : `publicationTitle` s'occupe du titre principal d'une publication (et non d'une source), `titleInItalics` produit un titre en italiques ; * Le nom d'une macro doit indiquer précisément ce qu'elle fait : `publicationTitle` s'occupe du titre principal d'une publication (et non d'une source), `titleInItalics` produit un titre en italiques ;
* Par convention, les noms de macros doivent être en _camelCase_ ; * Par convention, les noms de macros doivent être en _camelCase_ ;
* Les macros doivent être courtes (entre 3 et 40 lignes). Dès que vous imbriquez des choix conditionnels ou que vous mêlez des informations sur des parties différentes de la citation (titre, auteur,...), demandez-vous si vous ne pourriez pas créer différentes macros pour gérer ces différents problèmes et les appeler dans votre macro principale. La logique d'ensemble n'en sera que plus claire ; * Les macros doivent être courtes (entre 3 et 40 lignes). Dès que vous imbriquez des choix conditionnels ou que vous mêlez des informations sur des parties différentes de la citation (titre, auteur,...), demandez-vous si vous ne pourriez pas créer différentes macros pour gérer ces différents problèmes et les appeler dans votre macro principale. La logique d'ensemble n'en sera que plus claire ;