Formiko, a Python dokumentációjának strukturált szövegszerkesztője

A formikóról

A következő cikkben megnézzük a Formikót. Ez egy Python-nal épített kis szerkesztő, amelyet véletlenül találtam meg a GitHubon. Formiko az egy alkalmazás reStructuredText MarkDown szerkesztővel és előnézettel hogy ellenőrizze az elvégzett munka előrehaladását.

A ReStructuredText az a Docutils projekt része és a Python programozói technikai dokumentáció készítésére használják. Biztos vagyok benne, hogy sok olyan ember lesz, aki még soha nem hallott a reStructuredText-ről, de ezen a programon és néhány alapkoncepción keresztül látni fogja, hogy könnyű ezt a szintaxis rendszert használni. A program Python-ban van megírva a Gtk3, a GtkSourceView és a Webkit2 fájlokkal. Használja a Docutils és jelölje újra a Common Mark Parser elemet.

Ezt el kell mondani Árleszállítás és a reStructuredText hasonló képességekkel rendelkeznek. Különbségként meg kell jegyezni, hogy az reStructuredText célja a dokumentáció készítése, támogatja a táblákat, a lábjegyzeteket és a végjegyzeteket.

A ReStructuredText egy könnyen olvasható elemző és szintaxis rendszer. Hasznos az online programdokumentációhoz, a Python dokumentumhúrokhoz, az egyszerű weboldalak gyors létrehozásához és az önálló dokumentumokhoz. Az reStructuredText elemző a Docutils egyik összetevője, és a StructuredText és a Setext könnyű jelölő rendszerek átdolgozása és újraértelmezése.

A Formiko általános jellemzői

foriko gtk

Formiko

A projekt GitHub oldala szerint a Formiko a következő szolgáltatásokat tartalmazza:

  • Szerkesztőt jelentettem a GtkSourceView alapján szintaxis kiemelés és egy Vim szerkesztő.
  • Megyünk ossza meg a munkaterületet függőlegesen vagy vízszintesen.
  • Ajánlatok a előnézeti mód hogy lássa, milyen a munka.
  • JSON és előnézete HTML.
  • Helyesírás-ellenőrzés.

Kompatibilis a következőkkel is:

A Formiko telepítése az Ubuntu-ra

Ehhez a cikkhez fogok telepítse a Formikót az Ubuntu 18.04-re. Megtaláljuk ezt a programot a Debian és a BSD számára elérhetővé, ahogyan azt láthatjuk GitHub oldal.

Formiko Vim projekt

Formiko vim

Követelmények

A telepítés folytatása előtt el kell mondani, hogy a GitHub oldaluk szerint nekünk kell javítson néhányat követelmények amely megkéri a program megfelelő működését, amikor a pip3-mal telepítjük.

  • python 2.7 vagy 3
  • GTK+3
  • gobject-introspekció
  • PyGObject
  • webkészlet
  • GtkSourceView

Megnyitunk egy terminált (Ctrl + Alt + T), és ezt írjuk:

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

Ismét tisztázni szeretném, hogy ezt a telepítést az Ubuntu 18.04-en hajtom végre. Amint a követelmények teljesülnek, ezt látni fogjuk a program telepítése a pip vagy az apt segítségével történik ahogy érdekel minket. Mert használja a pip3-at a telepítésben a terminálba írjuk (Ctrl + Alt + T):

pip3 install formiko

Ha jobban tetszik használd az apt-t, ugyanabban a terminálban írjuk:

találó formiko telepítés

sudo apt update && sudo apt install formiko

El kell mondani, hogy mindkét telepítés a program azonos verzióját biztosítja számunkra. Opcionálisan telepíthetjük:

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

A telepítéskor két bejegyzés kerül az alkalmazás menübe: Formiko y Formiko vim.

Formiko indító és Formiko Vim

Meg kell találnunk azt, amelyik leginkább megfelel az igényeinknek.

Távolítsa el a Formiko alkalmazást

Mivel két telepítési lehetőséget láttunk, két parancsot is látni fogunk a program eltávolítására az operációs rendszerünkről.

A parancsok közül az első lesz az, amely a telepítés a pip3-mal történt. A program kiküszöbölése érdekében megnyitunk egy terminált (Ctrl + Alt + T), és beírjuk:

sudo pip3 uninstall formiko

Most látni fogjuk a parancsot azok számára, akik a telepítés apt-tal. Egy terminálba (Ctrl + Alt + T) ezt írjuk:

sudo apt purge formiko && sudo apt autoremove

Lehet, hogy funkciója szempontjából nem a legjobb a programok közül, de azt kell mondanom, hogy a Formiko problémamentesen működött, amíg én teszteltem. Nem akarom befejezni anélkül, hogy először beszélnék arról, ami ennek a programnak talán a legnagyobb fekete pontja, a formátumkorlátozás amellyel dolgozhatunk

További információ erről a programról a. Oldalon található GitHub projekt.


A cikk tartalma betartja a szerkesztői etika. A hiba bejelentéséhez kattintson a gombra itt.

Legyen Ön az első hozzászóló

Hagyja megjegyzését

E-mail címed nem kerül nyilvánosságra. Kötelező mezők vannak jelölve *

*

*

  1. Az adatokért felelős: Miguel Ángel Gatón
  2. Az adatok célja: A SPAM ellenőrzése, a megjegyzések kezelése.
  3. Legitimáció: Az Ön beleegyezése
  4. Az adatok közlése: Az adatokat csak jogi kötelezettség alapján továbbítjuk harmadik felekkel.
  5. Adattárolás: Az Occentus Networks (EU) által üzemeltetett adatbázis
  6. Jogok: Bármikor korlátozhatja, helyreállíthatja és törölheti adatait.