Formiko, um editor de texto estruturado para documentação Python

Sobre formiko

No próximo artigo daremos uma olhada no Formiko. Este é um pequeno editor construído em Python que encontrei por acaso no GitHub. Formiko é uma aplicação Texto reestruturado com um editor MarkDown e visualização para verificar o andamento do trabalho realizado.

ReStructuredText é parte do projeto Docutils e é usado por programadores Python para criar documentação técnica. Tenho certeza de que haverá muitas pessoas que nunca ouviram falar do reStructuredText, mas através deste programa e de alguns conceitos básicos você verá que é fácil usar este sistema de sintaxe. O programa é escrito em Python com Gtk3, GtkSourceView e Webkit2. Use Docutils e recommonmark Analisador de Marca Comum.

Deve ser dito que Redução de preço e reStructuredText têm recursos semelhantes. Como diferença, deve-se notar que reStructuredText é projetado para criar documentação, ele suporta tabelas e notas de rodapé e notas de fim.

ReStructuredText é um analisador e sistema de sintaxe de fácil leitura. É útil para documentação de programa online, strings de documentos Python, para criar rapidamente páginas da web simples e para documentos autônomos. O analisador reStructuredText é um componente do Docutils e é uma revisão e reinterpretação dos sistemas de marcação leve StructuredText e Setext.

Características gerais do Formiko

foriko gtk

Formiko

De acordo com a página GitHub do projeto, o Formiko inclui os seguintes recursos:

  • Apresentei um editor baseado em GtkSourceView com destaque de sintaxe e um editor Vim.
  • Nós vamos dividir a área de trabalho verticalmente ou horizontalmente.
  • Oferece um modo de pré-visualização para ver como está o trabalho.
  • JSON e visualização de HTML.
  • Verificação ortográfica.

Também é compatível com:

Instalando Formiko no Ubuntu

Para este artigo eu irei instale o Formiko no Ubuntu 18.04. Encontraremos este programa disponível para Debian e BSD como podemos ver em seu Página GitHub.

Projeto Formiko Vim

Formiko vim

requisitos

Antes de prosseguir com a instalação, deve ser dito que de acordo com sua página GitHub, vamos ter que consertar alguns requisitos que pede ao programa para funcionar corretamente quando o instalamos com pip3.

  • python 2.7 ou 3
  • GTK+3
  • introspecção de objeto
  • PyGObjectName
  • kit web
  • GtkSourceViewGenericName

Abrimos um terminal (Ctrl + Alt + T) e escrevemos:

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

Quero esclarecer novamente que estou fazendo esta instalação no Ubuntu 18.04. Assim que os requisitos forem cumpridos, veremos que a instalação do programa será feita através do pip ou apt como estamos interessados. Pra usar pip3 na instalação vamos escrever no terminal (Ctrl + Alt + T):

pip3 install formiko

Caso você prefira usar apt, no mesmo terminal escrevemos:

instalação apt formiko

sudo apt update && sudo apt install formiko

Deve ser dito que ambas as instalações nos fornecerão a mesma versão do programa. Opcionalmente, também podemos instalar:

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

Quando o instalarmos, duas entradas serão adicionadas ao menu do aplicativo: Formiko y Formiko vim.

Lançador Formiko e Formiko Vim

Teremos que encontrar aquele que melhor se adapta às nossas necessidades.

Desinstalar o Formiko

Como vimos duas opções de instalação, também veremos dois comandos para remover o programa de nosso sistema operacional.

O primeiro dos comandos será aquele referente ao instalação feita com pip3. Para eliminar o programa, vamos abrir um terminal (Ctrl + Alt + T) e escrever nele:

sudo pip3 uninstall formiko

Agora veremos o comando para quem escolheu o instalação com apt. Em um terminal (Ctrl + Alt + T), escrevemos:

sudo apt purge formiko && sudo apt autoremove

Pode não ser o melhor dos programas para sua função, mas devo dizer que o Formiko funcionou sem problemas enquanto eu o testava. Não quero terminar sem falar primeiro sobre o que talvez seja o maior ponto negro deste programa, o limitação de formato com o qual nos permite trabalhar

Mais informações sobre este programa podem ser obtidas na página do Projeto GitHub.


Deixe um comentário

Seu endereço de email não será publicado. Campos obrigatórios são marcados com *

*

*

  1. Responsável pelos dados: Miguel Ángel Gatón
  2. Finalidade dos dados: Controle de SPAM, gerenciamento de comentários.
  3. Legitimação: Seu consentimento
  4. Comunicação de dados: Os dados não serão comunicados a terceiros, exceto por obrigação legal.
  5. Armazenamento de dados: banco de dados hospedado pela Occentus Networks (UE)
  6. Direitos: A qualquer momento você pode limitar, recuperar e excluir suas informações.