Markowik

Markowik je Python aplikace, která převádí Markdown formátovaný text na Google Code Wiki.
Markowik je schopen převést většinu srážky konstrukcí svých Google Code Wiki (GCW) ekvivalenty. Místo toho, aby seznam všech podporovaných konverze, prosím podívejte se na Markowik v testovací sady a jeho vitríně.
Instalace
Spustit:
Pip nainstalovat markowik
nebo:
easy_install markowik
Můžete také použít Markowik bez instalace, jak je popsáno v Contribute.
Příkazový řádek Použití
Z nápovědy výstup:
Využití: markowik [-h] [--mx [MX [MX ...]]] [--image-baseURL URL]
& Nbsp; [- HTML-images] [--encoding ENCODING] [--quiet]
& Nbsp; INFILE [OUTFILE]
Převod Markdown na Google Code Wiki.
poziční argumenty:
& Nbsp; INFILE markdown soubor
& Nbsp; OUTFILE wiki souboru (výchozí: stdout)
volitelné argumenty:
& Nbsp; -h, --help zobrazit tuto nápovědu a skončí
& Nbsp; - mx [MX [MX ...]] rozšíření srážky aktivovat
& Nbsp; - image-baseURL URL base URL prepend relativních obrazových míst
& Nbsp; - HTML-obrazy vždy používat HTML pro obrazy
& Nbsp; - kódování ENCODING kódování vstupu a výstupu (výchozí: UTF8)
& Nbsp; - tiché zakázat informační zprávy
Rozšíření srážky mohou být podobně jako na Python Markdown (PyMD) nástroje příkazového řádku, s tím rozdílem, že jednotlivé rozšíření musí být odděleny mezerou:
markowik tabulky vstup --mx def_list
V současné době podporované (tj testované) rozšíření jsou abbr, stoly, a def_list. Další rozšíření obecně by měl fungovat taky, ale může přinést neočekávané výsledky převedené wiki textu.
Pokud jde o opčních --html-obrazy, viz popis níže na omezení.
Programové Použití
Markowik je implementován v jazyce Python. Markowik modul poskytuje funkci s názvem převést. Sémanticky to je podobné rozhraní příkazového řádku (klíčové slovo argumenty odpovídají Možnosti příkazové řádky). Zde je krátký příklad využití:
>>> Import markowik
>>> markowik.convert ("Někteří * markdown * text ...", Mx = ['tabulky'])
u'Some _markdown_ textu ... "
Page Pragmas
GCW stránky pragmas lze nastavit v srážky zdrojové soubory jako meta data ve formátu definovaném PyMD meta rozšíření:
>>> Src = "" "Shrnutí: Shrnutí strana
... Štítky: někteří, etikety
...
... Zde začíná * stránku * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary shrnutí strana
#labels některé, štítky

Tady začíná _page_ ..
Všimněte si, že meta prodloužení musí být povolen explicitně, tj výchozím Markowik neuznává strana pragmas

Co je nového v této verzi:.

< ul>

Co je nového ve verzi 0.1.1:.

• Lepší dokumentace
• Drobné opravy.

Požadavky na :

• Python

Omezení :

• GCW nemohou vyjádřit všechny značky možné Markdown. To znamená, že snížení ceny zdrojové soubory by měly být psán s následujícími omezeními v mysli.


• URL v odkazech a obrazů:
• URL používané pro odkazy a zdroje obrazu musí být absolutní a musí mít zvláštní protokol, aby se uznávaného GCW. Zejména v případě URL musí začínat http: //, https: // nebo ftp: //. Markowik přeruší převod, pokud zjistí URL není odpovídající těmto požadavkům.


• Typefacing v Link názvy:
• GCW nepodporuje typefacing jména odkazu. Například GCW činí název odkazu v [http://foo.com _Foo_] doslovně, tj _Foo_. Nicméně, GCW uznává typefacing v HTML odkazy, tj & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / & Gt; správně zdůraznil. Z tohoto důvodu srážky spojení s vnořené typefacing jako [* Foo *] (http://foo.com), budou převedeny na HTML odkazy. Výsledkem je, že odkaz štítky s některými speciálními znaky, které musí být unikl GCW pomocí backtick (`), markery také povede HTML odkazy.


• vnořené odstavce:
• GCW není opravdu podporují více vnořených odstavců (např seznamů nebo blockquotes). Markowik simuluje více vnořených odstavců, oddělte je & lt; br / & gt; (Což vizuálně napodobuje odstavce, ale neporuší hnízdní prostředí).


• Obrázky:
• Markdown umožňuje vyjádřit alternativní a titulní texty pro obrazy. Syntax image GCW nepodporuje to. Jediným způsobem, jak zachovat tyto texty, je použít obyčejný HTML & lt; img & gt; tagy. Možnost --html-obrázky umožňuje toto řešení.
• Dalším problémem je, že GCW očekává, že adresy URL obrázků skončit s příponou obrazu typu souboru. Markowik přidává umělé rozšíření obrazu, pokud je to nutné, pro je například http://foo.bar/image změněn na http://foo.bar/image?x=x.png.


• Zkratky:
• GCW nemá značení pro zkratek ani podporu HTML tag & lt; abbr & gt ;. Markowik převádí zkratky na & lt; span & gt; -elements jaký druh napodobuje zkratek (v omezené míře samozřejmě)
.

• HTML:
• Každá rovina HTML vyskytující se ve zdroji Markdown končí doslova GCW (s výjimkou obsahu značek rozpětí úrovně). To znamená, že zdroj Markdown by měl obsahovat pouze HTML podporované GCW. Dalším důsledkem je, že URL používané v civilním HTML tagy nejsou kontrolovány na GCW kompatibilitu. Jinými slovy: při použití raw HTML jste na vlastní pěst,
!