Документация

Готовится свежая версия документации. 


Читайте также:

 

1. Общие сведения

Meruert — очень лёгкая, быстрая и нетребовательная к ресурсам CMS для ведения персонального блога. Система однопользовательская. Записи, страницы, черновики, комментарии, постраничная навигация, темы (рубрики), автоматические формирование меню двух типов, администрирование, файловый менеджер, RSS, темы дизайна, гибкое изменение шаблона вёрстки, возможность подключения плагинов, возможность ведения полностью закрытого блога, тизеры к записям, редактирование Title и Meta-тэгов, приложенные файлы, поиск по записям, многоязычный интерфейс.

 

2. Состав файлов и сборки

По умолчанию в самой простой конфигурации поставляется zip-архив, в котором лежат файлы index.php и .htaccess — этого достаточно, поскольку стили и шаблоны по умолчанию генерирует сама Meruert. Она способна генерировать и .htaccess, но не каждый хостинг позволяет модифицировать .htaccess скриптами.

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

 

3. Системные требования и установка

На хостинге обязательно должен работать PHP не ниже версии 4.3.0, желательна возможность работать с файлом .htaccess и модулем mod_rewrite; сервер Apache или любой другой; база данных не требуется.

Установка (инсталляция) заключается в следующем: необходимо распаковать архив с Meruert и полученные файлы (в простейшем случае это только index.php и .htaccess) в ту директорию, куда требуется (это может быть корневая директория сайта, а может быть вложенная директория), после чего набрать в браузере адрес вашего сайта. При первом запуске нужно будет ввести название сайта и пароль для администрирования, после чего CMS автоматически авторизует вас, и можно будет начинать работать.

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

 

4. Настройка

Настройка самой CMS довольно проста: посредством административной панели можно менять название сайта, пароль, отключать комментарии, делать блог секретным и устанавливать количество записей на страницу при постраничном разбиении (это же число настраивает и количество записей, выводимых в RSS); кроме того, если введён e-mail, то владелец блога будет получать уведомления о новых комментариях на электронный почтовый ящик.

Настройки записей блога более подробны. Часть настроек записи скрыта за раскрывающей ссылкой, чтобы на виду оставались только необходимые. Каждую запись блога можно сделать страницей (вне ленты блога) и/или черновиком, можно поместить ссылками в меню или боковую колонку, можно отключить комментарии к конкретной записи и т.п.

 

5. Записи, страницы и черновики

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

 

6. Дизайн

По умолчанию при первом запуске система устанавливает шаблон вёрстки и несколько цветовых вариантов одной схемы дизайна. При необходимости добавления темы дизайна следует скопировать оба файла из /Meruert/themes/main/, создать в папке /Meruert/themes/ новую папку и, положив туда скопированные файлы, отредактировать их по необходимости. Если нет одного из двух файлов, то недостающий читается системой из /Meruert/themes/main/; после создания своей темы дизайна её нужно подключить в настройках. Файл шаблона представляет собой две секции, в первой из которых общий шаблон, а во второй для отдельной записи.

 

7. Файловый менеджер

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

 

8. Резервное копирование и восстановление

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

Если же требуется резервирование только текстового содержимого, настроек и меню, то будет достаточно копирования файла /Meruert/data.php (его можно загрузить через файловый менеджер средствами самого сайта).

 

9. API для создания плагинов

Плагины как отдельно устанавливаемые сущности отсутствуют, но любое программное расширение, находящееся в папке Meruert/special, расценивается как плагин. Если ваше расширение располагается в /Meruert/special/abc.php, то адрес страницы с раширением будет «адрес-сайта.ру/abc/».

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


     ob_start();
     // нужное включение, дающее вывод в браузер
     $m = ob_get_contents();
     ob_end_clean();

 

Проверка, авторизован ли пользователь, осуществляется так:

if( defined('manage') ) { ... }

Расширению можно передавать параметры. По умолчанию переменная $param равна пустой строке. Однако, если ваше расширение, например, располагается в /Meruert/special/abc.php, а адрес страницы запрошен как «адрес-сайта.ру/abc/1144678/», то переменная $param будет равна значению «1144678». Значения можно передавать любые (строковые или числовые), а разбирать их уже в пределах расширения.

 

10. Особенности

Начиная со второй версии, если в папке /Meruert/js/ лежит файл meruert.js, то он будет корректно обрабатываться системой (ссылка на него появится в блоке HEAD).

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


11. О названии

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