QPLBoard - документация

[Seo-man]

3. Создание custom-шаблонов



3.1 Список файлов custom-шаблона



Для каждого custom-шаблона необходимо создать следующий набор файлов:

Ø Для пользовательского интерфейса: файлы должна находиться в директории \modules\qplboard\templates\custom\user\

1. Шаблон формы подачи объявления (_edit.tpl)

2. Шаблон формы поиска объявления (_search.tpl)

3. Шаблон отображения текста объявления (_adv.tpl)

4. Шаблон предварительного просмотра объявления перед публикацией (_preview.tpl)

5. Шаблон отображения объявления в блоке новых объявлений на стартовой странице (_start_page_new.tpl)

6. Шаблон отображения объявления в всплывающем окне в блоке новых объявлений на стартовой странице (_start_page_new_float.tpl)

7. Шаблон отображения объявления в блоке VIP объявлений на стартовой странице (_start_page_spec.tpl)

8. Шаблон отображения объявления в всплывающем окне в блоке VIP объявлений на стартовой странице (_start_page_spec_float.tpl). Шаблон является необязательным. В случае его отсутствия используется шаблон 6.

9. Шаблон отображения названий custom-полей в шапке таблицы с результатами поиска объявлений в разделе, использующем custom-шаблоны (_found_adv.tpl)

10. Шаблон отображения значений custom-полей в таблице с результатами поиска объявлений в разделе, использующем custom-шаблоны (_found_adv_short.tpl)

11. Шаблон отображения значений custom-полей в таблице с результатами поиска объявлений в разделе, использующем custom-шаблоны для случая, если объявление является выделенным (_found_adv_selected_short.tpl)



Ø Для интерфейса администратора: файлы должна находиться в директории \modules\qplboard\templates\custom\admin\

12. Шаблон редактирования объявления (_edit.tpl)

13. Шаблон предварительного просмотра объявления перед публикацией (_preview.tpl)





HTML код custom-шаблона автоматически встраивается в стандартный шаблон доски. Ниже приведен список custom-шаблонов и стандартных шаблонов:

1. Содержимое custom-шаблона _edit.tpl вставляется в шаблон EditAdv.tpl вместо тега

<# CUSTOM_FORM #>

2. Содержимое custom-шаблона _search.tpl вставляется в шаблон SearchAdvForm.tpl вместо тега

<# CUSTOM_FORM #>

3. Содержимое custom-шаблона _adv.tpl вставляется в шаблон ViewAdv.tpl вместо тега

<# CUSTOM_FORM #>

4. Содержимое custom-шаблона _ preview.tpl вставляется в шаблон PreviewPlacedAdv.tpl вместо тега <# CUSTOM_FORM #>

5. Содержимое custom-шаблона _start_page_new.tpl вставляется в шаблон StartPageNewAdv.tpl вместо тега <# CUSTOM_FORM #> (по умолчанию этот тег закомментирован)

6. Содержимое custom-шаблона _start_page_new_float.tpl вставляется в шаблон StartPageNewAdv.tpl вместо тега <# CUSTOM_FLOAT_FORM #> (по умолчанию этот тег закомментирован)

7. Содержимое custom-шаблона _start_page_spec.tpl вставляется в шаблон SpecAdvShort.tpl вместо тега <# CUSTOM_FORM #> (по умолчанию этот тег закомментирован)

8. Содержимое custom-шаблона _start_page_spec_float.tpl вставляется в шаблон SpecAdvShort.tpl вместо тега <# CUSTOM_FLOAT_FORM #> (по умолчанию этот тег закомментирован)

9. Содержимое custom-шаблона _found_adv.tpl вставляется в шаблон FoundAdv.tpl вместо тега

<# CUSTOM_FORM #> (по умолчанию этот тег закомментирован)

10. Содержимое custom-шаблона _found_adv_short.tpl вставляется в шаблон FoundAdv.tpl вместо тега <# CUSTOM_FORM #> (по умолчанию этот тег закомментирован)

11. Содержимое custom-шаблона _found_adv_selected_short.tpl вставляется в шаблон FoundAdvSelectedShort.tpl вместо тега <# CUSTOM_FORM #> (по умолчанию этот тег закомментирован)



ВАЖНО:

1. Начиная с версии скрипта 4.20 «Шаблон предварительного просмотра объявления перед публикацией» является необязательным. При его отсутствии используется «Шаблон отображения текста объявления».

2. Шаблоны 5, 6, 7, 8 доступны начиная с версии скрипта 4.20

3. Шаблоны 9, 10, 11 доступны начиная с версии скрипта 4.40


3.2 Структура файлов custom-шаблона



Все шаблоны представляют собой обычные фрагменты HTML кода со специальными командами (мета-тегами), которые указывают доске, какой список отобразить и с помощью какого шаблона, какое значение вывести в custom-поле и т.д.



3.2.1 Шаблон формы подачи объявления _edit.tpl



<input type="hidden" name="CustomFieldNum" value="8">

<TR>

<TD>Текстовое поле:</TD>

<TD><input name="cf1" type=text class="gui_form" maxlength=150 value="<# cf1 #>"></TD>

</TR>

<TR>

<TD>Текстовое поле (для поиска От и До):</TD>

<TD><input name="cf2" type=text class="gui_form" maxlength=150 value="<# cf2 #>"></TD>

</TR>

<TR>

<TD>Многострочное текстовое поле:</TD>

<TD><TEXTAREA class="gui_form" name="cf3" rows=10 cols=50 ><# cf3 #></TEXTAREA></TD>

</TR>

<TR>

<TD>Список:</TD>

<TD><# NAME=cf4;LIST_ID=list_example1;SORTBY=priority;TYP E=select;TEMPLATE=select_edit;COLNUM=1 #></TD>

</TR>

<TR>

<TD>Список с множественным выбором:</TD>

<TD><# NAME=cf5;LIST_ID=list_example2;SORTBY=priority;TYP E=multiselect;TEMPLATE=multiselect_edit;COLNUM=1 #></TD>

</TR>

<TR>

<TD>Одиночный чекбокс:</TD>

<TD><input type=checkbox name="cf6" <# check_cf6 #>> флажок</TD>

</TR>

<TR>

<TD>Несколько чекбоксов:</TD>

<TD><# NAME=cf7;LIST_ID=list_example3;SORTBY=priority;TYP E=check;TEMPLATE=check_edit;COLNUM=3 #></TD>

</TR>

<TR>

<TD>Радиокнопка:</TD>

<TD><# NAME=cf8;LIST_ID=list_example4;SORTBY=priority;TYP E=radio;TEMPLATE=radio_edit;COLNUM=2 #></TD>

</TR>



Шаблоны формы подачи объявления, а так же формы поиска объявления, редактирования объявления для администратора доски, должны обязательно содержать элемент формы <INPUT> с именем “CustomFieldNum” и значением равным числу полей ввода в данном шаблоне.

Например:



<input type="hidden" name="CustomFieldNum" value="8">



value = “8” – custom-шаблон содержит 8 полей ввода.





Ø Элементы формы «Текстовое поле», «Текстовое поле (для поиска От и До)»:



<input name="cf1" type=text class="gui_form" maxlength=150 value="<# cf1 #>">



cf1 – имя элемента. Имя элемента обязательно должно состоять из букв cf и порядкового номера элемента;

<# cf1 #> - тэг для вывода значения данного элемента. Имя тэга должно совпадать с именем элемента.



Ø Элементы формы «Многострочное текстовое поле»:



<TEXTAREA class="gui_form" name="cf3" rows=10 cols=50 ><# cf3 #></TEXTAREA>



cf3 – имя элемента. Имя элемента обязательно должно состоять из букв cf и порядкового номера элемента;

<# cf3 #> - тэг для вывода значения данного элемента. Имя тэга должно совпадать с именем элемента.



Ø Элементы формы «Одиночный чекбокс»:



><input type=checkbox name="cf6" <# check_cf6 #>>



cf6 – имя элемента. Имя элемента обязательно должно состоять из букв cf и порядкового номера элемента;

<# check_cf6 #> - тэг для вывода значения данного чекбокса (отмечен или не отмечен). Суффикс (_cf6) тэга должен совпадать с именем элемента.

Ø Элементы формы «Список», «Список с множественным выбором», «Несколько чекбоксов», «Радиокнопка»:



<# NAME=cf4;LIST_ID=list_example1;SORTBY=priority;TYP E=select;TEMPLATE=select_edit;COLNUM=1 #>



NAME=cf4 – имя элемента. Имя элемента обязательно должно состоять из букв cf и порядкового номера элемента;

LIST_ID=list_example1 – идентификатор списка (см. раздел 2);

SORTBY=priority – тип сортировки:

name – по имени в алфавитом порядке

name_rev – по имени в обратном алфавитном порядке

id_rev – по ID элемента списка в порядке уменьшения ID

priority - по приоритету элемента списка

priority_rev – по приоритету элемента списка в порядке убывания

TYPE=select – тип списка:

select – выпадающий список

multiselect - выпадающий список со множественным выбором

check – набор чекбоксов

radio – радио кнопка

TEMPLATE=select_edit – использовать шаблон select_edit.tpl для отображения выпадающего списка (см. раздел 4)

COLNUM=1 – кол-во столбцов для вывода списка (флажки и радио-кнопки можно отображать в несколько столбцов для удобства восприятия)