Formiko, en strukturerad textredigerare för Python-dokumentation

Om formiko

I nästa artikel ska vi ta en titt på Formiko. Detta är en liten redaktör byggd med Python som jag hittade av en slump på GitHub. Formiko är en ansökan ReStructuredText med en MarkDown-redigerare och förhandsgranskning för att kontrollera utvecklingen av det utförda arbetet.

ReStructuredText är del av Docutils-projektet och används av Python-programmerare för att skapa teknisk dokumentation. Jag är säker på att det kommer finnas många människor som aldrig har hört talas om reStructuredText, men genom detta program och några grundläggande begrepp kommer du att se att det är enkelt att använda detta syntaxsystem. Programmet är skrivet i Python med Gtk3, GtkSourceView och Webkit2. Använd Docutils och vanligt förekommande Mark Parser.

Det måste sägas att Markdown och reStructuredText har liknande funktioner. Som en skillnad bör det noteras att reStructuredText är utformad för att skapa dokumentation, stöder tabeller och fotnoter och slutnoter.

ReStructuredText är ett lättläst parser- och syntaxsystem. Det är användbart för online-programdokumentation, Python-dokumentsträngar, för att snabbt skapa enkla webbsidor och för fristående dokument. ReStructuredText-analysatorn är en komponent i Docutils och är en revision och nytolkning av StructuredText och Setext-lätta markeringssystem.

Allmänna egenskaper hos Formiko

foriko gtk

Formiko

Enligt projektets GitHub-sida innehåller Formiko följande funktioner:

  • Jag poserade en redaktör baserad på GtkSourceView med syntaxmarkering och en Vim-redigerare.
  • Vi går dela upp arbetsområdet vertikalt eller horisontellt.
  • Erbjuder en förhandsgranskningsläge för att se hur arbetet är.
  • JSON och förhandsgranskning av html.
  • Stavnings kontroll.

Den är också kompatibel med:

Installera Formiko på Ubuntu

För den här artikeln kommer jag installera Formiko på Ubuntu 18.04. Vi hittar det här programmet tillgängligt för Debian och BSD som vi kan se i dess GitHub-sida.

Formiko Vim-projekt

Formiko vim

Krav

Innan du fortsätter med installationen måste det sägas att enligt deras GitHub-sida måste vi fixa några krav som ber programmet att fungera korrekt när vi installerar det med pip3.

  • python 2.7 eller 3
  • GTK+3
  • gobject-introspektion
  • PyGObject
  • Webbkit
  • gtksourceview

Vi öppnar en terminal (Ctrl + Alt + T) och skriver:

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

Jag vill klargöra igen att jag gör den här installationen på Ubuntu 18.04. När kraven är uppfyllda kommer vi att se det installationen av programmet kommer att göras via pip eller apt eftersom vi är intresserade. För använd pip3 i installationen skriver vi i terminalen (Ctrl + Alt + T):

pip3 install formiko

Om du föredrar det använd apt, i samma terminal skriver vi:

apt formiko installation

sudo apt update && sudo apt install formiko

Det måste sägas att båda installationerna kommer att ge oss samma version av programmet. Alternativt kan vi också installera:

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

När vi installerar det kommer två poster att läggas till i applikationsmenyn: Formiko y Formiko vim.

Formiko launcher och Formiko Vim

Vi måste hitta den som bäst passar våra behov.

Avinstallera Formiko

Eftersom vi har sett två installationsalternativ kommer vi också att se två kommandon för att ta bort programmet från vårt operativsystem.

Den första av kommandona är den som hänvisar till installationen gjort med pip3. För att eliminera programmet ska vi öppna en terminal (Ctrl + Alt + T) och skriva i den:

sudo pip3 uninstall formiko

Nu kommer vi att se kommandot för dem som valde installation med apt. I en terminal (Ctrl + Alt + T) skriver vi:

sudo apt purge formiko && sudo apt autoremove

Det kanske inte är det bästa av programmen för dess funktion, men jag måste säga att Formiko arbetade utan problem medan jag testade det. Jag vill inte avsluta utan att först prata om vad som kanske är den största svarta punkten i detta program formatbegränsning som gör att vi kan arbeta

Mer information om detta program kan erhållas på sidan av Projekt GitHub.


Lämna din kommentar

Din e-postadress kommer inte att publiceras. Obligatoriska fält är markerade med *

*

*

  1. Ansvarig för uppgifterna: Miguel Ángel Gatón
  2. Syftet med uppgifterna: Kontrollera skräppost, kommentarhantering.
  3. Legitimering: Ditt samtycke
  4. Kommunikation av uppgifterna: Uppgifterna kommer inte att kommuniceras till tredje part förutom enligt laglig skyldighet.
  5. Datalagring: databas värd för Occentus Networks (EU)
  6. Rättigheter: När som helst kan du begränsa, återställa och radera din information.