undefined

Da Google Doc direttamente a Read the Docs con GGeditor

Passando automaticamente da Github!

Le spiegazioni contenute in questo documento rappresentano una via piuttosto facile per migliorare la qualità dei documenti pubblicati sul web e sono la traduzione in italiano del tutorial GGeditor. Fondamentalmente il tutorial spiega come usare lo strumento di Google doc, ed un componente aggiuntivo, per pubblicare documenti con lo stile di Read the Docs e con il design di Docs Italia.

Questo documento nasce subito dopo la produzione del tutorial “Come abbiamo creato un «Read the Docs» per pubblicare documenti pubblici su Docs Italia”.

Per questo tutorial i seguenti ringraziamenti particolari

Ringraziare queste persone è importante, perché con i loro approfondimenti hanno permesso di ampliare le possibilità d’uso di Read the Docs come piattaforma di pubblicazione documentale:

Hsin Yuan Yeh, Andrea Borruso, Giovan Battista Vitrano, Salvatore Fiandaca, Pablo Persico, Marina Bassi, Andrea Ivan Baldassarre, Daniele Rizzo, Maurizio Costa, Michela Stentella.


Vantaggi dell’uso di “Read the Docs”

L’uso di “Read the Docs” come piattaforma di pubblicazione di documenti ha i seguenti vantaggi sul formato “PDF”:

Responsive

Funzioni avanzate di ricerca testo

Fornisce testo in HTML, EPUB e PDF

Codice sorgente del testo online

E’ elegante e bello da vedere


GGeditor, un componente aggiuntivo di Google doc


GGeditor è un componente plugin che si installa direttamente da Google Doc (della suite di Google Drive) cercandolo nei componenti aggiuntivi e installandolo.

Importante

Se cliccando su “installa componente aggiuntivo” non trovate GGeditor - cercando sul Marketplace di Google (capita dall’agosto 2019 per una ridefinizione dei termini d’uso di Google) - potete cliccare direttamente sul link del componente aggiuntivo GGeditor e premere su “installa gratis”.

Il componente aggiuntivo GGeditor rappresenta uno strumento molto utile e comodo in quanto i servizi di Google Drive oggi sono molto usati anche nelle Pubbliche Amministrazioni, oltre che dai privati, per la facilità d’uso e per la funzionalità di condivisione dei documenti in gruppo.

Il lavoro principale che svolge il componente aggiuntivo GGeditor è quello di trasformare il testo editato su un foglio di Google doc in un file con linguaggio .rST dentro il repository di Github. Github a sua volta permette la compilazione automatica dello stesso documento su Read the Docs. Sembra una cosa difficile nella descrizione, ma posso assicurare che se lo faccio io lo possono fare tutti.

Breve video introduttivo (2’10”)


Le principali funzioni e punti di forza di GGeditor sono

  • Facile inizio per chi non ha dimestichezza con i file RST, anche per chi non ha idea dei marcatori di RST.
  • Alimentato da Google Docs. Quasi la totalità di quello che vedi su Google Docs è quello che ottieni su Readthedocs. Lo stesso è per l’intero gruppo di lavoro.
  • Un click per commissionare il lavoro sul repository di Github.
  • Puoi vedere in anteprima il file RST generato dall’interno di Google Docs e scaricarlo nel tuo PC.
  • Supporta headings, bold, italic, hyperlink, subscript e superscript.
  • Supporta note a margine, immagini, liste di articolo e tabelle.
  • Supporta caratteri a larghezza intera (CKJ) nelle intestazioni e nelle tabelle.
  • Supporta i link interni ai bookmarks, headings e le Google Docs tabelle native di contenuti (in document table of contents).
  • Supporta i link relativi ai file RST generati dai Google Docs all’interno della stessa directory e sotto-directory Google Docs.
  • Supporta la tabella dei contenuti (cross-document table of content (.. toctree::)) per fare generare l’indice a Readthedocs.
  • Supporta tutti gli stili di «admonitions» di Readthedocs.
  • Supporta account multipli per compilare i file nei repository di diversi account Github.
  • Supporta la conversione di tabelle con i tags HTML to let look-and-feel e la stessa cosa è possibile per i blogger.

Indice

Suggerimento

il contenuto di questa pagina che state leggendo è editato in questo Google Doc