Тендер на создание пользовательской документации


Решили объявить тендер на написание пользовательской документации по LiveStreet.
Причина — банальная нехватка собственного времени. Поэтому надеемся, что среди активных пользователей нашего сообщества найдется(найдутся?) тот, кто сможет нам в этом помочь. Не бесплатно.
Мы готовы на это выделить 5000 рублей.

Что требуется: написать так называемый user guide в формате HTML по использованию LiveStreet для «чайника», желательно с иллюстрирующими скриншотами. Т.е. структурировано, доступным языком написать как пользоваться LS начиная от установки и настройки конфига, до создания своего блога/топика, голосования и т.п.

Есть желающие?

P.S. В итоге хочется получить что то подобное — liverpoolwebdesigner.files.wordpress.com/2008/01/wordpress_user_guide_v2_beta.pdf

UPD Кандидаты могут предложить структурированное оглавление руководства, это будет также критерием при выборе исполнителя.

Где найти документацию по созданию шаблонов.

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

Руководство по созданию плагина для v.0.4 на примере "Лента друзей"

Предисловие

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

Примечание. Долго не публиковал этот материал, держал в черновиках — на случай «мало-ли-что-измениться». Но думаю, кардинальных изменений в механизме плагинов в ближайшем релизе уже не будет.

Пошаговая схема:

Читать дальше →

молитва чайника или снова о силе и рейтинге.

тьфу, тьфу. чтоб не сглазить :)

Не прими господи за флудогенерацию,
Прими за ценную информацию,
Не флудим господи, а спрашиваем.
Не ради рейтинга, ради блага всеобщего,
Не спеши гуру силу использовать,
надоумь чайника RTMF-ом, Авось он и образумится.
Так изыди непонимание, останься чистое знание,
да не пойди во вред силе моей и рейтингу.
Аминь.

а теперь о силе и рейтинге…
как я понимаю святая святых движка это сила и рейтинг, собственно, то на чем держится вся идеология, однако облазил весь сайт в поисках внятного объяснения что это такое ине нашел ответа (
пришлось собирать по крохам информацию…

итак:
сразу после региcтрации и сила и рейтинг пользователя равны 0.

Сила должна зависить от активности пользователя и от оценки его работ(топиков, комментов) другими юзерами. А дельта голосования за коммент, топик, блог, юзера должна зависить от силы голосующего. Как то так :) (орт)

степень влияния рейтинга коммента на рейтинг автора самая низкая(десятые и сотые доли) т.е. даже 100 негативных оценок за коммент не могут существенно повлиять на рейтинг. Кстати 100 оценок комменту это уже много :), на той же Хабре редкость 100 голосов за коммент. Следущим по степени влияния должен быть топик, и самый большой вклад должен давать непосредственно голос за/против пользователя. (орт)

при создании личного блога автоматом ставиться порог рейтинга -1000 — получается он всегда может постить в личный :) (ort)

в. дайте определение Силе и рейтингу
о. пиписько мерство + доступ к фичам, таким как создание собственного коллективного блога и т.п.
рейтинг — по сути твой статус в сети, чем выше тем ты «круче»
сила — твоя степень влияние в сети на происходящее (ort)

в. а зачем вообще рейтинг раздвоен на два показателя?
о. чтобы при отрицательном рейтинге можно было влиять на что то за счет силы
прошу уточнение… а как это происходит?

В. на что влияет сила?
О. Сила влияет на то как сильно будет влиять голос пользователи при голосовании за что либо. (орт)

В. как уменьшается сила?
О. сила уменьшается при голосовании в «минус» (орт)

В. как увеличивается сила?
о. Сила растёт по похожему алгоритму с рейтингом. (iValera)
прошу уточнение… вопрос не в алгоритме, а в идее? каким образом у меня может подняться сила?

В. как изменятется рейтинг?
о. Рейтинг можно изменять: плюсовать и минусовать коменты, топики, самого пользователя. По рейтингу ведётся ТОП. На то как сильно будет расти и уменьшаться рейтинг при голосовании — влияет сила голосующего. (iValera)

в. каков принцип рейтинга в блоге?
о. вообще принцип прост: 1) вступаеш в блог 2) набираеш нужнок количество кармы (рейтинга) 3) спокойно пишешь в блог
уточнение — создатель блога может писать в него при любом рейтинге,
за возможность создания блога, возможности голосования и т.п. отвечает модуль ACL, который разруливать все возможности по рейтингу (орт)

пожалуй это все что я нашел с топиках о Этом.

в итоге вопросы про рейтинг ушли, остаются вопросы про силу… (смотрим выше)

upd.:
Сила это возможность действовать, создавать, если бы сила была отрицательной то по идее это был бы заблокированный аккаунт, «твоя степень влияния в сети на происходящее», опыт.
Рейтинг — это оценка действий пользователя, вектор силы, карма пользователя, при отрицательной карме его силу (действия) искусственно ограничивают. То как вашу деятельность воспринимают остальные участники сообщества.

при голосовании за комментарий в плюс немного увеличивается сила пользователя,
при голосовании за топик сила и рейтинг увеличиваются пропорционально силе голосующего, при голосовании за пользователя — влияние голоса еще сильнее.

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

Нехватка документации

Парни, движёк охрененный, честно, все классно, но несколько дней сижу прикручиваю модуль и испытываю жуткую нехватку документации и примеров по движку! Всю информацию приходится искать по крупицам по всему сайту, а та скудная вики, что есть сейчас, даёт лишь образное представление о работе. Жесть. Нужно менять как то ситуёвину. Очень нужно.

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

Очень уж хочется использовать ваш движок в проектах, но отсутсвие полноценной докуменатции никак не позволяет мне решиться на этот шаг. Конечно Wiki и статьи, разбросанные по блогам это немножко хорошо, но не совсем. Например вообще непонятно как работают Entity и как передаются параметры в отображения (Viewer_Assign как я понял, но видимо есть еще способы, т.к. многие параметры доступны и без него) Непонятна логика, почему код функционала имеется и в экшенах и в модулях и в темплейтах :( и что за такие глобалдьные переменные _aData и какие есть функции у классов стандартных (например у oDb).

Отличным примером документации может служить http://code-igniter.ru/user_guide/toc.html, это так, на заметку.

PS: прошу прощения за такое наглое поведение :)

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

Т.к. появились платные модули предлагаю обсудить вопрос структуры модуля и его свойства:

Модуль — набор програмных средств призванный расширить функционал стандартного ядра движка.

В модуле должно быть:

1) Текстовое описание модуля и его функций
2) Файл таблиц баз данных, если модуль использует свои таблицы и запросы
3) Версия движка (с казанием версии), уже содержащая этот модуль
4) Описание ручной установки модуля
5) Описание возможных проблемных ситуаций и пути их решения
6) контакты разработчика
7) Файл автоматической установки модуля в лайвстрит

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

Т.к. разработчик несет моральную и материальную ответственность за созданый им продукт перед клиентом. А клиент зачастую не может увидеть ничего кроме демострации работы модуля.

Wiki

Друзья!
Мы видим что сообщество уже разделилось на 2 типа людей:
1. Люди, которые приходят и задают вопросы.
2. Люди, которые уже задали вопросы, изучили движок и вносят предложения.

Давайте наконец сделаем wiki-страничку проекта, где каждый сможет по чуть-чуть описать что он знает о движке. Там же можно сделать FAQ типичных ошибок и т.п.
Upd. Я создал страничку: http://livestreet.wiki.zoho.com
Редактировать могут только зарегистрированные пользователи, комментировать все. Давайте сделаем хороший мануал!

Как говорится с миру по нитке — голому рубаха. Я бы с удовольствием периодически пополнял информацией страницу проекта.

В основном конечно предложение относится к орт:)

Читать дальше →

Новый механизм евентов

Изменил механизм регистрации и выполнения евентов в экшене.
Теперь можно регистрировать евент используя регулярные выражения, как для самого евента, так и для всех параметров, передаваемых в URL. Это позволяет избавиться от переопределения метода EventNotFound() при динамических евентах.

$this->AddEvent('edit','EventEditBlog');
$this->AddEventPreg('/^(\d+)\.html$/i','EventShowTopicPersonal');
$this->AddEventPreg('/^\w+$/i','/^(\d+)\.html$/i','EventShowTopic');
$this->AddEventPreg('/^\w+$/i','/^bad$/i','/^$/i','EventShowBlogBad');
$this->AddEventPreg('/^\w+$/i','/^bad$/i','/^page(\d+)$/i','EventShowBlogBad');

Так же осталась возможность использовать старый вариант с методом AddEvent(), он просто является оберткой для AddEventPreg().
Изменения здесь — http://trac.lsdev.ru/livestreet/changeset/35, просьба кто может протестить новый механизм :)

Описание ядра LiveStreet

Данная документация прежде всего для людей знакомых с PHP(объектной моделью) и желающих модифицировать движок.

Общее представление


Движок LiveStreet построен на базе собственного фреймворка с использованием модульности и модели MVC.
Фреймворк представляет из себя каркас из абстрактных классов(абстракции module, action, block, mapper, entity), ядро(engine), роутер(route) и набор системных модулей(модули с префиксом sys_).
Читать дальше →