Re: [PHP-DOC] How to use programlisting? From: Damien Seguy (damien.seguy <email protected>)
Date: 01/05/01

Hi,

>> 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
>>
> The most scripts are PHP programs.
I agree on this, but there are also a pretty good number of alternative :
some HTML examples (as in features/upload-files.xml)
some shell commands (as in chapters/install.xml)

xml and sesam are completely related to their fields, and may not
have their own "role".

> Therefore we should use role="php".
> And the special role="php3.ini" could be renamed to role="php.ini".
OK for this.

So, we keep :
php for PHP,
php.ini for directive,
html for HTML
shell for commands
all others should not have any role.

How does this sound like?

> Script output could be taged with <computeroutput> and <screen>. It is
> indeed not a programlisting.
I think we should use <computeroutput> rather than <screen>.

Best regards,
Damien Seguy