View file docs/dev.files.html

File size: 6.87Kb
<html>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>Документация по MobileCMS</title>
	<link rel="stylesheet" href="style.css" type="text/css" />
</head>

<body><div class="navheader">
<table width="100%" summary="Navigation header">
	<tr>
		<th align="center">Документация по MobileCMS</th>
	</tr>
	<tr>
		<th align="center">Дерево каталогов</th>
	</tr>
</table>
<hr />
</div>
    
<div class="refsect1">
	<h2>/cache</h2>
	<p class="classname">
		Предназначен для хранения кэша системы. В свою очередь делится на две поддиректории file_cache и smarty_templates.<br /> 
		Подкаталог file_cache предназначен для хранения файлов кэша системы, например, в нем хранится кэш главной страницы.
	</p>
</div>

<div class="refsect1">
	<h2>/data_files</h2>
	<p class="classname">
		Предназначен для хранения конфигурационных файлов системы и важных файлов данных.<br />
		Структура подкаталога:<br />
		<ul>
			<li>каталог <strong class="command">data_files/<b>events</b></strong> необходим для хранения файлов событий различных модулей</li>
			<li>каталог <strong class="command">data_files/<b>route_rules</b></strong> предназначен для хранения правил роутинга системы, напоминает rewrite_rules mod_rewrite</li>
			<li>файл <strong class="command">data_files/<b>config.php</b></strong> содержит основную конфигурацию системы, такую как данные БД и адрес сайта</li>
			<li>файл <strong class="command">data_files/<b>day.dat</b></strong> содержит одну цифру - текущий день, предназначен для реализации выполнения ежедневных действий в системе</li>
			<li>файл <strong class="command">data_files/<b>forgot_message.tpl</b></strong> — шаблон сообщения при восстановлении пароля</li>
			<li>файл <strong class="command">data_files/<b>reg_message.tpl</b></strong> — шаблон сообщения при регистрации пользователя в системе</li>
			<li>файл <strong class="command">data_files/<b>version.dat</b></strong> содержит информацию о текущей версии MobileCMS</li>
		</ul>
	</p>
</div>

<div class="refsect1">
	<h2>/files</h2>
	<p class="classname">
		Содержит файлы загрузок, аватаров, библиотеки (подкаталоги downloads, avatars, lib соответственно), а так же файлы и папки дополнительных модулей.
	</p>
</div>

<div class="refsect1">
	<h2>/install</h2>
	<p class="classname">
		Содержит файлы  установщика.
	</p>
</div>

<div class="refsect1">
	<h2>/js</h2>
	<p class="classname">
		Хранит файлы JavaScript, в данный момент только JS фреймворк JQuery
	</p>
</div>

<div class="refsect1">
	<h2>/kernel</h2>
	<p class="classname">
		Cодержит важные файлы ядра системы. Содержимое каталога:
		<ul>
			<li>файл <strong class="command">kernel/<b>everyday.php</b></strong> скрипт, выполняющий ежедневные действия в системе, например, чистит старые файлы в каталоге временных файлов tmp</li>
			<li>файл <strong class="command">kernel/<b>general_functions.php</b></strong> содержит основные функции системы, а так же аналоги некоторых функций, которых нет в ранних версиях php5. Описание функций будет приведено ниже.</li>
			<li>файл <strong class="command">kernel/<b>ini_set.php</b></strong> содержит важную конфигурацию php для правильной работы MobileCMS</li>
		</ul>
	</p>
</div>

<div class="refsect1">
	<h2>/libraries</h2>
	<p class="classname">
		Содержит основные библиотеки системы. Детальное описание библиотек смотрите в разделе <a href="libraries.html">краткое описание библиотек</a>
	</p>
</div>

<div class="refsect1">
	<h2>/modules</h2>
	<p class="classname">
		Содержит модули системы
	</p>
</div>

<div class="refsect1">
	<h2>/tmp</h2>
	<p class="classname">
		Содержит временные файлы системы, которые удаляются каждые сутки
	</p>
</div>

<div class="refsect1">
	<h2>/utils</h2>
	<p class="classname">
		Содержит вспомогательные файлы системы
		<ul>
			<li>файл <strong class="command">utils/<b>captcha.php</b></strong> скрипт для генерации каптчи (защитное изображение)</li>
			<li>файл <strong class="command">utils/<b>default_font.php</b></strong> основной шрифт системы</li>
			<li>файл <strong class="command">utils/<b>mimes.php</b></strong> файл, содержащий массив mime типов</li>
			<li>файл <strong class="command">utils/<b>time_zones.php</b></strong> файл, содержащий массив временных зон</li>
		</ul>
	</p>
</div>

<div class="refsect1">
	<h2>/views</h2>
	<p class="classname">
		Содержит папки тем
		<ul>
			<li><strong class="command">views/<b>admin_*</b></strong> темы админки</li>
			<li><strong class="command">views/<b>web_*</b></strong> web темы (в данный момент не используются)</li>
			<li>папки без префиксов — основные темы сайта</li>
		</ul>
	</p>
</div>

<div><br /><br /></div>

<div class="navfooter"><hr />
	<table width="100%" summary="Navigation footer">
		<tr>
			<td width="40%" align="left"><a href="dev.enter.html">Пред</a></td>
			<td width="20%" align="center"><a href="index.html">На уровень выше</a></td>
			<td width="40%" align="right"><a href="dev.general_functions.html">След</a></td>
		</tr>
		<tr>
			<td width="40%" align="left" valign="top">Введение</td>
			<td width="20%" align="center">Содержание</td>
			<td width="40%" align="right" valign="top">Главные методы ядра</td>
		</tr>
	</table>
</div>
    
</body>
</html>