Template:Nutshell/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 04:17, 29 March 2023

This is a documentation subpage for Template:Nutshell.
It contains usage information, categories, and other content that is not part of the original template page.

Location

This infobox template presents a concise summary at the top of pages. It is placed below the title and other infoboxes and above the first paragraph of the main body.

The template display up to three dot points.

Usage

```
{{nutshell|text}}
```

becomes:

This page in a nutshell: text

{{nutshell|First bullet point|Second bullet point|Third bullet point}}

becomes:

This page in a nutshell:

First bullet point
Second bullet point
Third bullet point

{{Nutshell|title=A nutshell|text}}

becomes:

A nutshell in a nutshell: text

```
{{Nutshell|title=section|text}}
```

becomes:

This section in a nutshell: text

Template data

This infobox template presents a concise summary at the top of pages. It is placed below the title and other infoboxes and above the first paragraph of the main body.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
1	`1`	"Nutshell" description of main topic.	Content	required
Title	`title`	Title of issue/topic for which a "nutshell" description is being provided. Some pre-translated options are available, or a custom option can be inserted. Suggested values `guideline` `policy` `section`	Content	optional
2	`2`	Formats "nutshell" description as bullet list and provides entry for 2nd bullet list.	Content	optional
3	`3`	Provides entry for 3rd bullet list. Only works if 2 is set as well.	Content	optional

@@ Line 16: / Line 16: @@
 ::becomes:
 {{nutshell|title=A nutshell|text}}
+* <pre>{{Nutshell|title=section|text}}</pre>
+::becomes:
+{{nutshell|title=section|text}}
+==Template data==
+<templatedata>
+{
+	"params": {
+		"1": {
+			"description": "\"Nutshell\" description of main topic.",
+			"type": "content",
+			"required": true
+		},
+		"2": {
+			"description": "Formats \"nutshell\" description as bullet list and provides entry for 2nd bullet list.",
+			"type": "content"
+		},
+		"3": {
+			"description": "Provides entry for 3rd bullet list. Only works if 2 is set as well.",
+			"type": "content"
+		},
+		"title": {
+			"label": "Title",
+			"description": "Title of issue/topic for which a \"nutshell\" description is being provided. Some pre-translated options are available, or a custom option can be inserted.",
+			"type": "content",
+			"suggestedvalues": [
+				"guideline",
+				"policy",
+				"section"
+			]
+		}
+	},
+	"paramOrder": [
+		"1",
+		"title",
+		"2",
+		"3"
+	],
+	"format": "inline",
+	"description": "This infobox template presents a concise summary at the top of pages. It is placed below the title and other infoboxes and above the first paragraph of the main body."
+}
+</templatedata>
 <includeonly>
 <!--Categories-->