Alyxia: 2 revisions imported: TemplateData carryovers

2023-06-06T18:35:42Z

2 revisions imported: TemplateData carryovers

← Older revision

Revision as of 18:35, 6 June 2023

c2dl>Streetclaw: /* Examples */ unused param removed

2020-08-15T14:38:08Z

Examples: unused param removed

← Older revision		Revision as of 14:38, 15 August 2020
Line 27:		Line 27:
	{{TemplateData/entry\|name=Auto pre name B\|alias1=B alias 1\|alias2=B alias 2\|alias3=B alias 3\|param=B param\|desc=B description\|def=NULL\|example=		{{TemplateData/entry\|name=Auto pre name B\|alias1=B alias 1\|alias2=B alias 2\|alias3=B alias 3\|param=B param\|desc=B description\|def=NULL\|example=
	* List example with containing templates and HTML tags		* List example with containing templates and HTML tags
	* No Icon (<code>1</code>): {{ItemLink\|Ginger Tom. Salad\|noIcon=1}}
	* Icon (<code>0</code>): {{ItemLink\|Ginger Tom. Salad\|noIcon=0}}
	* Default (parameter not used / <code>0</code>): {{ItemLink\|Ginger Tom. Salad}}
	\|type=String\|status=Required\|autoPre=1}}		\|type=String\|status=Required\|autoPre=1}}
	{{TemplateData/entry\|name=Deprecated Example name\|alias1=Deprecated alias 1\|alias2=Deprecated alias 2\|alias3=Deprecated alias 3\|param=deprecated param\|desc=deprecated description\|def=NULL\|example=xyz\|type=String\|status=Deprecated}}		{{TemplateData/entry\|name=Deprecated Example name\|alias1=Deprecated alias 1\|alias2=Deprecated alias 2\|alias3=Deprecated alias 3\|param=deprecated param\|desc=deprecated description\|def=NULL\|example=xyz\|type=String\|status=Deprecated}}
Line 39:		Line 36:
	{{TemplateData/entry\|name=Auto pre name B\|alias1=B alias 1\|alias2=B alias 2\|alias3=B alias 3\|param=B param\|desc=B description\|def=NULL\|example=		{{TemplateData/entry\|name=Auto pre name B\|alias1=B alias 1\|alias2=B alias 2\|alias3=B alias 3\|param=B param\|desc=B description\|def=NULL\|example=
	* List example with containing templates and HTML tags		* List example with containing templates and HTML tags
	* No Icon (<code>1</code>): {{ItemLink\|Ginger Tom. Salad\|noIcon=1}}
	* Icon (<code>0</code>): {{ItemLink\|Ginger Tom. Salad\|noIcon=0}}
	* Default (parameter not used / <code>0</code>): {{ItemLink\|Ginger Tom. Salad}}
	\|type=String\|status=Required\|autoPre=1}}		\|type=String\|status=Required\|autoPre=1}}
	{{TemplateData/entry\|name=Deprecated Example name\|alias1=Deprecated alias 1\|alias2=Deprecated alias 2\|alias3=Deprecated alias 3\|param=deprecated param\|desc=deprecated description\|def=NULL\|example=xyz\|type=String\|status=Deprecated}}		{{TemplateData/entry\|name=Deprecated Example name\|alias1=Deprecated alias 1\|alias2=Deprecated alias 2\|alias3=Deprecated alias 3\|param=deprecated param\|desc=deprecated description\|def=NULL\|example=xyz\|type=String\|status=Deprecated}}

c2dl>Streetclaw: Created page with "Template for creating a unified parameter format for templates == About == Creates a list that displays Template parameter in a unified format. This template creates a single..."

2020-08-15T14:33:21Z

Created page with "Template for creating a unified parameter format for templates == About == Creates a list that displays Template parameter in a unified format. This template creates a single..."

New page

Template for creating a unified parameter format for templates

== About ==
Creates a list that displays Template parameter in a unified format.
This template creates a single entry for the Required template [[Template:TemplateData]].

== Parameter ==
{{TemplateData|
{{TemplateData/entry|name=Parameter title|param=name|desc=Specify a title for a parameter of the template documentation|def=NULL|type=String|status=Required}}
{{TemplateData/entry|name=Parameter name|param=param|desc=Specify a name for a parameter of the template documentation|def=NULL|type=String|status=Required}}
{{TemplateData/entry|name=Parameter alias1|param=alias1|desc=Specify a alias for a parameter of the template documentation|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=Parameter alias2|param=alias2|desc=Specify a alias for a parameter of the template documentation|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=Parameter alias3|param=alias3|desc=Specify a alias for a parameter of the template documentation|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=Parameter Description|param=desc|desc=Specify a description for a parameter of the template documentation|def=no description|type=WikiCode|status=Recommended}}
{{TemplateData/entry|name=Parameter Example|param=example|desc=Specify an example for a parameter of the template documentation|def=no example|type=WikiCode|status=Recommended}}
{{TemplateData/entry|name=Parameter type|param=type|desc=Specify a type for a parameter of the template documentation: [[#Data_Dictionary_Notation_.28DDN.29_for_types|Data Dictionary Notation]]|def=NULL|type=[[#Data_Dictionary_Notation_.28DDN.29_for_types|DDNCode]]|status=Required}}
{{TemplateData/entry|name=Parameter status|param=status|desc=Specify a status for a parameter of the template documentation|def=NULL|type=<nowiki>["Required" | "Recommended" | "Optional" | "Deprecated" ]</nowiki>|status=Required}}
{{TemplateData/entry|name=Auto pre|param=autoPre|desc=Automatic pre for examples|def=0|type=Boolean|status=Optional}}
}}

== Examples ==

'''Complete example:'''

{{TemplateData|
{{TemplateData/entry|name=Example name|alias1=Example alias 1|alias2=Example alias 2|alias3=Example alias 3|param=example param|desc=example description|def=NULL|example=xyz|type=String|status=Required}}
{{TemplateData/entry|name=Auto pre name B|alias1=B alias 1|alias2=B alias 2|alias3=B alias 3|param=B param|desc=B description|def=NULL|example=
* List example with containing templates and HTML tags
* No Icon (<code>1</code>): {{ItemLink|Ginger Tom. Salad|noIcon=1}}
* Icon (<code>0</code>): {{ItemLink|Ginger Tom. Salad|noIcon=0}}
* Default (parameter not used / <code>0</code>): {{ItemLink|Ginger Tom. Salad}}
|type=String|status=Required|autoPre=1}}
{{TemplateData/entry|name=Deprecated Example name|alias1=Deprecated alias 1|alias2=Deprecated alias 2|alias3=Deprecated alias 3|param=deprecated param|desc=deprecated description|def=NULL|example=xyz|type=String|status=Deprecated}}
}}

<pre>
{{TemplateData|
{{TemplateData/entry|name=Example name|alias1=Example alias 1|alias2=Example alias 2|alias3=Example alias 3|param=example param|desc=example description|def=NULL|example=xyz|type=String|status=Required}}
{{TemplateData/entry|name=Auto pre name B|alias1=B alias 1|alias2=B alias 2|alias3=B alias 3|param=B param|desc=B description|def=NULL|example=
* List example with containing templates and HTML tags
* No Icon (<code>1</code>): {{ItemLink|Ginger Tom. Salad|noIcon=1}}
* Icon (<code>0</code>): {{ItemLink|Ginger Tom. Salad|noIcon=0}}
* Default (parameter not used / <code>0</code>): {{ItemLink|Ginger Tom. Salad}}
|type=String|status=Required|autoPre=1}}
{{TemplateData/entry|name=Deprecated Example name|alias1=Deprecated alias 1|alias2=Deprecated alias 2|alias3=Deprecated alias 3|param=deprecated param|desc=deprecated description|def=NULL|example=xyz|type=String|status=Deprecated}}
}}
</pre>

== Data Dictionary Notation (DDN) for types ==

The [http://users.csc.calpoly.edu/~jdalbey/SWE/DDnotation.html Data Dictionary Notation (DDN)] is a modified modified [https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form BNF notation] (which is used in [https://en.wikipedia.org/wiki/Data_dictionary Data Dictionaries]) to describes the structure of data entries. The BNF and DDN notation is used in the field of [https://en.wikipedia.org/wiki/Software_engineering Software engineering (SWE)]. In this case it describes how types have to be structured.

The used DDN Notation is slightly different than the linked DDN Notation:
* The upper limit is '''not''' superscript
* Can have a lower limit
* Can have optional parts

{| class="wikitable"
|-
! Type
! Notation
! Description
|-
| Sequence
| +
| Sequence of definitions
|-
| Alternative
| <nowiki>[...|...]</nowiki>
| Only one element out of this list
|-
| Repetition
| {...}
| Repetition of the definition
|-
| Repetition
| 2 {...}
| Repetition of the definition with the minimum of two
|-
| Repetition
| {...} 5
| Repetition of the definition with the maximum of five
|-
| Repetition
| 1 {...} 6
| Repetition of the definition with the minimum of one and the maximum of six
|-
| Option
| (...)
| Optional definition
|-
| Specific value
| "..."
| fix definition
|}

=== Predefined ===

All predefined Types can be used directly or inside DDNCode

{| class="wikitable"
|-
! Type
! Definition
! Comment
|-
| NULL
| <nowiki>""</nowiki>
| Empty
|-
| NonzeroDigit
| <nowiki>["1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"]</nowiki>
| Single character, 1 - 9
|-
| Digit
| <nowiki>["0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"]</nowiki>
| Single character, 0 - 9
|-
| LowerAlphabet
| <nowiki>["a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" ]</nowiki>
| Single character, a - z
|-
| UpperAlphabet
| <nowiki>["A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z"]</nowiki>
| Single character, A - Z
|-
| Alphabet
| <nowiki>[LowerAlphabet | UpperAlphabet]</nowiki>
| Single character, a - z / A - Z
|-
| Ascii
| <nowiki>1 {Ascii} 1</nowiki>
| [https://en.wikipedia.org/wiki/ASCII ASCII] character
|-
| Char
| <nowiki>1 {Char} 1</nowiki>
| [https://en.wikipedia.org/wiki/UTF-8 UTF-8] character
|-
| String
| <nowiki>1 {Char}</nowiki>
| One or more UTF-8 characters
|-
| AsciiString
| <nowiki>1 {Ascii}</nowiki>
| One or more ASCII characters
|-
| WikiCode
| <nowiki>1 {WikiCode} 1</nowiki>
| Any wiki code
|-
| DDNCode
| <nowiki>1 {DDNCode} 1</nowiki>
| Any DDNCode (links are allowed)
|-
| Number
| <nowiki>1 {Digit}</nowiki>
| Any natural number with zero
|-
| Decimal
| <nowiki>1 {Digit} + ( "." + 1 {Digit} )</nowiki>
| Any natural number with zero
|-
| NonzeroNumber
| <nowiki>[ 1 {NonzeroDigit} 1 | 2 {Digit} ]</nowiki>
| Any natural number without zero
|-
| SignedNumber
| <nowiki>[ "-" + 1 {NonzeroDigit} 1 | 1 {Digit} 1 | ("-") + 2 {Digit} ]</nowiki>
| Any Integer (doesn't allow -0 only 0)
|-
| PercentValue
| <nowiki>[ 1 {Digit} 2 | "100" ]</nowiki>
| Any natural number from 0 to 100
|-
| SignedPercentValue
| <nowiki>[ "-" + 1 {NonzeroDigit} 1 | 1 {Digit} 1 | ("-") + 2 {Digit} 2 | ("-") + "100" ]</nowiki>
| Any natural number from 0 to 100 and from -1 to -100
|-
| Percent
| <nowiki>PercentValue + "%"</nowiki>
| From 0% to 100% (natural number)
|-
| SignedPercent
| <nowiki>SignedPercentValue + "%"</nowiki>
| From 0% to 100% and from -1% to -100% (natural number)
|-
| Boolean
| <nowiki>["0" | "1"]</nowiki>
| 0 (off) or 1 (on)
|-
| True
| <nowiki>"1"</nowiki>
| 1 (on)
|-
| False
| <nowiki>"0"</nowiki>
| 0 (off)
|-
| Month
| <nowiki>[ 1 {NonzeroDigit} 1 | "10" | "11" | "12"]</nowiki>
| 1 - 12
|-
| Monthfill
| <nowiki>["0" + 1 {NonzeroDigit} 1 | "10" | "11" | "12"]</nowiki>
| 01, 02, 03 ... - 12
|-
| Monthname
| <nowiki>["January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"]</nowiki>
| Month (name)
|-
| Day
| <nowiki>[ ( [ "1" | "2" ] ) + 1 {Digit} 1 | "30" | "31" ]</nowiki>
| 1 - 31
|-
| Dayfill
| <nowiki>[ [ "0" | 1" | "2" ] + 1 {Digit} 1 | "30" | "31" ]</nowiki>
| 01, 02, 03 ... - 31
|-
| Year
| <nowiki>1 {Digit}</nowiki>
| Any year
|-
| LabeledYear
| <nowiki>Year + [" AD" | " BC" | " AC"]</nowiki>
| Any year with label
|-
| LevelNumber
| <nowiki>[ 1 {NonzeroDigit} 1 | 2 {Digit} 2 ]</nowiki>
| 1, 2, ... - 99
|-
| LevelNumberFill
| <nowiki>[ "0" + 1 {NonzeroDigit} 1 | 2 {Digit} 2 ]</nowiki>
| 01, 02, ... - 99
|}

=== Special Predefined ===

These predefines are based on the current Template

{| class="wikitable"
|-
! Type
! Definition
! Comment
|-
| <nowiki><name></nowiki>
| <nowiki>"{{{<name>}}}"</nowiki>
| All parameter names of the current template (this means: use the same type as in <nowiki><name></nowiki>)
|-
| <nowiki><Template:<name>></nowiki>
| <nowiki>"[[Template:<name>]]"</nowiki>
| Other templates (link required for type; this means: use these template as type; used in nested templates)
|}

=== Examples ===
* String + Number + {param}
* Number + param
(param is in this example an other parameter of the template)
* String + " = " + 1 {String} 2
* String + (Number)

Template:TemplateData/entry/doc - Revision history

Alyxia: 2 revisions imported: TemplateData carryovers

c2dl>Streetclaw: /* Examples */ unused param removed

c2dl>Streetclaw: Created page with "Template for creating a unified parameter format for templates == About == Creates a list that displays Template parameter in a unified format. This template creates a single..."