DocBook: Spécification code ou balisage

Question

Vous pouvez spécifier des équations en utilisant <equation> et aussi plusieurs autres, mais quelle balise doit être utilisé pour spécifier le code? Plus précisément, PHP, HTML, CSS et Javascript? Y at-il un plugin que vous pouvez utiliser avec OxygenXML pour ajouter ces fonctionnalités automatiquement? Je dois sortie au format PDF.

Answer 1

Je travaille sur un projet qui utilise DocBook, et a des exemples en PHP.

Les exemples en PHP utilisent balise programlisting , comme ceci:

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

// Here goes the PHP code

]]></programlisting>

Notez l'attribut langue.
Il est utilisé plus tard par un autre outil pour ajouter la syntaxe coloration, lors de la génération de la sortie (pour la sortie HTML, au moins)

Pour des exemples qui ne sont pas spécifiques à un langage de programmation, comme les fichiers de configuration, nous utilisons le screen étiquette; par exemple, pour une partie d'un fichier de configuration Apache liés, un exemple serait:

<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>

Citant leurs documentations:

  

A programlisting est un mot à mot   environnement pour la source de programme ou   annonces fragment source. le   programlistings sont souvent placés dans   des exemples ou des chiffres afin qu'ils puissent   être recoupées du texte.

  

Un écran est un environnement verbatim pour   l'affichage du texte que l'utilisateur peut   voir sur un terminal d'ordinateur. Il est   souvent utilisé pour afficher les résultats d'une   commande.

     

Avoir moins sémantique spécifique   harmoniques, l'écran est souvent utilisé   où une présentation in extenso est   désiré, mais la sémantique   programlisting est inappropriée.

Alors, ces deux semblent tout à fait approprié.