Templates: Difference between revisions
Markmcumber (talk | contribs) No edit summary |
Markmcumber (talk | contribs) No edit summary |
||
| (26 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{StudentManual}} {{AdministratorManual}} | |||
< | '''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. [[Contributor|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 [[Editors|RichTextEditor]] is done by clicking the appropriate Template icon in the toolbar: | |||
[[File:TemplateIcon.png|center]] | |||
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: | |||
[[File:TemplateRTE.png|center]] | |||
<p style="text-align: center;">Clicking OK will embed the template in the previously selected position as designated by the cursor.</p><p style="text-align: center;"></p> | |||
= WikiTextEditor = | |||
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:''' {{Example}}</center> | <center>'''Example:''' {{Example}}</center> | ||
= Essential Templates = | |||
There are the essential templates that will be most useful to Contributors when developing pages. | |||
== Copyright == | |||
'''Copyright:''' the Copyright template— '''© UNB Archives & Special Collections, 2014 '''—should appear at the bottom of every [[Entries and Pages|entry]] in this wiki and should be placed at the bottom of every entry created by a [[Contributor]]. <span style="font-size: 13px; line-height: 1.6;">This is intended to declare ownership and protect the information contained in the wiki pages.</span> | |||
<center>'''At the bottom of every entry created, insert: '''{{Copyright}}</center> | |||
== Under Development == | |||
'''UnderDevelopment:''' the UnderDevelopment template declares to [[Reader|readers]] that an entry, though initiated, has not yet been completed. <span style="font-size: 13px; line-height: 1.6;">As information for the entry is still being collected and refined, the contents of the page cannot yet be considered </span>[[Authoritative]]<span style="font-size: 13px; line-height: 1.6;">.</span> | |||
<center>'''At the top of every entry created that meet this criteria, insert: '''<span style="font-size: 13px; line-height: 1.6;">{{UnderDevelopment}}</span></center><br/> | |||
<br/>{{UnderDevelopment}} | <br/>{{UnderDevelopment}} | ||
== Stubs == | |||
</ | '''Stubs:''' the Stub template declares to the reader that, while an entry is not yet completed, the information that it contains is correct and authoritative. <span style="font-size: 13px; line-height: 1.6;">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.</span> | ||
<center>'''At the top of every entry created that meet this criteria, insert: '''{{Stubs}}</center> | |||
<br/><br/>{{Stub}} | |||
== Images == | |||
Every image embedded within the ''History at a Glance ''wiki exists as a hardcopy in the UNB Archives & Special Collections. These images have been formatted to fit conveniently into the wiki entries/pages, and each image uploaded to the wiki is assigned its own independent page (accessable by clicking the displayed image). On each Image Page a template has been embedded, declaring to the user that a higher quality version of that image can be readily delivered upon contacting the UNB Archives & Special Collections staff. | |||
{{Images}} | |||
--[[User:Markmcumber|MarkMcCumber]] ([[User talk:Markmcumber|talk]]) 18 June 2014 (ADT) | |||
[[Category:Mark's Contributions|Template]]<br/>[[Category:Manual Pages|Template]] | |||
Latest revision as of 10:44, 9 July 2014
Return to Student Manual.
Return to Administrator Manual.
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:
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:
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:
Essential Templates
There are the essential templates that will be most useful to Contributors when developing pages.
Copyright
Copyright: the Copyright template— © UNB Archives & Special Collections, 2014 —should appear at the bottom of every entry in this wiki and should be placed at the bottom of every entry created by a Contributor. This is intended to declare ownership and protect the information contained in the wiki pages.
Under Development
UnderDevelopment: the UnderDevelopment template declares to readers 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.
Stubs
Stubs: the Stub template declares to the reader that, while an entry is not yet completed, the information that it contains is correct and 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.
Images
Every image embedded within the History at a Glance wiki exists as a hardcopy in the UNB Archives & Special Collections. These images have been formatted to fit conveniently into the wiki entries/pages, and each image uploaded to the wiki is assigned its own independent page (accessable by clicking the displayed image). On each Image Page a template has been embedded, declaring to the user that a higher quality version of that image can be readily delivered upon contacting the UNB Archives & Special Collections staff.
--MarkMcCumber (talk) 18 June 2014 (ADT)