ttreep - Интернет в облаке

ПРОГРАММА:

ИМЯ

Template :: Tools :: ttree - Обрабатывает все деревья каталогов шаблонов

СИНТАКСИС

ttree [параметры] [файлы]

ОПИСАНИЕ

Команда дерево скрипт используется для обработки целых деревьев каталогов, содержащих файлы шаблонов. В
результат обработки каждого файла затем записывается в соответствующий файл в
целевой каталог. Скрипт сравнивает время модификации исходного и
файлы назначения (где они уже существуют) и обрабатывает только те файлы, которые были
изменен. Другими словами, это эквивалент make для Template Toolkit.

Он поддерживает ряд параметров, которые можно использовать для настройки поведения, определения местоположения.
и установите параметры Template Toolkit. Сценарий сначала читает .ttreerc файл конфигурации
в каталоге HOME или альтернативном файле, указанном в среде TTREERC
Переменная. Затем он обрабатывает любые аргументы командной строки, включая любые дополнительные
файлы конфигурации, указанные с помощью параметра "-f" (файл).

Команда .ttreerc Конфигурация Файл
Когда вы запускаете дерево впервые он спросит вас, хотите ли вы, чтобы он создал .ttreerc
файл для вас. Он будет создан в вашем домашнем каталоге.

$ дерево
Вы хотите, чтобы я создал для вас образец файла .ttreerc?
(файл: /home/abw/.ttreerc) [да / нет]: да
/home/abw/.ttreerc создан. Пожалуйста, отредактируйте соответствующим образом и повторно запустите ttree

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

Минимальный .ttreerc:

# игнорировать эти файлы
игнорировать = \ b (CVS | RCS) \ b
игнорировать = ^ #
игнорировать = ~ $

# копируем эти файлы
copy = \. (gif | png | jpg | pdf) $

# рекурсивно переходить в каталоги
рекурсию

# предоставить информацию о том, что происходит
подробный

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

cfg = /home/abw/.ttree

Параметр командной строки "-f" можно использовать, чтобы указать, какой файл конфигурации должен быть
использовал. Вы можете указать имя файла, используя абсолютный или относительный путь:

$ ttree -f /home/abw/web/example/etc/ttree.cfg
$ ttree -f ./etc/ttree.cfg
$ ttree -f ../etc/ttree.cfg

Если файл конфигурации не начинается с "/" или "." или что-то похожее на
Абсолютный путь MS-DOS (например, «C: \\ etc \\ ttree.cfg»), затем дерево будет искать это в
каталог, указанный параметром "cfg".

$ ttree -f test1 # /home/abw/.ttree/test1

Опцию "cfg" можно использовать только в .ttreerc файл. Все остальные варианты можно использовать
в .ttreerc или любой другой дерево конфигурационный файл. Все они также могут быть указаны как
параметры командной строки.

Помните, что .ttreerc всегда обрабатывается до любой файл конфигурации, указанный с помощью
параметр "-f". Некоторые параметры, такие как "lib", можно использовать любое количество раз и
накапливают свои ценности.

Например, рассмотрим следующие файлы конфигурации:

/home/abw/.ttreerc:

cfg = /home/abw/.ttree
lib = / usr / local / tt2 / шаблоны

/home/abw/.ttree/myconfig:

библиотека = / главная / abw / веб / пример / шаблоны / библиотека

После появления дерево вызывается следующим образом:

$ ttree -f myconfig

опция "lib" будет установлена ​​в следующие каталоги:

/ usr / местные / tt2 / шаблоны
/ главная / abw / веб / пример / шаблоны / библиотека

Любые шаблоны, расположенные в / usr / местные / tt2 / шаблоны будет использоваться вместо тех
находится под / главная / abw / веб / пример / шаблоны / библиотека. Это может быть то, что вы хотите, но тогда
опять же, может и нет. По этой причине рекомендуется сохранять .ttreerc Как просто
по возможности и используйте разные файлы конфигурации для каждого дерево проект.

Каталог Возможности
Параметр "src" используется для определения каталога, содержащего исходные шаблоны, которые будут
обработанный. Его можно указать как параметр командной строки или в файле конфигурации как
показано здесь:

SRC = / Главная / ABW / Интернет / пример / шаблоны / SRC

Каждый шаблон в этом каталоге обычно соответствует одной веб-странице или другому
документа.

Параметр «dest» используется для указания каталога назначения для сгенерированного вывода.

dest = / home / abw / web / example / html

Параметр "lib" используется для определения одного или нескольких каталогов, содержащих дополнительную библиотеку.
шаблоны. Эти шаблоны сами по себе не являются документами и обычно состоят из
меньшие по размеру модульные компоненты, такие как верхние и нижние колонтитулы и меню, которые включены в
шаблоны страниц.

библиотека = / главная / abw / веб / пример / шаблоны / библиотека
lib = / usr / local / tt2 / шаблоны

Опцию «lib» можно многократно использовать для добавления дополнительных каталогов в путь поиска.

Список шаблонов можно передать в дерево как аргументы командной строки.

$ ttree foo.html bar.html

Он ищет эти шаблоны в каталоге "src" и обрабатывает их через
Template Toolkit, используя любые дополнительные компоненты шаблона из каталогов "lib".
Сгенерированный вывод затем записывается в соответствующий файл в каталоге "dest".

If дерево вызывается без явного указания каких-либо шаблонов для обработки, тогда он
обработает каждый файл в каталоге "src". Если установлен параметр "-r" (рекурсивный), то
он будет дополнительно перебирать подкаталоги, обрабатывать и другие шаблоны
файлы, которые он там находит.

$ тдерево -r

Если шаблон был обработан ранее, дерево сравнит время модификации
исходный и целевой файлы. Если исходный шаблон (или тот, от которого он зависит) имеет
не был изменен позже, чем сгенерированный выходной файл, тогда дерево не будет обрабатывать
Это. -a (все) опция может использоваться для принудительного дерево обрабатывать все файлы независимо от
время модификации.

$ дерево -а

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

Файл Возможности
Параметры "игнорировать", "копировать" и "принять" используются для указания регулярного выражения Perl для фильтрации файла.
имена. Файлы, соответствующие любой из опций «игнорировать», обрабатываться не будут. Оставшийся
файлы, соответствующие любому регулярному выражению «копия», будут скопированы в целевой каталог.
Оставшиеся файлы, которые затем соответствуют любому из критериев "принятия", затем обрабатываются через
Набор инструментов для шаблонов. Если не указан параметр accept, то все файлы будут приняты
для обработки, если он еще не скопирован или проигнорирован.

# игнорировать эти файлы
игнорировать = \ b (CVS | RCS) \ b
игнорировать = ^ #
игнорировать = ~ $

# копируем эти файлы
copy = \. (gif | png | jpg | pdf) $

# принимать только шаблоны .tt2
accept = \ .tt2 $

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

суффикс tt2 = html

Или в командной строке

--suffix tt2 = html

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

Опция «binmode» используется для установки кодировки выходного файла. Например, используйте
«--binmode =: utf8», чтобы установить формат вывода в Юникод.

шаблон Зависимости
Параметры «Depension» и «Depension_file» позволяют указать, каким образом любой заданный файл шаблона
зависит от другого файла или группы файлов. Параметр «зависеть» используется для выражения
единственная зависимость.

$ ttree --depend foo = bar, baz

В этом примере командной строки показан параметр «--depend», используемый для указания того, что Foo
файл зависит от бар и Баз шаблоны. Эту опцию можно использовать много раз на
командная строка:

$ ttree --depend foo = bar, baz --depend crash = bang, wallop

или в файле конфигурации:

зависеть foo = bar, baz
зависеть сбой = удар, удар

Файл, расположенный слева от "=", указывается относительно "src" или "lib".
каталоги. Файл (ы), отображаемый справа, можно указать относительно любого из этих файлов.
каталоги или как абсолютные пути к файлам.

Например:

$ ttree --depend foo = bar, / tmp / baz

Чтобы определить зависимость, которая применяется ко всем файлам, используйте «*» слева от «=».

$ ttree --depend * = верхний колонтитул, нижний колонтитул

или в файле конфигурации:

зависеть * = верхний колонтитул, нижний колонтитул

Любые шаблоны, определенные в «pre_process», «post_process», «process» или
параметры "оболочки" будут автоматически добавлены в список глобальных зависимостей, которые
применяются ко всем шаблонам.

Параметр «файл_в зависимости» может использоваться для указания файла, содержащего зависимость.
Информация.

$ ttree --depend_file = / home / abw / web / example / etc / ttree.dep

Вот пример файла зависимости:

# Это комментарий. Это игнорируется.

index.html: строка меню нижнего колонтитула

заголовок: заголовок горячих ссылок

Menubar: menuitem

# охват нескольких строк обратной косой чертой
another.html: строка меню нижнего колонтитула \
форма поиска на боковой панели

Строки, начинающиеся с символа «#», являются комментариями и игнорируются. Пустые строки также
игнорируется. Все остальные строки должны содержать имя файла, за которым следует двоеточие, а затем список
зависимые файлы, разделенные пробелами, запятыми или обоими. Пробел вокруг двоеточия
также необязательно. Строки, заканчивающиеся символом "\", продолжаются до следующей строки.

Файлы, содержащие пробелы, можно цитировать. Это необходимо только для файлов после двоеточия
(':'). Файл перед двоеточием может быть заключен в кавычки, если он содержит двоеточие.

Как и в случае с параметрами командной строки, символ «*» можно использовать как подстановочный знак для указания
зависимость для всех шаблонов.

*: конфигурация, заголовок

шаблон Инструментарий Возможности
дерево также предоставляет доступ к обычному набору опций Template Toolkit. Например,
--pre_chomp и --post_chomp дерево параметры соответствуют «PRE_CHOMP» и
Параметры «POST_CHOMP».

Запустите «ttree -h», чтобы просмотреть список доступных опций.

АВТОРЫ

Энди Уордли[электронная почта защищена]>

<http://www.andywardley.com/>

При участии Дилана Уильяма Хардисона (поддержка зависимостей) Брайс
Харрингтон («абсолютный» и «относительный» варианты), Марк Андерсон («суффикс» и «отладка»
варианты), Харальд Йорг и Леон Брокар, которые, кажется, добираются повсюду.

Версия

2.68, распространяемая как часть Template Toolkit версии 2.19, выпущенная 27 апреля 2007 года.

АВТОРСКИЕ ПРАВА

Авторское право (C) 1996-2007 Энди Уордли. Все права защищены.

Этот модуль является бесплатным программным обеспечением; вы можете распространять его и / или изменять под тем же
термины как сам Perl.

Используйте ttreep в Интернете с помощью сервисов onworks.net