Style manual

From Anaesthesia_MCQ
(Redirected from Style Manual)
Jump to: navigation, search

Contents

Background

The strength of the wiki is that it enables many people to contribute to writing the text. Without a style guide each contributor formats the content in a slightly different way making the pages more difficult to access than they need to be. The purpose of this page is to provide a brief guide on formatting to enable interested contributors to work towards a consistent goal.

Importantly this style manual must not become an impediment to contributions. Contributors should not be berated for not complying with this style and all useful contributions and contributors should be welcomed.

Main points

  • Content on pages either takes the form of encyclopaedic explanation, or a dialogue. Paying a little attention to some formatting - even if it seems a little pedantic - goes a long, long way to making your contribution much more useful for others:
  • In general, just edit the encyclopaedic explanation to clarify, correct or expand it. Try to preserve the flow and maintain the texts readability. Be bold! Your contribution is valid and important.
  • If making comments, prefix your first paragraph with a '*' to give it a dot point. If your comments extend to parargraphs, prefix each of the following paragraphs with ':' to preserve the indenting. And please sign your comments with your name, or if you are logged in, simply by by appending ~~~~.
  • In general, use the "Oxford Handbook of Anaesthesia" as guide for formatting and language.
  • Use English (not American) spelling and drug names.
  • Try to write in complete sentances and finish them with a full stop (.).
  • Reference as much as possible.
  • When quoting chunks of text, enclose it in quotes (") and indent it by placing a colon (:) at the beginning of each paragraph.
  • Only capitalise the first word of headings.
  • The order of options may change when the actual ANZCA question is released, avoid ABCDE as the sole reference to your true/false answer.

References

Try to provide a URL, or better still, the PMID for all the articles you cite. The simplest and most reliable referencing method is to link to the PubMed PMID citation. To place a PubMed link, just copy the PMID, using this format: PMID 9525362.

The perfect format for the bibliography is:

  1. Moller JT, Cluitmans P, Rasmussen LS, Houx P, Rasmussen H, Canet J, et al (1998) Long-term postoperative cognitive dysfunction in the elderly: ISPOCD1 study. Lancet 351:857-61 doi:10.1016/S0140-6736(97)07382-0 PMID 9525362
  2. Hanning CD (2005). Postoperative cognitive dysfunction. British Journal of Anaesthesia 95:82-87. [1] doi:10.1093/bja/aei062

Note the inclusion of the DOI.

Alternatively the whole reference can be included in the hyperlink. This makes it easier to click on:

  1. Moller JT, Cluitmans P, Rasmussen LS, Houx P, Rasmussen H, Canet J, et al (1998. Long-term postoperative cognitive dysfunction in the elderly: ISPOCD1 study. Lancet 351:857-61

In the text, reference to specific papers either simply by author and year or URL, or best of all, by author and year as a hotlink. For example:

"New CPR guidelines now recommend a single rescuer compression to ventilation ratio of 30:2 for all victims except infants (AHA, 2005)"

After saving the page, it is a good idea to check that all links you put in do work as intended: just click on each one and see if you go to the correct page.

Reference Templates

You can quickly insert common references into pages you are editing (without having to type them out fully) by using templates. Templates for some of the standard texts can be found here.

Personal tools
Namespaces
Variants
Actions
Navigation
MCQs
Toolbox