altre destinazioni

ultimi post

ultimi commenti

tag principali

categorie

archivi

powered by

  • WPFrontman + WP

friends

copyright

  • © 2004-2011
    Ludovico Magnocavallo
    tutti i diritti riservati

Editor Restructured Text per OSX

31 dicembre 2004

0 commenti

categorie

Ho sempre pensato che una delle funzionalità più utili dei linguaggi di scripting Open Source come Perl e Python siano i formati di documentazione sviluppati ad hoc, che permettono di scrivere testi strutturati in maniera molto semplice, che possono essere poi convertiti facilmente in HTML, PDF (di solito via LaTeX), Unix man pages, eccetera. Esempi di questo tipo di formati sono la Plain Ol’ Documentation (POD) di Perl, Textile di PHP (anche se limitato all’HTML), StructuredText (STX) di Zope e ReStructuredText (ReST) di Python, il mio preferito per la chiarezza delle formattazioni che rendono il documento sorgente piacevole da leggere e molto simile ad un documento formattato con un Word Processor.

Anche se si basano tutti sul formato più semplice ed universale (testo) e non richiedono quindi un editor sofisticato, questi formati sono sconosciuti al grande pubblico che è abituato ad utilizzare mastodonti come Word o OpenOffice anche per le esigenze più elementari, perdendosi gli innegabili vantaggi di questo tipo di documentazione: la facilità di scrittura, che permette di concentrarsi sul contenuto invece che sul layout; la possibilità di leggerle e modificare i documenti prodotti su qualsiasi computer dotato di un programma di gestione testi, da VI o Emacs sotto Unix al Blocco Note di Windows; la compattezza dei file e il loro essere semplice testo, che li rende immediatamente utilizzabili come contenuto di una email o come pagina web; la compatibilità con i sistemi di controllo di versione tipo CVS, che permette la gestione delle revisioni anche multiutente.

Credo che la diffidenza del pubblico di non programmatori verso questi formati sia dovuta, oltre che alla poca visibilità di cui questi godono, alla necessità di lanciare utility dalla linea di comando per convertire i documenti nel formato desiderato ed alla mancanza di una anteprima del documento formattato. Non devo essere l’unico a pensarla così, se Bill Bumgarner ha deciso di impiegare parte del suo tempo per sviluppare ReSTedit, un editor di documenti ReST per Mac OSX che permette l’anteprima in tempo reale del documento formattato in HTML. ReSTedit è scritto in Python e può quindi essere facilmente modificato da chi conosce questo linguaggio, ma chi volesse solo provarlo ed eventualmente utilizzarlo non deve preoccuparsi visto che è scaricabile come applicazione pronta per essere utilizzata. Provatelo, dando magari un’occhiata alla documentazione del formato (in particolare alla Quick Reference e alla demo), ovviamente scritta in ReST come potete vedere dai link ai documenti sorgente in fondo ad ogni documento. E se non ci risentiamo passate un buon capodanno, all’anno prossimo!