Added some docs about configuration file

diff --git a/doc/config.txt b/doc/config.txt
new file mode 100644 (file)
index 0000000..7b2768f
--- /dev/null
+++ b/doc/config.txt
@@ -0,0 +1,48 @@
+Файл конфигурации форума
+
+Файл имеет имя .forum и размещается в корневой директории форума (там
+же, где список подфорумов верхнего уровня).
+
+Состоит из строк
+
+параметр = значение.
+
+Используются следующие параметры:
+
+templates = имя-директории-на-сервере
+       Место расположения используемого набора шаблонов. Может быть (но не
+       обязано) быть за пределами DocumentRoot.
+
+userdir = имя-директории-на-сервере
+  
+  Место, куда складываются аватары пользователей 
+
+userurl = url
+  
+  Имя под которым эта директория видна по http
+
+passwd = имя-файла-на-сервере
+
+  Место расположения базы информации о пользователях. Должно быть
+  имя файла в недоступной по http директории (за пределами DocumentRoot
+  или в крайнем случае, запрещенной для доступа через .htaccess) к
+  которой cgi-скрипты имеют доступ на запись.
+
+sessions= имя-файла-на-сервере
+
+  База активных пользовательских сессий. Те же требования
+
+authperiod - время жизни пользовательской сессии. 
+               Формат число единица измерения, где единица измерения может быть
+               m (минута)
+               h (час)
+               d (день)
+               M (месяц)
+               y (год). По умолчанию 1M.
+
+renewtime - время автоматического продления сессии. В секундах. 
+       Т.е. если у пользователя осталось меньше чем renewtime секунд до
+       конца жизни его сессии, и он выполнил какую-то операцию, требующую
+       проверки его сессии (постинг комментария, редактирование профиля)
+       его сессия продлевается на authperiod. По умолчанию 86400.
+

diff --git a/doc/templates.txt b/doc/templates.txt
index 6a0302c592fdfcef83f29d474a77933f2eba716c..c7d5baf3d6555114c0c3d11e99e2b5c5b776f28f 100644 (file)
--- a/doc/templates.txt
+++ b/doc/templates.txt
@@ -29,7 +29,7 @@ message
 manchor - якорь на который будут формироваться ссылки на это сообщение.
                Атрибут name заменяется на идентификтаор этого сообщения
 mlink - ссылка на это сообщение. Атрибут href заменяется на
-mauthor - ник автора сообщения. innerHtml заменяется на ник автора
+author - ник автора сообщения. innerHtml заменяется на ник автора
                Следует учитывать что в случае openId авторизации в этот элемент
                будет помещен элемент a со ссылкой на домашнюю страницу 
 mdate  - дата публикации сообщения  innerHtml заменяется на дату
@@ -161,7 +161,7 @@ POST-запроса уже содержащего требуемые данны
 элементов ввода заменяются на эти данные.
 
 В случае если во введенных данных произошла ошибка, сообщение об ошибке
-скрипт вписывает в элемент с классом errmsg вместо его innerHtml
+скрипт вписывает в элемент с классом error вместо его innerHtml
 
 Как правило, все скрипты получают следующую информацию 
 1. Поле с именем операции и произвольным непустым значением
@@ -201,12 +201,18 @@ POST-запроса уже содержащего требуемые данны
 
  Форма регистрации нового пользователя (операция register, форма с
  именем register)
- Содержит поля name 
- password password2 comment avatar (file upload field)
- email
+ Содержит поля user 
+ pass1 pass2 comment 
+ avatar (поле ввода URL) или avatarfile(file upload field)
+ email 
  Может также содержать любые дополнительные поля информации о
  пользователе (кроме поля status). Они будут сохранены в списке пользователей
  и могут потом выводиться в шаблонах рядом с информацией об авторе.  
+ Скрытое поле required содержит список полей, которые обязательно
+ требуются при регистрации. Поля user, pass1 и pass2 туда включать не
+ следует.
+ Скрытое поле ignore содержит список полей, которые НЕ НУЖНО
+ сохранять в качестве информации о пользователе.
 
 Скрипт отправки комментария
        
@@ -258,3 +264,10 @@ Cкрипт просмотра списка пользователей (опци
   тем/списка форумов. Желательно чтобы она делалась видимой только при
   нажатии кнопки. Отправка этой формы приводит к выполнению необходимого
   действия без  показа страницы скрипта.
+
+Служебные шаблоны
+
+Шаблон с именем error.html используется для выдачи фатальных ошибок
+скрипта. (когда нет возможности показать форму). Он должен содержать
+элемент с классом error, innerHTML которого будет заменен на сообщение
+об ошибке.