Markowik

Markowik є Python додаток, що перетворює Markdown форматований текст в Google Code Wiki.
Markowik здатний конвертувати більшість Markdown конструкції його Google Code Wiki (ГСК) еквівалентів. Замість перерахування всіх підтримуваних перетворень, будь ласка, подивіться на набір тестів Markowik і його вітрині.
Установка
Пробіг:
пункт встановити markowik
або:
easy_install markowik
Ви також можете використовувати Markowik без установки, як описано в розділі Заплатити.
Командний рядок Використання
З виходу допомога:
Використання: markowik [-h] [--mx [MX [MX ...]]] [URL --image-BaseUrl]
І NBSP; [- HTML-зображення] [--encoding 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 ("Деякі * уцінки * текст ...", Мх = ['таблиці'])
Текст u'Some _markdown_ ... '
Сторінка Pragmas
ГСК сторінка директив можуть бути встановлені в Markdown вихідних файлів мета-даних у форматі, визначеному мета розширення PyMD:
>>> SRC = "" "Опис: зведена сторінка
... Мітки: деякі, етикетки
...
... Тут починається * стр * ..
... "" "
>>> Печатки markowik.convert (SRC, тх = ['мета'])
#summary підсумкова сторінка
#labels деякі, етикетки

Тут починається _page_ ..
Зверніть увагу, що мета додатковий номер повинен бути включений явно, тобто за замовчуванням Markowik не визнає сторінок Прагма

Що нового У цьому випуску :.

< UL>

Що нового у версії 0.1.1 :.

• Покращена документація
• Виправлені.

Вимоги

• Python

Обмеження

• ГСК не може висловити всю можливу розмітку в Markdown. Це означає, Markdown вихідні файли повинні бути написані з наступними обмеженнями на увазі.


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


• Typefacing за посиланням імен:
• ГСК браузер не підтримує typefacing в тексті посилання. Наприклад ГСК надає ім'я посилання в [http://foo.com _Foo_] в буквальному сенсі, тобто як _Foo_. Тим не менш, ГСК визнає typefacing в HTML посиланнях, тобто & LT; HREF = & Quot; Http: //foo.com" І GT; _Foo_ і л; / & GT; Підкреслюється належним чином. З цієї причини Markdown зв'язку з вкладеною typefacing як [* Foo *] (http://foo.com) будуть перетворені в HTML посилання. В результаті, посилання етикетки з деяких спеціальних символів, які повинні бути екрановані в ГСК за допомогою Зворотні (`) маркери також призведе до HTML посилання.

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

<Клас Li = "bbli"> Зображення:
• Markdown дозволяє висловити альтернативні і назва тексти для зображень. Синтаксис зображення ГСК в браузер не підтримує цього. Єдиний спосіб зберегти ці тексти, щоб використовувати простий 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 закінчується буквально в ГСК (за винятком змісту тегів чистоті рівня). Це означає, джерелом Markdown повинен містити тільки HTML, підтримуваний ГСК. Ще одним наслідком є ​​те, що URL-адреси, використовувані в простих тегів HTML не перевіряються на сумісність ГСК. Іншими словами: при використанні сировини HTML ви за своїм розсудом
!