Markowik

Markowik är en Python-app som omvandlar Wiki formaterad text till Google Code Wiki.
Markowik kan konvertera de flesta markdown konstruktioner till sina Google Code Wiki (GCW) motsvarigheter. Istället för att lista alla konverteringar stöds, vänligen ta en titt på Markowik testsvit och dess show case.
Installation
Kör:
Pip installera markowik
eller:
easy_install markowik
Du kan också använda Markowik utan installation, som beskrivs under Contribute.
Command Line Användning
Från hjälputgång:
användning: markowik [-h] [--mx [MX [MX ...]]] [--image-baseURL URL]
& Nbsp; [- html-bilder] [--encoding KODNING] [--quiet]
& Nbsp; INFILE [UTFIL]
Konvertera Wiki till Google Code Wiki.
positionsargument
& Nbsp; INFILE markdown-fil
& Nbsp; UTFIL wiki-fil (default: stdout)
valfria argument:
& Nbsp; -h, --help visa denna hjälpmeddelande och avsluta
& Nbsp; - mx [MX [MX ...]] markdown förlängningar för att aktivera
& Nbsp; - bild baseURL URL bas-URL för att infoga före relativa bildplatser
& Nbsp; - html-bilder använder alltid HTML för bilder
& Nbsp; - kodning ENCODING kodning av input och output (default: UTF8)
& Nbsp; - tyst inaktivera infomeddelanden
Wiki förlängningar kan ges på samma sätt som till Python Wiki (PyMD) kommandoradsverktyg, med undantaget att enskilda anknytningar måste separeras med ett mellanslag:
markowik INPUT --mx tabeller def_list
De närvarande stöds (dvs testade) förlängningar är abbr, bord, och def_list. Andra förlängningar allmänhet bör fungera också men kanske ge oväntade resultat i den konverterade wiki texten.
När det gäller options --html-bilder, se förklaringarna nedan på Begränsningar.
Program Användning
Markowik förs i Python. Den markowik modulen ger en funktion som heter konvertera. Semantiskt det liknar kommandoradsgränssnittet (sökord argument motsvarar kommandoradsväljare). Här är en kort användning exempel:
>>> Import markowik
>>> markowik.convert ("Vissa * markdown * text ...", mx = ['bord'])
u'Some _markdown_ text ... "
Sida Pragmas
GCW sida pragmas kan ställas in i markdown källfiler som metadata i det format som definieras av PyMD meta förlängning:
>>> Src = "" "Sammanfattning: sida sammandrag
... Etiketter: vissa, etiketter
...
... Här startar * sidan * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary sida sammandrag
#labels några, etiketter

Här startar _page_ ..
Observera att meta förlängningen måste uttryckligen aktiveras, dvs som standard Markowik känner inte igen sidan pragmas

Vad är nytt i den här versionen:.

< ul>

Vad är nytt i version 0.1.1:.

• Förbättrad dokumentation
• Mindre fixar.

Krav :

• Python

Begränsningar :

• GCW kan inte uttrycka allt uppmärkning möjligt i Markdown. Det innebär markdown källfilerna ska skrivas med följande begränsningar i åtanke.


• webbadresser i Länkar och bilder:
• webbadresser som används för länkar eller bildkällor måste vara absolut och måste ha ett särskilt protokoll för att få igen av GCW. I synnerhet måste alla URL börjar med http: //, https: // eller ftp: //. Markowik avbryter omvandlingen om den finner webbadresser som inte matchar dessa krav.


• Typefacing i Länk Namn:
• GCW stöder inte typefacing i länknamn. Till exempel GCW gör länken namn i [http://foo.com _Foo_] bokstav, dvs som _Foo_. Men GCW erkänner typefacing i HTML-länkar, dvs. & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / A & gt; betonas korrekt. Av denna anledning nedsättning förbindelser med kapslade typefacing som [* Foo *] (http://foo.com) kommer att konverteras till HTML-länkar. Som ett resultat, länk etiketter med vissa specialtecken som måste flydde i GCW använder backtick (`) markörer kommer också att resultera i HTML-länkar.


• Bygga bo Punkterna:
• GCW egentligen inte stöd för flera kapslade stycken (t.ex. i listor eller blockquotes). Markowik simulerar flera kapslade stycken genom att separera dem med ett & lt; br / & gt; (Vilket visuellt härmar stycken men bryter inte häckande miljö).


• Bilder:
• Wiki gör det möjligt att uttrycka alternativa och titeltexterna för bilder. GCW image syntax stöder inte den här. Det enda sättet att bevara dessa texter är att använda vanlig HTML & lt; img & gt; taggar. Alternativet --html-bilder gör den här lösningen.
• En annan fråga är att GCW förväntar bildwebbadresser för att sluta med en bildfil typ förlängning. Markowik lägger artificiella bild förlängningar om det behövs, till exempel http://foo.bar/image ändras till http://foo.bar/image?x=x.png.


• Förkortningar:
• GCW har inget pålägg för förkortningar inte heller stödja HTML-taggen & lt; abbr & gt ;. Markowik omvandlar förkortningar som & lt; span & gt; Beståndsdelar vilken typ av härmar förkortningar (på ett begränsat sätt förstås)
.

• HTML:
• Alla vanlig HTML inträffar i en Wiki källa hamnar bokstavligen i GCW (med undantag av innehållet i span nivå taggar). Detta innebär att Markdownkällan ska bara innehålla HTML stöds av GCW. En annan implikation är att webbadresser som används i vanlig HTML-taggar är inte kontrolleras för GCW kompatibilitet. Med andra ord: när man använder rå HTML du är på din egen
!