httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tim Gerundt" <...@gerundt.de>
Subject suggestions for the documentation style
Date Fri, 04 Oct 2002 22:11:37 GMT
Hello!

I have few suggestions for the documentation style.
Only little things, nothing world-moving thing! ;)

<note type="warning">...</note>
You should use a light red background-color for
warning notes.
That makes the warning clearer!


<name>Name</name>
<syntax>Syntax ...</syntax>
<sourcefile>sourcefile.c</sourcefile>
For this tags from <modulesynopsis> and <directivesynopsis>
you should use the <code>-tag with the html-output.
It looks better, like the <default> tag.
Maybe you can use it for <identifier> too.

Also, in headers (h1, h2, ...), you can use the <code>-tag
to modulname and directive.
So it looks like the links to modules or directives.


Last but not least:
The the centered title from notes and examples look
not so good, because nothing else at the page are centered.
I think the bolder font from the title is enough to take off
form the note and example.

*ww*

Tim

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Mime
View raw message