Formiko, urejevalnik strukturiranega besedila za dokumentacijo Python

O formiko

V naslednjem članku si bomo ogledali Formiko. To je majhen urejevalnik, zgrajen s Pythonom, ki sem ga po naključju našel na GitHubu. Formiko je prijava preoblikovanoText z urejevalnikom MarkDown in predogledom za preverjanje napredka opravljenega dela.

ReStructuredText je del projekta Docutils in ga programerji Python uporabljajo za ustvarjanje tehnične dokumentacije. Prepričan sem, da bo veliko ljudi, ki še nikoli niso slišali za reStructuredText, toda s tem programom in nekaterimi osnovnimi koncepti boste videli, da je ta sistem sintakse enostaven za uporabo. Program je napisan v Pythonu z Gtk3, GtkSourceView in Webkit2. Uporabite Docutils in ponovno uporabite skupni razčlenjevalnik skupnih oznak.

Treba je reči, da Markdown in reStructuredText imata podobne zmogljivosti. Za razliko je treba opozoriti, da je reStructuredText zasnovan za ustvarjanje dokumentacije, podpira tabele ter sprotne in končne opombe.

ReStructuredText je razumljiv sistem za razčlenjevanje in sintakso. Uporaben je za spletno programsko dokumentacijo, nize dokumentov Python, za hitro ustvarjanje preprostih spletnih strani in za samostojne dokumente. Razčlenjevalnik reStructuredText je sestavni del Docutilov in je revizija in ponovna interpretacija lahkih označevalnih sistemov StructuredText in Setext.

Splošne značilnosti Formika

foriko gtk

Formiko

V skladu s projektno stranjo GitHub Formiko vključuje naslednje funkcije:

  • Postavil sem urednika, ki temelji na GtkSourceView, z poudarjanje sintakse in urejevalnik Vim.
  • Mi gremo razdelite delovno območje navpično ali vodoravno.
  • Ponudbe a način predogleda da vidim, kako je delo.
  • JSON in predogled HTML.
  • Preverjanje črkovanja.

Združljiv je tudi z:

Namestitev Formika na Ubuntu

Za ta članek bom namestite Formiko na Ubuntu 18.04. Ta program bomo našli na voljo za Debian in BSD, kot lahko vidimo v njegovem Stran GitHub.

Projekt Formiko Vim

Formiko vim

Zahteve

Preden nadaljujemo z namestitvijo, je treba povedati, da bomo morali na njihovi strani GitHub to storiti popraviti nekaj zahteve ki zahteva, da program pravilno deluje, ko ga namestimo s pip3.

  • python 2.7 ali 3
  • GTK+3
  • gobject-introspekcija
  • PyGObject
  • Spletni komplet
  • GtkSourceView

Odpremo terminal (Ctrl + Alt + T) in zapišemo:

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

Še enkrat bi rad pojasnil, da to namestitev izvajam v Ubuntu 18.04. Ko bodo zahteve izpolnjene, bomo to videli namestitev programa bo izvedena s pomočjo pip ali apt kot nas zanima. Za uporabite pip3 v namestitvi bomo v terminal zapisali (Ctrl + Alt + T):

pip3 install formiko

V primeru, da vam je ljubše uporabite apt, v isti terminal pišemo:

namestitev

sudo apt update && sudo apt install formiko

Treba je povedati, da nam bosta obe namestitvi zagotovili isto različico programa. Po želji lahko namestimo tudi:

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

Ko ga namestimo, se v meni aplikacije dodata dva vnosa: Formiko y Formiko vim.

Izstrelitev Formiko in Formiko Vim

Poiskati bomo morali tistega, ki najbolj ustreza našim potrebam.

Odstranite Formiko

Ker smo videli dve možnosti namestitve, bomo videli tudi dva ukaza za odstranitev programa iz našega operacijskega sistema.

Prvi od ukazov bo tisti, ki se nanaša na namestitev izvedena s pip3. Za odpravo programa bomo odprli terminal (Ctrl + Alt + T) in vanj zapisali:

sudo pip3 uninstall formiko

Zdaj bomo videli ukaz za tiste, ki so izbrali namestitev z apt. V terminalu (Ctrl + Alt + T) zapišemo:

sudo apt purge formiko && sudo apt autoremove

Morda ni najboljši od programov za njegovo delovanje, vendar moram reči, da je Formiko med testiranjem delal brez težav. Ne želim končati, ne da bi se najprej pogovorili o tem, kaj je morda največja črna točka tega programa, omejitev formata s katero nam omogoča delo

Več informacij o tem programu je na voljo na strani Projekt GitHub.


Pustite svoj komentar

Vaš e-naslov ne bo objavljen. Obvezna polja so označena z *

*

*

  1. Za podatke odgovoren: Miguel Ángel Gatón
  2. Namen podatkov: Nadzor neželene pošte, upravljanje komentarjev.
  3. Legitimacija: Vaše soglasje
  4. Sporočanje podatkov: Podatki se ne bodo posredovali tretjim osebam, razen po zakonski obveznosti.
  5. Shranjevanje podatkov: Zbirka podatkov, ki jo gosti Occentus Networks (EU)
  6. Pravice: Kadar koli lahko omejite, obnovite in izbrišete svoje podatke.