Markowik

Markowik è un'applicazione Python che converte Markdown testo formattato a Google Code Wiki.
Markowik è in grado di convertire la maggior parte dei costrutti Markdown alle sue Google Code Wiki (GCW) equivalenti. Invece di elencare tutte le conversioni supportate, si prega di dare un'occhiata alla suite di test di Markowik e la sua vetrina.
Installazione
Correre:
pip installare markowik
o:
easy_install markowik
È inoltre possibile utilizzare Markowik senza installazione, come descritto in Contribute.
Command Line Uso
Dalla uscita aiuto:
Utilizzo: markowik [-h] [--mx [MX [MX ...]]] [URL --image-baseurl]
& Nbsp; [- html-immagini] [--encoding CODIFICA] [--quiet]
& Nbsp; INFILE [OUTFILE]
Convertire Markdown di Google Code Wiki.
argomenti posizionali:
& Nbsp; di file Markdown INFILE
& Nbsp; di file wiki OUTFILE (default: stdout)
argomenti opzionali:
& Nbsp; -h, --help mostra questo messaggio di aiuto ed esce
& Nbsp; - mx [MX [MX ...]] estensioni di riduzione dei prezzi per attivare
& Nbsp; - URL dell'immagine-baseurl base di URL di anteporre alle posizioni di immagini relative
& Nbsp; - html-immagini utilizzano sempre HTML per le immagini
& Nbsp; - codifica codifica Codifica di ingresso e di uscita (default: UTF8)
& Nbsp; - tranquille disabilitare i messaggi info
Estensioni Markdown possono essere dati allo stesso modo come la linea di comando Python Markdown (PyMD), con l'eccezione che le singole estensioni devono essere separate da uno spazio:
markowik tavoli INPUT --mx def_list
I (cioè testati) le estensioni attualmente supportati sono abbr, tavoli, e def_list. Altre estensioni generalmente devono lavorare troppo, ma potrebbe portare a risultati imprevisti nel testo convertito wiki.
Per quanto riguarda l'opzione --html-immagini, consultare le spiegazioni qui sotto a limitazioni.
Programmatico Uso
Markowik è implementato in Python. Il modulo markowik fornisce una funzione denominata conversione. Semanticamente è simile alla riga di comando (argomenti chiave corrispondono a comandare opzioni della riga). Ecco un breve esempio di utilizzo:
>>> Markowik import
>>> markowik.convert ("Alcuni * Markdown * testo ...", mx = ['tavoli'])
testo u'Some _markdown_ ... '
Pagina Pragma
Pagina MTC pragma possono essere impostate in file di origine Markdown come meta dati nel formato definito dalla meta estensione PyMD:
>>> Src = "" "Sommario: Riepilogo pagina
... Etichette: alcuni, etichette
...
... Qui inizia la pagina * * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary sintesi pagina
#labels alcuni, etichette

Da qui inizia la _page_ ..
Si noti che l'estensione meta deve essere abilitato in modo esplicito, cioè per default Markowik non riconosce pragma pagina

Cosa c'è di nuovo in questa versione:.

< ul>

Cosa c'è di nuovo nella versione 0.1.1:.

• migliorata documentazione
• Correzioni minori.

Requisiti :

• Python

Limitazioni :

• GCW non può esprimere tutto markup possibili in Markdown. Questo significa che i file di origine Markdown dovrebbero essere scritte con le seguenti limitazioni in mente.


• URL in link e immagini:
• URL utilizzati per i collegamenti o fonti di immagine deve essere assoluta e devono avere un protocollo specifico per essere riconosciuto da GCW. In particolare, ogni URL deve iniziare con http: //, https: // o ftp: //. Markowik interrompe la conversione se trova gli URL non corrispondenti a questi requisiti.


• Typefacing in collegamento Nomi:
• GCW non supporta typefacing nei nomi dei collegamenti. Per esempio GCW rende il nome del collegamento in [http://foo.com _Foo_] letteralmente, vale a dire come _Foo_. Tuttavia, GCW riconosce typefacing in link HTML, ovvero & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / A & gt; si sottolinea correttamente. Per questa ragione i collegamenti con Markdown typefacing nidificato come [* Foo *] (http://foo.com) sarà convertito in link HTML. Come risultato, le etichette sui collegamenti con alcuni caratteri speciali che devono essere sfuggito in GCW con apice inverso (`) marcatori anche tradursi in link HTML.


• nidificato paragrafi:
• GCW realtà non supporta più paragrafi nidificati (ad esempio, in liste o blockquotes). Markowik simula più paragrafi nidificati separandoli con una & lt; br / & gt; (Che visivamente imita paragrafi, ma non rompere l'ambiente di nidificazione).


• bbli Immagini:
• Markdown permette di esprimere testi alternativi per le immagini e titolo. Sintassi immagine di GCW non supporta questo. L'unico modo per preservare questi testi è di usare il codice HTML semplice & lt; img & gt; tag. L'opzione --html-immagini consente questa soluzione.
• Un altro problema è che GCW aspetta URL di immagini per finire con una estensione di immagine del tipo di file. Markowik aggiunge estensioni immagini artificiali, se necessario, per esempio http://foo.bar/image viene modificato http://foo.bar/image?x=x.png.


• Abbreviazioni:
• GCW ha markup per le abbreviazioni né supporta il tag HTML & lt; abbr & gt ;. Markowik converte abbreviazioni per & lt; arco & gt; -elementi che tipo di imita abbreviazioni (in modo limitato, naturalmente)
.

• HTML:
• Qualsiasi semplice HTML che si verificano in una fonte Markdown finisce letteralmente GCW (ad eccezione del contenuto di tag campata livello). Ciò significa che la fonte Markdown dovrebbe contenere solo HTML supportati da GCW. Un'altra implicazione è che gli URL utilizzati nei tag HTML semplici non vengono controllati per la compatibilità GCW. In altre parole: quando si utilizza HTML grezzo si è da soli
!