Debian 网页 HTML 代码写作指引

本页面仍是草稿状态。

前言
一般提示
缩略语和首字母缩写词
引用和引述
程序名称和代码
计算机输出示例
键盘输入
变量
预格式化内容
图像
链接

前言

本页面旨在帮助编辑者和翻译者创建结构良好的网页。它包含了关于标签使用以及如何创建新页面并使其更易于翻译的提示。

一般提示

对于新页面或翻译，以下是一些通用建议

不要使用过长的行: wml 文件和其他文件应该包含适合普通终端窗口的行。这样在 vi 中编辑更容易，更好搜索且更易于翻译。这也很重要，因为在长行中解决冲突更困难。
尽可能将标签保持在单独的行中: 大多数 HTML 标签可以保持在单独的行中。其中一些是 <div>、 <p>、<table>、<ul>。为了让翻译者更容易处理，你应该将所有可以这样使用的标签保持在单独的行中。否则翻译者可能会意外删除标签，并在翻译后忘记恢复它们。
不要在内联标签中使用空格或换行符: 一些标签如果保持在单独的行中会产生空格。其中一个是用于小引用或引述的 <q> 标签。你只能将它们作为整体与内容保持在一行中。否则在生成的 HTML 页面中内容和标签之间可能会出现空格。在这些标签中的单词之间，你可以根据需要使用任意数量的换行符或空格。

缩略语和首字母缩写词

对于缩略语和首字母缩写词，应该使用 HTML 标签 <acronym>。不推荐使用 <abbr> 标签有两个原因：首先，不是所有浏览器都支持它，其次，关于什么是首字母缩写词什么是缩略语，定义不一致。

首字母缩写词按照以下语法添加到页面中： <acronym lang="language code" title="Full definition of acronym">ACRONYM</acronym>。 title 属性包含完整的词汇表述。如果首字母缩写词是由单词的首字母构成的，这些字母在 title 中应该是大写的。只有当首字母缩写词或缩略语是外语时才需要 lang 属性。

在 wml 模板中已经包含了一套常用的首字母缩写词，要在你的页面中使用它，你必须在 wml 文件中添加一行 acronyms。例如，DD 的 wml 标签是 <acronym_DD />。

引用和引述

不同语言对于什么是引用或引述有不同的规则。如果你有一个短的内联引用，你必须使用 <q> 标签。内容的渲染由语言 CSS 处理。<q> 标签在开始和结束标签与内容之间不能有空格或换行符。

对于较长的引用，使用 <blockquote> 标签。<blockquote> 包含一个或多个用 <p> 标记的文本段落。请不要使用 <blockquote> 标签来居中任何不是引用的文本块。块引用专门用于引用，将来会由特定语言的 CSS 代码进行渲染。

HTML 中还有一个 <cite> 标签。 <cite> 标签不用于引用文本本身。它用于引用的来源。这可以是引用出处人的姓名，并作为 URL 属性添加到 <blockquote> 中。