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