Markowik

Markowik ist ein Python-Anwendung, die Markdown-formatierten Text auf Google Code Wiki umwandelt.
Markowik der Lage ist, die meisten Markdown-Konstrukte, seine Google Code Wiki (GCW) Äquivalente zu konvertieren. Statt einer Liste aller unterstützten Konvertierungen, bitte haben Sie einen Blick auf Markowik der Testsuite und ihre Vitrine.
Installation
Run:
pip markowik installieren
oder:
easy_install markowik
Sie können Markowik auch ohne Installation nutzen, wie unter Mitmachen beschrieben.
Verwendung der Befehlszeile
Von Hilfe Ausgabe:
Nutzung: markowik [-h] [--mx [MX [MX ...]]] [--image-baseurl URL]
& Nbsp; [- html-Bilder] [--encoding ENCODING] [--quiet]
& Nbsp; INFILE [OUTFILE]
Konvertieren Sie Markdown auf Google Code Wiki.
Positionsargumente:
& Nbsp; INFILE Markdown-Datei
& Nbsp; OUTFILE Wiki Datei (Standard: Standardausgabe)
optionale Argumente:
& Nbsp; -h, --help diese Hilfe und beende zeigen
& Nbsp; - mx [MX [MX ...]] Abschlag Erweiterungen aktivieren
& Nbsp; - Bild baseurl URL Basis-URL, um die relative Bildstellen voranstellen
& Nbsp; - html-Bilder verwenden immer HTML für Bilder
& Nbsp; - kodiert Codierung von Ein- und Ausgang (Standard: UTF8)
& Nbsp; - ruhige disable-Info-Meldungen
Markdown-Erweiterungen können in ähnlicher Weise wie mit dem Python-Markdown (PyMD) Kommandozeilen-Tool gegeben werden, mit der Ausnahme, dass einzelne Erweiterungen müssen durch ein Leerzeichen getrennt werden:
markowik INPUT --mx Tabellen def_list
Die derzeit unterstützten (dh getestet) Erweiterungen sind abbr, Tabellen und def_list. Andere Erweiterungen der Regel sollten auch funktionieren, aber vielleicht in der umgebauten Wiki-Text zu unerwarteten Ergebnissen führen.
In Bezug auf die Option --html-Bilder finden Sie in den nachstehenden Erläuterungen zu Einschränkungen.
programmtechnische Verwendung
Markowik ist in Python implementiert. Die markowik Modul bietet eine Funktion mit dem Namen zu konvertieren. Semantisch ist es ähnlich wie die Befehlszeilenschnittstelle (Schlüsselwort-Argumente entsprechen den Befehlszeilenoptionen). Hier eine kurze Anwendungsbeispiel:
>>> Import markowik
>>> Markowik.convert ("Some * Abschlag * Text ...", mx = ['Tabellen'])
u'Some _markdown_ Text ... '
Seite Pragmas
GCW Seite Pragmas in Markdown-Quelldateien als Meta-Daten in der vom PyMD Meta Erweiterung definiert Format eingestellt werden:
>>> Src = "" "Zusammenfassung: seitige Zusammenfassung
... Labels: einige, Etiketten
...
... Hier beginnt die * Seite * ..
... "" "
>>> Print markowik.convert (src, mx = ['Meta'])
#summary Seite Zusammenfassung
#labels einige, Etiketten

Hier beginnt der _page_ ..
Beachten Sie, dass die Meta-Erweiterung muss explizit aktiviert werden, dh durch Standard Markowik nicht Seite Pragmas erkennen

Was ist neu in dieser Pressemitteilung:.

< ul>

Was ist neu in Version 0.1.1:.

• Verbesserte Dokumentation
• Kleinere Korrekturen.

Anforderungen :

• Python

Grenzen :

• GCW nicht alle Markup in Markdown möglich auszudrücken. Das bedeutet, Markdown-Quelldateien sollten mit den folgenden Einschränkungen im Hinterkopf geschrieben werden.


• URLs in Links und Bilder:
• URLs für Links oder Bildquellen müssen absolut sein und muss ein bestimmtes Protokoll von GCW erkannt zu haben. Insbesondere muss jede URL mit http: //, https: // oder ftp: //. Markowik bricht die Konvertierung, wenn es URLs nicht fest, die diese Anforderungen erfüllen.


• Typefacing in Link-Namen:
• GCW nicht unterstützt typefacing in Linknamen. Zum Beispiel GCW macht den Link-Namen in [http://foo.com _Foo_] wörtlich, dh als _Foo_. Allerdings erkennt GCW typefacing in HTML-Links, das heißt & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / A & gt; richtig betont. Aus diesem Grund Markdown-Links mit verschachtelten typefacing wie [* Foo *] (http://foo.com) auf HTML-Links umgewandelt. Als Folge Link Etiketten mit bestimmten Sonderzeichen, die in GCW mit Backtick maskiert werden müssen (`) Marker werden auch in HTML-Links führen.


• Verschachtelte Absätze:
• GCW nicht wirklich unterstützt mehrere verschachtelte Absätze (zB in Listen oder Blockzitaten). Markowik simuliert mehrere verschachtelte Absätze durch eine & lt trennen; br / & gt; (Die optisch nachahmt Absätze aber nicht die Brutumgebung zu brechen).


• Bilder:
• Markdown erlaubt es, alternative und Titeltexte für Bilder auszudrücken. GCW das Image-Syntax nicht unterstützt. Die einzige Möglichkeit, diese Texte zu bewahren ist es, einfache HTML & lt verwenden; img & gt; Tags. Die Option --html-Bilder können diese Problemumgehung.
• Ein weiteres Problem ist, dass GCW rechnet Bild-URLs, um mit einem Bilddateierweiterung enden. Markowik fügt künstliche Bilderweiterungen bei Bedarf, zum Beispiel http://foo.bar/image an http://foo.bar/image?x=x.png. Geändert


• Abkürzungen:
• GCW keinen Markup für Abkürzungen noch unterstützt es das HTML-Tag & lt; abbr & gt ;. Markowik wandelt Abkürzungen & lt; Spanne & gt; -Elemente, welche Art von Mimik Abkürzungen (in eingeschränkter Weise natürlich)
.

• HTML:
• Jede einfachem HTML in Markdown Quelle auftretenden endet buchstäblich in GCW (mit Ausnahme des Inhalts der Spanne-Level-Tags). Das bedeutet, die Markdown Quelle sollte nur HTML von GCW unterstützt enthalten. Eine weitere Folge ist, dass URLs in einfachen HTML-Tags verwendet werden, nicht für GCW-Kompatibilität überprüft. Mit anderen Worten: bei der Verwendung von reinem HTML Sie sind auf eigene Faust
!