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

Текущая версия на 14:07, 21 ноября 2018

Актуально для версии 18 85081

Содержание

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

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

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

Замечание 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. Начиная с версии 2.14.* по умолчанию используется скин Modern.

PHP код

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

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

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

FRONT-END шаблоны

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

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

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

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

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

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

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

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

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

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

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

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

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кин "Modern" - иконки для этого скина находятся в папке ~/images/cms/admin/modern/icon Для этого скина базовое имя для иконки игнорируется. Иконка должна носить имя модуля, тип иконки - прозрачный png

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

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

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

Справка

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

@@ Строка 1: / Строка 1: @@
+'''Актуально для версии 18 85081'''
 ==Расположение файлов модуля==
 Основные факты, связанные с расположением файлов модуля относительно корня сайта:
@@ Строка 6: / Строка 8: @@
 '''''Замечание 2.''' '''$template_name''' – имя файла шаблона. По умолчанию этот файл называется default.''
-'''''Замечание 3.''' '''$skin_name''' – кодовое имя скина. Начиная с версии 2.8.* в системе используется один скин '''mac – Butterfly'''.
+'''''Замечание 3.''' '''$skin_name''' – кодовое имя скина. Начиная с версии 2.8.* в системе используется скин '''mac – Butterfly'''. Начиная с версии 2.14.* по умолчанию используется скин '''Modern'''.
 ===PHP код===
-PHP код модуля расположен в директории /classes/modules/'''{$module_name}'''/
+PHP код модуля расположен в директории /classes/components/'''{$module_name}'''/
 ===Шаблоны скинов админки ===
 XSLT шаблон скина административной панели /styles/skins/'''{$skin_name}'''/
 ===FRONT-END шаблоны===
-FRONT-END шаблоны модуля. Шаблонизатор подключается по расширению файла. Существует два варианта расширений файлов:  tpl, xsl
+FRONT-END шаблоны модуля. Шаблонизатор подключается по расширению файла. Существует три варианта расширений файлов:  tpl, xsl, phtml
 ====TPL шаблонизатор====
-. Файлы лежат в /tpls/{$module_name}/'''{$template_name}'''.tpl Точкой входа является шаблон из папки /tpls/content/'''{$template_name}'''.tpl ассоциированный с конкретной страницей в административной панели.
+Файлы лежат в /templates/'''имя_шаблона'''/tpls/{$module_name}/'''{$template_name}'''.tpl Точкой входа является шаблон из папки /templates/'''имя_модуля'''/tpls/content/'''{$template_name}'''.tpl ассоциированный с конкретной страницей в административной панели.
 ====XSLT шаблонизатор====
-Все файлы шаблонов лежат в папке /xsltTpls/ . Любой файл может являться точкой входа. Правил, по которым упорядочиваются файлы в этой папке, на данный момент не существует.
+Все файлы шаблонов лежат в папке /templates/'''имя_шаблона'''/xslt/ . Любой файл может являться точкой входа. Правил, по которым упорядочиваются файлы в этой папке, на данный момент не существует.
+====PHP шаблонизатор====
+Все файлы шаблонов лежат в папке /templates/'''имя_шаблона'''/php/ . Любой файл может являться точкой входа. Правил, по которым упорядочиваются файлы в этой папке, на данный момент не существует.
-===Изобращения и CSS стили===
+===Изображения и CSS стили===
 Изображения и CSS стили, относящиеся к конкретному модулю необходимо помещать в следующие папки:
-*	CSS файлы в папку /css/cms/admin/'''{$module_name}'''.css
+*	CSS файлы в папку styles/skins/modern/design/css/'''{$module_name}'''.css
-*	IMG файлы используемые в админке помещаются в папку соответствующего скина /images/cms/admin/'''{$skin_name}'''/ внутри этой папки действуют собственные правила этого скина.
+*	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
@@ Строка 37: / Строка 37: @@
 **~/images/cms/admin/mac/icons/medium/'''{$module_name}'''.png - иконка 64x64 px
 **~/images/cms/admin/mac/icons/big/'''{$module_name}'''.png - иконка 95x95 px
-*Лёгкий cкин "Simple"  - для этого скина нет иконок.
+*Cкин "Modern" - иконки для этого скина находятся в папке ~/images/cms/admin/modern/icon Для этого скина базовое имя для иконки игнорируется. Иконка должна носить имя модуля, тип иконки - прозрачный png
 ===Иконки элементов в структуре сайта===
@@ Строка 43: / Строка 44: @@
 Спасает то, что пути для всех одинаковые:
-*~/images/cms/admin/'''{$skin_name}'''/tree/ico_'''{$module_name}'''_'''{$method_name}'''.gif
+*~/images/cms/admin/'''mac'''/tree/ico_'''{$module_name}'''_'''{$method_name}'''.gif
 ===Справка===
 В качестве справки загружается соответствующий файл из папки '''~/man/''', например, для страницы admin/content/seo/ при русском языке по умолчанию будет загружен файл /man/ru/content/seo.html
+[[Категория:Вопросы и уроки разработки сайтов на UMI.CMS]]