Справочник по WDT (ЧЕРНОВИК)

ВНИМАНИЕ: этот документ находится в стадии разработки. Если у вас есть какие-либо комментарии или предложения, огромная просьба сообщить автору (stas@plg.lrn.ru).

Содержание

Основные положения

Системные теги в WDT начинаются с точки в первом столбце строки. Далее идет имя тега и его значение после двоеточия. Если у тега несколько параметров, они разделяются знаком "|" (прямая черта). Примеры (обратите внимание на именованные параметры в последней строке):

	.title: Заголовок
	
	.  title  :    Заголовок
	
	.author : Иван Петров | ivan@petrov.net
	
	.img: "images/screenshot1.jpeg" | width = 50% | height = 50% | align = fleft

Значением параметра считается строка от первого до последнего печатного символа.

Комментарии начинаются с символов %% и продолжаются до конца строки. Многострочные - с символов %{ и заканчиваются }%.

Системные теги

Вот полный список системных тегов:

	title           author          translator      contributor
	date            version         abstract        chap
	sect            subsect         head            subhead
	img             code/ecode      cmd/ecmd        pre/epre
	note            warning         tip             html/ehtml

title

Тег title задает название документа. Он должен быть указан только один раз. Значение принимается от первго печатного символа до конца строки.

author, translator, contributor

Эти теги задают соответственно имя автора, переводчика и человека, предоставившего документ и ссылку на его email или домашнюю страницу. Может встречаться несколько раз. Синтаксис следующий:

	.author: имя [| ссылка]

Примеры:

	.     author : Иван Петров | ivan@petrov.net
	.     author : Петр Иванов | www.ivanov.ru
	.contributor : Василий Васильев

В атрибуте ссылки не нужно указывать mailto: или http://, система подставит их автоматически.

date

Дата публикации документа. Должна быть указана в формате YYYY-MM-DD. Если тег не указан, подставляется дата сборки документа.

version

Указывает версию документа. Параметр задается в свободной форме.

abstract

Содержит краткое описание документа. Эта информация будет записана в HTML в атрибуте description тега <meta>, а также перед статьей курсивом (в стандартном шаблоне). abstract, также как и title, может встречаться в документе только один раз.

chap, sect, subsect, head, subhead

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

img

Вставляет изображение. Синтаксис следующий:

	.img: ссылка [| width=ширина] [|height=высота] [| align=выравнивание]

Параметр align может принимать следующие значения:

	left, right, center, fleft, fright

Значения fleft и fright задают плавающее положение (float).

code/ecode

Тег code начинает блок исходного текста, ecode его заканчивает. Параметр тега code задает язык исходного текста. Если параметр не задан, используется язык Си. Все теги внутри блока игнорируются. Примеры:

	.code: python
	def sayHello():
	    print "Hello"
		
	sayHello()
	.ecode

pre/epre

Аналог тега <pre> в HTML.

html/ehtml

Позволяет вам использовать "сырой" HTML-код в вашем документе.

note/enote, warning/ewarning, tip/etip

Задает блоки: note - примечание, warning - предупреждение, tip - подсказка. Теги enote, ewarning, etip являются закрывающими.

Основной текст

Абзац

За абзац принимается блок текста заканчивающийся пустой строкой или тегом. Пример:

	The Free Software Foundation plays an extremely important role in the   %% Это абзац
future of Debian.  By the simple fact that they will be distributing
it, a message is sent to the world that Linux is not a commercial
	product and that it never should be, but that this does not mean that	%% абзац продолжается - 
Linux will never be able to compete commercially.  For those of you who		%% табуляция игнорируется
disagree, I challenge you to rationalize the success of GNU Emacs and
GCC, which are not commercial software but which have had quite an
impact on the commercial market regardless of that fact.

	The time has come to concentrate on the future of Linux rather than on  %% Это новый абзац
the destructive goal of enriching oneself at the expense of the entire
Linux community and its future.
.tip                                                                      %% А это уже не абзац :)
The development and distribution of
Debian may not be the answer to the problems that I have outlined in
the Manifesto, but I hope that it will at least attract enough
attention to these problems to allow them to be solved.
.etip

Списки

Ненумерованные

Элементы ненумерованного списка - блоки текста, которые начинаются с нескольких пробелов в начале (не менее двух) или знака табуляции, звездочки и самого текста. Пример:

  * Первый элемент
  * Второй
    элемент
    
  * А это уже будет воспринято как новый список

Нумерованные

Еще пока не придумал

Теги в тексте

Для выделения различных элементов в тексте применяются следующие способы:

	Файл =|/etc/fstab|= содержит таблицу /|файловых систем|/.
	*|WDT|* расшифровывается как Web Documentation Typesetter.
	~|<html>|~ - корневой тег в файле HTML.

Включение других файлов, директива .include

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

Пример:

	======= Основной файл =======
.include header.wb
.include chap01.wb
.include chap02.wb
	
	========= header.wb =========
.title: Заголовок
.author: Вася Пупкин

	========= chap01.wb =========
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.chap: Глава I

	Текст главы I

	========= chap02.wb =========
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.chap: Глава II

	Текст главы II

Получаем:

.title: Заголовок
.author: Вася Пупкин
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.chap: Глава I

	Текст главы I

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.chap: Глава II

	Текст главы II

Вопросы?

Конечно, еще много нерешенных вопросов. Основные из них:

• Как вставлять таблицы?

Пока можно использовать теги html/ehtml и в них рисовать таблицы на HTML

...

• Как ...?

Если у вас есть еще вопросы - шлите их мне на email: stas@plg.lrn.ru