Help:Template

Contents 1 About templates 2 Sample templates 2.1 Boxes to put text in 3 Editorial Templates 3.1 Expiry Template 3.2 Clinical Evidence Base templates 3.3 Reference needed 3.4 JanusBox 3.5 Boxes to put country-specific text in 3.6 Templates that provide information on a page 3.7 Templates for use with uploaded files 4 Complex Templates 4.1 SubjectBox 4.2 GeneticsBox 4.3 BiochemistryBox 4.4 ChemistryBox 4.5 CytokineBox 4.6 PharmacologyBox 4.7 Infobox Anatomy 4.8 Bacteria 4.9 Templates for Tabulation 5 Function Templates 5.1 Strip newlines 5.2 PassEquals 5.3 Refsec 5.4 Refsame 5.5 OnlyIfPage 5.6 OnlyIfPageShowTemplate

About templates

Templates are designed to make life easier, and provide a way of duplicating repetitive, dull or complicated content across the site, as well as helping to bring a consistent look and feel to different pages. As time goes on, we will create a whole list of templates for various uses, such as anatomical descriptions, drug details, dosage details, etc. A list of all the templates currently defined can be found here.

Templates can then be used anywhere on ganfyd by placing the name of the template within two sets of curly braces, e.g. {{Draft}}.

Some templates allow content to be added to them:

Your text goes here!

For example:

{{KeyPointsBox|Your text goes here!}} will create the box on the right:

If you are feeling very brave you can also create your own templates by creating a new page with the prefix of 'Template: (for example Template:sample) - keep the nomenclature simple, and try and ensure the look of the template fits with the rest of the site.

Templates used in a page that are themselves unlikely to have to change with time are best written as {{subst:TEMPLATE}} as this reduces load on the server. Please do this once a Template and its content is finalised, as much as possible.

Sample templates

Boxes to put text in

It is important that vincristine is not accidentally administered intrathecally.

{{WarningBox|PLACE YOUR TEXT HERE}}

Use this box to convey a warning, to provide information which may prevent harm or to provide information which must be read.

The Health Protection Agency was formed from what used to be the Public Health Laboratory Service.

{{InterestBox|PLACE YOUR TEXT HERE}}

Use this box to convey information which provides an interesting aside, yet doesn't warrant a page all of its own, or just to provide a bit of padding regarding a subject - e.g. a bit of historical data.

The Three R's are reading, writing and arithmetic.

{{KeyPointsBox|PLACE YOUR TEXT HERE}}

Use this box for summaries or for making particularly important information more prominent by drawing it out of a long article. Please, use it sparingly and try to write articles in continuous prose as much as possible.

I think this box is appropriate for those occasions where I just can't keep my opinion to myself!  - Rupert Millard

{{QuotationBox|QUOTATION|ORIGINATOR}}

Use this box in an article if you want to relate something personal, (eg. an anecdote or your opinion) or for an illustrative quotation of someone else.

ΕΤΥΜΟΛΟΓΙΑ

ganfyd is an acronym

{{EtymologyBox|PLACE YOUR TEXT HERE}}

Use this box in an article to include information about the roots of words.

X	Exclusion this that

{{ExcludeThisBox|PLACE YOUR TEXT HERE}}

Use this box to remind people to rule out something before thinking of something else.

{{BiteBox|SOUNDBITE HERE}}

Use this box in an article if you want to make a paragraph stand out as below, eg. for a soundbite.

Something punchy.

{{GreenBox|Multiline SOUNDBITE HERE}}

Use this box in an article if you want to make a number of lines of text with complex formating stand out as below, eg. for a soundbite.

This is complex and more than a paragraph

• Something punchy.

---

Editorial Templates

---

Expiry Template

{{Expire|ExpiryDate=20991231|ExpiredMessage={{WarningBox|This information was only valid to 2099.}}|UnexpiredMessage=

The Expiry Template allows you to:

*Specify text that only appears on a page up to a set date

*Specify text that appears on a page after a set date

*Have reasonable lengths of such text in wiki format

* This text would disappear in 2100 and a warning box appear

}}

The Expiry Template allows you to:

• Specify text that only appears on a page up to a set date
• Specify text that appears on a page after a set date
• Have reasonable lengths of such text in wiki format
• This text would disappear in 2100 and a warning box appear

Clinical Evidence Base templates

A set of templates has been developed to indicate the level of evidence by each of the major grading schemes. Full details are in the Evidence-based medicine article. These templates cover the full range from {{CE B}} creating beneficial to likely to be ineffective or harmful

Reference needed

• {{Fact}} gives Needs citation and automatically links to Category:Articles needing citations
• {{NoLinkYet}} generates a member of Category:Pages requiring links to papers and gives
  Please supply a link for this paper.
• {{NoPMIDYet}} is best used when a reference is provided without a pubmed reference yet being published and generates a member of Category:Pages requiring links to papers

JanusBox

Use {{JanusBox}} on all years

---

Boxes to put country-specific text in

As ganfyd contributors come from a variety of countries, some content (for example medicolegal information) is relevant to an individual country. These boxes provide a place to put that content. For the flag alone at 60px use template {{<CountryAbbreviation>Flag}} eg {{UNFlag}}

{{Australia|PLACE YOUR TEXT HERE}} - Australia

{{Australasia|PLACE YOUR TEXT HERE}} - Australia

{{England|PLACE YOUR TEXT HERE}} - England

{{Canada|PLACE YOUR TEXT HERE}} - Canada

{{NZ|PLACE YOUR TEXT HERE}} - New Zealand

{{NI|PLACE YOUR TEXT HERE}} - Northern Ireland

{{ROI|PLACE YOUR TEXT HERE}} - Republic of Ireland

{{Scotland|PLACE YOUR TEXT HERE}} - Scotland

{{Wales|PLACE YOUR TEXT HERE}} - Wales

{{England & Wales|PLACE YOUR TEXT HERE}} - Wales

{{UK|PLACE YOUR TEXT HERE}} - United Kingdom

{{USA|PLACE YOUR TEXT HERE}} - United States of America

{{EU|PLACE YOUR TEXT HERE}} - European Union

{{Lebanon|PLACE YOUR TEXT HERE}} - Lebanon

{{India|PLACE YOUR TEXT HERE}} - India

{{Switzerland|PLACE YOUR TEXT HERE}} - Switzerland

{{UN|PLACE YOUR TEXT HERE}} - UN

---

Templates that provide information on a page

{{stub}} - Place this on a page which you feel is in need of expansion:

{{draft}} - Place this on a page which you feel is unfinished:

{{delete}} - Place this on a page which is not required and needs deleting by the administrators:

IE specific link - Place where link known to have web standards compliance problems

---

Templates for use with uploaded files

{{Ganfyd-licence}} - Add this to the description of a file which you would like to be released under the Creative Commons licence used by ganfyd:

{{PD-licence}} - Add this to the description of a file which is available in the public domain:

{{Flag-licence}} - Add this to the description of a file which relates to a state or international intergovernmental organization emblem:

{{Crowncopyright-licence}} - Add this for up to 250 words extracted from a crown document, specifying source (excludes text that appears in tables, diagrams and forms, other restrictions apply: OPSI guidelines

{{Logo-licence}} - Add this to the description of an image which constitutes the logo or registered trademark of a commercial venture (Please do not breach copyright!):

{{Copyright-licence|author=~~~}} - Add this to the description of a file which you have created and wish to retain the copyright to:

{{Copyright-permission-licence|author=NAME OF AUTHOR|caveat=A PROVISO GOES HERE}} - Add this to the description of an image which you or another person owns the copyright to and where permission for use is granted with caveat(s):

{{Gray's-licence}} - Add this to any images from the 1918 edition of Gray's Anatomy (Please do not upload images from editions still subject to copyright!):

{{PHIL-licence}} - Add this to any images obtained from the CDC Public Health Image Library, which are in the public domain:

{{Freeimages-licence}} - Add this to any images obtained from freeimages as they have certain restrictions placed on their usage:

{{Canada-archive-licence}} - Add this to any images obtained from Library and Archives Canada (Bibliothèque et Archives Canada) image library (Please ensure that the copyright has expired before uploading the image!):

{{Open-clipart-licence}} - Add this to images obtained from the Open Clipart Library, which are in the public domain:

---

See this link for evidence base templates

---

Complex Templates

SubjectBox

call {{SubjectBox|}} to create a right justified box with many web resource links to the page title. More details are on Template talk:SubjectBox . vis (see how much there is on templates !)

GeneticsBox

Use syntax as for SubjectBox but also links to on line genetics databases

BiochemistryBox

call {{BiochemistryBox|||||||}} with syntax fields empty (it will use the name of the current page) or as per Template talk:BiochemistryBox. The sections on ChemistryBox and PharmacologyBox below give more details.

ChemistryBox

call {{ChemistryBox||||||}} with syntax fields empty (it will use the name of the current page) or as per Template talk:ChemistryBox. The section on PharmacologyBox below gives more details.

CytokineBox

Use syntax as for SubjectBox but also links to on line cytokine databases

PharmacologyBox

• There are 7 fields so this empty PharmacologyBox would be called by:

{{PharmacologyBox|||||||}} This will self populate from the page name, so can be inserted with every drug:It will categorise the compound as a medicine ! see also Template talk:PharmacologyBox

• A full box has data like so and is illustrated at Template talk:PharmacologyBox :
  • (hint always end a line with a '|' divider, except the last)

{{ PharmacologyBox|

Enter rINN name here|

Enter alternative names here - hint indicate trademarks thus ^®|

You can put any image you like here. An example is

[[image:OmeprazoleMolecules.png|thumb|Omeprazole Enantiomers]]|

You can put another image here. An example is

[[image:Omeprazole.png|centre]]|

Enter key points on Metabolism & Interactions|

Enter Mechanism of Action here|

Enter other key issues here

}}

Infobox Anatomy

{{{name}}}
{{{image_name}}} {{{caption}}}
System:	{{{system}}}
Function:	{{{function}}}
Origin:	{{{origin}}}
Branches:	{{{branches}}}
Insertion:	{{{insertion}}}
Arterial supply:	{{{arterial_supply}}}
Venous drainage:	{{{venous_drainage}}}
Lymphatic drainage:	{{{lymphatic_drainage}}}
Innervation:	{{{innervation}}}
Vertebral levels:	{{{vertebral_levels}}}
Search for Template in Gray's.

{{ infobox Anatomy |name={{PAGENAME }} |image_name= |caption= |system= |function= |origin= |branches= |insertion= |arterial_supply= |venous_drainage= |lymphatic_drainage= |innervation= |vertebral_levels= |search_gray = }}

Bacteria

see Template:Bacteria

---

Templates for Tabulation

see Help:Tabulation templates

---

Function Templates

See Help:Advanced functions#Advanced template functions for templates used to preprocess variables passed to other templates to ensure they work.

Strip newlines

PassEquals

See Help:Citations for templates used with references

Refsec

Usually at end of a page to gather all references into a footnote.

Refsame

Allows you to exclude {{refsec}} from a page that might be subcluded elsewhere so it is only shown on the page whose name is prespecified

OnlyIfPage

Allows you to exclude text (not template containing text) from a page that might be subcluded elsewhere so it is only shown on the page whose name is prespecified

OnlyIfPageShowTemplate

Allows you to exclude a template from a page that might be subcluded elsewhere so it is only shown on the page whose name is prespecified