Web Documentation Typesetter
Система подготовки документации для публикации в Web

Вступление

Web Documentation Typesetter (WDT) предназначен в основном для подготовки статей по программированию и документации к программам.

Основные характеристики WDT:

Ближе к делу

Вместо множества слов эффективнее привести реальный пример простой статьи:

.    title : Пишем программу Hello World на C++
.   author : Станислав Ягло | stas@plg.lrn.ru
.     date : 2005-11-08
. abstract : В статье рассказывается о том, как написать простую программу на языке C++.
     
%% Начало текста
.sect:                                    Ваша первая программа

    Меньше слов, больше дела:

.code: cpp
#include <iostream>

int main(int argc, char *argv[])
{
    std::cout << "Hello World!" << std::endl;
}
.endcode

    В первой строке при помощи команды препроцессора *|#include|* мы включаем заголовочный файл
    с функциями ввода-вывода.

    ..... ..... .....

.sect:                                     Компиляция

    Для компиляции нашей программы нужно ввести следующую команду:

.cmd
g++ hello.cpp -o hello
.endcmd

    Для запуска:

.cmd:  ./hello

    Вот и все.

Тег title задает название документа и может встречаться в документе всего один раз. (Есть идея, что документ должен начинаться только с него.) Тег author задает имя автора и после знака | ссылку на него, т.е. адрес email или ссылку на домашнюю страницу. Тег author может встречаться несколько раз. date задает дату публикации статьи (в такой же форме, как в примере). Если дата не указана, атоматически подставляется дата сборки документа, т.е. его преобразования в HTML-код. Тег abstract содержит краткое описание документа. Эта информация будет записана в HTML в атрибуте description тега <meta>, а также перед статьей курсивом (в стандартном шаблоне). abstract, также как и title, может встречаться в статье только один раз.

ДОПОЛНИТЬ

Что еще будет

  1. Включение других файлов тегом include.
  2. Вставка изображений.
  3. Ссылки внутри документа.
  4. ДОПОЛНИТЬ