Markowik

Markowik est une application Python qui convertit Markdown du texte formaté à Google Code Wiki.
Markowik est capable de convertir la plupart des constructions de Markdown à ses Google Code Wiki (GCW) équivalents. Plutôt que d'énumérer toutes les conversions prises en charge, se il vous plaît jeter un oeil à la suite de tests de Markowik et son show case.
Installation
Exécutez:
pip installer markowik
ou:
easy_install markowik
Vous pouvez également utiliser Markowik sans installation, comme décrit dans Contribute.
Utilisation en ligne de commande
De la sortie de l'aide:
utilisation: markowik [-h] [--mx [MX [MX ...]]] [--image-baseurl URL]
& Nbsp; [- html-images] [CODER --encoding] [--quiet]
& Nbsp; INFILE [OUTFILE]
Convertir Markdown à Google Code Wiki.
arguments de position:
& Nbsp; fichier démarque INFILE
& Nbsp; fichier wiki OUTFILE (par défaut: stdout)
arguments optionnels:
& Nbsp; -h, --help afficher ce message d'aide et de sortie
& Nbsp; - mx [MX MX [...]] extensions de démarques pour activer
& Nbsp; - image baseurl base URL URL d'ajouter au début de l'emplacement des images relatives
& Nbsp; - html-images utilisent toujours HTML pour les images
& Nbsp; - encodage encodage de codage entrée et de sortie (par défaut: UTF8)
& Nbsp; - calme messages d'information désactiver
extensions Markdown peuvent être donnés de manière similaire à l'outil de ligne de commande Python Markdown (PyMD), à l'exception que les extensions individuelles doivent être séparés par un espace:
markowik les tables de ENTRÉE def_list
Les extensions actuellement pris en charge (c.-à-testés) sont abbr, tables et def_list. Autres extensions doivent généralement travailler trop, mais pourraient donner des résultats inattendus dans le texte wiki convertie.
Concernant les options --html-images, voir les explications ci-dessous à Limitations.
Utilisation programmatique
Markowik est mis en œuvre en Python. Le module de markowik fournit une fonction nommée converti. Sémantiquement, il est similaire à l'interface de ligne de commande (arguments mots clés correspondent à commander options de ligne). Voici un exemple d'utilisation de courte:
>>> Markowik d'importation
>>> markowik.convert ("Certains démarque * * texte ...", mx = ['tables'])
u'Some de texte ... '
Page Pragmas
GCW pages pragmas peuvent être définies dans les fichiers source Markdown que les méta-données dans le format défini par la méta prolongation PyMD:
>>> Src = "" "Résumé: résumé d'une page
... Libellés: certains, étiquettes
...
... Ici commence la page * * ..
... "" "
>>> Print markowik.convert (src, mx = ['meta'])
#summary résumé d'une page
#labels certains, étiquettes

Ici commence l'_page_ ..
Notez que la méta extension doit être activé explicitement, par défaut Markowik ne reconnaît pas la page pragmas

Ce qui est nouveau dans cette version:.

< ul>

Ce qui est nouveau dans la version 0.1.1:.

• Amélioration de la documentation
• Corrections mineures.

Exigences :

• Python

Limites :

• GCW ne peut pas exprimer tout balisage possible dans Markdown. Cela signifie fichiers source Markdown doivent être écrits avec les restrictions suivantes à l'esprit.


• bbli URL dans Liens et images:
• URL utilisées pour des liens ou des sources d'image doivent être absolue et doivent avoir un protocole spécifique de se faire reconnaître par GCW. En particulier, toute URL doit commencer par http: //, https: // ou ftp: //. Markowik interrompt la conversion si elle constate des URL qui ne correspondent pas à ces exigences.


• Typefacing dans les noms Lien:
• GCW ne supporte pas typefacing nom de lien. Par exemple GCW rend le nom du lien dans [http://foo.com _Foo_] littéralement, ce est à dire que _Foo_. Cependant, GCW reconnaît typefacing dans les liens HTML, ce est à dire & lt; a href = & quot; http: //foo.com" & Gt; & lt _Foo_; / A & gt; est soulignée correctement. Pour cette raison liens Markdown avec typefacing imbriqué comme [* Foo *] (http://foo.com) seront converties en liens HTML. En conséquence, les étiquettes de lien avec certains caractères spéciaux qui doivent être échappé en utilisant GCW backtick (`) marqueurs seront également entraîner des liens HTML.


• imbriqué paragraphes:
• GCW ne supporte pas vraiment plusieurs paragraphes imbriqués (par exemple dans des listes ou des blocs de citation). Markowik simule plusieurs paragraphes imbriqués en les séparant par un & lt; br / & gt; (Qui imite paragraphes visuellement, mais ne rompt pas l'environnement de nidification).


• bbli Images:
• Markdown permet d'exprimer des textes alternatifs et le titre pour les images. La syntaxe de l'image de GCW ne supporte pas cela. La seule façon de préserver ces textes est d'utiliser HTML brut & lt; img & gt; balises. L'option --html-images permet cette solution de contournement.
• Un autre problème est que GCW attend URL d'image pour se terminent par une extension du type de fichier d'image. Markowik ajoute extensions d'image artificielle si nécessaire, par exemple http://foo.bar/image est changé en http://foo.bar/image?x=x.png.


• abréviations:
• GCW a sans majoration pour les abréviations ni ne en charge la balise HTML & lt; & gt ;. abbr Markowik convertit abréviations pour & lt; durée & gt; -elements quel type de imite abréviations (de façon limitée bien sûr)
.

• HTML:
• Ne importe quel HTML brut se produisant dans une source de Markdown finit littéralement dans GCW (à l'exception du contenu des tags durée niveau). Cela signifie que la source de Markdown ne doit contenir HTML soutenu par GCW. Une autre conséquence est que les URL utilisées dans les balises HTML simples ne sont pas vérifiées pour la compatibilité GCW. En d'autres termes: lorsque vous utilisez HTML brut vous êtes sur votre propre
!