Дискуссия: Расширения и документация yii

Уже исправленные репорты или принятые предложения
Аватара пользователя
Одиночка Айс
Сообщения: 267
Зарегистрирован: 2010.02.05, 10:26
Откуда: Алма-Ата, Казахстан
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Одиночка Айс » 2010.05.16, 15:39

Мде... Таким макаром нужно или ждать пока разработка фреймворка остановится совсем (что, думаю, в ближайшие пять лет не произойдет точно), либо изначально писать на русском, либо писать русский фреймворк.
Ни любви, ни тоски, ни жалости...

Ekstazi
Сообщения: 1428
Зарегистрирован: 2009.08.20, 22:54
Откуда: Молдова, Бельцы
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Ekstazi » 2010.05.16, 22:54

Sam Dark Sam, как вариант можно сортировать комменты в порядке убывания времени, то есть свежие комменты первыми показывать, это разрешит проблему актуальности комментариев, или, как альтернативу, использовать нечто вроде привязки комментов к определеной версии фрэймвока. Думаю первый вариант предпочтительней

Аватара пользователя
Одиночка Айс
Сообщения: 267
Зарегистрирован: 2010.02.05, 10:26
Откуда: Алма-Ата, Казахстан
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Одиночка Айс » 2010.05.17, 08:45

Кстати, я так и не понял, нафига в гуглекоде было переводить файлы(!), когда я считаю нужно API перевести (для чего нужно и как юзать).
Ни любви, ни тоски, ни жалости...

Аватара пользователя
Caveman
Сообщения: 152
Зарегистрирован: 2009.04.04, 20:56
Откуда: Москва
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Caveman » 2010.05.17, 10:14

Sam Dark писал(а):API постоянно меняется, поэтому перевод постоянно устаревает. Чтобы это отслеживать и работать над переводом командой нужен как минимум SVN. То, что сейчас в http://code.google.com/p/yiiru/ уже не актуально, хотя Алексей вложил в перевод довольно много сил и времени.
Да, работа над переводом приостановилась, но она есть. Как минимум то, что уже есть в гуглекоде, поддерживается в актуальном состоянии (правда, локально пока). В данный момент доделываю обновленную диаграмму классов.
Одиночка Айс писал(а):Кстати, я так и не понял, нафига в гуглекоде было переводить файлы(!), когда я считаю нужно API перевести (для чего нужно и как юзать).
Какую версию АПИ Вы предлагаете переводить? И есть ли какие-то вообще идеи по переводу АПИ, но с заделом на будущее, на возможность обновления и синхронизации с оригиналом?
Перевод файлов как минимум проще - я могу заглянуть в код метода, чтобы убедиться, что правильно понял фразу. Плюс, легко можно использовать (будет когда-то, надеюсь ))) переведенный пакет при разработке.
А вот синхронизация тяжеловата конечно. Придумать бы что-то достаточно удобное...

Аватара пользователя
Одиночка Айс
Сообщения: 267
Зарегистрирован: 2010.02.05, 10:26
Откуда: Алма-Ата, Казахстан
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Одиночка Айс » 2010.05.17, 10:25

Для начала, не помешало бы перевести нечто общее, вряд ли метод app() или getVersion() будут меняться, дальше думаю по запросам пользователей, хотя... хз, решать разработчикам и переводчикам.
Ни любви, ни тоски, ни жалости...

Ekstazi
Сообщения: 1428
Зарегистрирован: 2009.08.20, 22:54
Откуда: Молдова, Бельцы
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Ekstazi » 2010.05.17, 11:03

Есть одна идея, судя по phpdoc комментам там для каждого метода указано с какой версии фрэймвока он не менялся(если я верно понял), так вот на основе этого можно написать скрипт/прогу которая бы извлекала из php файлов phpdoc комментарии, проверяла их изменились они или нет(изменился ли функционал метода), и если да, то подставляет описание на английском, иначе на русском.

snowflake
Сообщения: 24
Зарегистрирован: 2010.05.14, 12:15

Re: Дискуссия: Расширения и документация yii

Сообщение snowflake » 2010.05.21, 00:03

Уважаемое сообщество, извините, но я считаю переводить API - это просто бредовая затея. Во-первых, как бы вы не старались - перевод всегда (или почти всегда) будет не актуальным, во-вторых, он очень зависит от переводчика (то есть, не всегда сохраняет первоначальный смысл), в-третьих - ну зачем? Я не думаю что для кого то есть проблемно прочитать небольшое описание или пояснение на английском, если это не так - то это реально проблема такого человека и ему стоит о ней задуматься. Не хочу никого обидеть - но это факт.
Лучше все эти силы (которые будут затрачиваться на переводы API) направить в действительно нужное русло - примеры, примеры и ещё раз примеры.
Вот это проблема документации, а не перевод. Да перевод мануала, возможно кому то пригодиться, возможно даже многим (так как там текста много и часто он очень отходит от технического), но не стоит заниматься переводом API, лучше напишите примеры.

snowflake
Сообщения: 24
Зарегистрирован: 2010.05.14, 12:15

Re: Дискуссия: Расширения и документация yii

Сообщение snowflake » 2010.05.21, 00:08

Sam Dark писал(а):Пока решение видится таким:
Надо отделить текущие расширения и официально одобренные.
Текущие оставить неконтролируемой свалкой, для официальных ввести процесс, похожий на proposals ZF: т.е. описание задачи, API, тесты, стандарты
В официальные не допускать более одного решения, выполняющего сходные задачи.
Полностью согласен, именно так и нужно делать. Если, это на данный момент нельзя осуществить с помощью разработчиков фреймворка (или хотя бы получить от них одобрение такой идеи), то нужно показать им что это должно работать - а показать это можно только взяв какое-то расширение из тех которые реально часто используются и начать его поддерживать, переписывать под новые версии и т.д. В такой работе я готов поучаствовать.

snowflake
Сообщения: 24
Зарегистрирован: 2010.05.14, 12:15

Re: Дискуссия: Расширения и документация yii

Сообщение snowflake » 2010.05.21, 00:13

Одиночка Айс писал(а):Для начала, не помешало бы перевести нечто общее, вряд ли метод app() или getVersion() будут меняться, дальше думаю по запросам пользователей, хотя... хз, решать разработчикам и переводчикам.
Посмотри их английские описания. Зачем их переводить? Проблемно понять для чего они (если не с названия, то с английского описания)? Зачем делать ОГРОМНУЮ и глупую работу?

Аватара пользователя
timlar
Сообщения: 1382
Зарегистрирован: 2009.09.19, 17:49
Откуда: Украина, Днепропетровск
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение timlar » 2010.05.21, 01:02

Солидарен с snowflake. Лучше писать мануалы и как-то удобно структурировать их, чтобы можно было легко найти нужный мануал по различным критериям. Перевести 3 строчки описания API можно и в ГуглТранслейте, если у кого-то уж совсем всё плохо с английским.

Может сделать какое-то YiiWiki? Правда там поиск не удобный...
Twitter: @timlar_ua

Аватара пользователя
Одиночка Айс
Сообщения: 267
Зарегистрирован: 2010.02.05, 10:26
Откуда: Алма-Ата, Казахстан
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Одиночка Айс » 2010.05.21, 09:27

Но прежде чем писать мануалы, нужно ПОНИМАТЬ как это все работает. Короче, пока мы тут воду льем, время идет, и каждый мучается сам по себе, лишь изредка спрашивая совета у других.
Ни любви, ни тоски, ни жалости...

snowflake
Сообщения: 24
Зарегистрирован: 2010.05.14, 12:15

Re: Дискуссия: Расширения и документация yii

Сообщение snowflake » 2010.05.21, 15:47

Одиночка Айс писал(а):Но прежде чем писать мануалы, нужно ПОНИМАТЬ как это все работает. Короче, пока мы тут воду льем, время идет, и каждый мучается сам по себе, лишь изредка спрашивая совета у других.
Абсолютно согласен, но мне для понимания очень не хватает примеров в API, именно примеров, так как их нет, из-за недопоняток приходится или искать примеры или смотреть в корень (к код фреймворка). Хочу подчеркнуть ещё раз не хватает примеров, а не перевода API.

Аватара пользователя
aser
Сообщения: 167
Зарегистрирован: 2009.04.02, 14:25
Откуда: Киев

Re: Дискуссия: Расширения и документация yii

Сообщение aser » 2010.05.21, 15:59

snowflake писал(а):
Одиночка Айс писал(а):Но прежде чем писать мануалы, нужно ПОНИМАТЬ как это все работает. Короче, пока мы тут воду льем, время идет, и каждый мучается сам по себе, лишь изредка спрашивая совета у других.
Абсолютно согласен, но мне для понимания очень не хватает примеров в API, именно примеров, так как их нет, из-за недопоняток приходится или искать примеры или смотреть в корень (к код фреймворка). Хочу подчеркнуть ещё раз не хватает примеров, а не перевода API.
Аналогично, вместо 3х абзацев хоть на русском, хоть кухарском, пример является более наглядным и понятным для восприятия!

Аватара пользователя
Одиночка Айс
Сообщения: 267
Зарегистрирован: 2010.02.05, 10:26
Откуда: Алма-Ата, Казахстан
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Одиночка Айс » 2010.05.21, 17:46

А вот теперь следующий вопрос: у каждого свои потребности, кому-то нужно одно, кому-то другое от одного и того же функционала. Тут как быть? От простого к сложному? Но опять таки, у одних может работать на 100%, а других с глюками, у третьих - вообще не будет работать.
Ни любви, ни тоски, ни жалости...

Аватара пользователя
samdark
Администратор
Сообщения: 8773
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2010.05.21, 19:42

Одиночка Айс
А поконкретней можно? Ничего не понял…

Аватара пользователя
timlar
Сообщения: 1382
Зарегистрирован: 2009.09.19, 17:49
Откуда: Украина, Днепропетровск
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение timlar » 2010.05.22, 02:25

Как вариант, можно сделать некий вишлист. Допустим, кто-то пишет туда "Хочу пример работы с таким-то классом" или "Хочу пример реализации такого-то функционала", а далее любой желающий выкладывает туда пример(ы), которые в последствии добавлять в общую базу. Как-то так...
Twitter: @timlar_ua

Аватара пользователя
samdark
Администратор
Сообщения: 8773
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2010.05.22, 03:23

Ну, вишлист уже есть — это багтрекер Yii.

snowflake
Сообщения: 24
Зарегистрирован: 2010.05.14, 12:15

Re: Дискуссия: Расширения и документация yii

Сообщение snowflake » 2010.05.22, 12:36

Одиночка Айс писал(а):А вот теперь следующий вопрос: у каждого свои потребности, кому-то нужно одно, кому-то другое от одного и того же функционала. Тут как быть? От простого к сложному? Но опять таки, у одних может работать на 100%, а других с глюками, у третьих - вообще не будет работать.
Это понятно что у каждого свои потребности, речь идет о том что большинству реально не хватает примеров в документации, под примерами я понимаю просто кусочки кода такого вида - если припустим у нас вот такая ситуация, то данный класс можно применить вот так вот. И чем более пример будет показывать преимущества Yii тем лучше. Пример служит отрывной точкой и наглядным пособием типа вот так вот должно работать. Пример может быть довольно абстрактным, но он должен показывать так сказать механизм использования и не более. А вот если тебе нужно что то по сложней сделать - тогда нужно это делать, но механизм как оно будет работать ты видишь.
А сейчас ситуация такая что на много простых вещей приходится тратить очень много времени, просто потому что ты не видишь как их предполагалось использовать. Вот и все. Думаю я правильно понял твой замысловатый вопрос и постарался донести мое мнение по поводу ответа.

minibikini
Сообщения: 51
Зарегистрирован: 2010.04.21, 21:27

Re: Дискуссия: Расширения и документация yii

Сообщение minibikini » 2010.05.22, 13:48

Поддерживаю — примеры в API необходимы. Странно что это вообще обсуждается, примеры в API — это стандартная практика.

Аватара пользователя
samdark
Администратор
Сообщения: 8773
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2010.05.22, 14:33

Да что примеры необходимы и так понятно. С обсуждением необходимости пора заканчивать и переходить к конкретным действиям — сбору заявок на примеры к классам и методам. Далее всё это дело я оформлю в тикеты и постепенно добавлю в фреймворк.

Ответить