Re: [PHP-DOC] How to use programlisting? From: Egon Schmid ( <email protected>) (( <email protected>))
Date: 01/05/01

Damien Seguy wrote:

> As I'm reading again French translation, I noticed that
> programlisting tag seems to have several usage :
> <programlisting role="php"> // for PHP script
> <programlisting role="php3"> // for PHP3 script
> <programlisting role="php3.ini"> // for php3 directive
> <programlisting role="apache-conf"> // for apache directive
> <programlisting role="apache"> // for apache directive (another one)
> <programlisting role="bs2000"> // for sesam configuration
> <programlisting role="makefile"> // for shell commands
> <programlisting role="xml"> // for xml code
> <programlisting role="html"> // for xml code
>
> <programlisting> also exist, and is being used to contains differents
> kinds of code (php, html, shell...), and sometimes for script output too.
> (while there is a <computeroutput> or <screen> tag).
>
> Now, is there a standard rule for using <programlisting> tag?
> What should be used for script/shell output?

The most scripts are PHP programs. Therefore we should use role="php".
And the special role="php3.ini" could be renamed to role="php.ini".

Script output could be taged with <computeroutput> and <screen>. It is
indeed not a programlisting.

Other opinions?

-Egon 

-- 
SIX Offene Systeme GmbH · Stuttgart  -  Berlin  -  New York
Sielminger Straße 63   ·    D-70771 Leinfelden-Echterdingen
Fon +49 711 9909164 · Fax +49 711 9909199 http://www.six.de