En el següent article anem a fer una ullada a Formiko. Es tracta d'un petit editor creat amb Python que vaig trobar de manera casual en GitHub. Formiko és una aplicació ReStructuredText amb un editor Markdown i vista prèvia per comprovar els progressos de la feina realitzada.
ReStructuredText és part de el projecte Docutils i és utilitzat pels programadors de Python per a crear documentació tècnica. Estic segur que hi haurà moltes persones que mai han sentit parlar de reStructuredText, però mitjançant aquest programa i alguns conceptes bàsics es veurà que és senzill utilitzar aquest sistema de sintaxi. El programa està escrit en Python amb Gtk3, GtkSourceView i Webkit2. Utilitza Docutils i recommonmark Common Mark Parser.
Cal dir que Markdown i reStructuredText tenen capacitats similars. Com diferència, cal destacar que reStructuredText està dissenyat per crear documentació, admet taules i notes a peu i a al final.
ReStructuredText és un sistema de sintaxi i analitzador sintàctic fàcil de llegir. És útil per a la documentació de programes en línia, les cadenes de documents Python, per crear ràpidament pàgines web simples i per a documents independents. L'analitzador de reStructuredText és un component de Docutils i és una revisió i reinterpretació dels sistemes de marcat lleuger StructuredText i Setext.
Característiques generals de Formiko
Segons la pàgina GitHub de el projecte, Formiko inclou les següents característiques:
- Vaig posar un editor basat en GtkSourceView amb ressaltat de sintaxi i un editor Vim.
- ens va dividir l'àrea de treball de manera vertical o horitzontal.
- ofereix un mode de vista prèvia per anar veient com queda la feina.
- JSON i vista prèvia de HTML.
- verificació ortogràfica.
També és compatible amb:
- Docutils reStructuredText parser. Docutils HTML4, S5 / HTML presentació de diapositives i PEP HTML writer.
- Common Mark parser.
- Tiny HTML writer.
- HTML 5 writer
Instal·lació de Formiko en Ubuntu
Per a aquest article vaig a instal·lar Formiko en Ubuntu 18.04. Aquest programa el trobarem disponible a per a Debian i BSD com podrem veure en el seu pàgina de GitHub.
Requisits
Abans de procedir amb la instal·lació, cal dir que segons informen a la seva pàgina de GitHub, anem a haver de solucionar alguns requisits que demana el programa per funcionar quan ho instal·lem amb PIP3.
- python 2.7 o 3
- GTK +3
- GObject-Introspection
- PyGObject
- Webkit
- GtkSourceView
Obrim una terminal (Ctrl + Alt + T) i escrivim:
sudo apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-3.0 \ gir1.2-webkit2-4.0 gir1.2-gtkspell3-3.0
Vull tornar a aclarir que aquesta instal·lació l'estic fent sobre Ubuntu 18.04. Complerts els requisits, veurem que la instal·lació de el programa la realitzarem mitjançant pip o apt segons ens interessi. per utilitzar PIP3 en la instal·lació escriurem a la terminal (Ctrl + Alt + T):
pip3 install formiko
En cas de preferir utilitzar apt, A la mateixa terminal escrivim:
sudo apt update && sudo apt install formiko
Cal dir que les dues instal·lacions ens proporcionaran la mateixa versió de el programa. De manera opcional podrem instal·lar també:
sudo apt install vim-gtk3 pip3 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer
Quan ho instal·lem es van a afegir dues entrades a menú de les aplicacions: Formiko y Formiko Vim.
Haurem de buscar el que millor s'adapti a les nostres necessitats.
Desinstal Formiko
Com hem vist dues opcions d'instal·lació, també veurem dos ordres per eliminar el programa del nostre sistema operatiu.
El primer dels comandaments serà el referent a la instal·lació realitzada amb PIP3. Per eliminar el programa obrirem una terminal (Ctrl + Alt + T) i escriure-hi:
sudo pip3 uninstall formiko
Ara veurem la comanda per als que optin per la instal·lació amb apt. En una terminal (Ctrl + Alt + T) vam escriure:
sudo apt purge formiko && sudo apt autoremove
Potser no sigui el millor dels programes per a la seva funció, però he de dir que Formiko va funcionar sense problemes mentre ho he provat. No vull acabar sense abans parlar de el que potser sigui el major punt negre d'aquest programa, la limitació de formats amb els ens permet treballar
Es pot obtenir més informació sobre aquest programi a la pàgina de GitHub de el projecte.