Formiko, penyunting teks berstruktur untuk dokumentasi Python

Mengenai formiko

Dalam artikel seterusnya kita akan melihat Formiko. Ini adalah editor kecil yang dibina dengan Python yang saya temui secara kebetulan di GitHub. Formiko adalah sebuah aplikasi reStructuredText dengan editor dan pratonton MarkDown untuk memeriksa kemajuan kerja yang dilakukan.

ReStructuredText ialah sebahagian daripada projek Docutils dan digunakan oleh pengaturcara Python untuk membuat dokumentasi teknikal. Saya pasti akan ada banyak orang yang tidak pernah mendengar tentang ReStructuredText, tetapi melalui program ini dan beberapa konsep asas anda akan melihat bahawa mudah menggunakan sistem sintaks ini. Program ini ditulis dalam Python dengan Gtk3, GtkSourceView, dan Webkit2. Gunakan Docutils dan mengesyorkan semula Common Mark Parser.

Ia mesti dikatakan bahawa Penurunan harga dan reStructuredText mempunyai keupayaan yang serupa. Sebagai perbezaan, perlu diperhatikan bahawa reStructuredText dirancang untuk membuat dokumentasi, menyokong jadual dan nota kaki dan nota akhir.

ReStructuredText adalah sistem parser dan sintaks yang mudah dibaca. Ia berguna untuk dokumentasi program dalam talian, rentetan dokumen Python, untuk membuat halaman web mudah dengan cepat, dan untuk dokumen yang berdiri sendiri. Pengurai reStructuredText adalah komponen Docutils dan merupakan revisi dan pentafsiran semula sistem markup ringan StructuredText dan Setext.

Ciri umum Formiko

foriko gtk

Formiko

Menurut laman GitHub projek, Formiko merangkumi ciri-ciri berikut:

  • Saya mengemukakan editor berdasarkan GtkSourceView dengan sorotan sintaks dan penyunting Vim.
  • Kita pergi bahagikan kawasan kerja secara menegak atau mendatar.
  • Tawaran a mod pratonton untuk melihat bagaimana kerjanya.
  • JSON dan pratonton dari HTML.
  • Semak ejaan.

Ia juga serasi dengan:

Memasang Formiko di Ubuntu

Untuk artikel ini saya akan pasang Formiko di Ubuntu 18.04. Kami akan mendapati program ini tersedia untuk Debian dan BSD seperti yang dapat kita lihat di dalamnya Halaman GitHub.

Projek Formiko Vim

Formiko vim

Requisitos

Sebelum meneruskan pemasangan, mesti dinyatakan bahawa mengikut halaman GitHub mereka, kita akan mempunyai betulkan beberapa keperluan yang meminta program berfungsi dengan betul semasa kita memasangnya dengan pip3.

  • ular sawa 2.7 atau 3
  • GTK+3
  • introspeksi matlamat
  • Objektif PyGO
  • Kit web
  • GtkSourceView

Kami membuka terminal (Ctrl + Alt + T) dan menulis:

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

Saya ingin menjelaskan lagi bahawa saya melakukan pemasangan ini di Ubuntu 18.04. Setelah syarat dipenuhi, kita akan melihatnya pemasangan program akan dilakukan melalui pip atau apt seperti yang kita berminat. Untuk gunakan pip3 dalam pemasangan kita akan menulis di terminal (Ctrl + Alt + T):

pip3 install formiko

Sekiranya anda lebih suka gunakan apt, di terminal yang sama kita menulis:

pemasangan formiko

sudo apt update && sudo apt install formiko

Harus dikatakan bahawa kedua-dua pemasangan akan memberi kita versi program yang sama. Secara pilihan kami juga boleh memasang:

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

Apabila kami memasangnya, dua entri akan ditambahkan ke menu aplikasi: Formiko y Formiko vim.

Pelancar Formiko dan Formiko Vim

Kita mesti mencari yang paling sesuai dengan keperluan kita.

Nyahpasang Formiko

Seperti yang telah kita lihat dua pilihan pemasangan, kita juga akan melihat dua arahan untuk membuang program dari sistem operasi kita.

Perintah pertama akan menjadi arahan yang merujuk kepada pemasangan dilakukan dengan pip3. Untuk menghilangkan program ini, kita akan membuka terminal (Ctrl + Alt + T) dan menulis di dalamnya:

sudo pip3 uninstall formiko

Sekarang kita akan melihat perintah bagi mereka yang memilih pemasangan dengan apt. Di terminal (Ctrl + Alt + T) kita menulis:

sudo apt purge formiko && sudo apt autoremove

Ini mungkin bukan program terbaik untuk fungsinya, tetapi saya harus mengatakan bahawa Formiko bekerja tanpa masalah semasa saya mengujinya. Saya tidak mahu berakhir tanpa membincangkan terlebih dahulu apa yang mungkin merupakan titik hitam terbesar program ini, iaitu had format yang membolehkan kita bekerja

Maklumat lebih lanjut mengenai program ini boleh didapati di halaman Projek GitHub.


Tinggalkan komen anda

Alamat email anda tidak akan disiarkan. Ruangan yang diperlukan ditanda dengan *

*

*

  1. Bertanggungjawab atas data: Miguel Ángel Gatón
  2. Tujuan data: Mengendalikan SPAM, pengurusan komen.
  3. Perundangan: Persetujuan anda
  4. Komunikasi data: Data tidak akan disampaikan kepada pihak ketiga kecuali dengan kewajiban hukum.
  5. Penyimpanan data: Pangkalan data yang dihoskan oleh Occentus Networks (EU)
  6. Hak: Pada bila-bila masa anda boleh menghadkan, memulihkan dan menghapus maklumat anda.