Markowik

Markowik is een Python-app die Markdown opgemaakte tekst converteert naar Google Code Wiki.
Markowik is in staat om de meeste Markdown constructies om te zetten naar de Google Code Wiki (GCW) equivalenten. In plaats van een lijst van alle ondersteunde conversies, neem dan eens een kijkje op Markowik's testsuite en haar show case.
installatie
Run:
pip markowik installeren
of:
easy_install markowik
U kunt Markowik ook gebruiken zonder de installatie, zoals beschreven onder Contribute.
Command Line Usage
Van de hulp uitgang:
verbruik: markowik [-h] [--mx [MX [MX ...]]] [--image-baseurl URL]
& Nbsp; [- html-beelden] [--encoding ENCODING] [--quiet]
& Nbsp; INFILE [OUTFILE]
Omzetten Markdown naar Google Code Wiki.
positionele argumenten:
& Nbsp; INFILE markdown bestand
& Nbsp; OUTFILE wiki-bestand (standaard: stdout)
optionele argumenten:
& Nbsp; -h, --help deze hulp bericht en afrit tonen
& Nbsp; - MX [MX [MX ...]] markdown extensies om te activeren
& Nbsp; - image-baseurl URL basis-URL om prepend relatieve afbeelding locaties
& Nbsp; - html-beelden altijd gebruik maken van HTML voor afbeeldingen
& Nbsp; - codering Encoding codering van input en output (standaard: UTF8)
& Nbsp; - rustig uitschakelen informatieberichten
Markdown extensies kan worden gegeven op dezelfde wijze als bij de Python Markdown (PyMD) command-line tool, met de uitzondering dat individuele extensies moeten worden gescheiden door een spatie:
markowik INPUT --mx tafels def_list
De momenteel ondersteund (dwz getest) extensies zijn abbr, tabellen en def_list. Andere uitbreidingen dienen in het algemeen te werken, maar misschien onverwachte resultaten op in de geconverteerde wiki tekst.
Met betrekking tot de optie --html-beelden, zie de onderstaande uitleg bij Beperkingen.
Programmatische Gebruik
Markowik is geïmplementeerd in Python. De markowik module bevat een functie genaamd bekeerling. Semantisch het is vergelijkbaar met de command line interface (trefwoord argumenten komen overeen met lijn opdracht Opties). Hier is een kort gebruik bijvoorbeeld:
>>> Import markowik
>>> Markowik.convert ("Sommigen * markdown * tekst ...", mx = ['tafels'])
u'Some _markdown_ tekst ... '
Pagina pragma
GCW pagina pragma kan worden ingesteld in Markdown bronbestanden zoals meta data in het formaat dat is gedefinieerd door de PyMD meta extensie:
>>> Src = "" "Samenvatting: pagina overzicht
... Labels: sommige, etiketten
...
... Hier begint de pagina * * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary pagina samenvatting
#labels sommige, etiketten

Hier begint het _page_ ..
Merk op dat de meta extensie moet expliciet worden ingeschakeld, dwz standaard Markowik geen pagina pragma herkennen

Wat is nieuw in deze release:.

< ul>

Wat is nieuw in versie 0.1.1:.

• Verbeterde documentatie
• Kleine aanpassingen.

Eisen

• Python

Beperkingen

• GCW kan niet uitdrukken alle markup mogelijk in Markdown. Dit betekent Markdown bronbestanden moet met de volgende beperkingen in het achterhoofd worden geschreven.


• URL's in links en afbeeldingen:
• URL's gebruikt voor koppelingen of beeldbronnen absolute te zijn en moet een specifiek protocol om zich te herkennen aan GCW hebben. In het bijzonder moet een URL beginnen met http: //, https: // of ftp: //. Markowik breekt de conversie, indien hij vaststelt URL's niet overeenkomen met deze eisen.


• Typefacing in Link Namen:
• GCW niet ondersteunt typefacing in verband namen. Bijvoorbeeld GCW maakt de link in bij [http://foo.com _Foo_] letterlijk, dat wil zeggen als _Foo_. Echter, GCW erkent typefacing in HTML-links, dwz & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / A & gt; goed benadrukt. Om deze reden Markdown banden met geneste typefacing zoals [* Foo *] (http://foo.com) zal worden omgezet naar HTML-links. Als gevolg hiervan, koppeling etiketten met bepaalde speciale tekens die moeten worden ontsnapt in GCW behulp backtick (`) markers zal ook resulteren in HTML-links.


• geneste leden:
• GCW niet echt ondersteuning voor meerdere geneste alinea's (bijvoorbeeld in lijsten of blockquotes). Markowik simuleert meerdere geneste alinea's door ze te scheiden met een & lt; br / & gt; (Die visueel bootst de punten, maar niet de nesten milieu te breken).


• Afbeeldingen:
• Markdown maakt het mogelijk om alternatieve en titel teksten voor afbeeldingen uit te drukken. GCW's afbeelding syntax ondersteunt dit niet. De enige manier om deze teksten te behouden is om eenvoudige HTML & lt gebruiken; img & gt; markeringen. De optie --html-beelden maakt deze tijdelijke oplossing.
• Een ander probleem is dat GCW verwacht image URL's om te eindigen met een afbeelding bestandstype extensie. Markowik voegt kunstmatige afbeelding extensies, indien nodig, bijvoorbeeld http://foo.bar/image wordt gewijzigd in http://foo.bar/image?x=x.png.


• Afkortingen:
• GCW heeft geen markup voor afkortingen en evenmin ondersteuning voor de HTML-tag & lt; abbr & gt ;. Markowik zet afkortingen om & lt; overspanning & gt; -elementen die soort nabootst afkortingen (in beperkte mate natuurlijk)
.

• HTML:
• Elke eenvoudige HTML die zich in een Markdown bron eindigt letterlijk in GCW (met uitzondering van de inhoud van de overspanning-level-tags). Dit betekent dat de Markdown bron mag alleen HTML ondersteund door GCW bevatten. Een andere implicatie is dat URL's gebruikt in eenvoudige HTML-tags niet worden gecontroleerd op GCW compatibiliteit. Met andere woorden: bij het gebruik van ruwe HTML bent u op uw eigen
!