СделатьДок

MakeDoc — это легкий язык разметки, созданный в 2000 году Карлом Сассенратом для создания документации и веб-страниц с использованием простых текстовых обозначений. ^{[ 1 ]} Этот язык широко используется сообществом REBOL для документации, веб-сайтов и вики.

Обзор

MakeDoc изначально был разработан, чтобы позволить авторам создавать форматированную документацию без необходимости использования программного обеспечения для обработки текста. ^{[ 2 ]} Для ввода можно использовать любой обычный текстовый редактор, включая веб-формы ввода, а на выходе может быть HTML , PDF или обычный текст. ^{[ 2 ]}

Дополнительная цель MakeDoc заключалась в том, чтобы сам формат текстового ввода был читабельным, не перегруженным нотациями разметки, обычно встречающимися в языках разметки на основе SGML, таких как HTML и XML . Это было сделано для того, чтобы обеспечить распространение документации для пакетов программного обеспечения, при этом такие документы часто просматриваются (или даже создаются) в текстовых командных оболочках.

Основной формат

Формат MakeDoc предназначен для ввода и редактирования из любого текстового редактора, в том числе часто используемого в оболочках-средах, таких как vi и Emacs .

Заголовки, заголовки и абзацы

Title of document

    Optional boiler plate
    Such as author name, date, etc.

=== Primary headings

This is an example paragraph. All this text will remain in
the same paragraph until a blank line is reached.

This is a separate paragraph.

--- Subheading

Text continues from here...

Командные строки

Маркеры, числовые списки, определения и другие специальные форматы документов обозначаются путем начала строки специальным символом.

Например:

*Bullet item

*Another 

#Numbered item

#Another numbered item

Другие командные строки начинаются с знака равенства (=), за которым следует сама команда.

Например, чтобы включить изображение:

=image nyc.jpg

Также предусмотрены многие другие команды. См. справочные ссылки ниже.

Специальные команды

Язык также позволяет оценивать (выполнять) участки кода для получения результатов, например, или вывода изображений. Это позволяет точно генерировать разделы кода, содержащие точные результаты.

Например, если команда:

=view

Как следует из примера кода, процессор автоматически сгенерирует изображение любого кода, отображаемого в его окне.

Обработка языка

Язык MakeDoc обрабатывается с помощью бесплатного скрипта под открытой лицензией BSD . ^{[ 3 ]} Его исходный код написан на языке REBOL и весит всего около 17 КБ.

Процессор разделен на сканер ввода текста и генератор вывода. Выходные данные сканера имеют формат блока REBOL и могут быть введены в один из нескольких форматировщиков вывода.

Генератор вывода HTML включен в стандартный сценарий MakeDoc. Генераторы вывода для PDF являются отдельными.

Ссылки

^ Страница REBOL MakeDoc
^ Перейти обратно: ^а ^б Истоки MakeDoc
^ Исходный код MakeDoc (открытый исходный код BSD)

См. также

Легкий язык разметки
MakeDoc Pro (бесплатные расширения для MakeDoc)

[1] Страница REBOL MakeDoc

[origins-2] Перейти обратно: ^а ^б Истоки MakeDoc

[3] Исходный код MakeDoc (открытый исходный код BSD)

[ 1 ]

[ 2 ]

[ 3 ]