Formiko, un editor di testo strutturato per la documentazione di Python

A proposito di formiko

Nel prossimo articolo daremo uno sguardo a Formiko. Si tratta di un piccolo editor realizzato con Python che ho trovato per caso su GitHub. Formiko è un'applicazione testoristrutturato con un editor MarkDown e anteprima per verificare lo stato di avanzamento del lavoro svolto.

ReStructuredText è parte del progetto Docutils ed è utilizzato dai programmatori Python per creare documentazione tecnica. Sono sicuro che ci saranno molte persone che non hanno mai sentito parlare di reStructuredText, ma attraverso questo programma e alcuni concetti di base vedrai che è facile usare questo sistema di sintassi. Il programma è scritto in Python con Gtk3, GtkSourceView e Webkit2. Usa Docutils e raccomandare Common Mark Parser.

Va detto questo riduione di prezzo e reStructuredText hanno funzionalità simili. Come differenza, va notato che reStructuredText è progettato per creare documentazione, supportare tabelle, note a piè di pagina e note di chiusura.

ReStructuredText è un parser e un sistema di sintassi di facile lettura. È utile per la documentazione di programmi in linea, stringhe di documenti Python, per creare rapidamente semplici pagine web e per documenti indipendenti. Il parser reStructuredText è un componente di Docutils ed è una revisione e reinterpretazione dei sistemi di markup leggero StructuredText e Setext.

Caratteristiche generali di Formiko

foriko gtk

Formico

Secondo la pagina GitHub del progetto, Formiko include le seguenti funzionalità:

  • Ho posato un editor basato su GtkSourceView con evidenziazione della sintassi e un editor Vim.
  • Andiamo dividere l'area di lavoro verticalmente o orizzontalmente.
  • Offerte a modalità anteprima per vedere come va il lavoro.
  • JSON e anteprima di HTML.
  • Controllo ortografico.

È inoltre compatibile con:

Installazione di Formiko su Ubuntu

Per questo articolo lo farò installa Formiko su Ubuntu 18.04. Troveremo questo programma disponibile per Debian e BSD come possiamo vedere nel suo file Pagina GitHub.

Progetto Formiko Vim

Formiko vim

Requisiti

Prima di procedere con l'installazione, va detto che secondo la loro pagina GitHub, dovremo farlo aggiustane alcuni requisiti che chiede al programma di funzionare correttamente quando lo installiamo con pip3.

  • pitone 2.7 o 3
  • GTK+3
  • gobject-introspezione
  • PyGObject
  • webkit
  • GtkSourceView

Apriamo un terminale (Ctrl + Alt + T) e scriviamo:

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

Voglio chiarire ancora una volta che sto eseguendo questa installazione su Ubuntu 18.04. Una volta soddisfatti i requisiti, lo vedremo l'installazione del programma avverrà tramite pip o apt come ci interessa. Per usa pip3 nell'installazione scriveremo nel terminale (Ctrl + Alt + T):

pip3 install formiko

Nel caso tu preferisca usa apt, nello stesso terminale scriviamo:

installazione di apt formiko

sudo apt update && sudo apt install formiko

Va detto che entrambe le installazioni ci forniranno la stessa versione del programma. Opzionalmente possiamo anche installare:

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

Quando lo installiamo, verranno aggiunte due voci al menu dell'applicazione: Formico y Formiko vim.

Launcher Formiko e Formiko Vim

Dovremo trovare quello più adatto alle nostre esigenze.

Disinstalla Formiko

Come abbiamo visto due opzioni di installazione, vedremo anche due comandi per rimuovere il programma dal nostro sistema operativo.

Il primo dei comandi sarà quello riferito al file installazione eseguita con pip3. Per eliminare il programma apriremo un terminale (Ctrl + Alt + T) e vi scriveremo:

sudo pip3 uninstall formiko

Adesso vedremo il comando per chi ha scelto il installazione con apt. In un terminale (Ctrl + Alt + T) scriviamo:

sudo apt purge formiko && sudo apt autoremove

Potrebbe non essere il migliore dei programmi per la sua funzione, ma devo dire che Formiko ha funzionato senza problemi mentre l'ho testato. Non voglio concludere senza prima parlare di quello che è forse il più grande punto nero di questo programma, il limitazione del formato con cui ci permette di lavorare

Maggiori informazioni su questo programma possono essere ottenute sulla pagina di Progetto GitHub.


Lascia un tuo commento

L'indirizzo email non verrà pubblicato. I campi obbligatori sono contrassegnati con *

*

*

  1. Responsabile dei dati: Miguel Ángel Gatón
  2. Scopo dei dati: controllo SPAM, gestione commenti.
  3. Legittimazione: il tuo consenso
  4. Comunicazione dei dati: I dati non saranno oggetto di comunicazione a terzi se non per obbligo di legge.
  5. Archiviazione dati: database ospitato da Occentus Networks (UE)
  6. Diritti: in qualsiasi momento puoi limitare, recuperare ed eliminare le tue informazioni.