Markowik

Markowik является Python приложение, которое преобразует Markdown форматированный текст, чтобы Google Code Wiki.
Markowik способен конвертировать большинство Markdown конструкции его Google Code вики (ГСК) эквивалентов. Вместо перечисления всех поддерживаемых преобразований, пожалуйста, посмотрите на набор тестов Markowik и его шоу случае.
Установка
Бег:
пункт установить markowik
или:
easy_install markowik
Вы также можете использовать Markowik без установки, как описано в Заплатить.
Командная строка Использование
С выхода справочной:
Использование: markowik [-h] [--mx [MX [MX ...]]] [URL --image-BaseUrl]
& NBSP; [- HTML-изображения] [--encoding КОДИРОВАНИЯ] [--quiet]
& NBSP; INFILE [OUTFILE]
Преобразование Markdown в Google Code Wiki.
позиционные аргументы:
& NBSP; INFILE уценки файл
& NBSP; OUTFILE вики файл (по умолчанию: стандартный вывод)
необязательные аргументы:
& NBSP; -h, --help показать эту справку и выйти
& NBSP; - х [MX [MX ...]] расширений уценки, чтобы активировать
& NBSP; - изображения BaseUrl URL базы URL предварять относительным местах изображения
& NBSP; - HTML-изображения всегда использовать HTML для изображений
& NBSP; - кодирования Кодирование Кодирование входа и выхода (по умолчанию: UTF8)
& NBSP; - тихие отключить информационные сообщения
Расширения Markdown может быть дано аналогично в Python уценки (PyMD) инструмент командной строки, с тем исключением, что отдельные расширения должны быть разделены пробелом:
markowik входных --mx таблицы def_list
В настоящее время поддерживаются (т.е. проверенные) расширений сокр, таблицы и def_list. Другие расширения в целом должны работать тоже, но может дать неожиданные результаты в преобразованном тексте вики.
Относительно опционных --html-изображений, см ниже пояснения на ограничения.
Программный Использование
Markowik реализуется в Python. Модуль обеспечивает markowik функцию с именем Convert. Семантически он похож на интерфейс командной строки (ключевые аргументы соответствуют параметры командной строки). Вот краткий пример использования:
>>> Импорта markowik
>>> Markowik.convert ("Некоторые * * уценки текст ...", MX = ['таблицы'])
Текст u'Some _markdown_ ...
Страница Прагмы
ГСК страница псевдокомментарии может быть установлен в Markdown исходных файлов, как мета-данных в формате, определенном в мета расширения PyMD:
>>> SRC = "" "Описание: краткое страница
... Метки: некоторые, этикетки
...
... Здесь начинается * * .. страница
... "" "
>>> Печати markowik.convert (SRC, х = ['мета'])
#summary итоговая страница
#labels некоторые, этикетки

Здесь начинается _page_ ..
Обратите внимание, что мета добавочный номер должен быть включен явно, т.е. по умолчанию Markowik не признает страницы директив

Что нового В этом выпуске:.

< UL>

Что нового в версии 0.1.1:.

• Улучшена документация
• Исправлены.

Требования

• Python

Ограничения

• ГСК не может выразить всю возможную разметку в Markdown. Это означает, Markdown исходные файлы должны быть написаны со следующими ограничениями в виду.


• bbli URL-адреса в ссылки и изображения:
• URL-адреса, используемые для ссылок или источников изображения должны быть абсолютным и должны быть определенный протокол, чтобы признанный ГСК. В частности, любая ссылка должна начинаться с HTTP: //, HTTPS: //, или FTP: //. Markowik прерывает преобразование, если он находит адреса не соответствующие этим требованиям.


• Typefacing в Link имен:
• ГСК не поддерживает typefacing в тексте ссылки. Например ГСК оказывает имя ссылки в [http://foo.com _Foo_] буквально, то есть как _Foo_. Тем не менее, ГСК признает typefacing в HTML ссылки, т.е. & LT; HREF = & Quot; HTTP: //foo.com" & GT; _Foo_ & Lt; / а и GT; Подчеркивается, правильно. По этой причине Markdown связей с вложенной typefacing как [*] Foo * (http://foo.com) будут преобразованы в HTML ссылки. В результате, ссылка этикетки с некоторых специальных символов, которые должны быть экранированы в ГСК, используя Обратные (`) маркеры также приведет к HTML ссылки.

<класс Li = "bbli"> Вложенные Пункты:
• ГСК на самом деле не поддерживают несколько вложенных пунктов (например, в списках или Цитаты). Markowik имитирует несколько вложенных пунктов, разделяя их с & Lt; ш / & GT; (который визуально имитирует пункты, но не сломать вложенности среды).

<класс Li = ""> bbli Изображения:
• уценки позволяет выразить альтернативные и название тексты для изображений. Синтаксис изображения ГСК не поддерживает это. Единственный способ сохранить эти тексты, чтобы использовать простой HTML & Lt; IMG & GT; тэги. Опция --html-изображения позволяет это временное решение.
• Другой вопрос, что ожидает ГСК изображения URL-адреса, чтобы закончить с расширением изображения типа файла. Markowik добавляет искусственных расширения изображения, если необходимо, например http://foo.bar/image изменяется http://foo.bar/image?x=x.png.

<класс Li = "bbli"> Сокращения:
• ГСК не имеет разметку для сокращений и не поддерживает HTML тег & Lt; сокр & GT ;. Markowik преобразует аббревиатуры для & Lt; продолжительность и GT; -элементы, какой вид имитирует сокращений (в ограниченных, конечно)
.

• HTML
• Любая обычная HTML происходит в источнике Markdown заканчивается буквально в ГСК (за исключением содержания тегов чистоте уровня). Это означает, что источник уценки должен содержать только HTML, поддерживаемый ГСК. Еще одним следствием является то, что URL-адреса, используемые в простых тегов HTML не проверяются на совместимость ГСК. Другими словами: при использовании сырья HTML вы находитесь на свой собственный
!