Templates: Difference between revisions

From UNB Archives and Special Collections
Jump to navigation Jump to search
No edit summary
No edit summary
Line 19: Line 19:
Placing a template is very similar to internal [[Archives Manual#Linking within the wiki|linking]] when using the [[Editors|WikiTextEditor]]. Just as above, a template is embedded by enclosing the title of the template in double ''[[Mark-up Language|braces]]'' — {{ }} — within an entry in the desired location:
Placing a template is very similar to internal [[Archives Manual#Linking within the wiki|linking]] when using the [[Editors|WikiTextEditor]]. Just as above, a template is embedded by enclosing the title of the template in double ''[[Mark-up Language|braces]]'' — {{ }} — within an entry in the desired location:
<center>'''Example:'''&nbsp;&#x7B;&#x7B;Example&#x7D;&#x7D;</center>
<center>'''Example:'''&nbsp;&#x7B;&#x7B;Example&#x7D;&#x7D;</center>
= Essential Templates =
Here are the essential templates that will be most useful to Contributors when developing pages.
<br/>'''There are several templates that have been created for the use of the contributor that all should be aware of:'''
<br/>'''There are several templates that have been created for the use of the contributor that all should be aware of:'''



Revision as of 11:55, 18 June 2014

Templates are an effective way to present a precise body of information across many wiki entries. A change to the content of an original template page will result in corresponding changes across all of the entries onto which the template has been inserted. This allows for the efficient conveyance of a message throughout the corresponding pages. Contributors will likely not need to create new templates, but several templates have been created for the use of contributors.


RichTextEditor

Placing a template using either the RichTextEditor is done by clicking the appropriate Template icon in the toolbar:

TemplateIcon.png

Unlike using the RichTextEditor to create internal links throughout the wiki, the Template tool does not allow for the searching existing templates. Instead the Contributor must be aware of the template prior to its insertion. Upon selecting this icon, the Contributor must enter the title of the template enclosed by double braces — {{ }} — in the generated field:

TemplateRTE.png

Clicking OK will embed the template in the previously selected position as designated by the cursor.

WikiTextEditor

Placing a template is very similar to internal linking when using the WikiTextEditor. Just as above, a template is embedded by enclosing the title of the template in double braces — {{ }} — within an entry in the desired location:

Example: {{Example}}


Essential Templates

Here are the essential templates that will be most useful to Contributors when developing pages.


There are several templates that have been created for the use of the contributor that all should be aware of:

  • Copyright: the Copyright template—© UNB Archives & Special Collections, 2014—has been inserted at the bottom of every entry in this wiki and should be inserted at the bottom of every entry created by the contributor.
    • This is intended to declare ownership and protect the information contained in the wiki pages.
  • UnderDevelopment: the UnderDevelopment template declares to the reader that an entry, though initiated, has not yet been completed. As information for the entry is still being collected and refined, the contents of the page cannot yet be considered authoritative.
    • This template should be inserted at the top of an entry that meets this description.


This entry is currently under development. Please do not consider the entry authoritative until it has been completed.


  • Stubs: the Stub template declares to the reader that, while an entry is not yet completed, the information that it contains is authoritative. This is meant to indicate that the included sections of the entry have been completed, but that the entry still needs to be developed further.
    • This template should be inserted at the top of an entry that meets this description.


This article is a stub. The content provided is authoritative, but the entry still needs more work before it can be considered complete.


  • Images:

</div>