!! Плагин Snippets

Версия 1.0

!!! Содержание

** [[Краткое описание -> #brief]]
** [[Управление шаблонами -> #management]]
** [[Вставка шаблонного текста -> #enter]]
** [[Вставка шаблона в виде викикоманды -> #wikicommand]]
** [[Язык шаблонов -> #language]]
*** [[Задание переменных -> #var]]
*** [[Встроенные переменные -> #globalvar]]
*** [[Другие языковые конструкции -> #blocks]]
**** [[Оператор if -> #if]]
**** [[Оператор include -> #include]]
** [[Особенности хранения шаблонов -> #advanced]]
** [[Ссылки и контакты -> #contacts]]

!!! [[#brief]] Краткое описание

Плагин Snippets предназначен для сохранения шаблонного текста, который часто используется в заметках, для того, чтобы каждый раз не набирать повторяющийся текст заново. В тексте шаблона могут встречаться переменные подстановки, значения которых вводится пользователем при использовании шаблона. Кроме того, если вы знакомы с шаблонизатором [[Jinja2 -> http://jinja.pocoo.org/]], то можете использовать его возможности в шаблонах, поскольку плагин Snippets использует эту библиотеку для генерации текста по шаблону.

%center%%thumb width=700%Attach:snippets_rus_vardialog_snippet.png%%


!!! [[#management]] Управление шаблонами

Чтобы создать шаблон, выберите пункт меню "Шаблоны - Управление шаблонами...", откроется диалог "Управление шаблонами". В левой части диалога будет показано дерево шаблонов, в котором шаблоны можно группировать по папкам.

%center%%thumb width=700%Attach:snippets_rus_management.png%%

В верхней части диалога расположена панель инструментов с двумя группами кнопок.

В левую группу входят кнопки для создания папки шаблонов, создания нового шаблона, переименования папки или шаблона, удаления шаблона, запуска шаблона на выполнение.

В правую группу входят кнопка для вставки встроенных или пользовательских переменных, а также кнопка для вставки некоторых [[языковых конструкций Jinja -> #language]] в текст шаблона.

Если во введенном шаблоне есть синтаксическая ошибка, то она выводится в правом нижнем информационном поле.

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

Все созданные шаблоны помещаются в меню "Шаблоны" главного окна программы OutWiker, а созданные папки с шаблонами в этом меню представлены вложенными подменю. Вложенность папок практически не ограничена.

%center%Attach:snippets_rus_menu_snippets.png


!!! [[#enter]] Вставка шаблонного текста

Плагин Snippets позволяет вставлять шаблоны в двух режимах - в виде сгенерированного текста и в виде викикоманды (этот режим работает только для викистраниц).

Чтобы вставить шаблон в текст страницы, нужно выбрать соответствующий шаблон в меню "Шаблоны" или запустить на выполнение шаблон из диалога управлением шаблонами. После этого откроется диалог для ввода значений переменных. В левой части диалога будут перечислены переменные, которые необходимо ввести (при желании, их значения можно оставить пустыми), а справа можно увидеть результат, который будет вставлен в текст страницы, и исходный текст шаблона.

%center%%thumb width=600%Attach:snippets_rus_vardialog_result.png%%

%center%%thumb width=600%Attach:snippets_rus_vardialog_snippet.png%%

В левом нижнем углу диалога расположен переключатель "Вставить как викикоманду". Если он '''не установлен''', то полученный результат будет непосредственно вставлен в текст страницы. Если этот переключатель '''установлен''', то в текст страницы будет вставлена [[викикоманда -> #wikicommand]], которая будет преобразована в соответствующий текст в режиме просмотра. Переключатель "Вставить как викикоманду" существует только в том случае, если выбранная в данный момент страница является викистраницей (а не HTML-страницей, текстовой страницей и т.д.)

!!! [[#wikicommand]] Вставка шаблона в виде викикоманды

Если в [[диалоге ввода переменных -> #enter]] установить переключатель "Вставить как викикоманду", то в текст страницы будет вставлен не сгенерированный текст, а викикоманда [=(:snip:)=], которая будет преобразована в соответствующий текст в режиме просмотра. Эта команда имеет следующий формат:

[@
(:snip file="Папка с шаблоном/имя шаблона" varname1="значение переменной", varname2="значение переменной", ...:)
Необязательный текст
(:snipend:)
@]

Если задан параметр ''file'', то используется шаблон, указанный в качестве значения этого параметра. Путь до шаблона задается относительно корневой папки шаблона, т.е. если шаблон с именем "Мой шаблон" виден непосредственно в меню "Шаблоны", то значение параметра ''file'' должно быть равно "Мой шаблон". Если "Мой шаблон" находится в подменю "Шаблоны - Папка с шаблонами", то значение параметра ''file'' должно быть равно "Папка с шаблонами/Мой шаблон". При этом в пути всегда используются прямые слеши (/).

''varname1'', ''varname2'' и т.д. - имена переменных, встречающихся в тексте шаблона, а "Необязательный текст" будет сохранен во [[встроенную переменную -> #globalvar]] ''__text'', которая может использоваться в шаблоне.

В этом случае переменная ''__text'' будет хранить текст между [=(:snip:)=] и [=(:snipend:)=], т.е. в данном примере значение "Необязательный текст".

Если в викикоманде [=(:snip:)=] параметр ''file'' не задан, то считается, что текст шаблона задан между [=(:snip:)=] и [=(:snipend:)=]:

[@
(:snip varname1="значение переменной", varname2="значение переменной", ...:)
Текст шаблона
(:snipend:)
@]

В этом случае [[встроенная переменная -> #globalvar]] ''__text'' будет равна пустой строке "".


!!! [[#language]] Язык шаблонов

В шаблонах используется язык из библиотеки-шаблонизатора [[jinja2 -> http://jinja.pocoo.org/]]. Это очень мощная библиотека, но в данном разделе будут перечислены только наиболее простые и часто используемые в шаблонах возможности. Интерфейс плагина Snippets рассчитан на пользователя, незнакомого с этой библиотекой, однако если вы программист и работали с ней, то вы можете использовать все ее возможности, о которых здесь не будет упомянуто. Описание всех возможностей этой библиотеки вы можете найти в [[документации к Jinja2 -> http://jinja.pocoo.org/docs/dev/templates/]].


!!!! [[#var]] Задание переменных

Наиболее важная часть синтаксиса шаблонов - это переменные. Значение переменной в шаблоне вставляется с помощью конструкции {{''varname''}}, где ''varname'' - это имя переменной. Из-за особенности используемой библиотеки имя переменной может включать в себя только латинские буквы, цифры и знак подчеркивания "_", причем первым символом в имени переменной может быть только латинская буква.

В плагине Snippets есть набор встроенных переменных, которые нельзя задать через диалог ввода переменных, их значения зависят от свойств текущей страницы или текущей даты. Полный список таких переменных перечислен в разделе [[Встроенные переменные -> #variables]]. Эти переменные начинаются с символа двойного подчеркивания.

Рассмотрим такой шаблон:

[@
from outwiker.core.commands import MessageBox

MessageBox(
    _(u'{{message}}'),
    _(u'{{title}}'),
    wx.ICON_ERROR | wx.OK)
@]

В нем используются две переменные: ''message'' и ''title'', плагин Snippets попросит их определить в открывшемся диалоге при вызове данного шаблона:

%center%%thumb width=600%Attach:snippets_rus_vardialog_result.png%%


!!!! [[#globalvar]]Встроенные переменные

Кроме заданных пользователем переменных, плагин Snippets создает набор встроенных переменных, значения которых зависят от свойств текущей страницы. Имена всех встроенных переменные начинаются с двух знаков подчеркивания.

Имена встроенных переменных можно увидеть в диалоге управления шаблонами, если нажать кнопку для вставки переменных.

%center%%thumb width=600%Attach:snippets_rus_globalvar.png%%

Например. Переменная ''__text'' содержит в себе текст, выделенный на странице в момент вызова шаблона. Также переменная ''__text'' используется при работе [[викикоманды -> #wikicommand]] [=(:snip:)=], которая вставляет шаблон из файла (если задан параметр ''file''). В этом случае переменная ''__text'' содержит текст, находящийся между [=(:snip:)=] и [=(:snipend:)=].

Переменная ''__type'' равна значению ''wiki'' для викистраниц, ''html'' для страниц в формате HTML, ''text'' для простых текстовых страниц и т.д. Эту переменную вместе с [[оператором if -> #if]] можно использовать для изменения поведения шаблона в зависимости от типа страницы.
 

!!!! [[#blocks]] Другие языковые конструкции

Используемая внутри плагина Snippets библиотека [[Jinja2 -> http://jinja.pocoo.org/]] поддерживает достаточно большое количество языковых конструкций, но через интерфейс плагина можно вставить только некоторые из них. Если вы знакомы с данной библиотекой, то можете использовать все поддерживаемые ей конструкции.

Через интерфейс можно вставить три языковые конструкции: операторы ''[[if -> #if]]'', ''[[include -> #include]]'' и комментарии.

%center%%thumb width=600%Attach:snippets_rus_blocks.png%%

Комментарии обрамляются скобками вида [={# ... #}=] и во время обработки шаблона удаляются. Они нужны, чтобы пояснить текст шаблона - для чего он используется, что означают переменные и т.п.

!!!!! [[#if]] Оператор if

Оператор ''if'' предназначен для организации ветвления в шаблоне и вставки текста, зависящего от значений переменных. Синтаксис оператора ''if'' следующий:

[@
{% if условие_1 %}
    Текст 1
{% elif условие_2 %}
    Текст 2
{% elif условие_3 %}
    Текст 3
...
{% else %}
    Текст N.
{% endif %}
@]

Скорее всего подобная конструкция вам знакома по какому-либо языку программирования.

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

[@
{% if var == '1' %}100{% elif var == '2' %}200{% elif var == '3' %}300{% else %}xxx{% endif %}
@]

А такое выражение будет '''ошибочно''' (всегда будет выполняться ветвь ''else''):

[@
{% if var == 1 %}100{% elif var == 2 %}200{% elif var == 3 %}300{% else %}xxx{% endif %}
@]


!!!!! [[#include]] Оператор include

Оператор ''include'' предназначен для вставки одного шаблона в другой, при этом во вставляемом шаблоне могут быть объявлены собственные переменные. Синтаксис оператора ''include'' следующий:

[@
{% include "Вставляемый шаблон" %}
@]

В этом операторе "Вставляемый шаблон" - это имя шаблона, который должен находиться в той же папке, что и родительский шаблон (внутри которого находится оператор ''include'') или во вложенной папке, в этом случае оператор будет выглядеть следующим образом:

[@
{% include "Папка 1/Папка 2/Вставляемый шаблон" %}
@]


!!! [[#advanced]] Особенности хранения шаблонов 

Все шаблоны хранятся в виде отдельных файлов в папке ''snippets'' внутри директории с настройками программы (под Windows 7 / 8.x / 10 - C:\Users\USERNAME\AppData\Roaming\outwiker\snippets\, под Linux - /home/USERNAME/.config/outwiker/snippets/). Имя шаблона соответствует имени файла, поэтому чаще всего это будут файлы без расширения. Папки в шаблонах - это обычные папки в той же директории ''snippets''.


!!! [[#contacts]] Ссылки и контакты

* [[Страница плагина -> http://jenyay.net/Outwiker/Snippets]]
* Замеченные ошибки, пожелания и предложения пишите на почту [[jenyay.ilin@gmail.com -> mailto:jenyay.ilin@gmail.com]]