Re: [PHP-DOC] continue what I have started

2002-04-30 Thread Friedhelm Betz


[...]

 Every configure and ini options should be configured in
 a reference section, if there is a reference section
 for that topic. If there is no, then we need to put that
 remainder option (probably core one) to a common place
 (probably to that appendix, where the autogenerated index
 of all the ini and configure options will reside).

I can remember a discussion about ini.xml in every /referenc/ext
with all ini-related settings for that extension (like constants.xml)
Am I right and should this be done?

 Friedhelm   




Re: [PHP-DOC] continue what I have started

2002-04-30 Thread Gabor Hojtsy

  Every configure and ini options should be configured in
  a reference section, if there is a reference section
  for that topic. If there is no, then we need to put that
  remainder option (probably core one) to a common place
  (probably to that appendix, where the autogenerated index
  of all the ini and configure options will reside).

 I can remember a discussion about ini.xml in every /referenc/ext
 with all ini-related settings for that extension (like constants.xml)
 Am I right and should this be done?

/reference/someextension/
 reference.xml [intro]
 constants.xml [predefined constants]
 classes.xml   [predefined classes]
 ini.xml   [ini settings]
 configure.xml [configure options]
 aliases.xml   [function aliases - deprecated or still working]
 resources.xml [resource types, and functions using/creating/destorying
them]
 faq.xml   [extension specific FAQ]
 functions.xml [entity list of funcitons]

As discussed before, *everything* into extension docs. This let us
move all the stuff to PECL doc for example, or move an extension to
here from PECL. It also make finding particular extension related
docs easier, and we can also generate an index of all stuff including
aliases, resource types, functions, faq, etc... This is kind of a big
reorganization, but it worth the effort IMHO.

But please just start from one point (the first one was predefined
constants), and move then on forward. If we have these files in
some of the extensions in separate stages, then we make our work
really harder. Go step by step...

Goba





Re: [PHP-DOC] continue what I have started

2002-04-30 Thread holliwell

  I can remember a discussion about ini.xml in every /referenc/ext
  with all ini-related settings for that extension (like constants.xml)
  Am I right and should this be done?
 
 /reference/someextension/
  reference.xml [intro]
  constants.xml [predefined constants]
  classes.xml   [predefined classes]
  ini.xml   [ini settings]
  configure.xml [configure options]
  aliases.xml   [function aliases - deprecated or still working]
  resources.xml [resource types, and functions
 using/creating/destorying
 them]
  faq.xml   [extension specific FAQ]
  functions.xml [entity list of funcitons]
 
 As discussed before, *everything* into extension docs. This let us
 move all the stuff to PECL doc for example, or move an extension to
 here from PECL. It also make finding particular extension related
 docs easier, and we can also generate an index of all stuff including
 aliases, resource types, functions, faq, etc... This is kind of a big
 reorganization, but it worth the effort IMHO.

Thanks for the info.

 
 But please just start from one point (the first one was predefined
 constants), and move then on forward. If we have these files in
 some of the extensions in separate stages, then we make our work
 really harder. Go step by step...

Don't worry, I don't have too much time :-).
 If I could spent the time, I'll do some work on the structure of the
extensions (reference.xml).

Friedhelm

 

-- 
GMX - Die Kommunikationsplattform im Internet.
http://www.gmx.net




Re: [PHP-DOC] continue what I have started

2002-04-29 Thread Friedhelm Betz


 I tried to solve one problem of the many. As we discussed earlier,
 we would like to move all extension related stuff to the extensions
 directory, including configure options, ini settings, defined vars,
 constants, classes, faq entries, etc. So I started to apply the new
 section based structure to the reference pages, and move the
 constants info into the directories into a constants.xml file.

 I am ready till cyrus which is the last starting with letter c ;)
 I have no more time today to work on this, so if someone has some
 free time to do it, please continue my work ;)

 Applying the new structure to all extension docs would help us
 to have a man page like look, which we would like to achive
 AFAIK, and it would also help us to integrate the configure
 and ini info to all extensions = and so find a final place
 for install parts ;)

 IMHO applying the new structure is the starting point, and it
 is quite done till cyrus...

I (tried to) continue your work, and it's finished now till dbx.
Maybe someone could find the time to have a quick look over,
to ensure there are no major mistakes in the content I added.
BTW.: we have complete list of configure options in the install
section. should the already integrated parts removed from there?

 Friedhelm   




Re: [PHP-DOC] continue what I have started

2002-04-29 Thread Jesus M. Castagnetto

Friedhelm, Gabor:

Should the ini settings table in ini_set() be put alog
with the information you are reorganizing?, I recently
updated that table and the
phpdoc/scripts/mk_ini_set_table.sh script.

Also, how are you deciding what is an extension and
what is core?, anything in php4/ext? anything there
execpt for php4/ext/standard? I am asking this because
(1) I was unsubscribed from phpdoc for some time, so I
may have missed some of the discussions and (2) in the
case of ini settings, there are some in main.c (which
I was considering core), and a lot other ones in
php4/ext/*

--- Friedhelm Betz [EMAIL PROTECTED] wrote:
 
  I tried to solve one problem of the many. As we
 discussed earlier,
  we would like to move all extension related stuff
 to the extensions
  directory, including configure options, ini
 settings, defined vars,
  constants, classes, faq entries, etc. So I started
 to apply the new
  section based structure to the reference pages,
 and move the
  constants info into the directories into a
 constants.xml file.
 
  I am ready till cyrus which is the last starting
 with letter c ;)
  I have no more time today to work on this, so if
 someone has some
  free time to do it, please continue my work ;)
 
  Applying the new structure to all extension docs
 would help us
  to have a man page like look, which we would
 like to achive
  AFAIK, and it would also help us to integrate the
 configure
  and ini info to all extensions = and so find a
 final place
  for install parts ;)
 
  IMHO applying the new structure is the starting
 point, and it
  is quite done till cyrus...
 
 I (tried to) continue your work, and it's finished
 now till dbx.
 Maybe someone could find the time to have a quick
 look over,
 to ensure there are no major mistakes in the content
 I added.
 BTW.: we have complete list of configure options
 in the install
 section. should the already integrated parts removed
 from there?
 
  Friedhelm   
 


=
--- Jesus M. Castagnetto [EMAIL PROTECTED]

__
Do You Yahoo!?
Yahoo! Health - your guide to health and wellness
http://health.yahoo.com



Re: [PHP-DOC] continue what I have started

2002-04-29 Thread Gabor Hojtsy

 I (tried to) continue your work, and it's finished now till dbx.
 Maybe someone could find the time to have a quick look over,
 to ensure there are no major mistakes in the content I added.
 BTW.: we have complete list of configure options in the install
 section. should the already integrated parts removed from there?

IMHO they should be removed. We need to change that section title
to Configure options, and add a note, that it is not a full list,
and extension configure options can be found in extension docs [till
we can integrate all info, and make an autoindexer script to generate
an index of all options to an appendix].

Goba





Re: [PHP-DOC] continue what I have started

2002-04-29 Thread Gabor Hojtsy

 Should the ini settings table in ini_set() be put alog
 with the information you are reorganizing?, I recently
 updated that table and the
 phpdoc/scripts/mk_ini_set_table.sh script.

Well, that table should be spread to extension reference
parts [extension specific options of course].

 Also, how are you deciding what is an extension and
 what is core?, anything in php4/ext? anything there
 execpt for php4/ext/standard? I am asking this because
 (1) I was unsubscribed from phpdoc for some time, so I
 may have missed some of the discussions and (2) in the
 case of ini settings, there are some in main.c (which
 I was considering core), and a lot other ones in
 php4/ext/*

Every configure and ini options should be configured in
a reference section, if there is a reference section
for that topic. If there is no, then we need to put that
remainder option (probably core one) to a common place
(probably to that appendix, where the autogenerated index
of all the ini and configure options will reside).

Goba





[PHP-DOC] continue what I have started

2002-04-19 Thread Gabor Hojtsy

Hi!

I tried to solve one problem of the many. As we discussed earlier,
we would like to move all extension related stuff to the extensions
directory, including configure options, ini settings, defined vars,
constants, classes, faq entries, etc. So I started to apply the new
section based structure to the reference pages, and move the
constants info into the directories into a constants.xml file.

I am ready till cyrus which is the last starting with letter c ;)
I have no more time today to work on this, so if someone has some
free time to do it, please continue my work ;)

Applying the new structure to all extension docs would help us
to have a man page like look, which we would like to achive
AFAIK, and it would also help us to integrate the configure
and ini info to all extensions = and so find a final place
for install parts ;)

IMHO applying the new structure is the starting point, and it
is quite done till cyrus...

Goba