You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by Joshua Slive <jo...@slive.ca> on 2002/02/17 15:59:23 UTC
XML docs and Comanche (fwd)
Well, I don't know what lists Daniel is paying attention to. So let's
forward this on to him, and remind him and everyone else that the new
format is described at:
http://httpd.apache.org/docs-project/docsformat.html
and there is an example of it here:
http://httpd.apache.org/docs-2.0/mod/mod_setenvif.xml
Joshua.
---------- Forwarded message ----------
Date: Sun, 17 Feb 2002 07:53:51 -0500 (EST)
From: Rich Bowen <rb...@rcbowen.com>
Reply-To: docs@httpd.apache.org
To: Apache Documentation Project <do...@httpd.apache.org>
Subject: XML docs and Comanche
Something just occurred to me, re XML docs and Comanche. Daniel told me,
a long long time ago, that if the Apache module docs were in XML,
getting Comanche bindings to configure these modules and directives
would be trivial. We need to make sure that Daniel, and whoever else is
working on Comanche these days, knows about the XML stuff that we are
doing, so that Comanche is aware of what tags mean what. Joshua, do you
know if they are aware of this yet?
--
Nothing is perfekt. Certainly not me.
Success to failure. Just a matter of degrees.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML docs and Comanche (fwd)
Posted by Daniel Lopez <da...@covalent.net>.
> > b) About what Rich is mentioning, what I was thinking is making the directive
> > definition structured, so it can be parsed programmatically. I have in
> > Comanche something along the lines of:
> >
> > <directive type="number">
> > <name>Port</name>
> > <default>80</name>
> > <range><min>0</min><max>65536</max></range>
> > </directive>
> >
>
> I hadn't really considered this second part. It goes somewhat beyond the
> question of documentation as such, and could be quite complicated to
> implement. I notice you chose a simple example ;-) Could you show what
> you do for some of the more complex directives? (variable number of
> arguments, etc)
With a simple subset you can cover all apache directives. You can see
examples, downloading comanche, in the directory
plugins/apache/modules/*/directives.xml
For example the require directive can be a either valid-user or a list of
users or a list of groups:
<structure label="apache1.3_coredirs_require" style="normal" name="require"
align="vertical">
<syntax>
<boolean label="apache1.3_coredirs_validUser" name="validUser">
<default>0</default>
</boolean>
<list label="apache1.3_coredirs_users" name="users">
<syntax>
<string label="apache1.3_coredirs_user" name="user"/>
</syntax>
</list>
<list label="apache1.3_coredirs_groups" name="groups">
<syntax>
<string label="apache1.3_coredirs_group" name="group"/>
</syntax>
</list>
</syntax>
</structure>
> Basically, you are talking about a much more structured format for the
> <syntax> tag that we currently have. This would certainly be useful under
> some circumstances.
Yes, converting the docs from html to xml is a big task. This should be
considered much later on. But it would open the door to many interesting
posibilities, sucha as an XML based configuration language for Apache.
Daniel
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML docs and Comanche (fwd)
Posted by Joshua Slive <jo...@slive.ca>.
On Sun, 17 Feb 2002, Daniel Lopez wrote:
> b) About what Rich is mentioning, what I was thinking is making the directive
> definition structured, so it can be parsed programmatically. I have in
> Comanche something along the lines of:
>
> <directive type="number">
> <name>Port</name>
> <default>80</name>
> <range><min>0</min><max>65536</max></range>
> </directive>
>
I hadn't really considered this second part. It goes somewhat beyond the
question of documentation as such, and could be quite complicated to
implement. I notice you chose a simple example ;-) Could you show what
you do for some of the more complex directives? (variable number of
arguments, etc)
Basically, you are talking about a much more structured format for the
<syntax> tag that we currently have. This would certainly be useful under
some circumstances.
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML docs and Comanche (fwd)
Posted by Daniel Lopez <da...@covalent.net>.
Hi,
I follow docs@, and I like the idea of converting the docs to xml, for at
least two reasons:
a) This will help GUI tools in presenting online help.
b) About what Rich is mentioning, what I was thinking is making the directive
definition structured, so it can be parsed programmatically. I have in
Comanche something along the lines of:
<directive type="number">
<name>Port</name>
<default>80</name>
<range><min>0</min><max>65536</max></range>
</directive>
Cheers
Daniel
> Well, I don't know what lists Daniel is paying attention to. So let's
> forward this on to him, and remind him and everyone else that the new
> format is described at:
> http://httpd.apache.org/docs-project/docsformat.html
> and there is an example of it here:
> http://httpd.apache.org/docs-2.0/mod/mod_setenvif.xml
>
> Joshua.
>
> ---------- Forwarded message ----------
> Date: Sun, 17 Feb 2002 07:53:51 -0500 (EST)
> From: Rich Bowen <rb...@rcbowen.com>
> Reply-To: docs@httpd.apache.org
> To: Apache Documentation Project <do...@httpd.apache.org>
> Subject: XML docs and Comanche
>
> Something just occurred to me, re XML docs and Comanche. Daniel told me,
> a long long time ago, that if the Apache module docs were in XML,
> getting Comanche bindings to configure these modules and directives
> would be trivial. We need to make sure that Daniel, and whoever else is
> working on Comanche these days, knows about the XML stuff that we are
> doing, so that Comanche is aware of what tags mean what. Joshua, do you
> know if they are aware of this yet?
>
> --
> Nothing is perfekt. Certainly not me.
> Success to failure. Just a matter of degrees.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org