SimpleText: различия между версиями

Материал из GLENN CMS WIKI
Перейти к навигации Перейти к поиску
Нет описания правки
Нет описания правки
 
(не показано 7 промежуточных версий этого же участника)
Строка 3: Строка 3:
  Репозиторий - https://svn.glenn.ru/plugin_simpletext/trunk
  Репозиторий - https://svn.glenn.ru/plugin_simpletext/trunk
  Местоположение в проекте - /plugins/simpletext
  Местоположение в проекте - /plugins/simpletext
  Для работы, необходим [[Подключение BootStrap|подключенный BootStrap]]
  Для работы, необходим [[Подключение BootStrap|подключенный BootStrap]] и подключеный main.js
Сделать это можно, выполнив внутри контроллера.
$this->initBootstrap();
$this->initMainJs();
 
 
Чтобы подключить плагин просто положите его в папку /plugins/simpletext
svn co https://svn.glenn.ru/plugin_simpletext/trunk /plugins/simpletext/
Если вы хотите хранить текст в стандартном хранилище плагина, то необходимо создать таблицу в БД. Скрипт создания лежит в contrib/table.sql


Плагин выполнен в формате плагина Smarty.  
Плагин выполнен в формате плагина Smarty.  


Для того чтобы добавить редактируемый текст на страницу, мы пишем в шаблоне {simpleTextEditor name='<имя блока>'}
Для того чтобы добавить редактируемый текст на страницу - пишем в шаблоне {simpleTextEditor name='<имя блока>'}
В этом случае плагин будет оперировать с блоком текста, данные о котором будут сохраняться в таблицу simple_text_data.
 
Также можно кастомизировать текст, с которым мы будем работать и вариант его сохранения.
 
Для того чтобы указать текст, подлежащий редактированию используейте параметр '''data'''
{simpleTextEditor name='<имя блока>' data=$row.text}
 
Для указания JS функции сохранения текста, используйте параметр '''save'''
{simpleTextEditor name='<имя блока>' save=functionName}


===Параметры===
===Параметры===


name(text) - Имя блока
name(text) - Уникальное имя блока в рамках одного сайта.


edit(boolean) - признак возможности редактирования текста. Пример - {simpleTextEditor name='<имя блока>' edit=$edit_allowed}
edit(boolean) - признак возможности редактирования текста. Пример - {simpleTextEditor name='<имя блока>' edit=$edit_allowed}
Строка 19: Строка 36:
editor(boolean) - Нужно ли активировать CKEditor при редактировании.
editor(boolean) - Нужно ли активировать CKEditor при редактировании.


callback_script(text) - callback функция, которая будет вызвана для сохранения текста.
save(text) - callback функция, которая будет вызвана для сохранения текста. Ей будут переданы параметры: text(отредактированный текст), save_params(дополнительные параметры сохранения, переданные как saveparam<X>)


saveparam<X> - Дополнительные параметры для сохранения текста Пример - {simpleTextEditor name='<имя блока>' edit=$edit_allowed saveparam1=$data.id saveparam2=$data.parent}
saveparam<X> - Дополнительные параметры для сохранения текста Пример - {simpleTextEditor name='<имя блока>' edit=$edit_allowed saveparam1=$data.id saveparam2=$data.parent}
callback_script(text) - имя tpl файла, который будет подгружен к блоку редактирования. Для хранения в нём функции сохранения к примеру... В качестве параметров будут переданы id и name блока

Текущая версия от 11:16, 28 февраля 2013

simpleText - плагин, позволяющий редактировать любой текст на странице.

Репозиторий - https://svn.glenn.ru/plugin_simpletext/trunk
Местоположение в проекте - /plugins/simpletext
Для работы, необходим подключенный BootStrap и подключеный main.js
Сделать это можно, выполнив внутри контроллера.
$this->initBootstrap();
$this->initMainJs();


Чтобы подключить плагин просто положите его в папку /plugins/simpletext
svn co https://svn.glenn.ru/plugin_simpletext/trunk /plugins/simpletext/
Если вы хотите хранить текст в стандартном хранилище плагина, то необходимо создать таблицу в БД. Скрипт создания лежит в contrib/table.sql

Плагин выполнен в формате плагина Smarty.

Для того чтобы добавить редактируемый текст на страницу - пишем в шаблоне {simpleTextEditor name='<имя блока>'} В этом случае плагин будет оперировать с блоком текста, данные о котором будут сохраняться в таблицу simple_text_data.

Также можно кастомизировать текст, с которым мы будем работать и вариант его сохранения.

Для того чтобы указать текст, подлежащий редактированию используейте параметр data
{simpleTextEditor name='<имя блока>' data=$row.text}
Для указания JS функции сохранения текста, используйте параметр save
{simpleTextEditor name='<имя блока>' save=functionName}

Параметры

name(text) - Уникальное имя блока в рамках одного сайта.

edit(boolean) - признак возможности редактирования текста. Пример - {simpleTextEditor name='<имя блока>' edit=$edit_allowed}

data(text) - содержимое, редактируемого текста. В случае если текст находится в какой-то переменной.

editor(boolean) - Нужно ли активировать CKEditor при редактировании.

save(text) - callback функция, которая будет вызвана для сохранения текста. Ей будут переданы параметры: text(отредактированный текст), save_params(дополнительные параметры сохранения, переданные как saveparam<X>)

saveparam<X> - Дополнительные параметры для сохранения текста Пример - {simpleTextEditor name='<имя блока>' edit=$edit_allowed saveparam1=$data.id saveparam2=$data.parent}

callback_script(text) - имя tpl файла, который будет подгружен к блоку редактирования. Для хранения в нём функции сохранения к примеру... В качестве параметров будут переданы id и name блока