Правила создания структуры проекта
Last updated
Last updated
Структура бывает:
Логическая структура показывает как сгруппированы страницы и разделы по смыслу. Логическая структура должна чётко соответствовать техническому заданию к проекту или если совсем проще то главному меню на сайте.
Физическая структура показывает расположение файлов и папок на сервере. Файлы и папки (которые участвуют в логической структуре), должны соответствовать иерархии логической структуры. Если вы создаёте отдельный раздел в логической структур О компании/История/ то в физической структуре это должно выглядеть так: about/history/index.php. И запрещается делать так: about/history.php
Все URL которые сделаны в виде ЧПУ должны закапчиваться на / Для русскоязычных сайтов: Желательно использовать трансляцию с русского языка /o-kompanii/informaciya-o-kompanii/ Менее желательно, но можно перемешивать URL на английском и на транслите /catalog/cvety-v-permi/ или /personal/reklamnye-materialy/ Для многоязычных сайтов только: /about/company/ Чтобы перевод URL заработал в автоматическом режиме, нужно в настройках > настройки продукта > настройки модулей > Главный модуль > Внешние сервисы перевода. Добавить ключ для перевода. Получить ключ можно тут.
Персональные разделы пользователей /personal/ должны быть закрыты от незарегистрированных пользователей при помощи настройки прав доступа битрикс.
Если не авторизованный пользователь хочет зайти в раздел /personal/ то перед ним должно открыться форма авторизации, которая была в вёрстке. настроить стандартный шаблон для авторизации регистрации можно в настройках > настройки продукта > настройки модулей > Главный модуль > Авторизация > Шаблон системных компонентов авторизации (system.auth.*). Если вы вынесли страницу регистрации в отдельный раздел на сайте, то для того чтобы все ссылки на эту форму работали, то необходимо а настройках > настройки продукта > настройки модулей > Главный модуль > Авторизация > Страница регистрации (для системного компонента авторизации) вписать новый URL. Если перед вами стоит задача сделать авторизацию по e-mail, то для этого необходимо в настройках > настройки продукта > настройки модулей > Главный модуль > Авторизация > Деактивировать параметр "E-mail является обязательным полем" и параметр "Проверять E-mail на уникальность при регистрации" Активировать. В файле /local/components/stmd/main.register/component.php
Все файлы которые вы подключаете в шаблоне, должны располагаться в папке /include/название файла/ . Если вы подключаете номер телефона или адрес компании в шапке сайта через bitrix:include то необходимо задать файлу расширение .txt С этим расширением клиент не сможет попортить вам вёрстку, даже если захочет! Названия файлов include должно чётко вызывать ассоциации о хоронящейся в ней информации на английском языке. Например: телефон = phone.txt или менеджер = manager.php или Баннер в левой части сайта = banner-left.php
Если вы решились на костамизацию стандартного компонента или делаете новый, то размещать его нужно в /local/components/stmd/название компонента/ Только в папку local и только в stmd! Шаблон для сайта в 90% случаях должен быть один. Второй шаблон сайта может появится только в случае если на базе уже существующего сайта реализовывается многосайтовость. Или делаются отдельные шаблоны для почтовых рассылок. шаблоны для сайта и все шаблоны компонентов должны располагаться в папке /local/templates/название шаблона/
Все тестовые и устаревшие, файлы и папки, должны быть удалены с проекта.