Module:MilAward/data/doc - Revision history

Pppery: Duplicate

2024-11-22T04:45:03Z

Duplicate

← Previous revision		Revision as of 04:45, 22 November 2024
Line 1:		Line 1:
		⚫	#REDIRECT [[Module:MilAward/doc]]
	{{Module rating\|release<!-- Values: pre-alpha • alpha • beta • release • protected • semiprotected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->

	== Usage ==
	Please rather use one of the templates I've created to use this data. Start with {{tlx\|Template:MilAward}} and make sure to check out the {{tlx\|Template talk:MilAward}} for some stats and tests.

⚫	~~===~~ Module:MilAward/~~data ===~~
	'''EDITORS PLEASE NOTE''': Be VERY careful that you understand exactly what you are doing if you edit the data in this file.
	If in doubt, add a topic on the talk page or ping me {{tlx\|User:BoonDock}} with your questions.

	=== Structure ===
	Note that I have set this up to use the structure:
	<code>xx = {Code = "xx", Description = "xx", RibbonImage="XX", PageLink= "XX", PostNom="XX", Country="xxx" }</code>
	* xx : the UNIQUE code we use to access this record.
	* Description : Description to be used as Alt Description, so it will be used when producing the link
	* class: intended to be for the class of the award, it's turning out to be useful for other things as well
	* RibbonImage : File name of the file for the ribbon to be displayed
	* PageLink : Name of Wiki Article which the specific award will link to
	* PostNom : If this award has a Postnominal attached to it, enter that here or leave blank
	* Country. : This should be obvious, but I haven't made a decision whether to use codes or country name
	* org: Organisation

	Examples:
	* Ribbon : {{MilAward Ribbon\|MMM\|x12px}}
	* Description: {{MilAward Desc\|MMM\|x12px}}

	With different sizes:
	* Ribbon : {{MilAward Ribbon\|MMM\|x12px}}
	* Description: {{MilAward Desc\|MMM\|x20px}}

	What this does is it provides the data to various routines which combine it in different ways. For example, '''Ribbon''' will display just the image, but will link it to the link page. '''Desc''' displays the ribbon, then adds the description next to it.
	When a template calls one of the routines in the module, the {{{size}}} is replaced with the second un-named parameter when the template is called. That is passed on to this module to set the size of the image.
	The "PageLink" provides the name of an article on Wikipedia with no wikilinking. (In theory it could be a URL, but that's not preferred)
	The contents of the Description field can be any text which can be used as the "alt text" for an image link. Please be careful with this. Using links or curly braces "{}" or inverted commas <nowiki>''</nowiki> etc can break that entry as well as, potentially, the rest of the entries in the template.

	How this works, is that the first unnamed parameter when you call the template is used as the value to look up the corresponding value in this list. Once that value has been found, then the fields in that line are available to the module. These fields are combined in different ways to produce the specific formatting required for the template that called this module.
	For this reason, it's very important that this format is not broken or interfered with!

	===A NOTE ON COUNTRIES===
	For this Module, I have attempted to gather all the data into one large lookup table rather than splitting it into files for each country. It just means it's easier to maintain and it's less likely to get busybodies interfering and rearranging things because the "Good Idea Fairy" told them it would be a good idea.

	That being said, Let's please try to keep this as organised as possible. Search the file for your Country's name. If there isn't any mention of it, then create a heading using a comment for your country and add any relevant entries there. Within the country heading, not a bad idea to create sub-headings for different things. Examples might be "Military/Civilian", "Arms of service", "Types of awards". This then can be duplicated on the Documentation page of this Module and will make more sense to new readers and ease of use for maintainers and editors.

	NOTE: the data in this module is now self documenting. Place the template {{tlx\|MilAward Stats}] in your sandbox or any other page and you'll see what I mean.

	<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line; interwikis at Wikidata -->

	}}</includeonly>

Aidan9382: specify a size

2023-04-10T11:01:39Z

specify a size

← Previous revision		Revision as of 11:01, 10 April 2023
Line 23:		Line 23:
	Examples:		Examples:
	* Ribbon : {{MilAward Ribbon\|MMM\|x12px}}		* Ribbon : {{MilAward Ribbon\|MMM\|x12px}}
	* Description: {{MilAward Desc\|MMM}}		* Description: {{MilAward Desc\|MMM\|x12px}}

	With different sizes:		With different sizes:

WOSlinker: fix italics

2023-04-09T09:52:11Z

fix italics

← Previous revision		Revision as of 09:52, 9 April 2023
Line 32:		Line 32:
	When a template calls one of the routines in the module, the {{{size}}} is replaced with the second un-named parameter when the template is called. That is passed on to this module to set the size of the image.		When a template calls one of the routines in the module, the {{{size}}} is replaced with the second un-named parameter when the template is called. That is passed on to this module to set the size of the image.
	The "PageLink" provides the name of an article on Wikipedia with no wikilinking. (In theory it could be a URL, but that's not preferred)		The "PageLink" provides the name of an article on Wikipedia with no wikilinking. (In theory it could be a URL, but that's not preferred)
	The contents of the Description field can be any text which can be used as the "alt text" for an image link. Please be careful with this. Using links or curly braces "{}" or inverted commas '' etc can break that entry as well as, potentially, the rest of the entries in the template.		The contents of the Description field can be any text which can be used as the "alt text" for an image link. Please be careful with this. Using links or curly braces "{}" or inverted commas <nowiki>''</nowiki> etc can break that entry as well as, potentially, the rest of the entries in the template.

	How this works, is that the first unnamed parameter when you call the template is used as the value to look up the corresponding value in this list. Once that value has been found, then the fields in that line are available to the module. These fields are combined in different ways to produce the specific formatting required for the template that called this module.		How this works, is that the first unnamed parameter when you call the template is used as the value to look up the corresponding value in this list. Once that value has been found, then the fields in that line are available to the module. These fields are combined in different ways to produce the specific formatting required for the template that called this module.

BoonDock: Module rating

2023-04-07T14:43:00Z

Module rating

← Previous revision		Revision as of 14:43, 7 April 2023
Line 1:		Line 1:
	{{Module rating\|<!-- Values: pre-alpha • alpha • beta • release • protected • semiprotected -- If a rating not needed/relevant, delete this template call -->}}		{{Module rating\|release<!-- Values: pre-alpha • alpha • beta • release • protected • semiprotected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->		<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->

BoonDock: /* A NOTE ON COUNTRIES */Updated note

2023-04-07T05:36:12Z

A NOTE ON COUNTRIES: Updated note

← Previous revision		Revision as of 05:36, 7 April 2023
Line 42:		Line 42:
	That being said, Let's please try to keep this as organised as possible. Search the file for your Country's name. If there isn't any mention of it, then create a heading using a comment for your country and add any relevant entries there. Within the country heading, not a bad idea to create sub-headings for different things. Examples might be "Military/Civilian", "Arms of service", "Types of awards". This then can be duplicated on the Documentation page of this Module and will make more sense to new readers and ease of use for maintainers and editors.		That being said, Let's please try to keep this as organised as possible. Search the file for your Country's name. If there isn't any mention of it, then create a heading using a comment for your country and add any relevant entries there. Within the country heading, not a bad idea to create sub-headings for different things. Examples might be "Military/Civilian", "Arms of service", "Types of awards". This then can be duplicated on the Documentation page of this Module and will make more sense to new readers and ease of use for maintainers and editors.

			NOTE: the data in this module is now self documenting. Place the template {{tlx\|MilAward Stats}] in your sandbox or any other page and you'll see what I mean.
	PLEASE KEEP the entries in this file and the documentation in sync. If you add an entry here, please add it to the documentation page!!!!

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

BoonDock: /* Structure */Some tweaks

2023-04-07T05:33:29Z

Structure: Some tweaks

← Previous revision		Revision as of 05:33, 7 April 2023
Line 11:		Line 11:
	=== Structure ===		=== Structure ===
	Note that I have set this up to use the structure:		Note that I have set this up to use the structure:
	<code>xx = {Code = "xx", Description = "xx", RibbonImage="XX", PageLink= "XX", PostNom="XX", Country="~~GBR~~" }</code>		<code>xx = {Code = "xx", Description = "xx", RibbonImage="XX", PageLink= "XX", PostNom="XX", Country="xxx" }</code>
	* xx : the UNIQUE code we use to access this record.		* xx : the UNIQUE code we use to access this record.
	* Description : Description to be used as Alt Description, so it will be used when producing the link		* Description : Description to be used as Alt Description, so it will be used when producing the link
			* class: intended to be for the class of the award, it's turning out to be useful for other things as well
	* RibbonImage : File name of the file for the ribbon to be displayed		* RibbonImage : File name of the file for the ribbon to be displayed
	* PageLink : Name of Wiki Article which the specific award will link to		* PageLink : Name of Wiki Article which the specific award will link to
	* PostNom : If this award has a Postnominal attached to it, enter that here or leave blank		* PostNom : If this award has a Postnominal attached to it, enter that here or leave blank
	* Country. : This should be obvious, but I haven't made a decision whether to use codes or country name		* Country. : This should be obvious, but I haven't made a decision whether to use codes or country name
			* org: Organisation

	Examples:		Examples:
	* Ribbon : {{~~#invoke:~~MilAward\|Ribbon\|MMM}}		* Ribbon : {{MilAward Ribbon\|MMM\|x12px}}
	* Description: {{~~#invoke:~~MilAward~~\|RibbonDesc~~\|MMM}}		* Description: {{MilAward Desc\|MMM}}

	With different sizes:		With different sizes:
	* Ribbon : {{~~#invoke:~~MilAward\|Ribbon\|MMM\|x12px}}		* Ribbon : {{MilAward Ribbon\|MMM\|x12px}}
	* Description: {{~~#invoke:~~MilAward~~\|RibbonDesc~~\|MMM\|~~x12px~~}}		* Description: {{MilAward Desc\|MMM\|x20px}}

	What this does is it provides the data to various routines which combine it in different ways. For example, '''Ribbon''' will display just the image, but will link it to the link page. '''~~RibbonDesc~~''' displays the ribbon, then adds the description next to it.		What this does is it provides the data to various routines which combine it in different ways. For example, '''Ribbon''' will display just the image, but will link it to the link page. '''Desc''' displays the ribbon, then adds the description next to it.
	When a template calls one of the routines in the module, the {{{size}}} is replaced with the second un-named parameter when the template is called. That is passed on to this module to set the size of the image.		When a template calls one of the routines in the module, the {{{size}}} is replaced with the second un-named parameter when the template is called. That is passed on to this module to set the size of the image.
	The "PageLink" provides the name of an article on Wikipedia with no wikilinking. (In theory it could be a URL, but that's not preferred)		The "PageLink" provides the name of an article on Wikipedia with no wikilinking. (In theory it could be a URL, but that's not preferred)
	The contents of the Description field can be any text which can be used as the "alt text" for an image link. Please be careful with this. Using links or curly braces "{}" or inverted commas '' etc can break that entry as well as, potentially, the rest of the entries in the template.		The contents of the Description field can be any text which can be used as the "alt text" for an image link. Please be careful with this. Using links or curly braces "{}" or inverted commas '' etc can break that entry as well as, potentially, the rest of the entries in the template.

	How this works, is that the first unnamed parameter when you call the template is used as the value to look up the corresponding value in this list. Once that value has been found, then the fields in that line are available to the module. These fields are combined in different ways to produce ~~thee~~ specific formatting required for the template that called this module.		How this works, is that the first unnamed parameter when you call the template is used as the value to look up the corresponding value in this list. Once that value has been found, then the fields in that line are available to the module. These fields are combined in different ways to produce the specific formatting required for the template that called this module.
	For this reason, it's very important that this format is not broken or interfered with!		For this reason, it's very important that this format is not broken or interfered with!

BoonDock: /* Usage */Typo

2023-04-07T05:27:03Z

Usage: Typo

← Previous revision		Revision as of 05:27, 7 April 2023
Line 3:		Line 3:

	== Usage ==		== Usage ==
	Please rather use one of the templates I've created to use this data. Start with {{tl\|Template:MilAward}} and make sure to check out the {{tlx\|Template talk:MilAward}} for some stats and tests.		Please rather use one of the templates I've created to use this data. Start with {{tlx\|Template:MilAward}} and make sure to check out the {{tlx\|Template talk:MilAward}} for some stats and tests.

	=== Module:MilAward/data ===		=== Module:MilAward/data ===

BoonDock: /* Usage */Changed to "Usage" section

2023-04-07T05:26:25Z

Usage: Changed to "Usage" section

← Previous revision		Revision as of 05:26, 7 April 2023
Line 3:		Line 3:

	== Usage ==		== Usage ==
			Please rather use one of the templates I've created to use this data. Start with {{tl\|Template:MilAward}} and make sure to check out the {{tlx\|Template talk:MilAward}} for some stats and tests.
	<code><nowiki>{{</nowiki>#invoke:MilAward/data\|''function_name''<nowiki>}}</nowiki></code>

	=== Module:MilAward/data ===		=== Module:MilAward/data ===
	'''EDITORS PLEASE NOTE''': Be VERY careful that you understand exactly what you are doing if you edit the data in this file.		'''EDITORS PLEASE NOTE''': Be VERY careful that you understand exactly what you are doing if you edit the data in this file.

BoonDock: /* Module:MilAward/data */ Add Examples

2023-04-04T12:14:54Z

Module:MilAward/data: Add Examples

← Previous revision		Revision as of 12:14, 4 April 2023
Line 8:		Line 8:
	If in doubt, add a topic on the talk page or ping me {{tlx\|User:BoonDock}} with your questions.		If in doubt, add a topic on the talk page or ping me {{tlx\|User:BoonDock}} with your questions.

			=== Structure ===
	Note that I have set this up to use the structure:		Note that I have set this up to use the structure:
	<code>xx = {Code = "xx", Description = "xx", RibbonImage="XX", PageLink= "XX", PostNom="XX", Country="GBR" }</code>		<code>xx = {Code = "xx", Description = "xx", RibbonImage="XX", PageLink= "XX", PostNom="XX", Country="GBR" }</code>
Line 16:		Line 17:
	* PostNom : If this award has a Postnominal attached to it, enter that here or leave blank		* PostNom : If this award has a Postnominal attached to it, enter that here or leave blank
	* Country. : This should be obvious, but I haven't made a decision whether to use codes or country name		* Country. : This should be obvious, but I haven't made a decision whether to use codes or country name

			Examples:
			* Ribbon : {{#invoke:MilAward\|Ribbon\|MMM}}
			* Description: {{#invoke:MilAward\|RibbonDesc\|MMM}}

			With different sizes:
			* Ribbon : {{#invoke:MilAward\|Ribbon\|MMM\|x12px}}
			* Description: {{#invoke:MilAward\|RibbonDesc\|MMM\|x12px}}

	What this does is it provides the data to various routines which combine it in different ways. For example, '''Ribbon''' will display just the image, but will link it to the link page. '''RibbonDesc''' displays the ribbon, then adds the description next to it.		What this does is it provides the data to various routines which combine it in different ways. For example, '''Ribbon''' will display just the image, but will link it to the link page. '''RibbonDesc''' displays the ribbon, then adds the description next to it.

BoonDock: Added Docs

2023-04-04T12:11:26Z

Added Docs

New page

{{Module rating|}}


== Usage ==
<code><nowiki>{{</nowiki>#invoke:MilAward/data|''function_name''<nowiki>}}</nowiki></code>
=== Module:MilAward/data ===
'''EDITORS PLEASE NOTE''': Be VERY careful that you understand exactly what you are doing if you edit the data in this file.
If in doubt, add a topic on the talk page or ping me {{tlx|User:BoonDock}} with your questions.

Note that I have set this up to use the structure:
<code>xx = {Code = "xx", Description = "xx", RibbonImage="XX", PageLink= "XX", PostNom="XX", Country="GBR" }</code>
* xx : the UNIQUE code we use to access this record.
* Description : Description to be used as Alt Description, so it will be used when producing the link
* RibbonImage : File name of the file for the ribbon to be displayed
* PageLink : Name of Wiki Article which the specific award will link to
* PostNom : If this award has a Postnominal attached to it, enter that here or leave blank
* Country. : This should be obvious, but I haven't made a decision whether to use codes or country name

What this does is it provides the data to various routines which combine it in different ways. For example, '''Ribbon''' will display just the image, but will link it to the link page. '''RibbonDesc''' displays the ribbon, then adds the description next to it.
When a template calls one of the routines in the module, the {{{size}}} is replaced with the second un-named parameter when the template is called. That is passed on to this module to set the size of the image.
The "PageLink" provides the name of an article on Wikipedia with no wikilinking. (In theory it could be a URL, but that's not preferred)
The contents of the Description field can be any text which can be used as the "alt text" for an image link. Please be careful with this. Using links or curly braces "{}" or inverted commas '' etc can break that entry as well as, potentially, the rest of the entries in the template.

How this works, is that the first unnamed parameter when you call the template is used as the value to look up the corresponding value in this list. Once that value has been found, then the fields in that line are available to the module. These fields are combined in different ways to produce thee specific formatting required for the template that called this module.
For this reason, it's very important that this format is not broken or interfered with!

===A NOTE ON COUNTRIES===
For this Module, I have attempted to gather all the data into one large lookup table rather than splitting it into files for each country. It just means it's easier to maintain and it's less likely to get busybodies interfering and rearranging things because the "Good Idea Fairy" told them it would be a good idea.

That being said, Let's please try to keep this as organised as possible. Search the file for your Country's name. If there isn't any mention of it, then create a heading using a comment for your country and add any relevant entries there. Within the country heading, not a bad idea to create sub-headings for different things. Examples might be "Military/Civilian", "Arms of service", "Types of awards". This then can be duplicated on the Documentation page of this Module and will make more sense to new readers and ease of use for maintainers and editors.

PLEASE KEEP the entries in this file and the documentation in sync. If you add an entry here, please add it to the documentation page!!!!

<includeonly>{{Sandbox other||


}}</includeonly>