DocBook: Определение кода или разметки

Я всегда использовал Baretail для конца в Windows. Это свободно и довольно хорошо.

Редактирование: поскольку лучшее описание Baretail видит этот вопрос

8
задан Pascal MARTIN 14 August 2009 в 18:17
поделиться

1 ответ

Я работаю над проектом, который использует docbook и содержит примеры на PHP.

Примеры на PHP используют тег programlisting , например:

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

// Here goes the PHP code

]]></programlisting>

Обратите внимание на атрибут языка.
Он используется позже другим инструментом для добавления синтаксической окраски при генерации вывода (по крайней мере, для вывода HTML)


Для примеров, не относящихся к одному языку программирования, например файлов конфигурации, мы используем экран тег; например, для части файла конфигурации, относящегося к Apache, примером может быть:

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


Цитата из их документации:

Список программ - это дословно среда для исходного кода программы или списки исходных фрагментов. В списки программ часто помещаются в примеры или рисунки, чтобы они могли быть перекрестными ссылками из текста.

И:

Экран - это дословная среда для отображение текста, который пользователь может см. на компьютерном терминале. это часто используется для отображения результатов команда.

Имея менее конкретную семантическую обертоны, часто используется экран везде, где есть стенографическая презентация желаемый, но смысловой список программ неуместен.

Итак, эти два кажутся вполне подходящими.

14
ответ дан 5 December 2019 в 12:11
поделиться
Другие вопросы по тегам:

Похожие вопросы: