Руководство по настройке модулей

Оглавление

• Введение
  • Для кого это руководство
• О чём это руководство


• Общие особенности всех модулей
  • Инсталляция
  • Свойства модуля
  • Свойства модуля к странице
  • Шаблоны модулей
    • Блоки
    • Синтаксис блоков
    • Переменная
    • Синтаксис переменных
    • Содержимое переменных
    • Блок уровня
    • Реальные шаблоны
  • Создание действий
  • Назначение действия метке
    


• Модуль «Меню»
  • Описание
  • Свойства
  • Свойства к странице
  • Действия
    • Постановка задачи
    • Сформировать статическое меню
    • Сформировать динамическое меню
    • Ещё раз о разнице действий
  • Шаблоны
  • Стандартные блоки
  • Расширенные блоки
  • Блок уровня
  • Переменные в шаблоне
    


• Модуль «Дорога»
  • Описание
  • Свойства
  • Свойства к странице
  • Действия
    • Сформировать дорогу
    • Сформировать название страницы
  • Шаблоны
    • Блоки
    • Переменные в шаблоне


• Модуль «Карта сайта»
  • Описание
  • Свойства
  • Свойства к странице
  • Действия
    • Сформировать карту сайта
  • Шаблоны
  • Стандартные блоки
  • Блок уровня
  • Пример шаблона
  • Переменные в шаблоне


• Модуль «Новости»
  • Описание
  • Свойства
    • Управление главным изображением
    • Управление значениями по умолчанию
  • Свойства к странице
  • Действия
    • Сформировать ленту
    • Сформировать архив
    • Сформировать форму отбора
  • Шаблоны
  • Общие блоки
  • Блоки страничной навигации
  • Блоки полного представления новости
  • Блоки формы отбора
  • Переменные

Введение

Для кого это руководство

Данное руководство создано для «сборщиков» сайтов. Здесь, под сборщиками сайта мы подразумеваем тех людей, которые настраивают сайт и его модули таким образом, что бы это отвечало конечным требованиям владельцев (заказчиков) сайта.

Если вы только начинаете (или планируете) использовать систему управления контентом SantaFox™ для своего сайта, настоятельно рекомендуем ознакомиться с данным руководством. Во всех остальных случаях его изучение не обязательно.

О чём это руководство

В данном руководстве содержится описание модулей, доступных для сайта, работающего под управлением SantaFox™.

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

Данное руководство не содержит информации об административных разделах модуля и описания работы с ними. Если вам необходима данная информация вы можете обратиться к «Руководству по управлению модулями».

Так же, в данном руководстве не рассматриваются вопросы архитектуры модулей, если вам необходима подробная информация по этому вопросу, то следует обратиться к «Руководству по архитектуре»

Задача данного руководства – познакомить вас со всеми модулями SantaFox™, с тем, что бы вы могли в полной мере использовать все возможности модуля для реализации поставленных перед сайтом задач.

В конце вы сможете найти общий (сводный) перечень по всем органам настройки модуля.

Общие особенности всех модулей

Перед тем, как знакомиться непосредственно с настройками каждого модуля, давайте рассмотрим, а что собственно необходимо будет настраивать у модуля. Для того, что бы модуль работал под управлением SantaFox™ необходимо сделать следующее:

• установить свойства модуля;
• установить свойства модуля к странице;
• отредактировать шаблоны модуля;
• создать действия;
• назначение действия метке;

Приведенный список лишь показывает те действий, которые необходимо будет сделать, их порядок вы определяет самостоятельно.

Инсталляция

Для описания процесса инсталляции модуля необходимо обратиться к «Руководству администратора», раздел «Закладка модули». Здесь мы только отметим, что после инсталляции модуля будет создан как минимум базовый экземпляр модуля. К которому вам необходимо создать необходимое количество дочерних модулей (как минимум необходим один дочерний модуль).

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

Свойства модуля

Установка свойств модуля не требует каких-то специальных навыков или раздумий. Единственное что требуется, это выбрать одно из возможных значений для каждого свойства. В руководстве администратора описан процесс настройки свойств модуля, и он не должен вызвать больших затруднений.

Следует помнить, что по умолчанию, значение свойства наследуется от базового модуля, и в случае если используется несколько дочерних модулей, необходимо переопределить значение свойства у конкретного дочернего модуля.

Свойства модуля к странице

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

Шаблоны модулей

Любой модуль использует для своей работы шаблоны, которые определяют то, как будет выведен контент, обрабатываемый конкретным модулем. Файлы шаблонов модуля расположены в каталоге модуля в папке «templates_user». Файлы шаблонов должны иметь расширение «html» или «htm».

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

Блоки

Рис. 1: Схема обработки блоков и построения из них результирующего контента по данным, обрабатываем модулем.

Рассмотрим понятие блока сразу на примере. Допустим, есть модуль, отвечающий за ведение базы данных участников группы вечерних занятий. Данный модуль имеет административный интерфейс, где для каждого участника указываются следующие значения:

• Имя
• Фамилия
• Дата рождения
• Количество посещений

На страницах сайта данный модуль должен представить свой контент в табличном виде, что бы участники занятий смогли контролировать своё посещение. Для того, что бы отобразить такой контент, необходимо вывести заголовок таблицы (блок начала), затем какое-то количество строк (блок строки) и подвал (блок окончания) (Рис. 1).

Блоки как раз и определяют то, как будет выглядеть каждая из этих трёх частей. На Рис. 1 представлена схема того, как из блоков модуля будет формироваться итоговая таблица с контентом. Пунктирной линией здесь показан тот результирующий контент, который будет сформирован модулем после обработки данных и вывода их с помощью такого шаблона. Это достаточно простой пример, однако он наглядно демонстрирует, для чего нужны блоки.

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

Следует особо отметить, что вы можете управлять только содержимым блоков. Количество блоков и порядок их обработки (соединения) заложен в модуль и не может быть изменён средствами SantaFox™.

Синтаксис блоков

Объявление блока имеет следующий синтаксис:

Концом блока служит начало заголовка следующего блока или конец файла шаблона. Не смотря на то, что блоки строго определены модулем, вы можете создавать собственные блоки с тем, что бы отделить создать «невидимые блоки», то есть те, которые не попадут в результирующий контент. Для нашего примера, синтаксис блоков будет следующим:

Переменная

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

• порядковый номер строки (number);
• имя (fname);
• фамилия (lname);
• дата рождения (bdate);
• кол-во занятий (cemployment).

Возвращаясь к нашему примеру и Рис. 1, мы можем сказать, что каждый раз, при обработке «блока строки», переменные, используемые в этом блоке, будут заменены на значения, соответствующие обрабатываемой в данный момент записи базы данных модуля.

Следует отметить, что каждый блок имеет свой определённый набор переменных, которые заменяются определёнными значениями. Вы может по-разному комбинировать имеющиеся в блоке переменные, но не добавлять новые переменные.

Синтаксис переменных

Переменная имеет достаточно просто синтаксис:

Если вернуться к нашему примеру, то итоговый файл шаблона будет выглядеть следующим образом:

Содержимое переменных

Рассмотренный нами пример является достаточно простым и в нём все значения переменных заменяются простыми строками, которые подставляются непосредственно в результирующий контент.

В более сложных модуля значениями переменных могут быть ссылки, которые необходимо помещать в свойства «HREF» тега «<A>», или же ещё более сложными конструкциями. В любом случае, в описании модуля всегда указан весь перечень используемых переменных, а также те значения, которые могут быть возвращены переменной. Кроме того, в сложных модулях значения переменной может быть взято из того или иного блока, в соответствии с каким то условием.

Для того, что бы наглядно продемонстрировать это, немного усложним наш модуль. Добавим ещё одно поле, которое администратор может указать у участника занятий, а именно – фотографию участника. Тогда шаблон модуля примет следующий вид:

Как видите, мы добавили ещё одну колонку в шаблон для новой переменной «foto», данная переменная будет заменена ссылкой на файл изображения и потому, она вставлена непосредственно в свойство «SRC» тэга «IMG».

Однако, если у кого-то из участников не окажется фотографии, то в этой строке картинка не будет отображена, так как свойство «SRC» тэга «IMG» будет пустым. Для того что бы избежать такого поворота событий модуль должен по другому обрабатывать переменную «foto» и добавить два новых блока.

Теперь, в качестве значения переменной «foto» будет выступать контент блока «foto» или блока «no_foto», в зависимости от того, есть у данной строчки записи базы данных модуля фотография или нет.

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

Блок уровня

В некоторых модулях могут быть использованы уровни блоков. Особенно актуально это для модуля «Меню», «Дороги» и «Карты сайта», во всех тех модулях, где работа идёт со иерархически структурированными данными (в данном случае мы говорим о структуре сайта, но это могут быть и любые другие данные, к примеру, структура интернет-магазиан).

Отображения таких данных требует того, что бы одни и те же блоки, но выводимые для разных уровней, выглядели по-разному. Для того, что бы показать, что блок имеет несколько уровней необходимо использовать вспомогательный блок «<!-- @@nextlevel -->». Пример такого шаблона приведён ниже:

Как видите, в данном примере объявлен блок «@link», после которого следует два блока «@@nextlevel», которые определяют то, как будет выглядеть блок «@link» на втором и третьем уровнях соответственно (в данном случае всё различие сводится к разному количеству символов «пробела» перед ссылкой).

Если вы не выделяете у блока разные уровни, но модулем уровни используются, то для всех уровней, которые в шаблоне не описаны, будет использован последний описанный уровень. В данном примере, для вывода блока «@link» четвёртого и последующих уровней будет использован блок, объявленный в последнем «@@nextlevel».

Реальные шаблоны

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

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

Создание действий

Самый важный этап – создание действий, которые выводят контент, обрабатываемый модулем, для посетителя сайта.

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

Назначение действия метке

Когда действие создано, необходимо назначить его конкретной метке в шаблоне страницы сайта. Следует помнить (и использовать) то свойство, что привязка действий к метке наследуется для от родительской страницы.

Если вам необходима более подробная информация о привязке действий к меткам, следует обратиться к «Руководству администратора».

Модуль «Меню»

Описание

Модуль «Меню» предназначен для реализации всего одной функции, а именно построения меню сайта, для того что бы пользователи сайта могли осуществлять по нему (по сайту) навигацию.

Меню сайта строится из структуры сайта и может быть представлено как в виде простой линейной навигации, так и более сложной – древовидной.

Свойства

Модуль не имеет свойств.

Свойства к странице

В Таб. 1 представлено единственное свойство к странице, используемое модулем «Меню» Не забывайте устанавливать значение данного свойства, так как в случае если оно у страницы не определено, то страница не попадёт в сформированное меню.

Действия

Модуль «Меню» может строить два разных типа меню, а именно «статическое меню» и «динамическое меню». Совокупность двух методов построение контента позволит реализовать 99% вариантов меню вашего сайта.

Постановка задачи

Перед тем как рассмотреть эти два действия, давайте поставим задачу, которую надо решить с помощью модуля меню, с тем, что бы на конкретном примере увидеть, различия двух действий.

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

Рис. 2: Структура сайта, представленная в виде схемы. Разными цветами представлены страницы, относящиеся к разным уровням.

Теперь, исходя из структуры сайта, перед модулем меню стоят следующие задачи:

• Вывести меню быстрого доступа, которое постоянно должно присутствовать на сайте. (Мы не рассматриваем вопрос содержания этих страницах, так как наша главная задача, дать пользователю перейти на них.)
• вывести меню основных  разделов сайта («О Компании» / «Услуги» / «Контакты» / «Отзывы»), а также всех вложенных страниц (пока вложенные страницы имеет только один раздел – «О компании»);

Теперь рассмотрим в отдельности каждое действие, их сразу приведём варианты его использования для поставленной задачи.

Сформировать статическое меню

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

Такое меню строится для разделов структуры, которые всегда должны быть доступны пользователю сайта, например это может быть навигация по языкам сайта, или навигация по основному меню сайта.

Как вы, наверное, уже поняли, данное действие идеально подходит для выполнения задачи по выводу меню быстрого доступа. Рассмотрим параметры, которые необходимо указать при создании действия по формированию статического меню:

Применяя данное действие для нашей задачи, мы получаем следующие параметры действия, которые представлены. Если расшифровать данные параметры, то получается, что в меню попадут все страницы, которые являются дочерними страницами первого уровня по отношению к странице «Быстрый доступ» (fastpage).

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

Сформировать динамическое меню

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

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

Для того, что бы построить меню основных разделов и подразделов мы должны задать значения параметров действия, указанные в Таб. 5.

При построении такого меню, подразделы будут выведены подразделы только текущего раздела.

Если разница между двумя действиями вам всё ещё не понятна, обратитесь к следующему разделу документации, или же вы можете самостоятельно поэкспериментировать с модулем меню.

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

Ещё раз о разнице действий

Давайте ещё раз обозначим разницу двух действий модуля «Меню». Для того, что бы визуально разделить два этих действия и ощутить разницу между ними рассмотрим блок схемы со структурой сайта.

На Рис. 3 представлена блок схема структуры гипотетического сайта. Пусть вас не пугает изобилие блоков (страниц). Главное, что из этой схемы необходимо вынести – данная структура представлена страницами тремя уровня. «Основной раздел» – страницы первого уровня, «Раздел» – страницы второго уровня и «Подразделы» – страницы третьего уровня (Рис. 3)

Рис. 3: Условная схема сайта со страницами трёх уровней.

Теперь, допустим, необходимо, что бы на сайте постоянно отображались страницы «Подраздел 2.3.1», «Подраздел 2.3.2» и «Подраздел 2.3.3».Для этого используется только действие «постоянное меню». В качестве страницы начала формирования указывается идентификатор страницы «Раздел 2.3», а в качестве выводимых уровней выставляется в значение «1».

Статическое меню не должно вызывать особых сложностей и потому перейдём к формированию динамического меню. Представим, что пользователь сайта находиться на странице «Подраздел 1.3.2», и тогда ему динамическое меню сформирует такое меню, которое показано на Рис. 4. Красным цветом отмечены те страницы, которые будут обрабатываться при построении меню.

Рис. 4: Схема страниц сайта, в случае, когда пользователь находится на странице «Подраздел 1.3.2» (оранжевый блок). Красные блоки показывают те страницы, которые попадут в сформированное меню.

Теперь, допустим, если пользователь решит просмотреть страницу «Раздел 3.1» то сформированное меню примет вид, показанный на Рис. 5.

Рис. 5: Схема страниц сайта, в случае, когда пользователь находится на странице «Раздел 3.1» (оранжевый блок). Красные блоки показывают те страницы, которые попадут в сформированное меню.

Как вы можете видеть (Рис. 4 и Рис. 5), пользователю сайта будет сформировано меню без включения «лишних» разделов. Как уже говорилось, такой способ формирования меню используется в большинстве стандартных случаев. А что бы вывести такое меню, необходимо использовать параметры указанные в Таб. 7.

Следует учесть, что используя одно действие (с параметрами указанными в таб. 7) для вывода меню, показанного на Рис. 5, всё меню будет выведено в один блок (в одну область страницы). Довольно часто перед разработчиком встаёт задача вывода основного меню отдельно от меню вложенных разделов. Для того, что бы реализовать эту задачу используются два действия «сформировать динамическое меню», но с разными параметрами.

Первое действие формирует меню основных разделов, для чего используются параметры, указанные в Таб. 8. Вызов такого действия сформирует меню только из основных разделов. Справедливости ради, следует сказать, что в данном случае, для построения меню основных разделов подойдёт и действие «сформировать статическое меню», так как основные разделы сайта ни как не будут меняться при навигации пользователя по структуре, приведённой на рисунках 4 и 5.

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

Ещё необходимо отметить, что внешний вид меню полностью определяется шаблоном, используемым для его построения.

Шаблоны

Теперь давайте рассмотрим блоки и переменные, используемые в шаблонах для построения меню. Модуль «меню» может использовать достаточно много блоков. Рекомендуем внимательно ознакомиться с этим разделом, чтобы иметь представления о том, как реализовывать сложные (в графическом плане) меню сайта.

Стандартные блоки

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

Большинство блоков, представленных в Таблице 10, должны быть понятны, поэтому заострим наше внимание только на одном, а именно на «@passiveactive».

Этот блок используется для выделения страницы, на которой пользователь сейчас не находится, но в тоже время, она относится к текущей странице, так как находится в одной ветке с ней. Другими словами, если вы находитесь на странице «Подраздел 2.3.2», то этот блок будет вызываться для «Раздел 2.3» и для «Основной раздел 2» (Рис. 5).

Расширенные блоки

Дизайн меню может быть выполнен (свёрстан) таким образом что, вам будет не хватать базовых блоков для построения меню. Для реализации более сложных меню введены дополнительные блоки, указанные в Таблице 11:

Как вы можете заметить, представленные в Таблице 11 блоки позволяют изменять блоки «@begin», «@delimiter» и «@end» рядом с блоком активной страницы. Данная возможность может понадобиться для построения меню со сложным графическим оформлением, когда активный элемент меню влияет на отображение соседних элементов.

Блок уровня

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

Как уже говорилось, для этого используется блок «@@nextlevel», который указывается после любого из основных и дополнительных блоков и определяет их (эти блоки) для страниц следующего уровня.

Для получения примера использования блока уровня обратитесь к подразделу «Блок уровня» раздела «Общие особенности всех модулей».

Переменные в шаблоне

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

Модуль «Дорога»

Описание

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

Свойства

Модуль не имеет свойств.

Свойства к странице

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

Действия

Модуль имеет два действия, одно и которых непосредственно формирует дорогу, а второе является скорее вспомогательным, но не менее полезным и часто используемым на сайте.

Сформировать дорогу

Формирует дорогу сайта от текущей страницы (на которой сейчас находиться пользователь сайта, и для которой соответственно формируется дорога) до страницы самого верхнего уровня.

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

В качестве параметра действия указывается только используемый шаблон (Таб. 14).

Сформировать название страницы

Формирует название (просто строку) текущей страницы находящейся на определенном уровне в дороге сайта. Метод удобно использовать для вывода заголовка раздела или подраздела, чьи страницы пользователь сейчас просматривает.

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

Для пояснения результата формирования работы данного действия обратимся к Рис. 4 и Рис. 5 (стр. 16 и 17). Если данное действие будет вызываться для сайта со структурой, представленной на данных рисунках, и значением параметра равным 2 (двум), то для рисунка 4 действие вернёт строку «Раздел 1.3», а для рисунка 5 – строку «Раздел 3.1»

Следует учитывать, что если пользователь сайта просматривает страницы первого уровня, то действие, где в качестве параметра указаны цифра 2 (второй уровень), вернёт пустую строчку, так как пользователь находиться «выше» по структуре сайта.

Шаблоны

Шаблон, используемый для построения дороги достаточно прост и не должен вызвать у вас особых затруднений.

Блоки

В таблице 16 представлены все блоки, которые вы можете использовать в шаблоне дороги, а ниже приведён пример готового шаблона:

Переменные в шаблоне

В таблице 17 представлены все переменные, которые могут быть использованы для фомирования дороги сайта.

Модуль «Карта сайта»

Описание

Модуль «Карта сайта» предназначен для построения так называемой ссылочной карты сайта. Это страница, на которой полностью отображена вся структура сайта. Часто картой сайта пользуются непосредственно посетители сайта, но гораздо более важное значение она имеет для равномерной индексации поисковыми системами всех страниц сайта.

Свойства

Модуль не имеет свойств.

Свойства к странице

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

Действия

Сформировать карту сайта

Непосредственно формирует ссылочную карту. Для настройки действия используются два параметра, указанные в Таблице 19.

Шаблоны

Стандартные блоки

Для построения карты сайта могут быть использованы следующие основные блоки, которые представлены в Таблице 20.

Все блоки достаточно просты в использовании и не вызовут у вас проблем.

Блок уровня

Для того, что бы определить внешний вид элементов карты сайта более низкого уровня (чаще всего они должны быть с отступом), необходимо использовать специальный блок уровня, который должен быть вам уже знаком по модулю «Меню».

Для получения примера использования блока уровня обратитесь к подразделу «Блок уровня» раздела «Общие особенности всех модулей».

Пример шаблона

Рассмотрим пример шаблона, для построения стандартной карты сайта:

Как вы заметили из примера, блок уровня активно используется в шаблоне. С помощью него описывается то, как будет выглядеть карта сайта до четвёртого уровня вложенности включительно. Первый уровень описывает сам блок «@link» а три остальные блоки «@nextlevel».

Переменные в шаблоне

Представленные в Таблице 21 переменные используются только в четырёх блоках шаблона.

Модуль «Новости»

Описание

Модуль предназначен организации новостных лент, или любой другой информации со схожей системой вывода и обработки. Модуль новостей подразумевает возможную интеграцию с модулями «Рассылки» и «Рассылки RSS».

Для каждой записи, введённой в базу данных модуля, вы можете определить следующие параметры:

• дата новости;
• время новости;
• заголовок новости;
• краткое описание новости (не обязательно);
• полное описание новости (не обязательно);
• признак активности;
• признак попадания в ленту новостей;
• признак попадания в рассылку;
• признак попадания в RSS рассылку;
• автор новости (не обязательно);
• название источника, откуда получена новость (если необходимо);
• URL источника, откуда получена новость (если необходимо);
• главное изображение к новости (не обязательно);

Следует отметить, что такие параметры как  «признак попадания в рассылку» и «признак попадания в RSS рассылку» предназначены для возможности использования других модулей.

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

Свойства

Модуль имеет достаточно много свойств, потому рассмотрим эти свойства по группам тех задач, на решение которых они нацелены.

Управление главным изображением

Если в новостях планируется использовать изображения, которые необходимо выводить в ленте или в архиве новостей то, вам нужно обратить на первые четыре параметра (Таб. 22).

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

У новости может быть только одно «главное» изображение, в двух (или одном) разных масштабах. Если необходимо больше изображений то их необходимо добавлять в полное описание новости, средствами встроенного редактора контента.

Управление значениями по умолчанию

Следующие свойства управляют значениями по умолчанию свойство новости, при её создании, а так же задают количество новостей на страницу, отображаемых администратору сайта (Таб. 23).

Вы можете их настроить в соответствии от вашего конкретного случая. Например, если большинство новостей НЕ должны попадать в ленту новостей, то свойство «Значение признака «В ленту» удобнее будет снять, чтобы не делать этого у каждой вновь создаваемой новости.

Свойства к странице

Модуль не имеет свойств, прописываемых к странице сайта.

Действия

Сформировать ленту

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

При клике по новости из ленты посетитель должен направляться на страницу сайта, где вызывается действие «Сформировать архив», и происходит просмотр полного текста новости. В Таблице 24 представлен перечень параметр действия.

Параметр «Тип отбора» управляет тем, какие новости будут считаться новыми и обрабатываться для формирования ленты.

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

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

И в последнем случае, при выборе в качестве значения параметра «от текущей даты в будущее», в ленту будет отобрано заданное количество новостей, начиная с текущей даты и более новые. То есть, в новостную ленту попадет заданное количество новостей будущего, начиная от текущей даты. Этот способ удобно использовать для информирования об анонсах событий.

Следует упомянуть ещё один параметр, а именно «страница архива». В этом параметре необходимо определить страницу сайта, на которой будет вызываться действие «Сформировать архив». При использовании нескольких новостных лент (а значит и нескольких экземпляров модуля «Новости») ссылка должна быть именно на ту страницу, где вызывается СВОЁ действие «Сформировать архив».

Сформировать архив

Действие «Сформировать архив» строит список всех новостей, которые есть в базе модуля и разрешены к публикации. Кроме того, это же действие отвечает за просмотр пользователем полного текста новости, при выборе одной из доступных новостей. В Таблице 25 представлен перечень параметров, используемых для настройки действия.

Рассмотрим два последних параметра действия. В случае, когда страниц в архиве становится больше, чем значение параметра «количество новостей на страницу», то появляется блок постраничный навигации. Параметр «количество страниц в блоке» определяет, сколько ссылок на разные страницы будут одновременно доступны пользователю сайта.

Второй параметр, «вид страничной навигации», определяет то, как будет строиться этот блок. При значении параметра «блоками по N страниц», посетителю сайта будут показаны страницы с 1 по N. При большем количестве доступных страниц, пользователю сайта будет доступен переход к следующему блоку, а при клике в по страницам в рамках одного блока, этот блок никак не изменяется.

Если же значения второго параметра установлено в «текущая страница в центре», разница заключена лишь в том, что при клике пользователя по конкретной странице, блок выбора страниц перестраивается таким образом, что бы выбранная страница была в центре блока.

Сформировать форму отбора

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

Действие использует всего один параметр, который представлен в Таблице 26.

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

• все новости за конкретную дату;
• новости за период, в котором одна из границ может быть не указана;

Шаблоны

Сначала рассмотрим блоки, которые используются в шаблонах действий «Сформировать ленту» и «Сформировать архив». Затем перейдём к рассмотрению блоков, используемых только в действие «Сформировать архив». И в саму последнюю очередь рассмотрим блоки действия «Показать отбор».

Общие блоки

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

Блоки страничной навигации

Теперь рассмотрим дополнительные блоки, которые обрабатываются только действием «Сформировать архив» для того, что бы сформировать навигацию по большому объёму информации в архиве. В Таблице 28 приведено описание блоков, которые используются для формирования постраничной навигации.

Пусть вас не пугает объём блоков, все они достаточно просты для понимания. Прежде всего, следует обратить внимание на блок @page_template. Именно в нём вы определяете взаиморасположение элементов навигации по страницам. А за тем, в каждом из блоков определяете, как выглядит тот или иной элемент навигации (будь то ссылка на самую первую страницу, или переход к следующему блоку).

Если вы не хотите использовать все элементы навигации, то вам просто не надо использовать соответствующую переменную-блок в блоке @page_template.

Следует отметить, что при описании всех этих блоков используется термин «страницы», который обозначает не страницы сайта (те что представлены в структуре), а страницы архива новостей, на которые разбивается весь архив.

Блоки полного представления новости

В Таблице 29 представлены остальные блоки шаблона, которые используются в действии «Сформировать архив» и предназначены для управления внешним видом полного текста новости, который формируется при клике по конкретной новости из архива или ленты.

Блоки формы отбора

Заключительным набором блоков, которые нам необходимо рассмотреть являются блоки, используемые в шаблоне действия «Показать отбор». В Таблице 30 представлен перечень этих блоков.

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

В приведенном выше примере шаблона используется одно поле, имя которого задаётся переменной

Переменные

Мы рассматриваем только прямые переменные, так как переменные-блоки заменятся блоками и уже были описаны выше. В Таблице 31 приведено описание переменных, используемых во всех блоках шаблонов.