Подробно о шаблонах
- Введение;
- Создание исходного файла;
- Система тегов;
- Дополнительные настройки шаблона;
- Панель инструментов;
Введение
INCAS позволяет создавать документы через заранее определенные шаблоны.
Перед вами появляется три поля ввода и две области редактирования.
Поле Файл шаблона должно содержать название файла, включая расширение .docx (стандартное расширение Microsoft Word 2007 и выше) или расширение .xlsx (стандартное расширение Microsoft Excel 2007 и выше).
Обратите внимание, что исходный файл шаблона может быть только в расширениях .docx и .xlsx. Файлы с расширениями .doc, .rtf, .docm, .docm, .dotm, .dot, .xls и т.д. не будут приниматься программой, поскольку они неоптимальны для работы.
Не рекомендуется вбивать название файла вручную, лучше нажать на кнопку с троеточием, расположенную справа от поля и выбрать этот файл из каталога файлов.
Поле Категория обязательно для заполнения. Если его заполнить, то шаблон будет отображаться во вкладе с тем названием, которое будет указано.
Поле Имя шаблона должно быть уникальным и также не может быть пустым.
Создание исходного файла
Для создания исходного файла шаблона подойдет любой файл в формате .docx или .xlsx, который может содержать в себе заранее определенный набор данных в формате текстов, таблиц, картинок и т.д. Такая информация называется "статичной" и INCAS гарантирует, что не будет её изменять.
"Изменяемая" информация будет вставляться в документ через так называемые теги. Тег — это идентификатор поля, вместо которого программой будет подставлена информация из формы. Тег должен совпадать с уникальным именем поля, и внутри своего имени не должен содержать следующие символы: !, @, ", $, ;, %, ^, /, *, а также символ пробела.
Технические ограничения для исходных файлов: не рекомендуется использовать ватермарки (в MS Word именуются как "подложки") — может привести к сбою в работе программы при открытии окна предварительного просмотра документа.
Система тегов
Теги оформляются следующим образом:
[Название тега]
Ограничения при именовании тегов:
Допустим, в нашем файле указана следующая информация:
Я, [ФИО], прошу отчислить меня в связи с переводом в [Университет]
Здесь, тегами ожидаемо станут ФИО и Университет.
Для того, чтобы облегчить процесс заполнения полей документа, в INCAS предусмотрено 11 типов заполнения:
"Короткий текст" позволяет вводить данные в форму напрямую, обычно этот тип заполнения применяется для ФИО, паспортных данных, ИНН, и иной информации, которая не представляет из себя громоздкую строку.
Для этого типа допускается ввод значения по-умолчанию и описание.
Технические подробности:
1. Лимит по количеству знаков (включая пробелы) составляет 120 символов.
2. Переносы использовать нельзя.
Многострочный текст, напротив, разрешает вводить большой текст в поле. Обычно этот тип заполнения применяется для описания чего-либо при условии, что конечный результат не поддается шаблонизации и генерации.
Технические подробности:
1. Лимит по количеству знаков (включая пробелы) составляет 1200 символов.
2. Переносы использовать можно.
Перечисление используется в тех случаях, когда есть строго определенный набор значений, которые могут быть использованы в рамках данного поля и никакие другие не должны допускаться. Например, пол (мужской/женский) или статус физического лица (гражданин/лицо без гражданства).
В тех случаях, когда набор значений слишком велик или постоянно изменяется, а также присутствует в нескольких шаблонах в одинаковом виде, следует использовать тип заполнения "Данные".
Данный тип заполнения требует привязки к типу объекта в пользовательской базе данных. В форме создания документа при нажатии на кнопку ... откроется список доступных значений. Выбрав нужную запись, необходимо нажать на кнопку "Выбрать" в левом нижнем углу окна.
Дата позволяет выбрать нужную дату и вывести ее в документ в нужном форматировании.
Наиболее типичные виды форматирования дат:
Короткий вариант (например, 01.09.1991) — оформляется как dd.MM.yyyy
Длинный вариант (например, 01 сентября 1991) — оформляется как dd MMMM yyyy
Ограничивает ввод данных числовым форматом.
Максимальная длина — 9 символов. Диапазон значений: от -2 147 483 648 до 2 147 483 647
При настройке тега можно указать минимальное допустимое число, значение по-умолчанию и максимально допустимое число.
Например, если мы хотим, чтобы пользователь мог вписывать в поле значения от 1000 до 9999, а значением по-умолчанию было 1762, мы указываем так:
В тех случаях, когда нам точно известно, что документ содержит поле, которое меняется крайне редко, допустим ФИО директора, мы можем либо прописать его изначально в исходном файле (однако мы не рекомендуем так делать), либо использовать константу.
Тип заполнения "Константа" гарантирует, что значение, указанное в этом теге, будет проставлено в документ в неизменном виде. Это означает, что значение константы возможно будет изменить только посредством редактирования тега в шаблоне.
* Инструкция скрипта, устанавливающая новое значение для константы, будет проигнорирована программой.
В тех случаях, когда мы хотим минимизировать количество ошибок, совершаемых при заполнении формы, и хотим заполнять некоторые поля автоматически, мы можем выбрать тип заполнения "Скрытое поле". Таким образом, устанавливать и изменять значение такого поля можно будет только через пользовательские сценарии, а само поле, также как и "константа" выводиться на форму не будет.
Генераторы следует использовать в тех случаях, когда в нескольких шаблонах у нас присутствует текст, создаваемый по одному и тому же принципу или в тех случаях, когда нужно поделить документ на логические составляющие.
Важная отличительная особенность генераторов — они "из коробки" предоставляют возможность делегировать их заполнение другому пользователю.
Все поля в генераторах обязательны к заполнению, если хотя бы одно из них будет пустым, генератор не даст подтвердить изменения.
Если в поле "генератор" горит индикатор "не заполнено", то при попытке создать документ по шаблону, генератор вернет пустую строку.
Стоит также иметь в виду, что генераторы можно использовать в скриптах только для получения значения, однако же установить или изменить значение в генераторе через скрипт не получится.
Генераторы, технически, также являются шаблонами, поэтому они работают по модульному принципу: они не могут напрямую получать данные из шаблона. Вместо этого предусмотрена система входных параметров. Прим. она пока не реализована, но вскоре будет добавлена в программу.
В случаях, когда нам необходимо создавать большой текст, состоящий из повторяющегося паттерна, мы можем использовать макрогенератор. В отличие от предыдущего типа заполнения — этот позволяет создавать текст, "слепив" несколько элементов, созданных по определенному паттерну, между собой.
Макрогенераторы при использовании обладают рядом полезных функций:
1) обработка данных с использованием Excel (подобно шаблонам);
2) автоматический предпросмотр результирующего текста;
3) обратная совместимость с обычными генераторами.
Дополнительные настройки шаблона
Перед нами 4 секции настроек: работа со скриптами, работа с номером документа, работа с автоматическим присвоением наименования и работа с историей.
О системе скриптинга INCAS можно узнать здесь.
Номер документа формируется из префикса, основной части и постфикса. Чтобы проставить номер документа в исходном файле шаблона нужно использовать служебный тег [N], другое название ему дать нельзя.
Панель инструментов
После добавления файла вы можете нажать на вторую верхнюю кнопку ("обнаружить теги в выбранном файле").