Wiki: Message Templates

Wiki: Message Templates

 

 High-Level Overview
 How to

In this article

General

What are message templates?

This topic is inspired by Wikipedia:Template messages. Message Template (or simply a “template” for short) is a standardized block of text that points to a specific characteristic of an article. You can put a template to any article if you want to draw reader's attention to some specific feature of the topic. Feel free to add and remove templates from your articles but please do not change template wording unless specifically directed to do so by template usage guidance.

NOTE: For examples of each sign, click the tag related to the template. It is located after the code of each template (see below).

ISSUE: One issue is that by putting these at the top of your article, that's the intro text grabbed for scenarios like search results (Google, Bing, TechNet Wiki search), RSS feed summaries, and when an article is featured. So you might want to start with an intro paragraph or sentence first.

How do I use a message template?

To put a template to an article page please do the following.

  1. Go to this page.
  2. Chose the template you need.
  3. Locate the HTML code for the template. It is directly below the template example.
  4. Select and copy the entire code snippet.
  5. Go to the page that needs the template.
  6. Open the article in “Edit” mode.
  7. Click Edit HTML Source.
  8. In the HTML Source Editor window, move your cursor to the very beginning ot the HTML source.
  9. Paste the code of the template (that's what you copied in step 4).
  10. Click Update to close the HTML Source Editor windows and go back to the WYSIWYG editor mode.
  11. Check that the template is now present in the top of the article and all the text below it is okay.
  12. Click Save.

Template short form

Every template also has a “Short form” version. It does not show the template message until you hover your mouse over its picture or title. It may be useful to save space when there are a lot of templates (3+) placed on one page and you prefer to place tham one-by-one instead of stacked. This type of template is a bit harder to use because you would need basic HTML skills in order to place each template as a separate cell in one table (that unites all the templates).

Note: a template means a tag!

Here is one very important thing about templates: every template is meant to have a related tag. The template does not replace the tag! It just adds a visualization and clarity. When placing a template in an article—please, please, please don't forget to add the template tag to the list of other tags (it is located below the WYSIWYG editor box). When removing the template—please remove the tag as well.

How do I edit these templates?

If you wish to change something in existing templates, please avoid editing this page (either code or samples), if you are not completely, absolutely sure what are you doing. (Hint: you will need significant HTML editing skills for it!). If in doubt whether you could edit a template correctly please leave a comment to this page or participate in the templates discussion at TechNet Wiki Forums. Thanks in advance!

Back to top

Content type templates

Discussion

 This topic is a discussion.
There's no best practice that suits all environments. This article presents different options and points of view. If you disagree with some point — do not delete. Add your own thoughts and considerations instead. If they conflict with what was already written by others — mark yours as an “Alternate opinion”.

Template code

<table align="center"

       style="background-color: #eee; width: 80%; border: #aaa 1px solid;">

    <tbody>

        <tr>

            <td>

                <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/4760.discussion04.png" />

            </td>

            <td>

                <strong>This topic is a <em>discussion.</em></strong><br />

                There's no best practice that suits all environments. This article

                presents different options and points of view. If you disagree with some

                point &mdash; <strong>do not delete</strong>. Add your own thoughts and

                considerations instead. If they conflict with what was already written by

                others &mdash; mark yours as an &ldquo;Alternate opinion&rdquo;.

            </td>

        </tr>

    </tbody>

</table>

Short form (one message view example)


 Discussion

Template code

<table align="center" style="width: 90%;">

    <tr>

        <td>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="There's no best practice that suits all environments. This article presents different options and points of view. If you disagree with some point — do not delete. Add your own thoughts and considerations instead. If they conflict with what was already written by others — mark yours as an “Alternate opinion”.">

                <table align="center" style="background-color: #eee;

                                             border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/4760.discussion04.png" />

                        </td>

                        <td>

                            <strong>Discussion</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td>

        </td>

    </tr>

</table>

The tag related to this template is Discussion.

NOTE: Click the tag to see examples of this template.

Back to top

High-level Overview

 This topic is a high-level overview.
Here we discuss theory and general concepts. Do not be too specific. Avoid referencing specific product names or procedures (except as required for examples).

Template code

<table align="center"

       style="background-color: #eee; width: 80%; border: #aaa 1px solid;">

    <tbody>

        <tr>

            <td style="text-align: center;">

                <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/1220.highlevel03.png" />

            </td>

            <td>

                <strong>This topic is a <em>high-level overview.</em></strong><br />

                Here we discuss theory and general concepts. Do not be too specific.

                Avoid referencing specific product names or procedures (except as required

                for examples).

            </td>

        </tr>

    </tbody>

</table>

Short form (two messages view example)


 High-Level Overview
 High-Level Overview

Template code

<table align="center" style="width: 90%;">

    <tr>

        <td>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="Here we discuss theory and general concepts. Do not be too specific. Avoid referencing specific product names or procedures (except as required for examples).">

                <table align="center" style="background-color: #eee;

                                      border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/1220.highlevel03.png" />

                        </td>

                        <td>

                            <strong>High-Level Overview</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="Here we discuss theory and general concepts. Do not be too specific. Avoid referencing specific product names or procedures (except as required for examples).">

                <table align="center" style="background-color: #eee;

                                             border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/1220.highlevel03.png" />

                        </td>

                        <td>

                            <strong>High-Level Overview</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td>

        </td>

    </tr>

</table>

The tag related to this template is High Level.

NOTE: Click the tag to see examples of this template.

Back to top

How to

 This topic is a how to.
Please keep it as clear and simple as possible. Avoid speculative discussions as well as a deep dive into underlying mechanisms or related technologies.

Template code

<table align="center"

       style="background-color: #eee; width: 80%; border: #aaa 1px solid;">

    <tbody>

        <tr>

            <td style="text-align: center;">

                <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/0474.howto03.png" />

            </td>

            <td>

                <strong>This topic is a <em>how to.</em><br />

                </strong>Please keep it as clear and simple as possible. Avoid

                speculative discussions as well as a deep dive into underlying mechanisms

                or related technologies.

            </td>

        </tr>

    </tbody>

</table>

Short form (three messages view example)


 How to
 How to
 How to

Template code

<table align="center" style="width: 90%;">

    <tr>

        <td>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="Please keep it as clear and simple as possible. Avoid speculative discussions as well as deep dive into underlying mechanisms or related technologies.">

                <table align="center" style="background-color: #eee;

                                      border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/0474.howto03.png" />

                        </td>

                        <td>

                            <strong>How to</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="Please keep it as clear and simple as possible. Avoid speculative discussions as well as deep dive into underlying mechanisms or related technologies.">

                <table align="center" style="background-color: #eee;

                                             border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/0474.howto03.png" />

                        </td>

                        <td>

                            <strong>How to</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="Please keep it as clear and simple as possible. Avoid speculative discussions as well as deep dive into underlying mechanisms or related technologies.">

                <table align="center" style="background-color: #eee;

                                             border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/0474.howto03.png" />

                        </td>

                        <td>

                            <strong>How to</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td>

        </td>

    </tr>

</table>

The tag related to this template is How To.

NOTE: Click the tag to see examples of this template.

Back to top

More to do

(please add your suggestions here or post in forum)

  • This topic is a Stub.
  • This topic is a Link Collection.
  • This topic is for Troubleshooting.
  • This topic is a Reference Table.
  • This topic is a Knowledge Base list.
  • This topic is a Deep Dive.

Back to top

Recommended reading

 This topic is a recommended reading.
This article indicates a suggested or recommended reading that will provide you with accurate and important informations for a better understanding of the covered topic.

Template code

<table align="center"

       style="background-color: #eee; width: 80%; border: #aaa 1px solid;">

    <tbody>

        <tr>

            <td>

                <img src="/wiki/resized-image.ashx/__size/550x0/__key/communityserver-wikis-components-files/00-00-00-00-05/6165.RR.png" style="width: 60px; height: 60px;" /> 

            </td>

            <td>

                <strong>This topic is a <em>recommended reading.</em></strong><br />

                This article indicates a suggested or recommended reading that will provide you with accurate and importante informations for a better understanding of the covered topic.

            </td>

        </tr>

    </tbody>

</table>

Short form (one message view example)


   Recommended reading 

Template code

<table align="center" style="width: 90%;">

    <tr>

        <td>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="This article indicates a suggested or recommended reading that will provide you with accurate and important informations for a better understanding of the covered topic.">

                <table align="center" style="background-color: #eee;

                                             border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

<img src="/wiki/resized-image.ashx/__size/550x0/__key/communityserver-wikis-components-files/00-00-00-00-05/6165.RR.png" style="width: 50px; height: 50px;" /> 

                        </td>

                        <td>

                            <strong>Recommended reading</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td>

        </td>

    </tr>

</table>

The tag related to this template is Recommended reading.

NOTE: Click the tag to see examples of this template.

Back to top

Content style templates

Vendor-agnostic

 This topic is vendor-agnostic.
Here we talk about theory that applies to any hypervisor. For specific implementation and technical details please refer to other topics, for example those tagged “Hyper-V” and “How To”.

 Template code

<table align="center"

       style="background-color: #eee; width: 80%; border: #aaa 1px solid;">

    <tbody>

        <tr>

            <td style="text-align: center;">

                <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/3286.vendoragnostic07.png" />

            </td>

            <td>

                <strong>This topic is <em>vendor-agnostic.</em></strong><br />

                Here we talk about theory that applies to any hypervisor. For specific

                implementation and technical details please refer to other topics, for

                example those tagged &ldquo;<a

                href="/wiki/contents/articles/tags/Hyper-V/default.aspx">Hyper-V</a>&rdquo;

                and &ldquo;<a href="/wiki/contents/articles/tags/How+To/default.aspx">How

                To</a>&rdquo;.

            </td>

        </tr>

    </tbody>

</table>

Short form (one message view example) 


 Vendor-agnostic

Template code 

<table align="center" style="width: 90%;">

    <tr>

        <td>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="Here we talk about theory that applies to any hypervisor. For specific implementation and technical details please refer to other topics, for example those tagged “Hyper-V” and “How To”.">

                <table align="center" style="background-color: #eee;

                                             border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/3286.vendoragnostic07.png" />

                        </td>

                        <td>

                            <strong>Vendor-agnostic</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td>

        </td>

    </tr>

</table>

The tag related to this template is Vendor-agnostic.

NOTE: Click the tag to see examples of this template.

Usage guidance

Please replace “hypervisor” with the name of actual discussion topic. Also edit the list of tags to make it more relevant to discussion topic.

Back to top

More to do

(please add your suggestions here or post in forum)

  • This topic describes troubleshooting.
  • This topic is related to:
    • virtualization
    • backup
    • cryptography
    • a specific product (name the product)
  • This topic has:
    • code
    • video
    • anything else

Back to top

Temporary templates

Work in progress 

 This topic is work in progress.
Please abstain from editing it right now. You're welcome to contribute here in a couple of hours or days, though!
Please remove this sign if there are no changes made in last 48 hours.

Template code

<table align="center"

       style="background-color: #eee; width: 80%; border: #aaa 1px solid;">

    <tbody>

        <tr>

            <td style="text-align: center;">

                <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/8623.workinprogress.png" />

            </td>

            <td>

                <strong>This topic is <em>work in progress.</em></strong><br />

                Please abstain from editing it right now. You're welcome to contribute

                here in a couple of hours or days, though!<br />

                <em><span style="font-size: xx-small;">Please remove this sign if there

                are no changes made in last 48 hours.</span></em>

            </td>

        </tr>

    </tbody>

</table>

Short form (one message view example)


 Work in progress

Template code 

<table align="center" style="width: 90%;">

    <tr>

        <td>

        </td>

        <td style="width: 30%;">

            <acronym style="cursor: help;"

                     title="Please abstain from editing it right now. You're welcome to contribute here in a couple of hours or days, though! (Please remove this sign if there are no changes made in last 48 hours).">

                <table align="center" style="background-color: #eee;

                                             border: #aaa 1px solid; width: 100%;">

                    <tr>

                        <td style="text-align: center;">

                            <img src="/wiki/resized-image.ashx/__size/550x0/__key/CommunityServer.Wikis.Components.Files/articles/8623.workinprogress.png" />

                        </td>

                        <td>

                            <strong>Work in progress</strong>

                        </td>

                    </tr>

                </table>

            </acronym>

        </td>

        <td>

        </td>

    </tr>

</table>

The tag related to this template is In progress.

NOTE: Click the tag to see examples of this template.

Usage guidance

As the template says, place the template when you want to “check out” the article and politely ask the others to not edit it in order to avoid conflicts. Please remove the template as quickly as you finish your work. If you don't introduce any changes for a long time, be ready for someone to remove the template and edit the article him- or herself. Don't use this template if you just want to edit the article someday. Use it only when you are actually working on content or just took a little break.

Back to top

More to do

(please add your suggestions here or post in forum)

  • This topic needs work (to encourage the others to contribute).
  • This topic has questions (when you can't paint the whole picture yourself due to lack of knowledge in specific nuances).
  • This topic needs more:
    • details
    • sample code
    • reference links
    • anything else

 ↑ Back to top


See Also


 

Other Languages

This article is also available in these languages:

Sort by: Published Date | Most Recent | Most Useful
Comments
  • I'm voting on a good template to do next... Link Collection. I started a tag for "Link Collection" to get us closer.

  • Great Idea! Any suggestions on what exactly the message should say? I.e. what do we want folks do with this type of articles? My suggestion:

    This title is a Link Collection

    Please add more relevant links if they are not similar to those already in the list. We'd appreciate it if you not just type the link title but also provide the name of the website or specific publication and it author(s). E.g.: “TechNet Wiki – Contribute Boldly! (Craig Landis, “Ask the Directory Services Team” blog)”. So one could have more information to decide whether he's really interested in that particular link.

  • How about a template for "Content Requested" or something similar for topics that people would like to get information about, but they don't know enough about to write an article.  Then people with knowledge about the area requested could go ahead and add information.

  • Very useful!

  • I've translated one of these templates to use it in my Italian articles.

  • This is great, I really like the graphics as well for "To Do" and the various other types. I'd be interested to see a Survival Guide Icon/Image as well. Are the graphics something we should be adding if we're editing any of the above type of wiki entries?

  • Graphics would be nice, yes. Thanks! I added the big issue (why many of us stopped using these messages as prolifically)... which is that the text you lead with is important for SEO, RSS, and feature purposes. So you probably don't want your message at the very top (which is where i