本頁是模塊「Module:Tl」的文檔頁面。
本模塊用於模板鏈接:{{tl}}、模板鏈接:{{tlc}}、模板鏈接:{{tlx}}、模板鏈接:{{tls}}等模板。
函數說明
p._tlRaw
該函數傳入兩個參數:args和params。其中args是需要寫入模板輸出中的參數,包括模板名稱、模板參數,而params是用於調整輸出方式的參數。
p._tl
該函數同樣也是傳入兩個參數:frameArgs和defaultParams,這兩個都可以是框架項目(frame object)中的參數。這些參數會預先經過迭代重寫處理,傳入p._tlRaw中。
在特定情況下,frameArgs中的內容會轉移到defaultParams的表中(實際上是迭代重寫時的轉移),frameArgs重寫後的表不再有被轉移的域。這裡的「特定情況」包括:
- 鍵是特定的字段(詳見#參數說明)。
- 值是字符串0或1。
請注意:重寫時,不會對參數的值進行去除邊界空白字符(mw.text.trim)處理,也不會忽略空白字符串值。解析器函數在調用時,命名參數的邊界空白字符會被自動除去。
p.tl
這就是模板链接:{{#invoke:}}
解析器函數需要直接調用的函數了。它會從調用此模板的頁面中獲得參數表(即frame:getParent().args)作為frameArgs,然後直接從調用模板链接:{{#invoke:}}
時傳入的參數表(frame.args)作為defaultParams,然後以此調用p._tl,這兩個參數表被處理之後調用p._tlRaw。
參數說明
這些參數在傳入p._tl函數時,其值為字符串1或0,因此無論是在模板链接:{{#invoke:}}
中還是在調用模板時,調整輸出方式的參數的值應該是0或1。而在p._tlRaw中,其值會轉化為布爾值true和false。
參數名稱 | 描述 |
---|---|
generateLinks | 若為true,則輸出的內容中,模板名稱會自動添加鏈接。鏈接不會應用於subst:等前綴。若模板名稱以井號(# )開頭,則一律不生成鏈接。
|
isCode | 若為true,則輸出的結果會加上<code>標籤。 |
isSubst | 若為true,則輸出時模板名稱前面自動添加「subst:」前綴。如設置了substPrefix,則substPrefix的值覆蓋這一參數。 |
substPrefix | 字符串,用於替換引用時的前綴,不含冒號。它通常是subst、safesubst或msgnw。如果設置了,則會連同冒號一起自動添加在模板名稱前面(若添加了鏈接,則在鏈接至外),即使isSubst沒有設置為true。 |