]> www.wagner.pp.ru Git - oss/stilllife.git/commitdiff
*** empty log message ***
authorVictor Wagner <vitus@wagner.pp.ru>
Wed, 26 Mar 2008 20:30:41 +0000 (20:30 +0000)
committerVictor Wagner <vitus@wagner.pp.ru>
Wed, 26 Mar 2008 20:30:41 +0000 (20:30 +0000)
doc/config.txt
doc/profile.txt [new file with mode: 0644]

index 90a372cc383c038b5f47036cf346b90bfd454ff4..6dab558023ebb510bb561e702b4657b630fbb6e1 100644 (file)
@@ -69,4 +69,6 @@ new_user_имя-поля - значение поля из списка restricte
 openid_user_имя-поля - значение поля информации о пользователе, которое
   следует использовать для пользователя, зарегистрированного по openid, до
   тех пор пока он не отредактировал свой profile
+indexfile - имя файла, который отдается вашим web-сервером при запросе
+       директории. По умолчанию index.html
 
diff --git a/doc/profile.txt b/doc/profile.txt
new file mode 100644 (file)
index 0000000..967be3b
--- /dev/null
@@ -0,0 +1,89 @@
+Профиль пользователя.
+
+Профиль пользователя в StillLife может содержать произвольное количество
+параметров, определяемое только фантазией хозяина форума.
+
+Часть параметров может быть установлена самим пользователем при
+регистрации или редактировании профиля, часть могут быть разрешены для
+изменения только администратору форума.
+
+Специальным образом интерпретируются следующие параметры:
+
+1. avatar - представляет собой URL на картинку пользователя вместе с
+       информацией о её размерах.
+       Если в форме присутствует поле avatarfile, типа file, то
+       зааплоаженный через него файл складывается в директорию, заданную
+       параметром конфигурации userdir и в свойство пользователя avatar
+       прописывается URL на него.
+2. passwd - используется для авторизации локальных пользователей.
+   Никогда не показывается. При регистрации специальным образом формируется
+   из полей pass1 и pass2 (значения которых должны совападать.
+
+3. email - при вводе проверяется на корректный формат. В дальнейшем, при
+  некоторых обстоятельствах форум может на этот адрес писать письма.
+
+4. status - если в конфиге указано поле
+       denied_status = значение, то локального пользователя у которого
+       поле status в
+       профайле имеет это значение, на форум не пустят. До тех пор пока это
+       значение не будет изменено посредством либо администратором форума,
+       либо посредством некоей автоматизированной процедуры.
+       Не рекомендуется использовать в качестве значений поля статус
+       значений moderator, admin и banned. Эти значения используются для 
+       характеристики прав доступа пользователя к определенному разделу
+       форума и определяются на основе файлов perms.txt
+
+5. registered - указывает время регистрации. Для OpenID пользователей
+       не определено
+6. signature - поле, которое может содержать в себе HTML или BBcode
+   разметку (если в форме рядом присутствует поле signature_format,
+   задающее тип разметки. См стандартные шаблоны). Если это поле не
+   пусто, то содержимое этого поля дописывается в конец каждого
+   сообщения, созданного данным пользователем.
+
+7  messsages, forums, topics - количество сообщений, форумов и тем,
+   которые были созданы этим пользователем. 
+
+8. last_message, last_forum last_topic - дата создания последнего
+       сообщения,  форума, темы данным пользователем.  
+
+Использовать статистические поля имеет смысл только  в шаблонах,
+обработка которых происходит непосредственно в момент отдачи
+пользователю. Если использовать поле messages в шаблоне сообщения, то 
+оно покажет сколько сообщений создал данный пользователь ДО ЭТОГО
+сообщения. 
+
+OpenID пользователи
+
+При первом заходе в систему OpenID-пользователя, с его сайта считывается
+файл foaf, из которого извлекается информация для заполнения полей
+avatar, icq, jabber. Поле status проставляется в соответствии со
+значением параметра файла конфигурации openid_status. В дальнейшем такой
+пользователь может зайти на страницу редактирования профиля и заполнить
+поля, которые не удалось извлечь из foaf (например signature)
+
+Поля, доступные для редактирования только модератору
+
+Поля, имена которых перечислены в параметре файла конфигурации 
+restricted_user_info, недоступны для редактирования пользователем.
+В форме profile эти поля доступны для редактирования только
+администратору, в форме регистрации, даже если в результате ошибки
+дизайнера шаблонов это поле будет присутствовать как поле ввода,
+введенное пользователем значение будет проигнорировано. 
+
+Если в файле конфигурации имеется параметр default_имя-поля, будет
+использовано его значение.
+
+
+Поля с ограниченным набором значений
+
+Если поле может принимать только ограниченный набор значений (например,
+поле "Пол" "Мужской" и "Женский", то в форме оно обычно представляется в
+виде элемента select, а значения описываются элементами option.
+Рекомендуется обеспечить, чтобы значение, передаваемое на сервер и
+сохраняемое в базе пользователей, было тем самым значением, которе
+показано в меню. 
+
+Для этого следует не использовать в элементах option атрибут value. При
+отсутствии этого атрибута будет использовано значение текста пункта меню.
+