Formiko, ένας δομημένος επεξεργαστής κειμένου για την τεκμηρίωση της Python

Σχετικά με το φορμικό

Στο επόμενο άρθρο θα ρίξουμε μια ματιά στο Formiko. Πρόκειται για ένα μικρό πρόγραμμα επεξεργασίας που δημιουργήθηκε με τον Python που βρήκα τυχαία στο GitHub. Το Formiko είναι μια αίτηση restructuredText με πρόγραμμα επεξεργασίας και προεπισκόπηση MarkDown για να ελέγξετε την πρόοδο της εργασίας που έχει γίνει.

Το ReStructuredText είναι μέρος του έργου Docutils και χρησιμοποιείται από τους προγραμματιστές της Python για τη δημιουργία τεχνικής τεκμηρίωσης. Είμαι βέβαιος ότι θα υπάρχουν πολλοί άνθρωποι που δεν έχουν ακούσει ποτέ για το reStructuredText, αλλά μέσω αυτού του προγράμματος και ορισμένων βασικών εννοιών θα δείτε ότι είναι εύκολο να χρησιμοποιήσετε αυτό το συντακτικό σύστημα. Το πρόγραμμα είναι γραμμένο σε Python με Gtk3, GtkSourceView και Webkit2. Χρησιμοποιήστε το Docutils και το Επαναπροσδιορίστε το Common Mark Parser.

Πρέπει να ειπωθεί ότι Χαμήλωση τιμής και το reStructuredText έχουν παρόμοιες δυνατότητες. Ως διαφορά, πρέπει να σημειωθεί ότι το reStructuredText έχει σχεδιαστεί για τη δημιουργία τεκμηρίωσης, υποστηρίζει πίνακες και υποσημειώσεις και υποσημειώσεις.

Το ReStructuredText είναι ένα ευανάγνωστο σύστημα ανάλυσης και σύνταξης. Είναι χρήσιμο για διαδικτυακή τεκμηρίωση προγράμματος, συμβολοσειρές εγγράφων Python, για γρήγορη δημιουργία απλών ιστοσελίδων και για αυτόνομα έγγραφα. Ο αναλυτής reStructuredText είναι ένα στοιχείο του Docutils και είναι μια αναθεώρηση και επανερμηνεία των συστημάτων σήμανσης StructuredText και Setext.

Γενικά χαρακτηριστικά του Formiko

φορμικο γτκ

Φορμικό

Σύμφωνα με τη σελίδα GitHub του έργου, το Formiko περιλαμβάνει τα ακόλουθα χαρακτηριστικά:

  • Έθεσα ένα πρόγραμμα επεξεργασίας με βάση το GtkSourceView με επισήμανση σύνταξης και πρόγραμμα επεξεργασίας Vim.
  • Πάμε διαιρέστε την περιοχή εργασίας κάθετα ή οριζόντια.
  • Προσφορές α λειτουργία προεπισκόπησης για να δείτε πώς είναι η δουλειά.
  • JSON και προεπισκόπηση του HTML.
  • Ορθογραφικός έλεγχος.

Είναι επίσης συμβατό με:

Εγκατάσταση του Formiko στο Ubuntu

Για αυτό το άρθρο θα το κάνω εγκαταστήστε το Formiko στο Ubuntu 18.04. Θα βρούμε αυτό το πρόγραμμα διαθέσιμο για Debian και BSD όπως μπορούμε να δούμε σε αυτό Σελίδα GitHub.

Έργο Formiko Vim

Formiko vim

απαιτήσεις

Πριν προχωρήσουμε στην εγκατάσταση, πρέπει να πούμε ότι σύμφωνα με τη σελίδα του GitHub, θα πρέπει διορθώστε μερικά απαιτήσεις το οποίο ζητά από το πρόγραμμα να λειτουργεί σωστά όταν το εγκαθιστούμε με το pip3.

  • python 2.7 ή 3
  • GTK+3
  • στόχος-ενδοσκόπηση
  • PyGObject
  • κιτ ιστού
  • GtkSourceView

Ανοίγουμε ένα τερματικό (Ctrl + Alt + T) και γράφουμε:

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

Θέλω να ξεκαθαρίσω ξανά ότι κάνω αυτήν την εγκατάσταση στο Ubuntu 18.04. Μόλις πληρούνται οι απαιτήσεις, θα το δούμε η εγκατάσταση του προγράμματος θα γίνει μέσω pip ή apt όπως μας ενδιαφέρει. Για χρησιμοποιήστε το pip3 στην εγκατάσταση θα γράψουμε στο τερματικό (Ctrl + Alt + T):

pip3 install formiko

Σε περίπτωση που προτιμάτε χρησιμοποιήστε apt, στο ίδιο τερματικό γράφουμε:

κατάλληλη εγκατάσταση formiko

sudo apt update && sudo apt install formiko

Πρέπει να ειπωθεί ότι και οι δύο εγκαταστάσεις θα μας προσφέρουν την ίδια έκδοση του προγράμματος. Προαιρετικά μπορούμε επίσης να εγκαταστήσουμε:

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

Όταν το εγκαταστήσουμε, δύο καταχωρήσεις θα προστεθούν στο μενού της εφαρμογής: Φορμικό y Formiko vim.

Εκκινητής Formiko και Formiko Vim

Θα πρέπει να βρούμε αυτό που ταιριάζει καλύτερα στις ανάγκες μας.

Απεγκαταστήστε το Formiko

Όπως έχουμε δει δύο επιλογές εγκατάστασης, θα δούμε επίσης δύο εντολές για την κατάργηση του προγράμματος από το λειτουργικό μας σύστημα.

Η πρώτη από τις εντολές θα είναι αυτή που αναφέρεται στο η εγκατάσταση έγινε με pip3. Για να εξαλείψουμε το πρόγραμμα θα ανοίξουμε ένα τερματικό (Ctrl + Alt + T) και θα γράψουμε σε αυτό:

sudo pip3 uninstall formiko

Τώρα θα δούμε την εντολή για όσους επέλεξαν το εγκατάσταση με apt. Σε ένα τερματικό (Ctrl + Alt + T) γράφουμε:

sudo apt purge formiko && sudo apt autoremove

Μπορεί να μην είναι το καλύτερο από τα προγράμματα για τη λειτουργία του, αλλά πρέπει να πω ότι το Formiko δούλεψε χωρίς προβλήματα ενώ το έχω δοκιμάσει. Δεν θέλω να τελειώσω χωρίς να μιλήσω πρώτα για το ποιο είναι ίσως το μεγαλύτερο μαύρο σημείο αυτού του προγράμματος, το περιορισμός μορφής με το οποίο μας επιτρέπει να εργαστούμε

Περισσότερες πληροφορίες σχετικά με αυτό το πρόγραμμα μπορείτε να βρείτε στη σελίδα του Έργο GitHub.


Αφήστε το σχόλιό σας

Η διεύθυνση email σας δεν θα δημοσιευθεί. Τα υποχρεωτικά πεδία σημειώνονται με *

*

*

  1. Υπεύθυνος για τα δεδομένα: Miguel Ángel Gatón
  2. Σκοπός των δεδομένων: Έλεγχος SPAM, διαχείριση σχολίων.
  3. Νομιμοποίηση: Η συγκατάθεσή σας
  4. Κοινοποίηση των δεδομένων: Τα δεδομένα δεν θα κοινοποιούνται σε τρίτους, εκτός από νομική υποχρέωση.
  5. Αποθήκευση δεδομένων: Βάση δεδομένων που φιλοξενείται από τα δίκτυα Occentus (ΕΕ)
  6. Δικαιώματα: Ανά πάσα στιγμή μπορείτε να περιορίσετε, να ανακτήσετε και να διαγράψετε τις πληροφορίες σας.