跳至內容

模組:MilAward/doc

維基百科,自由的百科全書

此頁面為 Module:MilAward 的說明文件

用法

[編輯]

多個模板使用此數據。請從 {{MilAward}} 開始,並務必查看 討論頁 以了解一些統計數據和測試。

資料結構

[編輯]

此模塊使用如下結構: code = {Code = "xx", Description = "xx", Class="", RibbonImage="Ribbon - Question mark.png", PageLink="Wikipedia:WikiProject Orders, decorations, and medals", PostNom="", Country="None", Note="", Org="None", RecipCat="" },

  • xx:用於訪問此記錄的唯一代碼。
  • Description:用作替代說明的文本,會在生成連結時使用。
  • class:原意為獎項等級,但現已發現還有其他用途。
  • RibbonImage:要顯示的勛帶圖像文件名。
  • PageLink:該特定獎項所連結的維基百科條目名稱。
  • PostNom:如果該獎項附帶名後勛銜,請在此填寫,否則留空。
  • Country:國家,這應當很明顯,但我尚未決定是使用國家代碼還是國家名稱。
  • org:組織。
  • RecipCat:此字段內容用作分類名。其思路是:將某人的獎章添加到其頁面時,自動將其加入該獎章獲得者分類。

示例:

不同尺寸:

此模塊的作用是為各種例程提供數據,這些例程以不同方式組合數據。例如,Ribbon 僅顯示圖像,但會將其連結到連結頁面。Desc 顯示勛帶,然後在其旁邊添加描述。 當模板調用模塊中的某個例程時,模板調用中的第二個未命名參數會替換 {{{size}}}。該參數會傳遞給此模塊以設置圖像大小。 「PageLink」提供維基百科條目的名稱,不帶維基連結。(理論上可以是URL,但不推薦。) Description 字段的內容可以是任何可用作圖像連結「替代文本」的文本。請謹慎處理。使用連結、花括號「{}」或單引號等可能會破壞該條目,並可能破壞模板中其餘條目。

其工作原理是:調用模板時的第一個未命名參數用於在此列表中查找相應值。找到該值後,該行中的字段即可供模塊使用。這些字段以不同方式組合,以生成調用此模塊的模板所需的特定格式。 因此,切勿破壞或干擾此格式,這一點非常重要!

現在有命名參數。

  • code:獎章代碼
  • size:圖像尺寸

尚未實現的功能:

  • Country=yes - 在獎章描述中添加國家顯示。需要決定是直接顯示數據中的內容,還是通過ISO代碼查找國家名稱。
  • Class=no - 允許關閉在獎章描述中添加「Class」字段內容的功能。
  • TextSize=xx - 允許指定文本大小,可能是百分比。
  • Org=yes - 允許開啟顯示「Org」字段內容的功能。
  • Notes=no - 允許關閉顯示「Notes」字段內容的功能。

關於國家的說明

[編輯]

所有數據都放在一個大型查找表中,而不是按國家拆分成多個文件。這樣更易於維護,也不容易讓好事者因為「好主意仙女」告訴他們這是個好主意而干擾和重新排列內容。

編輯者應儘量保持此表有條理。在文件中搜索您的國家名稱。如果沒有提到,請用註釋為您的國家創建標題,並在其中添加相關條目。在國家標題內,最好為不同內容創建子標題。例如「軍事/民事」、「軍種」、「獎項類型」。然後可以將這些複製到本模塊的文檔頁面,使新讀者更容易理解,也便於維護者和編輯者使用。

此模塊中的數據是自文檔化的。將模板 {{MilAward Stats}} 放在您的沙盒或任何其他頁面,您就會明白我的意思。