# Шаблоны файлов

Anders
Lund

    anders@alweb.dk

Пн 16 Фев 2004
0.1

KDE
kate
kdeaddons
шаблон
макрос

# Введение

Модуль шаблонов файлов позволяет вам создавать файлы основанные на других. Вы можете использовать любой файл как шаблон, который создаст копию файла с пустой строкой URL или использовать специальный шаблон, который может содержать макросы заполнения информации, такие как ваше имя или адрес электронной почты, текущая дата и т.д., поместить курсор в подходящую позицию в новом файле.

В дальнейшем, шаблоны расположенные в каталоге шаблонов, будут представлены в пункте меню Файл Из шаблона..

Модуль также предоставляет метод лёгкого создания нового шаблона из открытого документа.

Каталоги шаблонов - часть файловой системы &kde; и состоятиз KDEDIR/share/applications/kate/plugins/katefiletemplates/templates и KDEHOME/share/applications/kate/plugins/katefiletemplates/templates. Если переменная окружения KDEDIRS содержит дополнительные каталоги, в них также будет проведен поиск схожих подкаталогов. если найдены одноимённые шаблоны, то будет использован шаблон в локальном каталоге (KDEHOME).

## Структура меню

Файл Создать из шаблона Выбрать файл...

  Представляет вам диалог Открыть файл, который позволяет использовать любой файл как шаблон. Если выбранный файл имеет расширение `katetemplate` в нём будут произведены поиск и подстановка макросов.

Файл Создать из шаблона Недавние

  Представляет список недавно открытых файлов, использованых в качестве шаблона, представленый в виде их URL.

Файл Создать из шаблона

  Оставшиеся подменю содержат ссылки на шаблоны. Выберите пункт меню, чтобы создать файл.

Настройки Настроить шаблоны

  Откроет диалог со списком всех шаблонов, найденных в директории шаблонов, вместе с настройками добавить, изменить или удалить.

## Использование шаблон &kate;

Во время создания файла по шаблону, который содержит макросы, некоторые из них показаны как редактируемые переменные в тексте. Такие переменные выглядят как подчёркнутые слова в тексте.

Сразу будет выделена первая такая переменная, так что для введения её значения нужно будет просто набрать его. Если в тексте встречаюется несколько переменных с таким же именем, их значение также будет изменено. Для перехода к следующей переменной, нажмите TAB. После изменения последней переменной, клавиша TAB будет работать в обычном режиме.

## Создание ваших собственных шаблонов

Чтобы создать новый шаблон, воспользуйтесь пунктом Настройки Управление шаблонами.... В нём нажмите Создать... для запуска мастера шаблонов. Будет задан вопрос о дополнительном файле, для обращения его в шаблон и о параметрах шаблона, после чего он будет создан.

Шаблон можно создать и вручную - просто добавьте заголовок шаблона в начало нового файла, и макросы, затем сохраните его с расширением `katetemplate`.

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

## Редактирование шаблонов

Чтобы редактировать шаблоны, используйте пункт Управление шаблонами.... Выберите шаблон, с которым хотите работать и намжите Изменить.... Отредактируйте открывшийся файл и сохраните его. Изменения в шаблоне будут приняты и вы сможете активировать шаблон, для проверки ваших изменений сразу после сохранения.

## Формат шаблонов Kate

Если вы используете файлы с расширением `katetemplate`, в них будет произведен поиск заголовка шаблона, макросов и положения курсора.

### Заголовок шаблона

Во время чтения файла, анализатор сохраняет строки, начинающиеся со слова `katetemplate:` и ищет в них информацию шаблона в форме ИМЯ_ПЕРЕМЕННОЙ=ЗНАЧЕНИЕ. Первая строка, не начинающаяяся с `katetemplate:` сообщает о начале содержимого шаблона. ЗНАЧЕНИЕ может содержать любые знаки кроме знака равенства (=). Правильные имена переменных:

`Template`

  Имя шаблона, показываемое в меню Файл Из шаблона.

`Group`

  Помещает шаблон в подменю Файл Из шаблона.

`Name`

  Это имя, которое будет присвоено для документа и отображено в списке файла и заголовке окна. Если имя содержит `%N` оно будет заменено цифрой-инкрементом, увеличивающимся, если файл с таким именем уже существует.

`Highlight`

  Модуль попытается установить режим подсветки синтаксиса для нового документа в значение этой переменной. Значение должно быть как в меню Сервис Режим подсветки .

`Description`

  Короткое информативное описание шаблона. Это используется для установки строки "Что это" пункта меню, но может быть использовано и для других целей в будущем.

Author

  Строка, обозначающая автора, например в виде `Имя <эл почта>` Это используется для установки строки "Что это" пункта меню, но может быть использовано и для других целей в будущем.

### Макросы шаблона

Во время анализа содержимого шаблона, макросы в виде `%{NAME}` или `${NAME}` подставляются реальными значениями. Если вы используете префикс `$`, макрос, станет редактируемой переменной, когда документ будет создан по шаблону, в отличии от `%`, в случае которого это произойдёт только если не удастся найти значение шаблона.

Допустимы следущие макросы:

time

  Текущее время в формате вашей локали.

date

  Текущая дата в сокращённом формате.

datetime

  Текущие дата и время, в виде строки, в соответствии с вашей локалью.

year

  Текущий год в формате четырёх цифр.

month

  Полное имя текущего месяца, в соответствии с вашей локалью.

day

  Текущий день месяца.

hostname

  Имя вашего компьютера.

index

  Расширяется в 'i'

fullname

  Ваше полное имя, как определено владельцем в вашей стандартной адресной книге KDE.

firstname

  Ваше имя, как определено в поле владельца в адресной книге KDE.

lastname

  Ваша фамилия, как определено в поле владельца в стандартной адресной книге KDE.

email

  Ваш адрес электронной почты, как задано в адресе владельца в стандартной адресной книге KDE.

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

### Установка позиции курсора

Специальный макрос `${cursor}` будет заменён вертикальной чертой и добавлен к списку редактируемых переменных, вне зависимости от его положения в тексте.

## Благодарности

Модуль &kate; Шаблоны файлов © Anders Lund anders@alweb.dk, 2004.

Документация © Anders Lund, 2004

Перевод документации © Amon2501, 2004

&underGPL;