Formiko, strukturovaný textový editor pro dokumentaci v Pythonu

O společnosti Formiko

V příštím článku se podíváme na Formiko. Toto je malý editor vytvořený pomocí Pythonu, na který jsem náhodou narazil na GitHubu. Formiko je aplikace reStructuredText s editorem MarkDown a náhledem zkontrolovat postup provedené práce.

ReStructuredText je část projektu Docutils a používají ho programátoři Pythonu k vytváření technické dokumentace. Jsem si jistý, že bude mnoho lidí, kteří o reStructuredText nikdy neslyšeli, ale prostřednictvím tohoto programu a několika základních konceptů uvidíte, že je snadné tento syntaxový systém používat. Program je napsán v Pythonu s Gtk3, GtkSourceView a Webkit2. Použijte Docutils a znovu označte analyzátor běžných značek.

Je třeba říci, že Snížení ceny a reStructuredText mají podobné schopnosti. Jako rozdíl je třeba poznamenat, že reStructuredText je navržen tak, aby vytvářel dokumentaci, podporuje tabulky a poznámky pod čarou a vysvětlivky.

ReStructuredText je snadno čitelný syntaktický analyzátor a syntaktický systém. Je to užitečné pro online dokumentaci programu, řetězce dokumentů Pythonu, pro rychlé vytváření jednoduchých webových stránek a pro samostatné dokumenty. Analyzátor reStructuredText je součástí Docutils a je revizí a reinterpretací lehkých značkovacích systémů StructuredText a Setext.

Obecná charakteristika přípravku Formiko

foriko gtk

Formiko

Podle stránky GitHub projektu zahrnuje Formiko následující funkce:

  • Postavil jsem editora založeného na GtkSourceView s zvýraznění syntaxe a editor Vim.
  • Jdeme rozdělit pracovní oblast svisle nebo vodorovně.
  • Nabídky a režim náhledu vidět, jak to funguje.
  • JSON a náhled HTML.
  • Kontrola pravopisu.

Je také kompatibilní s:

Instalace Formiko na Ubuntu

U tohoto článku budu nainstalujte Formiko na Ubuntu 18.04. Najdeme tento program dostupný pro Debian a BSD, jak vidíme v jeho Stránka GitHub.

Projekt Formiko Vim

Formiko vim

Požadavky

Před pokračováním v instalaci je třeba říci, že podle jejich stránky GitHub budeme muset opravit některé Požadavky který požádá program, aby správně fungoval, když jej nainstalujeme s pip3.

  • python 2.7 nebo 3
  • GTK+3
  • introspekce gobjektů
  • PyGOObject
  • webový kit
  • GtkSourceView

Otevřeme 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

Chci znovu objasnit, že tuto instalaci provádím na Ubuntu 18.04. Jakmile budou požadavky splněny, uvidíme to instalace programu bude provedena pomocí pip nebo apt jak nás zajímá. Pro použijte pip3 v instalaci napíšeme do terminálu (Ctrl + Alt + T):

pip3 install formiko

V případě, že chcete použijte apt, ve stejném terminálu píšeme:

apt formiko instalace

sudo apt update && sudo apt install formiko

Je třeba říci, že obě instalace nám poskytnou stejnou verzi programu. Volitelně můžeme také nainstalovat:

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

Když jej nainstalujeme, do nabídky aplikace budou přidány dvě položky: Formiko y Formiko vim.

Spouštěč Formiko a Formiko Vim

Budeme muset najít ten, který nejlépe vyhovuje našim potřebám.

Odinstalujte Formiko

Jak jsme viděli dvě možnosti instalace, uvidíme také dva příkazy k odebrání programu z našeho operačního systému.

První z příkazů bude příkaz odkazující na instalace provedena pomocí pip3. Abychom program vyloučili, otevřeme terminál (Ctrl + Alt + T) a zapíšeme do něj:

sudo pip3 uninstall formiko

Nyní uvidíme příkaz pro ty, kteří si vybrali instalace s apt. V terminálu (Ctrl + Alt + T) napíšeme:

sudo apt purge formiko && sudo apt autoremove

Možná to není nejlepší z programů pro jeho funkci, ale musím říct, že Formiko fungoval bez problémů, zatímco jsem to testoval. Nechci skončit, aniž bych nejprve promluvil o tom, co je možná největším černým bodem tohoto programu, tím omezení formátu se kterým nám umožňuje pracovat

Více informací o tomto programu najdete na stránce Projekt GitHub.


Zanechte svůj komentář

Vaše e-mailová adresa nebude zveřejněna. Povinné položky jsou označeny *

*

*

  1. Odpovědný za údaje: Miguel Ángel Gatón
  2. Účel údajů: Ovládací SPAM, správa komentářů.
  3. Legitimace: Váš souhlas
  4. Sdělování údajů: Údaje nebudou sděleny třetím osobám, s výjimkou zákonných povinností.
  5. Úložiště dat: Databáze hostovaná společností Occentus Networks (EU)
  6. Práva: Vaše údaje můžete kdykoli omezit, obnovit a odstranit.