DocBook: Especificar código ou marcação

Question

Você pode especificar equações usando <equation> e também vários outros, mas o tag deve ser usado para especificar o código? Mais especificamente, PHP, HTML, CSS e Javascript? Existe um plugin que você pode usar com OxygenXML para adicionar esses recursos automaticamente? Eu preciso de saída como PDF.

Answer 1

Eu estou trabalhando em um projeto que utiliza o DocBook, e tem exemplos em PHP.

Os exemplos em PHP estão usando programlisting tag, como este:

<programlisting language="php"><![CDATA[<?php

// Here goes the PHP code

]]></programlisting>

Observe o atributo idioma.
Ela é usada mais tarde por uma outra ferramenta para adicionar sintaxe-coloração, ao gerar o ouput (para a saída HTML, pelo menos)

Para exemplos que não são específicos para uma linguagem de programação, como arquivos de configuração, estamos usando a screen tag; por exemplo, para uma parte de um arquivo de configuração Apache-relacionada, um exemplo seria:

<screen><![CDATA[# Setup Listening Port
NameVirtualHost *:80

# Ensure "localhost" is preserved unchanged pointed
# to the default document root for our system.
<VirtualHost *:80>
    ServerName localhost
    DocumentRoot /var/www
</VirtualHost>]]></screen>

Citando suas documentações:

A programlisting é um verbatim ambiente para fonte de programa ou listagens fragmento fonte. o Programlistings são muitas vezes colocados em exemplos ou figuras de modo a que eles possam ser uma referência cruzada a partir do texto.

E:

A tela é um ambiente verbatim para texto exibindo que a força do usuário ver em um terminal de computador. Isto é muitas vezes usado para exibir os resultados de um comando.

Tendo semântica menos específico conotações, a tela é muitas vezes usado sempre que uma apresentação verbatim é desejado, mas a semântica da programlisting é inapropriado.

Assim, estes dois parecem bastante apropriado.