Расположение файлов модуля в UMI.CMS

Расположение файлов модуля

Основные факты, связанные с расположением файлов модуля относительно корня сайта:

Замечание 1. $module_name – имя модуля не должно совпадать с уже существующими в системе модулями. Список зарезервированных имен: news, content, catalog, data, autoupdate, comments, blogs, faq, filemanager, forum, vote, webforms, etc

Замечание 2. $template_name – имя файла шаблона. По умолчанию этот файл называется default.

Замечание 3. $skin_name – кодовое имя скина. Начиная с версии 2.8.* в системе используется один скин mac – Butterfly.

PHP код

PHP код модуля расположен в директории /classes/modules/{$module_name}/

Шаблоны скинов админки

XSLT шаблон скина административной панели /styles/skins/{$skin_name}/

FRONT-END шаблоны

FRONT-END шаблоны модуля. Шаблонизатор подключается по расширению файла. Существует два варианта расширений файлов: tpl, xsl

TPL шаблонизатор

. Файлы лежат в /tpls/{$module_name}/{$template_name}.tpl Точкой входа является шаблон из папки /tpls/content/{$template_name}.tpl ассоциированный с конкретной страницей в административной панели.

XSLT шаблонизатор

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

Изобращения и CSS стили

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

• CSS файлы в папку /css/cms/admin/{$module_name}.css
• IMG файлы используемые в админке помещаются в папку соответствующего скина /images/cms/admin/{$skin_name}/ внутри этой папки действуют собственные правила этого скина.

Иконки модуля

У модуля должны быть иконки определённых размеров для каждого скина. Базовое имя для иконки мы задали в файле инсталлятора ($INFO['ico']).

• Основной скин "Full" - иконки для этого скина находятся в папке ~/images/cms/admin/full
  • ~/images/cms/admin/full/ico_s/ico_{$module_name}.gif - иконка 16x16 px
  • ~/images/cms/admin/full/ico_b/ico_{$module_name}.gif - иконка 32x32 px

• Cкин "Butterfly" - иконки для этого скина находятся в папке ~/images/cms/admin/mac/icons Для этого скина базовое имя для иконки игнорируется. Иконка должна носить имя модуля, тип иконки - прозрачный png
  • ~/images/cms/admin/mac/icons/small/{$module_name}.png - иконка 42x30 px
  • ~/images/cms/admin/mac/icons/medium/{$module_name}.png - иконка 64x64 px
  • ~/images/cms/admin/mac/icons/big/{$module_name}.png - иконка 95x95 px
• Лёгкий cкин "Simple" - для этого скина нет иконок.

Иконки элементов в структуре сайта

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

• ~/images/cms/admin/{$skin_name}/tree/ico_{$module_name}_{$method_name}.gif

Справка

В качестве справки загружается соответствующий файл из папки ~/man/, например, для страницы admin/content/seo/ при русском языке по умолчанию будет загружен файл /man/ru/content/seo.html