Re: [PHP-DOC] user comments of the future
I too feel compelled to participate in this thread... On Apr 1, 2009, at 9:06 AM, Richard Quadling wrote: 2009/3/31 Philip Olson phi...@roshambo.org: As far as using a fancy looking comment system, I would vote for it. Everything is going web 2.0 with the ooohhh and ahhhs (gmail is a prime example, there are tons of libraries and sample code for Javascript effects). Almost every site I visit uses some sort of Javascript or AJAX in background (even vBulletin has gone AJAX to some extent). Yeah, people almost expect such features these days. Personally I think there is a usability case to be made for some Ajax- style features as well. My clients find edit in place to be a very easy feature to understand. So, for me, it's not just about being fancy or following the latest trend. After all, if it *were* about that, we'd all be using RoR by now... ;-) [snip snip] You don't need 2 versions. Even with the most complex of sites, it should be developed without JS initially. You then use unobtrusive JavaScript inclusion to modify the page as appropriate. This technique allows the widest range of clients with the least amount of effort. It is pretty much a given that the user-agent string is useless for anything other than truly rudimentary browser analysis. The browscap.ini file from Gary Keith (http://browsers.garykeith.com/stream.asp?PHP_BrowsCapINI) is fine and dandy but is updated pretty much every week. New user-agent strings are constantly being created. And, having said that, the agent string doesn't actually tell you if JS is supported or enabled. That can only be done on the client. So, they say don't bother. Assume it isn't. That way you site works with no special effects, AJAX, etc. Add JS to the mix and its a few form actions overridden, some observers and voila, Web 2.0 in all its glory. [snip snip] I use Prototype/Scriptaculous (both served by Google API, so the more sites that use the Google API cache the better for all). When using AJAX I supply a JS callback (using the JSONP concept) to let server side know the style of call being made. Essentially this means 1 set of HTML/CSS (with or without JS) and 1 set of server side scripts which are told to generate HTML or JSONP output. All the server side logic should be identical and it is just the output that is tuned. This is totally the way to do it and there are a few frameworks out there that lend themselves to just such an approach. If you think of it as an MVC approach, in the View stage you analyze the format of output requested and respond accordingly. Richard really does understand how it should be done. Also, it should be noted that for people who aren't able to render the JS (such as screen readers), accessibility is maintained. 1+ for using this approach... G. T. Stresen-Reuter Web: http://tedmasterweb.com Blog: http://tecnotertulia.com Twitter: http://twitter.com/tedmasterweb
Re: [PHP-DOC] user comments of the future
Hi 2009/3/28 Philip Olson phi...@roshambo.org We've discussed our comment system a few times but let's finally do something about it. Let's first discuss what our ideal user interactive system would be, then design a system while keeping in mind our resource limitations. Well, I like to start by looking at the existing system. So from a quick analysis, the types of user notes we currently see are: Comments to enhance the documentation: i.e. expanded code examples, use cases. Comments to correct the docs: fix typos, report changed behaviour Comments to correct/enhance previous user note(s) Comments with a link to article/blog post Comments asking for help Which in my view breaks down to the following functionality: Report errors: redirect to bug report (online editor later)? Request help: redirect to a 'where to get help' page? Comment: Auto tagged with the relevant PHP function/method? Optional 'code snippet' tag ? Optional 'hyperlink' tag ? So I agree with you that the users seem to want a code snippets/tips/etc repository. When you take out the error reports and help requests, a code snippets/tips/etc repository is left. Not sure about using tags though, I don't quite see what your goal is with tags. It's cool and all that but what's the benefit, when comments are linked specifically to a doc on paragraph/section level? Or are you thinking of accessing comments through a separate interface as well, without needing to go through the doc pages? That could be interesting :) Voting, I agree would be very useful. It should be possible to vote down a comment also imo, let the negative votes of users tell us which comments might need attention. And the high scoring comments will hopefully be the most useful. Aha, I now understand how tags could be used. An excellent code snippet for PHP 5.3 for example could be irrelevant (unavailable) for PHP 5.2. It would be nice to filter comments by versions, and I guess if I think about it further I'll find other examples of useful tags... I'm just thinking out loud here, a 'first impression' response. Juliette
Re: [PHP-DOC] user comments of the future
On Thu, Apr 2, 2009 at 13:46, Juliette jux...@gmail.com wrote: Voting, I agree would be very useful. It should be possible to vote down a comment also imo, let the negative votes of users tell us which comments might need attention. And the high scoring comments will hopefully be the most useful. We do have a patch available for voting system somewhere on the php-webmaster@ mailinglist if anyone wants to review it and commit... -Hannes
[PHP-DOC] Hi, I want to register a CVS account
Hi, PHP Doc Group My name is Weiguang Zhang, from Shanghai City, China. My career is Software Tester. I graduated from Qingdao University from July,2007. I am studying PHP, But I only find document(Chinese version ) from archive folder. I find the Chinese version is a little older and there is no body to update it. I want to translate the latest PHP document from English to Chinese. But I have no CVS account to check in. Could you help me? Have a nice day! Thanks, Weiguang Zhang ___ 好玩贺卡等你发，邮箱贺卡全新上线！ http://card.mail.cn.yahoo.com/
