Commit 0001dc8a authored by Elena Grandi's avatar Elena Grandi
Browse files

Comandi utili per migrare documenti dalla wiki di Redmine

parent 38716762
......@@ -135,3 +135,38 @@ prevede:
* ``-`` per le sottosezioni;
* ``^`` per le sotto-sottosezioni;
* ``"`` per i paragrafi.
Migrazione dalla wiki di Redmine
================================
I documenti presenti sulla wiki di redmine usano il formato (sorgente)
textile; per convertirlo in reStructuredText può essere utile il
programma `Pandoc <https://pandoc.org/>`_
Una volta copiato il sorgente della pagina in un file locale
``articolo.txt`` si può usare il seguente comando per ottenerne una
versione in reStructuredText nel file ``articolo.rst``::
pandoc -f textile -t rst -o articolo.rst articolo.txt
Tale file è un buon punto di partenza, ma non è pronto per l'inclusione
diretta nelle guide FUSS senza prima verificare manualmente i contenuti;
in particolare sarà sicuramente necessario sistemare manualmente alcune
caratteristiche.
* I livelli di struttura andranno corretti per adeguarsi allo standard
specificato qui sopra, facendo attenzione alla posizione in cui viene
inserito il documento (ad esempio se si sta convertendo una pagina
della wiki in una sezione o sottosezione di una pagina della guida).
* Le immagini vengono caricate dal file originale sulla wiki; per la
mantenibilità futura è invece opportuno caricarle localmente
all'interno della guida.
Dopo aver scaricato le immagini, ad esempio nella directory
``images/articolo/``, e spostati i riferimenti generati da pandoc
dalla fine del documento alla posizione dove dovrà apparire
l'immagine, li si può convertire in direttive ``figure`` col seguente
comando di vim::
:%s/|image.*| image:: https:\/\/work.fuss.bz.it\/attachments\/download\/.*\//figure:: images\/articolo\//
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment