search

yupe / yupe-ext

Дополнительные модули, виджеты и компоненты для Юпи!
15 stars 15 forks source link

Добавил модуль для чтения документации #4

Closed Veteriuz closed 11 years ago

Veteriuz commented 11 years ago

в ответ на https://github.com/yupe/yupe/issues/423

im-kulikov commented 11 years ago

А можно посмотреть вариант в работе? Не совсем понятно, как работать будет?

Veteriuz commented 11 years ago

Могу показать скриншот скриншот

im-kulikov commented 11 years ago

Предлагаю сделать настройки для модуля, то есть, чтобы можно было добавлять файлы. Хранить подобные настройки можно, например в каталоге data этого модуля, формат хранения можно взять - json Так же, стоит сделать возможность кеширования настроек, с депенденсом на этот файл. ( http://www.yiiframework.com/doc/guide/1.1/ru/caching.data#sec-2 ) Будет очень удобно, как считаете?

im-kulikov commented 11 years ago

Сможете осилить подобное? Если нет - делайте пулл-реквест ко мне в репу, доделаю и смерджу. Данный модуль как раз необходим на данный момент в мастер-ветке Юпи =)

Veteriuz commented 11 years ago

на данный момент уже можно управлять списком файлов, делается это в настройках модулей (мой линк - http://yupe.loc/yupe/backend/modulesettings/documentation), если нужен json в data - переделаем)

im-kulikov commented 11 years ago

Ок, я отпишу @xoma он посмотрит, если что напишет что по правкам =)

yupe commented 11 years ago

Парни, привет!

Смотрите, что нам необходимо. Если кратко - нам нужно повторить модуль для документации, который используется на yiiframework.ru

Общие особенности: 1 Структура каталога с доками https://github.com/yiisoft/yii/tree/master/docs 2 Возможность вести доки на N-языках (деление по каталогам en, ru и т.д.) 3 Урл для прочтения доки примерно вот такой http://yiiframework.ru/doc/guide/ru/index (отображается вот этот файл https://github.com/yiisoft/yii/blob/master/docs/guide/ru/index.txt) 4 Сами файлы документации могут быть в 2-х формтах - MarkDown (расширение .md) и HTML (.html)

Требования к модулю: 1 В модуле должна быть переменная указывающая на корневую папку с доками 2 Должен быть контроллер который будет обработывать урл-ы типа http://yupe.ru/doc/guide/ru/index Здесь doc - модуль, guide - каталог внутри основного каталога с доками, ru - язык (по сути тоже каталог), index - файл документации 3 Доки в фомате маркдаун должны кешироваться дабы каждый раз не рендерить его в html

im-kulikov commented 11 years ago

О! По форматам - я за MarkDown, его редактировать куда проще. Что касается рендеринга - да, будет круто его кешировать, тут я согласен

yupe commented 11 years ago

Тот функционал который уже есть в модуле - конечно же оставляем, все что я описал выше - это лишь дополнение.

yupe commented 11 years ago

Дополнительные требования к модулю вот тут https://github.com/yupe/yupe-ext/issues/5

Спасибо за труд!