Template:Todo: Difference between revisions

Revision as of 06:23, 17 February 2022

TODO

Create a note box to indicate that a section is a work in progress with an optional message

[Edit template data]
Template parameters
Parameter		Description	Type	Status
Message	`1`	The todo message you want to display. If set to ''generic'', the message ''This section is a work in progress'' is displayed instead of a specific message. Suggested values `generic` Example Document capacitor widths.	String	optional
Ask for reader help	`reader_help`	Displays ''This section is incomplete; you can contribute by adding missing information'' instead of ''This section is a work in progress'' when ''message'' is set to ''generic''. Suggested values `true` `yes` `y`	String	optional

@@ Line 3: / Line 3: @@
 	"params": {
 		"1": {
-			"label": "Generic",
+			"label": "Message",
-			"description": "Displays ''This section is a work in progress'' instead of a specific message.",
+			"description": "The todo message you want to display. If set to ''generic'', the message ''This section is a work in progress'' is displayed instead of a specific message.",
+		    "suggestedvalues": [
+				"generic"
+	        ],
+			"example": "Document capacitor widths.",
 			"type": "string",
-			"aliases": [ "generic" ],
 			"required": false
 		},
 		"reader_help": {
 			"label": "Ask for reader help",
-			"description": "Displays ''This section is incomplete; you can contribute by adding missing information'' instead of ''This section is a work in progress.''",
+			"description": "Displays ''This section is incomplete; you can contribute by adding missing information'' instead of ''This section is a work in progress'' when ''message'' is set to ''generic''.",
 			"suggestedvalues": [
-		      "true",
+				"true",
-              "yes",
+				"yes",
-		      "y"
+				"y"
 	        ],
 			"type": "string",