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/07/15 19:26:57 UTC
XML format for manual pages (was Re: German translation)
On Sat, 13 Jul 2002, Astrid Keßler wrote:
> Well, attached you'll find the manualpage.dtd and common.dtd.
Thanks again. I have committed this with a very few of my own changes
(including making the include common.dtd thing work).
The next steps if we want to use this for the english docs are:
1. Modify the common.xsl file so that it can transform a document
in this format into html.
2. Start converting.
Number 1 shouldn't be hard, but there is one caveat. When I originally
wrote the xsl that became common.xsl, I was really hoping that it would be
just a quick hack until some better web designer came along with something
nicer. Unfortunately, that hasn't happened yet. If anyone wants to take
one of the current mod_whatever.html pages, and turn it into something
that
1. Looks nice,
2. Is clean and simple, and
3. Makes proper use of css,
then I could help out with designing the xslt to create it from the xml.
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML format for manual pages
Posted by André Malo <nd...@perlig.de>.
* Joshua Slive wrote:
> in 1.3. With the xml transformations, we could easily have side-bar
> menus, etc. It needs someone with a real eye for web design, and I
> certainly don't qualify.
hmm, I didn't think so far, but it's a good idea ;-)
I don't qualify, too, but asked a colleague with a good hand for such
things. He will look at the docs as soon as possible (i.e. tomorrow
(we're in CEST here ;-)). Probably he will agree to do the work and
within a week or so we may provide an outline here.
> (Alternatively, we could just go find a set
> of documentation that we like the look of and copy the format.)
-1 ;-)
nd
--
s;.*;aaaaaoaaaoaaaaooooaaoaaaomaaaa:a:alataa:aaoat:a:a:a
maoaa:a:laoata:a:oia:a:o:a:m:a:o:alaoooat:aaool:aaoaa
matooololaaatoto:aaa:o:a:o:m;;s:\s:\::g;y;mailto:;
\40\51/\134\137|ndparker <nd...@perlig.de>;;print;
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML format for manual pages (was Re: German translation)
Posted by Joshua Slive <jo...@slive.ca>.
On Mon, 15 Jul 2002, Erik Abele wrote:
> Michael Schroepl recently posted an URL to the complete apache-docs
> converted to xhtml-1.0 strict. Perhaps these docs can be a starting point
> for further discussions about the look/the html+css specs of the new xslt
> ?!?
Yes, I saw that, but I haven't looked at it in great depth. To be frank,
I don't have the time to pay attention to 1.3 these days. I don't want to
discourage others from doing it, but I have more than I can handle trying
to get 2.0 in shape.
Regarding the overall look, I am hoping that someone will take a fresher
perspective on it. We don't need to stick so close to what we were doing
in 1.3. With the xml transformations, we could easily have side-bar
menus, etc. It needs someone with a real eye for web design, and I
certainly don't qualify. (Alternatively, we could just go find a set of
documentation that we like the look of and copy the format.)
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML format for manual pages (was Re: German translation)
Posted by Erik Abele <er...@codefaktor.de>.
> Number 1 shouldn't be hard, but there is one caveat. When I originally
> wrote the xsl that became common.xsl, I was really hoping that it would be
> just a quick hack until some better web designer came along with something
> nicer. Unfortunately, that hasn't happened yet. If anyone wants to take
> one of the current mod_whatever.html pages, and turn it into something
> that
>
> 1. Looks nice,
> 2. Is clean and simple, and
> 3. Makes proper use of css,
>
> then I could help out with designing the xslt to create it from the xml.
>
Michael Schroepl recently posted an URL to the complete apache-docs
converted to xhtml-1.0 strict. Perhaps these docs can be a starting point
for further discussions about the look/the html+css specs of the new xslt
?!?
Here a sample module-page:
http://www.schroepl.net/projekte/apache1326xhtml11/mod/mod_access.html
or a complete archive (1.1 mb)
http://www.schroepl.net/projekte/apache1326xhtml11/apache1326xhtml11.zip
-erik
for further/detailed explanations for this, see the original posting...
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
RE: XML format for manual pages (was Re: German translation)
Posted by Joshua Slive <jo...@slive.ca>.
On Tue, 16 Jul 2002, Vincent de Lau wrote:
> I might have spotted a problem:
>
> Both common.dtd and manualpage.dtd contain a section element definition,
> which results in a DTD error (after inclusion, manualpage.dtd contains two
> section elements definitions). The biggest difference being that the
> definition in manualpage.dtd requires a title element. Also, the id
> attribute in manualpage.dtd is defined as ID against CNAME in common.dtd.
>
> Can be solved by:
> 1. choose one definition and move it to common.dtd
> 2. move the definition from common.dtd to modulesynopsis.dtd
> 3. create a IGNORE/INCLUDE entity thing around the definition in common.dtd
You are perfectly correct here. And it is the result of changes that I
made, not of Astrid's original dtd. If nobody beats me to it, I will use
suggestion 1 (but it might be tommorow before I get to it).
Thanks for the testing.
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
RE: XML format for manual pages (was Re: German translation)
Posted by Vincent de Lau <vi...@delau.nl>.
> -----Original Message-----
> From: Joshua Slive [mailto:joshua@slive.ca]
> Sent: Monday, July 15, 2002 5:27 PM
>
> On Sat, 13 Jul 2002, Astrid Keler wrote:
> > Well, attached you'll find the manualpage.dtd and common.dtd.
>
> Thanks again. I have committed this with a very few of my own changes
> (including making the include common.dtd thing work).
>
I might have spotted a problem:
Both common.dtd and manualpage.dtd contain a section element definition,
which results in a DTD error (after inclusion, manualpage.dtd contains two
section elements definitions). The biggest difference being that the
definition in manualpage.dtd requires a title element. Also, the id
attribute in manualpage.dtd is defined as ID against CNAME in common.dtd.
Can be solved by:
1. choose one definition and move it to common.dtd
2. move the definition from common.dtd to modulesynopsis.dtd
3. create a IGNORE/INCLUDE entity thing around the definition in common.dtd
If you need help testing DTD's and XSLT, please let me know.
Kind regards,
Vincent de Lau
vincent@delau.nl
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML format for manual pages (was Re: German translation)
Posted by Rich Bowen <rb...@rcbowen.com>.
On Mon, 15 Jul 2002, Joshua Slive wrote:
>
> > Do we have an example something.xml file to work from? I feel that I've
> > missed some part of this conversation, but would be available to help
> > with the conversion phase.
>
> Indeed, Astrid created such a thing. See:
>
> http://marc.theaimsgroup.com/?l=apache-docs&m=102374942618014&w=2
>
> I think the DTD might have been simplified a little after some further
> discussion, but that should give you the general idea.
I'm sorry, I seem to have not been paying much attention lately. I'll
take a look at that.
--
Who can say where the road goes
Where the day flows
Only time
--Pilgrim (Enya - A Day Without Rain)
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML format for manual pages (was Re: German translation)
Posted by Joshua Slive <jo...@slive.ca>.
> Do we have an example something.xml file to work from? I feel that I've
> missed some part of this conversation, but would be available to help
> with the conversion phase.
Indeed, Astrid created such a thing. See:
http://marc.theaimsgroup.com/?l=apache-docs&m=102374942618014&w=2
I think the DTD might have been simplified a little after some further
discussion, but that should give you the general idea.
Joshua.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: XML format for manual pages (was Re: German translation)
Posted by Rich Bowen <rb...@rcbowen.com>.
On Mon, 15 Jul 2002, Joshua Slive wrote:
>
> On Sat, 13 Jul 2002, Astrid Ke�ler wrote:
> > Well, attached you'll find the manualpage.dtd and common.dtd.
>
> Thanks again. I have committed this with a very few of my own changes
> (including making the include common.dtd thing work).
>
> The next steps if we want to use this for the english docs are:
>
> 1. Modify the common.xsl file so that it can transform a document
> in this format into html.
>
> 2. Start converting.
Do we have an example something.xml file to work from? I feel that I've
missed some part of this conversation, but would be available to help
with the conversion phase.
--
Rich Bowen - rbowen@rcbowen.com
http://kenya.rcbowen.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org