|
|
Назначение
txt2html конвертер выполняет преобразование специальным образом подготовленных
текстовых файлов к формату html с возможной компиляцией в .chm-файл.
Краткий обзор:
Простая разметка текста
В подготовке текстовых файлов нет ничего сложного. В простейшем случае
достаточно отметить точками начало разделов и наименования.
- Разделы создаются как обычные текстовые файлы. Файл может содержать несколько
разделов.
- Каждый раздел начинается с точки в первой позиции строки. В остальных
строках раздела точки в первой позиции не допускается.
- Естественно, что внутри текста раздела уже присутствует его наименование.
Начало наименования отмечается двумя точками.
- Когда точки расставлены, файл готов к обработке.
- После обработки для каждого раздела файла получаем html-файл. Автоматически
формируются перекрестные ссылки между разделами, готовится содержание (.hhc)
и полный список разделов (.hhk) для формирования chm-файла.
Вместе с тем, разметка текста достаточно развита для создания сложных
текстов. Ниже рассматриваются некоторые возможности разметки.
Генерация перекрестных ссылок
Конвертер автоматически создаст перекрестные ссылки, подготовит файлы
содержания (.hhc), полный список разделов (.hhk), описание проекта (.hhp)
и сгенерирует html-файлы.
Выделение текста
Поддерживается большой набор способов выделения текста. Некоторые
возможности:
| Разметка | Оформление в html-файле
|
Текст можно @bвыделить@b, @iнаписать курсивом@i,
@uподчеркнуть@u, @sуменьшить@s, @lувеличить@l,
@myвыделить маркером@my, @xзачеркнуть@x ...
|
|
Текст можно выделить, написать курсивом, подчеркнуть
, уменьшить, увеличить, выделить маркером, зачеркнуть …
| |
Верхние и нижние индексы
Разметка позволяет легко включать верхние и нижние индексы в html-файл:
| Разметка | Оформление в html-файле
|
Пример верхнего X@^2 индекса
Пример нижнего A@_n+1 индекса
|
|
Пример верхнего X2 индекса
Пример нижнего An+1 индекса
| |
Автоматическая подсветка синтаксиса
Предусмотрена подсветка синтаксиса. Достаточно специальными символами
выделить в тексте блок кода и указать язык и в html-файле этот блок будет
сгенерирован с подсветкой синтаксиса. Поддерживается достаточно большой
список языков программирования. Пример:
| Разметка | Оформление в html-файле
|
@PAS
procedure test;
begin
for i := 1 to 10 do begin
writeln(i:5);
end;
end;
@
|
|
pascal
procedure test;
begin
for i := 1 to 10 do begin
writeln(i:5);
end;
end;
|
| |
Блоки кода можно полностью настраивать как и любые
другие блоки. Блок кода становится свернутым если содержит более 40 строк.
Поддержка формул 
В тестовые файлы можно включать математические формулы, написанные в
нотации После обработки формулы будут заменены рисунками.
Например:
| Разметка | Оформление в html-файле
|
$$ \cfrac1{\sqrt2+\cfrac1{\sqrt2+\cfrac1{\sqrt2+\cdots}}} $$
|
|
| |
Поддерживается бОльшая часть синтаксиса /  включая
матрицы, системы уравнений, коммутативные диаграммы.
Преобразование выражений в картинку выделено в отдельный
модуль alTex.dll.
Блоки текста
Любой блок текста можно выделить в рамку, задать цвет фона, выравнивание,
обтекание, дополнить заголовком, сделать сворачивающимся и настроить
другие параметры. Причем такая настройка может быть применена как
к ранее существовавшим блокам (выделенные абзацы, блоки кода), так и для
всех введенных вновь (таблиц, содержания, рисунков).
| Разметка | Оформление в html-файле
|
@div [< +- w50 #F5F5DC |Заголовок блока
Выделенный блок текста.
Выровнен влево, обтекаемый,
имеет кнопку сворачивания,
шириной 50%
@
Абзац справа от блока текста
|
|
Заголовок блока
Выделенный блок текста.
Выровнен влево, обтекаемый,
имеет кнопку сворачивания,
шириной 50%
Абзац справа от блока текста
| |
Выделенные абзацы
comment
Устаревшим или черновым может быть помечен не только абзац в тексте,
но и полностью весь раздел или целый файл.
Для включения в справочник часто встречающихся выделенных абзацев
предусмотрены специальные управляющие команды для некоторых видов таких
абзацев: примечаний, предупреждений, черновых частей текста, устаревших
разделов, описания ошибок, примеров вывода. Например, посмотрите на
блок комментария справа.
Выделенные абзацы можно полностью настраивать как и любые
другие блоки.
Списки
Поддерживаются два вида списков:
| Разметка | Оформление в html-файле
|
;Двухуровневые:с точкой с запятой в начале
Маркированные и нумерованные списки:
- Строка 1
# Строка 1.1.
- Строка 2
|
|
- Двухуровневые
- с точкой с запятой в начале
Маркированные и нумерованные списки:
| |
Таблицы
Разметка позволяет создавать таблицы. Например:
| Разметка | Оформление в html-файле
|
@|
@-||A |+|B
@-||1 ||2 ||3 ||4
@
|
|
| |
Как и для любых других блоков текста для таблицы можно настроить
выравнивание, обтекание, фон, сворачивание и другие параметры.
Рисунки
Рисунки, с одной стороны, вставляются так же как внешние ссылки, а
с другой имеют все настройки обычных блоков.
| Разметка | Оформление в html-файле
|
[[file:logo5.jpg|b1 [>|описание рисунка]]
|
|
| |
Также поддерживаются основные смайлики ( )
Заголовки и оглавление
Разметка позволяет выделить в тексте раздела заголовки и подзаголовки.
По сформированным заголовкам автоматически строится оглавление
раздела (возможны два варианта - полное и краткое). Кроме того,
заголовки в разделе автоматически становятся ссылками, на которые можно
ссылаться из других разделов.
Ссылки
Автоматически формируемые ссылки дополнены явно задаваемыми разметкой.
Возможно указание ссылки в середину раздела, подмена отображаемого
текста и окончания.
Поддерживаются внешние ссылки:
| Разметка | Оформление в html-файле
|
[[http://alex-Black.ru|мой сайт]]
|
|
мой сайт
| |
Сноски
Поддерживаются два вида сносок. В примере показаны сноски со звездочками.
Также можно использовать нумерованные сноски.
| Разметка | Оформление в html-файле
|
Можно использовать сноски[[*]]
со звездочками[[**]]
@*
Сноска 1
@*
Сноска 2
@
|
|
Можно использовать сноски*
со звездочками **
| |
Транскрипция
Разметка позволяет легко вставлять в текст символы транскрипции:
| Разметка | Оформление в html-файле
|
Thank you. <['thaeNk ju]>
|
|
Thank you. [ʹΘæŋk ju]
| |
Специальные символы
Поддерживается большой набор специальных символов. Для таких символов
введены сокращения. Можно указать любой unicode-символ, использовав его
код*.
| Разметка | Оформление в html-файле
|
@L @alpha @beta @gamma @L
@L @8 +- <= @L
@L <-- <<-- <~~ @L
@L a@<' @L
@L (C) (R) @L
@L ʚ @L
|
|
α β γ
∞ ± ≤
← ↞ ⇜
á
© ®
ʚ
| |
*↑В примере размер символов искуственно увеличен тэгом @L
Авто документация проектов
txt2html можно использовать для создания документации к проектам,
разрабатываемым в Delphi. Из файлов *.pas выбираются комментарии и из
этой выборки генерируются html-файлы. Разметка, применяемая в текстовых
файлах, поддерживается и файлах *.pas. Особенно удобна в этом случае
авто генерация ссылок и создание оглавлений. Кроме того, поддерживается
два вида комментариев, которые обрабатываются как текст справки. Это
позволяет прямо в файлах проекта создавать и два варианта справки - один
для разработчика по коду проекта, второй - для пользователя - как
руководство к программе.
Кодовая страница
Обрабатываются текстовые файлы в двух кодовых страницах - cp866 (старая
кодировка DOS) и windows-1251. По умолчанию html-файлы генерируются в
кодировке cp866. Это сделано для правильного отображения символов
псевдографики в справочнике (иногда это бывает удобным). При желании
кодовую страницу генерируемых html-файлов можно переключить на windows-1251.
Подготовка html-файлов для Web
Сгенерированные html-файлы можно использовать для публикации в Web.
Например, все страницы этого сайта подготовлены с помощью txt2html.
- 2.5.2
 В новой версии бо́льшая часть изменений связана с изменениями
в alTex.dll. Для работы теперь не требуется внешних шрифтов, реализованы
команды для управления шрифтами в формулах. Добавлены команды для набора
химических формул.
Текущая версия 2.5.2.
Предыдущие версии.
- 2.5.1 Значительно расширены возможности разметки по сравнению с
предыдущей версией.
|
