Help:Template

From Ganfyd

Jump to: navigation, search

Contents

About templates

LogoKeyPointsBox.pngThis is an example of the use of a template.

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:

LogoKeyPointsBox.pngYour 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

LogoWarningBox4.pngIt 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.
Info bulb.pngThe 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.
LogoKeyPointsBox.pngThe 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.

QuotationMarkLeft.png I think this box is appropriate for those occasions where I just can't keep my opinion to myself! QuotationMarkRight.pngRupert 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

JanusBox

Janus-tiny.jpg
Previous year: 1999 Next year: 2001

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

Flag of Australia.png

Christmas time in Australia is in the Summer. This is because Australia is upside-down.


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

Flag of Australia.png

Flag of New Zealand.png Use when you mean Australia & NZ


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

Flag of England.png

England is green. This is because it never stops raining (Except for when it is snowing).


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

Flag of Canada.png

Canada is the home of maple syrup. And lumberjacks who dress up in womens clothing, just like their dear papa. (Apologies to Monty Python, and to Canadian lumberjacks)


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

Flag of New Zealand.png

New Zealand has many huge ferns. And many huge rugby players.


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

Flag of Northern Ireland.png

Northern Ireland is even wetter than England. Though they do have a nice big Lough.


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

Flag of Ireland.png

The Republic of Ireland has lots of lovely Guinness. Guinness in large quantities can give you a hangover.


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

Flag of Scotland.png

Scotland is the home of the haggis, which is the subject of the poem 'Horace ate himself one day'.


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

Flag of Wales.gif

Q: How does one walk through a Welsh minefield? A: Caerphilly.


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

Flag of England.pngFlag of Wales.gif

Tend to raise the West Lothian question


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

Flag of the United Kingdom.png

Add England, Northern Ireland, Scotland and Wales together and you have the United Kingdom. The constituent members all like to beat each other in the Six Nations rugby tournament on a yearly basis.


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

Flag of USA.png

America, land of the free. South of Canada, North of Mexico. Home of the burger.


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

60px-Flag of EU.png

Bureaucracy of Nation States.

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

Flag of Lebanon.png

Has some nice cedars, and lovely beaches.

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

IndiaFlag.png

A bit of Gondwana crushing into Laurasia.


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

Flag of Switzerland.png

The Swiss Navy is one of the smallest in the world.

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

UN flag.png

Hosts who


Templates that provide information on a page

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

This article is a stub. Please feel free to expand it and make it more encyclopaedic.


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

This article is a work in progress. Please feel free to contribute to it.


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

This page is in need of deletion. Either it is a misspelled page started erroneously or it has become obsolete due to other pages taking over its content.
By adding this template to this page you are asking the admins to delete this page! Are you sure this is what you want?


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

Usage {{NotW3C|[link]}} eg {{NotW3C|[http://www.npsa.nhs.uk/patientsafety/improvingpatientsafety/rootcauseanalysis/ IE specific link]}}


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.org:

This file is licensed by the author using the same ganfyd-Attribution-NonCommercial-RegisteredMedical-ShareAlike 1.0 terms as www.ganfyd.org.ganfyd licence


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

This file is available elsewhere in the Public Domain, and is therefore not subject to the restrictions of the ganfyd.org licence. Anybody has the right to use this work for any purpose, without any conditions, unless such conditions are required by law. Public Domain

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

This file or that on which it is based is available elsewhere in the Public Domain, and is therefore not subject to the restrictions of the ganfyd.org licence. This image is a national, governmental, military, royal/vice-regal or historical flag. Such flags are ineligible for copyright but they are protected by Article 6 of the Paris Convention (Protection of State Emblems, and Names, Abbreviations and Emblems of International Intergovernmental Organizations), two-dimensional works of art. Public Domain

{{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

Flag of the United Kingdom.png This image, or parts of this text are subject to Crown Copyright. Information subject to Crown Copyright may be re-used if OPSI guidelines are followed.

Material subject to Crown Copyright may not be released under the GFDL or the Ganfyd licence.

Copyright.png


{{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!):

This is a logo of a corporation, sports team, or other organization, and is protected by copyright and/or trademark. It is believed that the use of low-resolution images of logos to illustrate the corporation, sports team, or organization in question on Ganfyd - the non-commercial medical knowledge base - hosted on servers in the United Kingdom, qualifies as fair use. Any other uses of this image, on ganfyd.org or elsewhere, may be copyright infringement. Certain commercial use of this image may also be trademark infringement. See Wikipedia:Fair use and Wikipedia:Logos.
Use of the logo here does not imply endorsement of the organization by ganfyd.org, nor does it imply endorsement of ganfyd.org by the organization.
Copyright.png


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

The copyright to this file is owned by (YOUR NAME APPEARS HERE) and must not be reproduced in any way without prior permission. Copyright.png


{{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):

The copyright to this file is owned by (AUTHORS NAME APPEARS HERE) and can be used provided that (CAVEAT APPEARS HERE). Copyright.png


{{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!):

This is a lithograph plate from Gray's Anatomy. Unless stated otherwise, it is from the online edition of the 20th U.S. edition of Gray's Anatomy of the Human Body, originally published in 1918. Online editions can be found on Bartleby and also on Yahoo!.


This image in the public domain because its copyright has expired. This applies worldwide.
Gray's skull.png


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

This image is available from the Public Health Image Library at the Centers for Disease Control, an agency of the United States Government. This image is therefore in the Public Domain, and is therefore not subject to the restrictions of the ganfyd.org licence. Anybody has the right to use this work for any purpose, without any conditions, unless such conditions are required by law. PHIL, CDC


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

This is an image uploaded from the freeimages.co.uk website. Please see their terms and conditions for usage permissions. Images taken from freeimages.co.uk must not be reused elsewhere without permission. All images used must be accompanied by an acknowledgement of its origin. Freeimages.gif


{{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!):

This is an image from the Library and Archives Canada (Bibliothèque et Archives Canada) online image archive.


This image in the public domain because its copyright has expired. This applies worldwide.
Flag of Canada.png


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

This image is from the Open Clip Art Library. All works included in the library are in the public domain. Open Clipart Library logo.png



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


{{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

Personal tools