模组:MilAward/doc
这是Module:MilAward的文档页面
| 此页面是Module:MilAward的模块文档。 此页面可能包含了模板的使用说明、分类和其他内容。 |
| 此模块文档已评为beta版,可广泛使用。因其新近完成,请谨慎使用,以确保输出结果符合预期。 |
用法
[编辑]多个模板使用此数据。请从 {{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:此字段内容用作分类名。其思路是:将某人的奖章添加到其页面时,自动将其加入该奖章获得者分类。
示例:
- 勋带:

- 描述:
军事功绩奖章 (MMM)
不同尺寸:
- 勋带:

- 描述:
军事功绩奖章 (MMM)
此模块的作用是为各种例程提供数据,这些例程以不同方式组合数据。例如,Ribbon 仅显示图像,但会将其链接到链接页面。Desc 显示勋带,然后在其旁边添加描述。 当模板调用模块中的某个例程时,模板调用中的第二个未命名参数会替换 {{{size}}}。该参数会传递给此模块以设置图像大小。 “PageLink”提供维基百科条目的名称,不带维基链接。(理论上可以是URL,但不推荐。) Description 字段的内容可以是任何可用作图像链接“替代文本”的文本。请谨慎处理。使用链接、花括号“{}”或单引号等可能会破坏该条目,并可能破坏模板中其余条目。
其工作原理是:调用模板时的第一个未命名参数用于在此列表中查找相应值。找到该值后,该行中的字段即可供模块使用。这些字段以不同方式组合,以生成调用此模块的模板所需的特定格式。 因此,切勿破坏或干扰此格式,这一点非常重要!
现在有命名参数。
- code:奖章代码
- size:图像尺寸
尚未实现的功能:
- Country=yes - 在奖章描述中添加国家显示。需要决定是直接显示数据中的内容,还是通过ISO代码查找国家名称。
- Class=no - 允许关闭在奖章描述中添加“Class”字段内容的功能。
- TextSize=xx - 允许指定文本大小,可能是百分比。
- Org=yes - 允许开启显示“Org”字段内容的功能。
- Notes=no - 允许关闭显示“Notes”字段内容的功能。
关于国家的说明
[编辑]所有数据都放在一个大型查找表中,而不是按国家拆分成多个文件。这样更易于维护,也不容易让好事者因为“好主意仙女”告诉他们这是个好主意而干扰和重新排列内容。
编辑者应尽量保持此表有条理。在文件中搜索您的国家名称。如果没有提到,请用注释为您的国家创建标题,并在其中添加相关条目。在国家标题内,最好为不同内容创建子标题。例如“军事/民事”、“军种”、“奖项类型”。然后可以将这些复制到本模块的文档页面,使新读者更容易理解,也便于维护者和编辑者使用。
此模块中的数据是自文档化的。将模板 {{MilAward Stats}} 放在您的沙盒或任何其他页面,您就会明白我的意思。