Структура и назначение файлов Bitrix Quick Start

Редактировать страницу

Разработку сайта на Bitrix, актуальной версии следует производить в папке local.
Читаем для чего и зачем нужна папка local

Типовая структура проекта на Quick Start:


auth/
bitrix/
├── php_interface/
│   ├── this_site_support.php
│   └── include/
│         └── site_closed.php
favicons/
includes/
    └── pages/
    │   ├── 404.php
    │   ├── main.php
    │   └── ui.php
    ├── favicons.php
    ├── footer.php
    ├── header.php
    └── html.php
local/ 
├── codenails/
│   ├── css/
│   ├── images/
│   ├── js/
│   ├── less/
│   └── tools/
├── components/
├── gadgets/
├── logs/
├── modules/
├── php_interface/
│   ├── cn_log.php
│   └── init.php
└── templates/
    ├── .default/
    │   ├── components/
    │   └── page_templates/
    │       └── standard.php
    └── rename_me/
personal/
search/
.htaccess_example
404.php
favicon.ico
index.php
robots.txt

auth/


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


bitrix/php_interface/


  • this_site_support.php — Информация о партнёре и техподдержке (нужна по требованиям монитора качества). Отображается внизу формы авторизации в админке. Этот файл не подхватывается из local, возможно со временем это исправят. Информация о поддержке и партнёре
  • include/site_closed.phpКрасивая заглушка для отключенной публички. К сожалению пока этот файл не подхватывается из папки local.

favicons/


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

Для генерации иконок очень хорошо подходит сервис realfavicongenerator.

:facepunch: Не забываем пнуть ленивого дизайнера, чтоб отрисовал нормальные иконки.

includes/


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


includes/pages/


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

  • 404.php — 404 страничка (не путать с файлом в корне, этот файл — просто вёрстка контента)
  • main.php — Главная страница.
  • ui.php — UIKit, тут собраны все основные элементы, для удобства проверки и стилизации элементов.

local/


Основная папка проекта.

local/codenails/

В этой папке содержатся файлы, относящиеся к фронтенду (стили, скрипты, картинки шаблона), а так же включаемые области и php-файлы, отвечающие на ajax-запросы.

local/codenails/css/

  • template_styles.css — Скомпилированный CSS-файл, который подключается в шаблон.
  • Так же в эту папку складываем все CSS-файлы, которые не требуется включать с LESS по различным соображениям (к примеру не требующий правок файл какого-нибудь плагина для jQuery). Файлы подключаются в автоматическом через cnAsset.

local/codenails/images/

  • В эту папку кладём картинки шаблона.
  • Если нужны временные картинки, не нужно копировать их из макета, используйте сервис (и плагин для SublimeText) не захламляйте папку.
  • ie_logo.png - не удаляем картинку, она отображается в админке (см раздел про минитор качества)

local/codenails/js/

  • Сюда складываем js-файлы и jquery-плагины, необходимые для работы шаблона, которые будут подгружаться через автозагрузчик cnAsset.
  • main.js — основной js-файл шаблона.

local/codenails/less/

Сюда складываем LESS-файлы проекта. Об организации less файлов написано в разделе LESS.


local/components/


Папка для размещения собственных компонентов.


local/gadgets/


Папка для размещения гаджетов рабочего стола (возможно когда-нибудь мы будем туда класть загортовки гаджетов)


local/logs/


Папка для хранения логов (туда автоматом записывается лог, создаваймый классом CNLog).


local/modules/


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


local/php_interface/


  • cn_log.php — Класс для ведения наглядного лога, нужен для удобной отладки того, что тяжело отладить (пример вызова в init.php)
  • init.php — init.php сайта, в который подключается дефолтный init.php. Так же там присутствуют некоторые, полезные во всех проектах, функции.

local/templates/


  • .default — папка с шаблонами компонентов.
    • page_templates/standard.php — шаблон для новых страниц (вместо глупой надписи "text here");
  • rename_me — папка с шаблоном сайта (не забываем переименовать).
    • header.php — шапка сайта.
    • footer.php — подвал сайта.
    • description.php — описание шаблона.


Папка, отвечающая за поиск по сайту и формирование карты сайта (не sitemap.xml, а непонятная сущность, формирующаяся из меню сайта).

.htaccess_example

Не забываем удалить этот файл, предварительно прочитав и сделав, как написано. Тут лежит пример правильной склейки зеркал для apache.

404.php

404-я страничка.