Martes, Septiembre 18, 2018

Formiko, un editor de texto estructurado para la documentación de Python

about-formiko

En el siguiente artículo vamos a echar un vistazo a Formiko. Se trata de un pequeño editor creado con Python que encontré de manera casual en GitHub. Formiko es una aplicación reStructuredText con un editor MarkDown y vista previa para comprobar los progresos del trabajo realizado.

ReStructuredText es parte del proyecto Docutils y es utilizado por los programadores de Python para crear documentación técnica. Estoy seguro de que habrá muchas personas que nunca han oído hablar de reStructuredText, pero mediante este programa y algunos conceptos básicos se verá que es sencillo utilizar este sistema de sintaxis. El programa está escrito en Python con Gtk3, GtkSourceView y Webkit2. Utiliza Docutils y recommonmark Common Mark Parser.

Hay que decir que Markdown y reStructuredText tienen capacidades similares. Como diferencia, hay que destacar que reStructuredText está diseñado para crear documentación, admite tablas y notas al pie y al final.

ReStructuredText es un sistema de sintaxis y analizador sintáctico fácil de leer. Es útil para la documentación de programas en línea, las cadenas de documentos Python, para crear rápidamente páginas web simples y para documentos independientes. El analizador de reStructuredText es un componente de Docutils y es una revisión y reinterpretación de los sistemas de marcado ligero StructuredText y Setext.

Características generales de Formiko

formiko-gtk

Formiko

Según la página GitHub del proyecto, Formiko incluye las siguientes características:

  • Posé un editor basado en GtkSourceView con resaltado de sintaxis y un editor Vim.
  • Nos va dividir el área de trabajo de manera vertical u horizontal.
  • Ofrece un modo de vista previa para ir viendo como queda el trabajo.
  • JSON y vista previa de HTML.
  • Verificación ortográfica.

También es compatible con:

Instalación de Formiko en Ubuntu

Para este artículo voy a instalar Formiko en Ubuntu 18.04. Este programa lo vamos a encontrar disponible en para Debian y BSD como podremos ver en su página de GitHub.

formiko-vim-proyecto

Formiko Vim

Requisitos

Antes de proceder con la instalación, hay que decir que según informan en su página de GitHub, vamos a tener que solucionar algunos requisitos que pide el programa para funcionar correctamente cuando lo instalamos con pip3.

  • python 2.7 o 3
  • GTK + 3
  • gobject-introspection
  • PyGObject
  • Webkit
  • GtkSourceView

Abrimos una terminal (Ctrl+Alt+T) y escribimos:

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

Quiero volver a aclarar que esta instalación la estoy haciendo sobre Ubuntu 18.04. Cumplidos los requisitos, vamos a ver que la instalación del programa la realizaremos mediante pip o apt según nos interese. Para utilizar pip3 en la instalación escribiremos en la terminal(Ctrl+Alt+T):

pip3 install formiko

En caso de preferir utilizar apt, en la misma terminal escribimos:

instalacion-apt-formiko

sudo apt update && sudo apt install formiko

Hay que decir que ambas instalaciones nos van a proporcionar la misma versión del programa. De manera opcional podremos instalar también:

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

Cuando lo instalemos se van a agregar dos entradas al menú de la aplicaciones: Formiko y Formiko Vim.

lanzador-formiko

Tendremos que buscar el que mejor se adapte a nuestras necesidades.

Desinstalar Formiko

Como hemos visto dos opciones de instalación, también veremos dos comandos para eliminar el programa de nuestro sistema operativo.

El primero de los comandos será el referente a la instalación realizada con pip3. Para eliminar el programa vamos a abrir una terminal (Ctrl+Alt+T) y escribir en ella:

sudo pip3 uninstall formiko

Ahora veremos el comando para los que optasen por la instalación con apt. En una terminal (Ctrl+Alt+T) escribimos:

sudo apt purge formiko && sudo apt autoremove

Quizás no sea el mejor de los programas para su función, pero he de decir que Formiko funcionó sin problemas mientras lo he probado. No quiero terminar sin antes hablar del que quizás sea el mayor punto negro de este programa, la limitación de formatos con los nos permite trabajar

Se puede obtener más información acerca de este programe en la página de GitHub del proyecto.

 

Fuente: ubunlog

¿Quién está en línea?

Hay 85 invitados y ningún miembro en línea

Contador de Visitas

9356503
Hoy Hoy 690
Ayer Ayer 1443
Esta semana Esta semana 2133
Este mes Este mes 27771
Total de Visitas Total de Visitas 9356503

Día con más
visitantes

09-13-2018 : 2017

Gracias por su visita