当前位置：文江博客话题详情

DocBook：指定代码或标记

发布于 2024-08-02 11:14:35 字数 156 浏览 11 评论 0原文

您可以使用以及其他几个来指定方程，但是必须使用什么标签来指定代码？更具体地说，是 PHP、HTML、CSS 和 Javascript？是否有一个插件可以与 OxygenXML 一起使用来自动添加这些功能？我需要输出为 PDF。

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

遥远的绿洲 2024-08-09 11:14:36

我正在开发一个使用 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>

引用他们的文档：

节目列表是逐字记录的
程序源环境或
源片段列表。这
节目列表通常放置在
示例或数字，以便他们能够
与文本交叉引用。

和：

屏幕是一个逐字环境
显示用户可能会看到的文本
在计算机终端上查看。这是
通常用于显示结果
命令。
具有不太具体的语义
泛音，经常使用屏幕
无论逐字演示在哪里
期望的，但是语义
节目列表不合适。

所以说，这两个人看起来还是挺合适的。

I'm working on a project which uses docbook, and has examples in PHP.

The examples in PHP are using programlisting tag, like this :

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

// Here goes the PHP code

]]></programlisting>

Note the language attribute.

It is used later by another tool to add syntax-coloration, when generating the ouput (for HTML output, at least)

For examples that are not specific to one programming language, like configuration files, we are using the screen tag ; for instance, for a part of an Apache-related config file, an example would be :

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

Quoting their documentations :

A programlisting is a verbatim
environment for program source or
source fragment listings. The
programlistings are often placed in
examples or figures so that they can
be cross-referenced from the text.

And :

A screen is a verbatim environment for
displaying text that the user might
see on a computer terminal. It is
often used to display the results of a
command.
Having less specific semantic
overtones, screen is often used
wherever a verbatim presentation is
desired, but the semantic of
programlisting is inappropriate.

So, these two seem quite appropriate.

回复收藏 0 原文

~没有更多了~