Re: [PHP-DOC] Re: online phpdoc-all editing tool

[Philip Olson]

 - how to manage the patch queue



Well, IMO what's most important here is, assuming this is open to  
everyone, not just people with doc-karma, to keep it moderated. So  
eg. all patches get sent to the appropriate mailinglist, and can be  
blocked/added there. It's imporant to do so, since most people don't  
bother reading about coding styles, about styles of writing (in  
first person, third person, etc.), and such. So, a bit of moderation  
there is important I think.


This is indeed an important aspect of the system and deserves  
(requires) a lot of thought. For now all it does is allow the user to  
save the file but eventually it will likely save the files to the  
server (patch queue) for translators to find/manage/commit. Since some  
patches will be perfect, some require light editing, some major  
editing, and some bogus, how to deal with all of that is a question  
too. As are guidelines for crediting patch creators in the commit  
message, and being sure we write a "the manual is granted all rights  
to this content, blah blah blah..." in the proper place.


And simplifying the HOWTO for patch creators is a good idea too, as  
I'm sure we can come up with a quick guide about writing style and  
format.


Regards,
Philip

Re: [PHP-DOC] Re: A PHPDoc DTD: Making subfiles validate

[Philip Olson]

Not really userfriendly solution, any ideas?


How are the ideas in this thread progressing? And please be clear  
about how the changes affect translations... So am I understanding it  
correctly that:


 1. All files will add a If so, these two parts can be done with very little impact on  
translations so that's nice. As for the English fallback situation,  
where are we at on that? Maybe there are people outside this list that  
can offer opinions too, like Rob Richards?


Regards,
Philip

Re: [PHP-DOC] Summer of Code Introduction

[Daniel Brown]

On Tue, Apr 22, 2008 at 5:16 PM, Nicholas Sloan
<[EMAIL PROTECTED]> wrote:
> Hi, my name is Nicholas Sloan and I was selected to participate in this
> year's Summer of Code program for the PHP project. Hannes Magnusson will be
> mentoring me as I work on PhD (The PHP Based Docbook Renderer). I'm excited
> to be working on the docs, since I feel that great documentation  can be the
> most welcoming thing to a new programming language for most users. The only
> thing that might be important is the community, but PHP's community
> certainly doesn't need any help at being great.
>
>  In any case, I look forward to working with everyone and getting to know
> you all this summer. If you have any questions, feel free to ask any time.

I do have one question, Nick: who the hell do you think you are?

Just kidding.  A quote by Stewie from Family Guy happened to be
playing through my headphones as I read your part about questions, and
seemed an ample introduction.

Welcome aboard!  Now get to work, slave.  ;-P

Oh, and P.S. - you lucked out with your mentor.  Hannes is a great
guy, and knows his stuff.  Take advantage of that and learn as much as
possible from him.

-- 

Dedicated Servers - Intel 2.4GHz w/2TB bandwidth/mo. starting at just
$59.99/mo. with no contract!
Dedicated servers, VPS, and hosting from $2.50/mo.

[PHP-DOC] Re: online phpdoc-all editing tool

[M. Sokolewicz]

Philip Olson wrote:

Hello everyone-

A few days ago Salah Faya introduced an online DocBook editing tool to 
phpdoc-ar here:


  http://news.php.net/php.doc.ar/758

We briefly talked about the possibility of having this work with all of 
phpdoc-all so let's discuss that now. Currently it's suited for new 
pages (no revcheck capabilities...) but Salah has some plans for that 
and is eager to hear ideas. Have a look and discuss what you think about 
this tool and how it can be implemented.


A few random thoughts to help get us started:

  - docs.php.net or doc.php.net or ...
  - how to manage the patch queue
  - how to implement revcheck capabilities
  - will we ever integrate 'cvs commit' directly
  - how will the 'edit this' option be presented to users
  - can we alter our html to better help this tool... like ids per block
  - cvs location of this tool
  - ...

In the past we've brought up the idea of having such a tool but never 
implemented it... well it's happening now so let's do this. As soon as 
we figure out where it'll of course be in CVS for people to play with.


Regards,
Philip



Well, IMO what's most important here is, assuming this is open to 
everyone, not just people with doc-karma, to keep it moderated. So eg. 
all patches get sent to the appropriate mailinglist, and can be 
blocked/added there. It's imporant to do so, since most people don't 
bother reading about coding styles, about styles of writing (in first 
person, third person, etc.), and such. So, a bit of moderation there is 
important I think.


- Tul

[PHP-DOC] Summer of Code Introduction

[Nicholas Sloan]

Hi, my name is Nicholas Sloan and I was selected to participate in this 
year's Summer of Code program for the PHP project. Hannes Magnusson will 
be mentoring me as I work on PhD (The PHP Based Docbook Renderer). I'm 
excited to be working on the docs, since I feel that great documentation 
 can be the most welcoming thing to a new programming language for most 
users. The only thing that might be important is the community, but 
PHP's community certainly doesn't need any help at being great.


In any case, I look forward to working with everyone and getting to know 
you all this summer. If you have any questions, feel free to ask any time.


For those of you that are interested, here is a link to my project abstract:
http://code.google.com/soc/2008/php/appinfo.html?csaid=74121AFCC0C7C341

And here is a link to my project proposal:
http://nicholassloan.com/public/gsoc.pdf

Regards,

Nicholas Sloan

Re: [PHP-DOC] online phpdoc-all editing tool

[Hannes Magnusson]

On Tue, Apr 22, 2008 at 10:20 PM, Philip Olson <[EMAIL PROTECTED]> wrote:
> Hello everyone-
>
>  A few days ago Salah Faya introduced an online DocBook editing tool to
> phpdoc-ar here:
>
>   http://news.php.net/php.doc.ar/758

Looks very good!
The only issue I have with it is when editing multiple lines (i.e.
long ) it feels like I should be translating the sentence
literally word for word..

-Hannes

[PHP-DOC] Moving "function index" and default to book TOC?

[Hannes Magnusson]

Hei!

> The index
> (http://docs.php.net/manual/en/indexes.php) should be found a bit easier,
> IMO, it's not just one appendice.. :)

Move it to the "PHP Manual" listing at the top maybe?

> > By default the search looks for 'intro.', 'book.', 'ref.', 'class.'
> > and then 'function.' prefixes.
> > The order of those can easily be changed.
> >
>
>  I'd like that the search would search in this order (no idea what the magic
> prefixes might be): function / class / ini option / constant / whole site
>  That would be what I think might be the most common what is been looked
> for.

Makes sense, missing a extension name and method name though ;)
However INI and constants options aren't indexed yet

I think the redirecting to ext-intro page for php.net/extname may have
been a mistake, it probably should be the book TOC page (i.e
www.php.net/book.dom rather than www.php.net/intro.dom) like it was
originally.

> > The problem was that those "extension frontpages" where _huge_. I mean
> > really really huge. Browsing pages like the session index or (god
> > forbid) the sca/sdo was simply impossible.
> >
>
>  Well, that kind of pages (IIRC) were in minority, so why not fix them
> instead of  making it the whole manual extremely inconvenient to use..?

Cause that would cause a major wtf with random extension structure
looking completely different.
This way all extensions use a consistent layout and naming and can
offer much more details than possibly could before.
The only thing we need to do now is to "publish" the new prefixes so
users can start using them (i.e. php.net/classname.methodname,
php.net/extensionname.installation,
php.net/extensionname.configuration) and browse the manual much more
efficiently.

-Hannes

[PHP-DOC] online phpdoc-all editing tool

[Philip Olson]

Hello everyone-

A few days ago Salah Faya introduced an online DocBook editing tool to  
phpdoc-ar here:


  http://news.php.net/php.doc.ar/758

We briefly talked about the possibility of having this work with all  
of phpdoc-all so let's discuss that now. Currently it's suited for new  
pages (no revcheck capabilities...) but Salah has some plans for that  
and is eager to hear ideas. Have a look and discuss what you think  
about this tool and how it can be implemented.


A few random thoughts to help get us started:

  - docs.php.net or doc.php.net or ...
  - how to manage the patch queue
  - how to implement revcheck capabilities
  - will we ever integrate 'cvs commit' directly
  - how will the 'edit this' option be presented to users
  - can we alter our html to better help this tool... like ids per  
block

  - cvs location of this tool
  - ...

In the past we've brought up the idea of having such a tool but never  
implemented it... well it's happening now so let's do this. As soon as  
we figure out where it'll of course be in CVS for people to play with.


Regards,
Philip

Re: [PHP-DOC] Re: PHP Documentation - Portuguese - André Ferreira

[Philip Olson]

On 22 Apr 2008, at 10:51, André Ferreira wrote:

Hello again.

I've updated the files so that they are compatible with the  
standards (line width) and include revision tracking.



Hello André,

This looks good, you've done a lot of translating with nice patches so  
please apply for a CVS account and soon after you'll be able to  
commit. Welcome to the team :)


Regards,
Philip

Re: [PHP-DOC] Where is the Chinese document?

[Hannes Magnusson]

On Tue, Apr 22, 2008 at 6:36 PM, Philip Olson <[EMAIL PROTECTED]> wrote:
>
>
>  On 22 Apr 2008, at 08:18, Antony Dovgal wrote:
>
> > On 22.04.2008 19:13, Edward Z. Yang wrote:
> >
> > > Antony Dovgal wrote:
> > >
> > > > Outdated and inactive translations that do not build correctly are
> > > > listed here:
> > > > http://www.php.net/manual/help-translate.php
> > > >
> > > Maybe there ought to be a litle note talking about outdated/inactive
> > > translations. It's not immediately evident why Chinese would be excluded
> > > from the list.
> > >
> >
> > Maybe.
> > Talk to Hannes about it (I CCed him), he might find a place for a note or
> something like that.
> >
>
>  It seems clear to me (although I wrote it) but feel free to submit updated
> text as I'm sure that page could use more and clearer content. After this
> upcoming Friday most remaining bugs should be fixed so we'll also add a news
> entry explaining everything that happened these past few weeks. Currently
> the only link to this page is via "Other" within the language select box.

I think that is the problem. We should rather post the news entry ASAP
rather then waiting for one more bugfix to hit the mirrors.
Admitting that there are some bugs, in the news entry, rather than
wait until it is fixed hoping noone notices :|
The link "Other" isn't very obvious but combined with a news entry it would.

-Hannes

Re: [PHP-DOC] Where is the Chinese document?

[Hannes Magnusson]

On Tue, Apr 22, 2008 at 2:25 PM, 张立冰 <[EMAIL PROTECTED]> wrote:
> But where is the Chinese document links at http://www.php.net/docs.php and

http://news.php.net/php.webmaster/1573

-Hannes

Re: [PHP-DOC] Where is the Chinese document?

[Philip Olson]

On 22 Apr 2008, at 08:18, Antony Dovgal wrote:

On 22.04.2008 19:13, Edward Z. Yang wrote:

Antony Dovgal wrote:

Outdated and inactive translations that do not build correctly are
listed here:
http://www.php.net/manual/help-translate.php

Maybe there ought to be a litle note talking about outdated/inactive
translations. It's not immediately evident why Chinese would be  
excluded

from the list.


Maybe.
Talk to Hannes about it (I CCed him), he might find a place for a  
note or something like that.


It seems clear to me (although I wrote it) but feel free to submit  
updated text as I'm sure that page could use more and clearer content.  
After this upcoming Friday most remaining bugs should be fixed so  
we'll also add a news entry explaining everything that happened these  
past few weeks. Currently the only link to this page is via "Other"  
within the language select box.


It's not fun removing 2/3 of the translations but reality is they are  
extremely outdated and even parts of the online 11 follow that but  
it's getting better. As we take translations more seriously by  
discussing them and accepting the fact that some are inactive, people  
start noticing. For example Salah Faya recently created an online  
editing tool for phpdoc-ar so anyone in the world may easily create  
patches. We briefly discussed having it work with phpdoc-all so expect  
more information soon.


So in direct relation to this thread, the three Chinese translations  
were removed because they are all outdated... along with most other  
languages. One goal is to get all translations to build but this does  
not dictate what's pushed to the mirrors.


Regards,
Philip

Re: [PHP-DOC] Where is the Chinese document?

[Antony Dovgal]

On 22.04.2008 19:13, Edward Z. Yang wrote:

Antony Dovgal wrote:

Outdated and inactive translations that do not build correctly are
listed here:
http://www.php.net/manual/help-translate.php


Maybe there ought to be a litle note talking about outdated/inactive
translations. It's not immediately evident why Chinese would be excluded
from the list.


Maybe.
Talk to Hannes about it (I CCed him), he might find a place for a note or 
something like that.

--
Wbr, 
Antony Dovgal

Re: [PHP-DOC] Where is the Chinese document?

[Edward Z. Yang]

Antony Dovgal wrote:
> Outdated and inactive translations that do not build correctly are
> listed here:
> http://www.php.net/manual/help-translate.php

Maybe there ought to be a litle note talking about outdated/inactive
translations. It's not immediately evident why Chinese would be excluded
from the list.

-- 
 Edward Z. YangGnuPG: 0x869C48DA
 HTML Purifier  Anti-XSS Filter
 [[ 3FA8 E9A9 7385 B691 A6FC B3CB A933 BE7D 869C 48DA ]]

Re: [PHP-DOC] Where is the Chinese document?

[Antony Dovgal]

On 22.04.2008 16:25, 张立冰 wrote:

Hi all.

I AM A *Chinese *.

Also I am being a documentation sponsor for PHP Chinese documentation.

But where is the Chinese document links at http://www.php.net/docs.php and
http://www.php.net/download-docs.php? Who deleted those links, did such
stupid job, and *WHY*?


Outdated and inactive translations that do not build correctly are listed here:
http://www.php.net/manual/help-translate.php

Feel free to help translators to catch up with the quickly changing original 
documentation.

For more details on the changes and why it was necessary to disable inactive 
translations see this thread: http://marc.info/?l=phpdoc&m=120511222021786&w=2



PHP.net is the official site of the php language, NOT a political site


Right, so please keep your politics out of here.

--
Wbr, 
Antony Dovgal

[PHP-DOC] Where is the Chinese document?

[张立冰]

Hi all.

I AM A *Chinese *.

Also I am being a documentation sponsor for PHP Chinese documentation.

But where is the Chinese document links at http://www.php.net/docs.php and
http://www.php.net/download-docs.php? Who deleted those links, did such
stupid job, and *WHY*?

PHP.net is the official site of the php language, NOT a political site with
your bad understanding of those political information.

I hope the links come back soon.

-- 
The time you enjoy wasting is not wasted time!