Formiko, un éditeur de texte structuré pour la documentation Python

À propos de Formiko

Dans le prochain article, nous allons jeter un œil à Formiko. C'est un petit éditeur construit avec Python que j'ai trouvé par hasard sur GitHub. Formiko est une application Texterestructuré avec un éditeur MarkDown et un aperçu pour vérifier l'avancement des travaux effectués.

ReStructuredText est dans le cadre du projet Docutils et est utilisé par les programmeurs Python pour créer de la documentation technique. Je suis sûr qu'il y aura beaucoup de gens qui n'auront jamais entendu parler de reStructuredText, mais à travers ce programme et quelques concepts de base, vous verrez qu'il est facile d'utiliser ce système de syntaxe. Le programme est écrit en Python avec Gtk3, GtkSourceView et Webkit2. Utilisez Docutils et Analyseur de marque de recommonmark commun.

Il faut dire que Markdown et reStructuredText ont des capacités similaires. A titre de différence, il convient de noter que reStructuredText est conçu pour créer de la documentation, prend en charge les tableaux et les notes de bas de page et de fin.

ReStructuredText est un analyseur et un système de syntaxe faciles à lire. Il est utile pour la documentation de programmes en ligne, les chaînes de documents Python, pour créer rapidement des pages Web simples et pour des documents autonomes. L'analyseur reStructuredText est un composant de Docutils et est une révision et une réinterprétation des systèmes de balisage léger StructuredText et Setext.

Caractéristiques générales de Formiko

foriko gtk

Formiko

Selon la page GitHub du projet, Formiko comprend les fonctionnalités suivantes:

  • J'ai posé un éditeur basé sur GtkSourceView avec coloration syntaxique et éditeur Vim.
  • Nous allons diviser la zone de travail verticalement ou horizontalement.
  • Offre un mode aperçu pour voir comment est le travail.
  • JSON et aperçu de HTML.
  • Vérification orthographique.

Il est également compatible avec:

Installer Formiko sur Ubuntu

Pour cet article je vais installer Formiko sur Ubuntu 18.04. Nous trouverons ce programme disponible pour Debian et BSD comme nous pouvons le voir dans son Page GitHub.

Projet Formiko Vim

Formiko vim

Exigences

Avant de procéder à l'installation, il faut dire que selon leur page GitHub, il va falloir réparer certains exigences qui demande au programme de fonctionner correctement lorsque nous l'installons avec pip3.

  • python 2.7 ou 3
  • GTK+3
  • gobject-introspection
  • PyGObjectName
  • Kit Web
  • GtkSourceViewGenericName

Nous ouvrons un terminal (Ctrl + Alt + T) et écrivons:

sudo apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-3.0 \
gir1.2-webkit2-4.0 gir1.2-gtkspell3-3.0

Je tiens à préciser à nouveau que je fais cette installation sur Ubuntu 18.04. Une fois les conditions remplies, nous verrons que l'installation du programme se fera via pip ou apt comme nous sommes intéressés. Pour utiliser pip3 dans l'installation, nous écrirons dans le terminal (Ctrl + Alt + T):

pip3 install formiko

Au cas où vous préférez utiliser apt, dans le même terminal, nous écrivons:

installation apt formiko

sudo apt update && sudo apt install formiko

Il faut dire que les deux installations nous fourniront la même version du programme. En option, nous pouvons également installer:

sudo apt install vim-gtk3
pip3 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer

Lorsque nous l'installons, deux entrées seront ajoutées au menu de l'application: Formiko y Formiko vim.

Lanceur Formiko et Formiko Vim

Nous devrons trouver celui qui correspond le mieux à nos besoins.

Désinstaller Formiko

Comme nous avons vu deux options d'installation, nous verrons également deux commandes pour supprimer le programme de notre système d'exploitation.

La première des commandes sera celle faisant référence au installation faite avec pip3. Pour éliminer le programme, nous allons ouvrir un terminal (Ctrl + Alt + T) et y écrire:

sudo pip3 uninstall formiko

Maintenant, nous allons voir la commande pour ceux qui ont choisi le installation avec apt. Dans un terminal (Ctrl + Alt + T) on écrit:

sudo apt purge formiko && sudo apt autoremove

Ce n'est peut-être pas le meilleur des programmes pour sa fonction, mais je dois dire que Formiko a fonctionné sans problème pendant que je l'ai testé. Je ne veux pas terminer sans parler d'abord de ce qui est peut-être le plus gros point noir de ce programme, le limitation de format avec qui nous permet de travailler

Plus d'informations sur ce programme peuvent être obtenues sur la page de Projet GitHub.


Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont marqués avec *

*

*

  1. Responsable des données: Miguel Ángel Gatón
  2. Finalité des données: Contrôle du SPAM, gestion des commentaires.
  3. Légitimation: votre consentement
  4. Communication des données: Les données ne seront pas communiquées à des tiers sauf obligation légale.
  5. Stockage des données: base de données hébergée par Occentus Networks (EU)
  6. Droits: à tout moment, vous pouvez limiter, récupérer et supprimer vos informations.