Formiko, një redaktues i strukturuar i tekstit për dokumentacionin Python

Rreth formiko

Në artikullin vijues do të hedhim një vështrim në Formiko. Ky është një redaktor i vogël i ndërtuar me Python që e gjeta rastësisht në GitHub. Formiko është një aplikim ristrukturuarTeksti me një redaktor dhe vrojtim të MarkDown për të kontrolluar ecurinë e punës së bërë.

Tekst i Ristrukturuar është pjesë e projektit Docutils dhe përdoret nga programuesit Python për të krijuar dokumentacion teknik. Unë jam i sigurt se do të ketë shumë njerëz që nuk kanë dëgjuar kurrë për reStrukturuarTeksti, por përmes këtij programi dhe disa koncepteve themelore do të shihni se është e lehtë të përdoret ky sistem sintaksor. Programi është shkruar në Python me Gtk3, GtkSourceView dhe Webkit2. Përdorni Docutils dhe rekommono Mark Parser-in e Përbashkët.

Duhet thënë që Markdown dhe teksti i ristrukturuar kanë aftësi të ngjashme. Si një ndryshim, duhet të theksohet se reStructuredText është krijuar për të krijuar dokumentacion, mbështet tabela dhe shënime dhe shënime në fund të faqes.

ReStructuredText është një sistem analizues dhe sintaksor i lehtë për t’u lexuar. Shtë i dobishëm për dokumentacionin e programit në internet, vargjet e dokumenteve Python, për krijimin e shpejtë të faqeve të thjeshta në internet dhe për dokumente të pavarura. Analizuesi i reStructuredText është një përbërës i Docutils dhe është një rishikim dhe riinterpretim i sistemeve të markimit të lehtë StrukturTeksit dhe Setext.

Karakteristikat e përgjithshme të Formiko

foriko gtk

Formiko

Sipas faqes GitHub të projektit, Formiko përfshin tiparet e mëposhtme:

  • Kam paraqitur një redaktor bazuar në GtkSourceView me theksimi i sintaksës dhe një redaktor Vim.
  • Ne shkojm ndani zonën e punës vertikalisht ose horizontalisht.
  • Oferta a mënyra e pamjes paraprake për të parë se si është puna.
  • JSON dhe pamjen paraprake të HTML.
  • Kontroll i drejtshkrimit.

Isshtë gjithashtu në përputhje me:

Po instalon Formiko në Ubuntu

Për këtë artikull unë do instaloni Formiko në Ubuntu 18.04. Këtë program do ta gjejmë të disponueshëm për Debian dhe BSD siç mund ta shohim në të Faqja e GitHub.

Projekti Formiko Vim

Formiko vim

Kërkesat

Para se të vazhdoni me instalimin, duhet të thuhet se sipas faqes së tyre të GitHub, ne do të duhet rregulloni disa requisitos i cili kërkon që programi të funksionojë si duhet kur e instalojmë me pip3.

  • pitoni 2.7 ose 3
  • GTK+3
  • gobject-introspeksion
  • PyGObject
  • Vegël
  • GtkSourceView

Ne hapim një terminal (Ctrl + Alt + T) dhe shkruajmë:

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

Dua të sqaroj përsëri se po e bëj këtë instalim në Ubuntu 18.04. Sapo të plotësohen kërkesat, ne do ta shohim atë instalimi i programit do të bëhet përmes pip ose apt siç jemi të interesuar. Për përdorni pip3 në instalim do të shkruajmë në terminal (Ctrl + Alt + T):

pip3 install formiko

Në rast se preferoni përdor apt, në të njëjtin terminal shkruajmë:

instalim i përshtatshëm formiko

sudo apt update && sudo apt install formiko

Duhet thënë që të dy instalimet do të na ofrojnë të njëjtin version të programit. Opsionale ne gjithashtu mund të instalojmë:

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

Kur ta instalojmë, dy shënime do të shtohen në menunë e aplikacionit: Formiko y Formiko vim.

Formiko hedhës dhe Formiko Vim

Ne do të duhet të gjejmë atë që i përshtatet më mirë nevojave tona.

Çinstalo Formiko

Siç kemi parë dy mundësi instalimi, do të shohim edhe dy komanda për të hequr programin nga sistemi ynë operativ.

Komanda e parë do të jetë ajo që i referohet instalimi bëhet me pip3. Për të eleminuar programin, ne do të hapim një terminal (Ctrl + Alt + T) dhe do të shkruajmë në të:

sudo pip3 uninstall formiko

Tani do të shohim komandën për ata që zgjodhën instalimi me apt. Në një terminal (Ctrl + Alt + T) shkruajmë:

sudo apt purge formiko && sudo apt autoremove

Ndoshta nuk është programi më i mirë për funksionin e tij, por më duhet të them që Formiko ka punuar pa ndonjë problem ndërsa unë e kam testuar. Unë nuk dua të përfundoj pa folur më parë për atë që është ndoshta pika më e madhe e zezë e këtij programi, kufizimi i formatit me të cilën na lejon të punojmë

Më shumë informacion në lidhje me këtë program mund të merren në faqen e Projekti GitHub.


Lini komentin tuaj

Adresa juaj e emailit nuk do të publikohet. Fusha e kërkuar janë shënuar me *

*

*

  1. Përgjegjës për të dhënat: Miguel Ángel Gatón
  2. Qëllimi i të dhënave: Kontrolloni SPAM, menaxhimin e komenteve.
  3. Legjitimimi: Pëlqimi juaj
  4. Komunikimi i të dhënave: Të dhënat nuk do t'u komunikohen palëve të treta përveç me detyrim ligjor.
  5. Ruajtja e të dhënave: Baza e të dhënave e organizuar nga Occentus Networks (BE)
  6. Të drejtat: Në çdo kohë mund të kufizoni, rikuperoni dhe fshini informacionin tuaj.