Template:Short description: Difference between revisions

From Know Islam
Jump to navigation Jump to search
(Replaced content with "<div id="shortdescription" style="display: none;">{{{1}}}</div>")
Tag: Replaced
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div id="shortdescription" style="display: none;">{{{1}}}</div>
<includeonly>
<!--
This template is used to add a short description to a page.
Usage: {{Short description|Your description here}}
-->
<div id="shortdescription" class="shortdescription">{{{1|}}}</div>
</includeonly>
 
<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.
 
=== Usage ===
To use this template, add the following code to the top of a page:
<pre>
{{Short description|Your description here}}
</pre>
 
Replace <code>Your description here</code> with a concise description of the page's content.
 
=== Parameters ===
{{Template:Short description/doc/parameters}}
 
=== Examples ===
Here are some examples of how to use this template:
 
==== Example 1 ====
<pre>
{{Short description|53rd chapter of the Book of Isaiah in the Hebrew Bible}}
</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:Metadata templates]]
</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;
}