Markowik

Markowik er en Python app som konverterer Markdown formatert tekst til Google Code Wiki.
Markowik er i stand til å konvertere de fleste Markdown konstruksjoner til sine Google Code Wiki (GCW) ekvivalenter. I stedet for å liste opp alle støttede konverteringer, kan du ta en titt på Markowik testsuite og dens showet saken.
Installasjon
Løpe:
PIP installere markowik
eller:
easy_install markowik
Du kan også bruke Markowik uten installasjon, som beskrevet under Contribute.
kommandolinje bruk
Fra hjelp utgang:
bruk: markowik [h] [--mx [MX [MX ...]]] [--image-baseURL URL]
& Nbsp; [- html-bilder] [--encoding KODING] [quiet]
& Nbsp; INFILE [utfil]
Konvertere Markdown til Google Code Wiki.
posisjonelle argumenter:
& Nbsp; INFILE Markdown fil
& Nbsp; utfil wiki-fil (standard: stdout)
valgfrie argumenter:
& Nbsp; -H, Hjelpe vis denne hjelpemeldingen og exit
& Nbsp; - mx [MX [MX ...]] Markdown utvidelser for å aktivere
& Nbsp; - bilderedigerings baseURL URL basen URL til foran til relative bilde steder
& Nbsp; - html-bilder alltid bruke HTML for bilder
& Nbsp; - koding OPPTAK koding av input og output (standard: UTF8)
& Nbsp; - stille deaktivere infomeldinger
Markdown utvidelser kan gis på samme måte som til Python Markdown (PyMD) kommandolinjeverktøyet, med unntak av at enkelte utvidelser må skilles med et mellomrom:
markowik INPUT --mx tabeller def_list
De støttede tiden (dvs. testet) utvidelser er abbr, tabeller, og def_list. Andre utvidelser generelt bør arbeide også, men kan gi uventede resultater i den konverterte wiki tekst.
Når det gjelder valget --html-bilder, se forklaringene nedenfor om begrensninger.
programma Bruk
Markowik er implementert i Python. Den markowik modulen gir en funksjon som heter konvertitt. Semantisk det ligner på kommandolinjegrensesnitt (søkeord argumenter tilsvarer kommandolinjevalg). Her er en kortvarig bruk eksempel:
>>> Import markowik
>>> markowik.convert ("Noen * Markdown * tekst ...", MX = ['bord'])
u'Some _markdown_ tekst ... '
Side Pragmas
GCW side pragmas kan settes i Markdown kildefiler som metadata i formatet definert av PyMD meta forlengelse:
>>> Src = "" "Summary: siders sammendrag
... Etiketter: noen, etiketter
...
... Her starter * side * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary siders sammendrag
#labels noen, etiketter

Her starter _page_ ..
Merk at meta forlengelse må være aktivert eksplisitt, dvs. som standard Markowik gjenkjenner ikke side pragmas

Hva er nytt i denne utgaven:.

< ul>

Hva er nytt i versjon 0.1.1:.

• Forbedret dokumentasjon
• Mindre feilrettinger.

Krav :

• Python

Begrensninger :

• GCW kan ikke uttrykke alle markup mulig i Markdown. Dette betyr Markdown kildefilene bør skrives med følgende begrensninger i tankene.


• URLer i lenker og bilder:
• URLene for linker eller bildekilder må være absolutt og må ha en spesifikk protokoll for å bli gjenkjent av GCW. Spesielt må en URL starter med http: //, https: // eller ftp: //. Markowik avbryter konvertering hvis den finner webadresser ikke samsvarer med disse kravene.


• Typefacing i Link Navn:
• GCW støtter ikke typefacing i lenkenavn. For eksempel GCW gjengir navn på lenken i [http://foo.com _Foo_] bokstavelig, dvs. som _Foo_. Men gjenkjenner GCW typefacing i HTML-koblinger, dvs. & lt; a href = & quot; http: //foo.com" & Gt; _Foo_ & lt; / A & gt; Det legges vekt på riktig måte. Av denne grunn Markdown linker med nestet typefacing som [* Foo *] (http://foo.com) vil bli konvertert til HTML-koblinger. Som et resultat, link etiketter med visse spesialtegn som må rømte i GCW bruker accent grave (`) markører vil også resultere i HTML-koblinger.


• Nøstet Avsnitt:
• GCW ikke virkelig støtter flere nestede avsnitt (f.eks i lister eller blockquotes). Markowik simulerer flere nestede avsnitt ved å skille dem med en & lt; br / & gt; (Som visuelt ligner paragrafer, men bryter ikke hekkende miljø).


• Bilder:
• Markdown gjør det mulig å uttrykke alternative og tittel tekster for bilder. GCW image syntaks tillater ikke dette. Den eneste måten å bevare disse tekstene er å bruke vanlig HTML & lt; img & gt; tags. Alternativet --html-bilder gjør denne løsningen.
• En annen sak er at GCW forventer bildenettadresser til å ende med et bilde filtype. Markowik legger kunstige bilde extensions hvis det er nødvendig, for eksempel http://foo.bar/image endres til http://foo.bar/image?x=x.png.


• Forkortelser:
• GCW har ingen markering for forkortelser og heller ikke støtter det HTML-tag & lt; abbr & gt ;. Markowik konverterer forkortelser til & lt; span & gt; -elements hva slags etterligner forkortelser (i en begrenset måte selvfølgelig)
.

• HTML:
• Enhver vanlig HTML forekommer i en Markdown kilde ender opp bokstavelig talt i GCW (med unntak av innholdet i span-nivå tags). Dette betyr at Markdown kilde skal kun inneholde HTML støttes av GCW. En annen implikasjon er at URLene i enkel HTML-koder ikke blir sjekket for GCW kompatibilitet. Med andre ord: når du bruker rå HTML du er på egen hånd
!