DocBook: Angeben von Code oder Markup
Frage
Sie können die Gleichungen angeben <equation>
verwenden und auch einige andere, aber was Tag muss verwendet werden, um Code angeben? Genauer gesagt, PHP, HTML, CSS und Javascript? Gibt es ein Plugin, das Sie mit OxygenXML verwenden können diese Funktionen automatisch hinzufügen? Ich brauche die Ausgabe als PDF.
Lösung
Ich arbeite an einem Projekt, das docbook verwendet und hat Beispiele in PHP.
Die Beispiele in PHP verwenden programlisting
Tag, wie folgt aus:
<programlisting language="php"><![CDATA[<?php
// Here goes the PHP code
]]></programlisting>
Beachten Sie das Sprachattribut.
Es wird später durch ein anderes Werkzeug verwendet Syntax-Färbung an, wenn die ouput Erzeugung (für HTML-Ausgabe, zumindest)
Für Beispiele, die nicht spezifisch für eine Programmiersprache, wie Konfigurationsdateien sind, verwenden wir die screen
Tag; zum Beispiel für einen Teil einer Apache-bezogenen Konfigurationsdatei, wäre ein Beispiel:
<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>
Zitiert ihre Dokumentationen:
Ein program ist ein wörtlich Umgebung für die Programmquelle oder Quelle Fragment Angebote. Das programlistings werden oft gestellt in Beispiele oder Figuren, so dass sie werden aus dem Text Querverweise.
Und:
Ein Bildschirm ist eine wortgetreue Umgebung für Anzeigen von Text, dass der Benutzer könnte sieht auf einem Computer-Terminal. Es ist oft verwendet, um die Ergebnisse eines anzuzeigen Befehl.
Mit weniger spezifischen semantischen Töne, Bildschirm wird oft verwendet, überall dort, wo eine wortgetreue Darstellung ist wünschen übrig, aber die Semantik program ungeeignet ist.
So scheinen diese beiden durchaus angemessen.