Formiko, en strukturert tekstredigerer for Python-dokumentasjon

Om formiko

I neste artikkel skal vi ta en titt på Formiko. Det er en liten redaktør bygget med Python som jeg ved en tilfeldighet fant på GitHub. Formiko er en søknad reStructuredText med en MarkDown-editor og forhåndsvisning for å kontrollere fremdriften i det utførte arbeidet.

ReStructuredText er en del av Docutils-prosjektet og brukes av Python-programmerere for å lage teknisk dokumentasjon. Jeg er sikker på at det vil være mange mennesker som aldri har hørt om reStructuredText, men gjennom dette programmet og noen grunnleggende konsepter vil du se at det er enkelt å bruke dette syntakssystemet. Programmet er skrevet i Python med Gtk3, GtkSourceView og Webkit2. Bruk Docutils og vanlig merke Parser.

Det må sies det Markdown og reStructuredText har lignende funksjoner. Som en forskjell skal det bemerkes at reStructuredText er designet for å lage dokumentasjon, støtter tabeller og fotnoter og sluttnoter.

ReStructuredText er et lettlest parser- og syntakssystem. Det er nyttig for online programdokumentasjon, Python-dokumentstrenger, for raskt å lage enkle websider og for frittstående dokumenter. ReStructuredText-parseren er en komponent i Docutils og er en revisjon og nytolkning av strukturerte tekst- og tekst-tekstmarkeringssystemer.

Generelle egenskaper ved Formiko

foriko gtk

Formiko

I følge prosjektets GitHub-side inkluderer Formiko følgende funksjoner:

  • Jeg stilte en redaktør basert på GtkSourceView med syntaksmarkering og en Vim-editor.
  • Vi går del arbeidsområdet vertikalt eller horisontalt.
  • Tilbyr en forhåndsvisningsmodus for å se hvordan arbeidet er.
  • JSON og forhåndsvisning av HTML.
  • Stavekontroll.

Den er også kompatibel med:

Installere Formiko på Ubuntu

For denne artikkelen vil jeg installer Formiko på Ubuntu 18.04. Vi finner dette programmet tilgjengelig for Debian og BSD, som vi kan se i programmet GitHub-side.

Formiko Vim-prosjekt

Formiko vim

Krav

Før du fortsetter med installasjonen, må det sies at vi ifølge GitHub-siden må fikse noen krav som ber programmet fungere riktig når vi installerer det med pip3.

  • python 2.7 eller 3
  • GTK+3
  • gobject-introspeksjon
  • PyGObject
  • nettsett
  • GtkSourceView

Vi åpner en terminal (Ctrl + Alt + T) og 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

Jeg vil avklare igjen at jeg gjør denne installasjonen på Ubuntu 18.04. Når kravene er oppfylt, vil vi se det installasjonen av programmet vil skje via pip eller apt som vi er interessert. Til bruk pip3 i installasjonen vil vi skrive i terminalen (Ctrl + Alt + T):

pip3 install formiko

I tilfelle du foretrekker det bruk apt, i samme terminal skriver vi:

apt formiko installasjon

sudo apt update && sudo apt install formiko

Det må sies at begge installasjonene vil gi oss den samme versjonen av programmet. Eventuelt kan vi også installere:

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

Når vi installerer det, vil to oppføringer legges til applikasjonsmenyen: Formiko y Formiko vim.

Formiko launcher og Formiko Vim

Vi må finne den som passer best til våre behov.

Avinstaller Formiko

Som vi har sett to installasjonsalternativer, vil vi også se to kommandoer for å fjerne programmet fra operativsystemet vårt.

Den første av kommandoene vil være den som refererer til installasjon gjort med pip3. For å eliminere programmet skal vi åpne en terminal (Ctrl + Alt + T) og skrive i den:

sudo pip3 uninstall formiko

Nå vil vi se kommandoen for de som valgte installasjon med apt. I en terminal (Ctrl + Alt + T) skriver vi:

sudo apt purge formiko && sudo apt autoremove

Det er kanskje ikke det beste av programmene for funksjonen, men jeg må si at Formiko jobbet uten problemer mens jeg har testet det. Jeg vil ikke avslutte uten først å snakke om det som kanskje er det største svarte punktet i dette programmet, The formatbegrensning som gjør at vi kan jobbe

Du kan få mer informasjon om dette programmet på siden av Prosjekt GitHub.


Legg igjen kommentaren

Din e-postadresse vil ikke bli publisert. Obligatoriske felt er merket med *

*

*

  1. Ansvarlig for dataene: Miguel Ángel Gatón
  2. Formålet med dataene: Kontroller SPAM, kommentaradministrasjon.
  3. Legitimering: Ditt samtykke
  4. Kommunikasjon av dataene: Dataene vil ikke bli kommunisert til tredjeparter bortsett fra ved juridisk forpliktelse.
  5. Datalagring: Database vert for Occentus Networks (EU)
  6. Rettigheter: Når som helst kan du begrense, gjenopprette og slette informasjonen din.