Skip to main content

Faire respecter les règles typographiques françaises en HTML.

Project description

Typographeur

Faire respecter les règles typographiques françaises en HTML.

Status: Beta

Build Status

Utilisation

>>> from typographeur import typographeur
>>> typographeur('<p>Exemple : <em>Salut ! ça va ?</em></p>')
"<p>Exemple&nbsp;: <em>Salut&nbsp;! ça va&nbsp;?</em></p>"
>>> typographeur('<strong>et , entre ( parenthèses  ...) les points sans espace  .</strong>')
"<strong>et, entre (parenthèses…) les points sans espace.</strong>"

Origine

Cette bibliothèque a pour but de faire appliquer les règles de base de la typographie française sur des documents au format HTML. Elle s'inspire du projet SmartyPants, et lui emprunte une partie du code.

Tester

Pour tester, lancer (de préférence dans un virtualenv):

make test

Un exemple complet des correctifs que peut produire typographeur est disponible dans le dossier tests/examples/. On y trouve un fichier input.html, qui contient de nombreuses fautes de typographie, et expected.html, qui est le résultat attendu après corerection.

Règles implémentées

  • les signes :, !, ? et ; doivent être précédés d'une (et une seule) espace insécable.
  • pas d'espace après une parenthèse ouvrante, ni avant une parenthèse fermante.
  • les points de suspension ... sont remplacés par le caractère ; de même, on nettoie les doubles, triples, quadruples, n-uples points. Ça n'existe pas, c'est tout.
  • pas d'espace avant un point (simple . ou ) ou une virgule (,).
  • les guillemets doubles classiques ("") sont remplacés par des chevrons («»). À noter l'utilisation d'espaces insécables à l'intérieur des guillemets français.
  • les apostrophes ' sont changées en et ne doivent pas être suivies d'espaces.

Pour votre plaisir, un document HTML qui respecte les règles énoncées ci-dessus restera inchangé.

Les blocs encadrés par les balises pre, samp, code, tt, kbd, script, style, math ne seront pas corrigés, pour que les bouts de code soient affichés sans être déteriorés ; et que les éventuels scripts JS ne présentent pas d'erreur de syntaxe.

Bien que non-testée, la bibliothèque est supposée corriger les textes « bruts » (markdown, par exemple) aussi bien que le HTML.

Paramètres

Chaque règle peut être désactivée via le paramétrage de la fonction typographeur() :

  • fix_parenthesis : appliquer la règle pour les parenthèse.
  • fix_colon : appliquer la règle pour les deux-points (:).
  • fix_exclamation : appliquer la règle pour les points d'exclamation (!).
  • fix_interrogation : appliquer la règle pour les points d'interrogation (?).
  • fix_semicolon : appliquer la règle pour les points-virgules (;).
  • fix_ellipsis : appliquer la règle pour les points de suspension (... -> …).
  • fix_point_space : supprimer les espaces avant les points (… ou .).
  • fix_comma_space : supprimer les espaces avant les virgules (,).
  • fix_double_quote : transformer les guillemets doubles en chevrons.
  • fix_apostrophes : transformer les apostrophes "dactylographiques" en apostrophes "typographiques".

Outil en ligne de commande

Une fois installé, le paquet propose un outil en ligne de commande. Exemples d'utilisation :

$ echo "<p>Salut! ça va?</p>" | typographeur
<p>Salut&nbsp; ça va&nbsp;?</p>

On peut également passer un ou plusieurs fichiers en tant que paramètres :

$ typographeur input1.html input2.html

Par défaut, tous les paramètres de la fonction typographeur() sont activés. On peut les désactiver via les options suivantes :

  • --skip-parenthesis,
  • --skip-colon,
  • --skip-exclamation,
  • --skip-interrogation,
  • --skip-semicolon,
  • --skip-ellipsis,
  • --skip-point-space,
  • --skip-comma-space,
  • --skip-double-quote,
  • --skip-apostrophes.

Toutes les options disponibles sont visibles via :

$ typographeur --help

Autres implémentations

Des fonctionnalités similaires ont été implémentées dans d'autres langages de programmation. À noter :

Autre ressource :

Grammalecte est une extension pour LibreOffice, Firefox et Thunderbird pour aider à corriger (entre autres) les fautes de typographie.

Licence

Ce projet est librement utilisable, publié sous licence MIT.


In English, now: this library tries to apply basic French typography rules. It's vastly inspired by SmartyPants, and borrows a lot of code from it.

MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typographeur-0.1.0.tar.gz (8.0 kB view details)

Uploaded Source

File details

Details for the file typographeur-0.1.0.tar.gz.

File metadata

File hashes

Hashes for typographeur-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3db05827dcbd7322d74f049c2e36902ff2196ee6ab44c4dab1ca30efe30a86a9
MD5 798b651f97160306018d5f063d4c3a86
BLAKE2b-256 7df6bd6061bba12343dd3dce12c71c88f9c676f03f9d05e3c9db55b79eeec4c5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page