Template:Markup/doc

說明

Template:Tlx可以將代碼和其效果顯示在同一行裡。

使用方法

參數：

• 參數1：第1行第1格的內容
• 參數2：第1行第2格的內容

如此類推，直到

• 參數39：第20行第1格的內容
• 參數40：第20行第2格的內容
• t1：左面直欄的標題，預設為“代碼”
• t2：右面直欄的標題，預設為“效果”
• title、標題：表格標題，預設為置空
• notitle、無標題：賦值時會隱藏表格和直欄的標題
• tag：預設為pre；可填入syntaxhighlight，但僅對單行程式碼可用
• margin：表格左邊的空位大小，單位為em

整個“代碼”欄已事先用<pre>格式化，內容會保留斷行和空格，同時亦會因應單元格的大小自動換行。通常最好用<nowiki>包圍著“代碼”欄裡的內容，這樣子便會顯示代碼本身。技術上無法將此功能添加進本模板內。

相反地，在“效果”一欄裡的內容通常直接複製自“代碼”欄，但並不以<nowiki>包圍著。不過在這些情況下則不一定：

• 假如第一行含有必須斷行後才生效的維基代碼，例如“#”、“*”、“;”，應在第一行之前使用{{crlf2}}。見以下例子。
• 諸如==的標題代碼會出現在頁面目錄裡；要避免的話應使用Template:Tlx。
• 使用Template:Tlx但沒有指定其他參數時，用Template:Tlx確保參考資料列表已關閉。
• 有些模板會將頁面放入維護分類中，但這通常不是想要的效果：
  • 用Template:Tlx代替Template:Tlx。
• 有些模板可能有檢查錯誤機制，會將頁面放入維護分類中。可以的話應當防止分類：
  • 引文格式1系列模板可以用|template doc demo=true參數，防止將頁面放入該維護分類中。

技術限制

如果不用<nowiki>包圍著代碼欄的內容，而裡面又有任何模板代碼的話，這些代碼統統都會展開。

以下例子展示{{tl|tag}}的代碼：

效果	本來應顯示為

代碼欄裡的HTML字符編碼也會被解析：

用“nowiki”包圍著的代碼顯示為	代碼本來應顯示為

要避免出現這種情況的話，可以手動將“&”代替“&”，這樣子“ ”會顯示為“ ”。

範例

簡單示例：

代码	效果

複雜示例：注意{{markup}}的第二個參數用了{{fake heading}}和{{fake citation needed}}。

代码	效果

使用多行：

代码	效果

使用標題：

Foxes and dogs

代码	效果

用{{code}}包圍著模板時，會顯示所生成的HTML代碼：

代码	效果