Formiko, štruktúrovaný textový editor pre dokumentáciu v jazyku Python

O formiko

V nasledujúcom článku sa pozrieme na Formiko. Toto je malý editor zostavený z Pythonu, ktorý som našiel náhodou na GitHub. Formiko je žiadosť reStructuredText s editorom MarkDown a ukážkou skontrolovať priebeh vykonanej práce.

ReStructuredText je súčasť projektu Docutils a používajú ho programátori Pythonu na tvorbu technickej dokumentácie. Som si istý, že bude veľa ľudí, ktorí o reStructuredText nikdy nepočuli, ale vďaka tomuto programu a niektorým základným koncepciám uvidíte, že je ľahké tento syntaxový systém používať. Program je napísaný v jazyku Python s programami Gtk3, GtkSourceView a Webkit2. Použite Docutils a znovu označte analyzátor bežných značiek.

Je potrebné povedať, že Markdown a reStructuredText majú podobné možnosti. Ako rozdiel je potrebné poznamenať, že program reStructuredText je navrhnutý tak, aby vytvoril dokumentáciu, podporuje tabuľky a poznámky pod čiarou a vysvetlivky.

ReStructuredText je ľahko čitateľný syntaktický analyzátor a syntaktický systém. Je to užitočné pre dokumentáciu online programov, reťazce dokumentov Pythonu, pre rýchle vytváranie jednoduchých webových stránok a pre samostatné dokumenty. Analyzátor reStructuredText je súčasťou Docutils a je revíziou a reinterpretáciou ľahkých značkovacích systémov StructuredText a Setext.

Všeobecná charakteristika lieku Formiko

foriko gtk

Formiko

Podľa stránky GitHub projektu Formiko obsahuje nasledujúce funkcie:

  • Postavil som editora založeného na GtkSourceView s zvýraznenie syntaxe a editor Vim.
  • Ideme rozdeliť pracovnú oblasť vertikálne alebo horizontálne.
  • Ponuky a režim ukážky aby sme videli, ako na tom je práca.
  • JSON a ukážka HTML.
  • Kontrola pravopisu.

Je tiež kompatibilný s:

Inštalácia Formiko na Ubuntu

Pre tento článok budem nainštalujte Formiko na Ubuntu 18.04. Nájdeme tento program dostupný pre Debian a BSD, ako vidíme na jeho Stránka GitHub.

Projekt Formiko Vim

Formiko vim

Požiadavky

Pred pokračovaním v inštalácii je potrebné povedať, že podľa ich stránky GitHub budeme musieť opraviť niektoré požiadavky ktorý požiada program, aby správne fungoval, keď ho nainštalujeme pomocou pip3.

  • python 2.7 alebo 3
  • GTK+3
  • gobjekt-introspekcia
  • PyGOObject
  • webový kit
  • GtkSourceView

Otvoríme terminál (Ctrl + Alt + T) a napíšeme:

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

Chcem znova objasniť, že túto inštaláciu robím na Ubuntu 18.04. Keď budú požiadavky splnené, uvidíme to inštalácia programu sa uskutoční pomocou pipu alebo apt ako nás to zaujíma. Pre použite pip3 v inštalácii napíšeme do terminálu (Ctrl + Alt + T):

pip3 install formiko

V prípade, že chcete pouzit apt, do toho istého terminálu napíšeme:

apt formiko inštalácia

sudo apt update && sudo apt install formiko

Je potrebné povedať, že obe inštalácie nám poskytnú rovnakú verziu programu. Voliteľne môžeme tiež nainštalovať:

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

Keď ho nainštalujeme, do ponuky aplikácie sa pridajú dva záznamy: Formiko y Formiko vim.

Launcher Formiko a Formiko Vim

Budeme musieť nájsť ten, ktorý najlepšie vyhovuje našim potrebám.

Odinštalujte Formiko

Pretože sme videli dve možnosti inštalácie, uvidíme aj dva príkazy na odstránenie programu z nášho operačného systému.

Prvý z príkazov bude príkaz odkazujúci na inštalácia vykonaná pomocou pip3. Aby sme program vylúčili, otvoríme terminál (Ctrl + Alt + T) a napíšeme doň:

sudo pip3 uninstall formiko

Teraz uvidíme príkaz pre tých, ktorí si vybrali inštalácia s apt. V termináli (Ctrl + Alt + T) napíšeme:

sudo apt purge formiko && sudo apt autoremove

Pre svoju funkciu to nemusí byť najlepší z programov, ale musím povedať, že Formiko fungoval bez problémov, kým som ho otestoval. Nechcem skončiť bez toho, aby som najskôr hovoril o tom, čo je možno najväčším čiernym bodom tohto programu, tým obmedzenie formátu s ktorými nám umožňuje pracovať

Viac informácií o tomto programe je možné získať na stránke Projekt GitHub.


Zanechajte svoj komentár

Vaša e-mailová adresa nebude zverejnená. Povinné položky sú označené *

*

*

  1. Zodpovedný za údaje: Miguel Ángel Gatón
  2. Účel údajov: Kontrolný SPAM, správa komentárov.
  3. Legitimácia: Váš súhlas
  4. Oznamovanie údajov: Údaje nebudú poskytnuté tretím stranám, iba ak to vyplýva zo zákona.
  5. Ukladanie dát: Databáza hostená spoločnosťou Occentus Networks (EU)
  6. Práva: Svoje údaje môžete kedykoľvek obmedziť, obnoviť a vymazať.