Template:Short description: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
<noinclude> | <noinclude> | ||
== | == Template:Short description == | ||
{{Template:Short description/doc}} | |||
<!-- Add a notice to indicate this is a template page --> | |||
<div style="background: #f8f9fa; border: 1px solid #aaa; padding: 0.5em 1em; margin-bottom: 1em;"> | |||
This is the documentation for the <code>Template:Short description</code>. To use this template, follow the instructions below. | |||
</div> | |||
=== Purpose === | |||
This template is used to add a short description to a page. The description is displayed in a visually subtle manner and can be used for search engine optimization (SEO) or to provide a brief summary of the page's content. | This template is used to add a short description to a page. The description is displayed in a visually subtle manner and can be used for search engine optimization (SEO) or to provide a brief summary of the page's content. | ||
| Line 17: | Line 24: | ||
</pre> | </pre> | ||
Replace | Replace <code>Your description here</code> with a concise description of the page's content. | ||
=== Parameters === | === Parameters === | ||
{{Template:Short description/doc/parameters}} | |||
: | |||
=== Examples === | === Examples === | ||
Here are some examples of how to use this template: | |||
==== Example 1 ==== | |||
<pre> | <pre> | ||
{{Short description|53rd chapter of the Book of Isaiah in the Hebrew Bible}} | {{Short description|53rd chapter of the Book of Isaiah in the Hebrew Bible}} | ||
</pre> | </pre> | ||
=== | ==== Example 2 ==== | ||
<pre> | |||
{{Short description|Overview of the history and culture of ancient Rome}} | |||
</pre> | |||
=== Customization === | |||
You can customize the appearance of the short description by adding CSS to <code>MediaWiki:Common.css</code>. For example: | |||
<pre> | |||
.shortdescription { | |||
font-size: 0.9em; | |||
color: #555; | |||
margin-bottom: 1em; | |||
} | |||
</pre> | |||
[[Category:Templates]] | [[Category:Templates]] | ||
[[Category:Metadata templates]] | |||
</noinclude> | </noinclude> | ||
Latest revision as of 22:12, 24 January 2025
Template:Short description
This is the documentation for the Template:Short description. To use this template, follow the instructions below.
Purpose
This template is used to add a short description to a page. The description is displayed in a visually subtle manner and can be used for search engine optimization (SEO) or to provide a brief summary of the page's content.
Usage
To use this template, add the following code to the top of a page:
{{Short description|Your description here}}
Replace Your description here with a concise description of the page's content.
Parameters
Parameters
| Parameter | Description | Type | Status |
|---|---|---|---|
| 1 | The short description text. | String (plain text) | Required |
Usage Notes
- The short description should be concise and no longer than one or two sentences.
- Avoid using complex formatting or markup in the description.
- The description is displayed in a visually subtle manner, so it should complement the page's content without distracting from it.
Examples
Example 1
{{Short description|53rd chapter of the Book of Isaiah in the Hebrew Bible}}
Example 2
{{Short description|Overview of the history and culture of ancient Rome}}
Examples
Here are some examples of how to use this template:
Example 1
{{Short description|53rd chapter of the Book of Isaiah in the Hebrew Bible}}
Example 2
{{Short description|Overview of the history and culture of ancient Rome}}
Customization
You can customize the appearance of the short description by adding CSS to MediaWiki:Common.css. For example:
.shortdescription {
font-size: 0.9em;
color: #555;
margin-bottom: 1em;
}