Updating and creating notes on WikEM: Difference between revisions

(168 intermediate revisions by 12 users not shown)
Line 1: Line 1:
== Creating a New Note ==
{{Getting started}}
#'''YOU MUST FIRST LOGIN'''  
 
##See [[Create an Account]]  
==General Guidelines==
#Search for the term in the search field in the upper right hand corner of the page  
*Keep entries concise yet informative
##If you find a note with a similar theme, please edit it instead with your new content (see below) rather than making a duplicate page
**Preference is for notes, not chapters (i.e. think Pepid, not UpToDate)
##If you don't find a note on your subject, click on the link: "Create the page on this wiki!"  
*Remember that the most common user format is the smart phone (view it on your phone to see the final format)
#Please follow formatting guidelines below
*Focus on practical knowledge. Describe pathophysiology only when necessary for bedside treatment.
*[[Updating_and_creating_notes_on_WikEM#Internal_Links|Link]] to other WikEM pages whenever possible
*[[Updating_and_creating_notes_on_WikEM#References|Reference]] your sources
**This is particularly important when adding information to established pages or making any kind of claim that is not universally agreed upon by medical practitioners
*Feel free to divide notes into several notes, or combine them if it makes them more useful
 
==Creating a New Note==
===Step by Step===
#'''YOU MUST FIRST LOGIN'''
#*See [[Create an Account]]  
#**'''You must confirm your email address (check your email account) before the site will give you the ability to make changes.'''
#'''Search for the term''' in the search field in the upper right hand corner of the page  
#*If you find a note with a similar theme, please edit it instead with your new content (see below) rather than making a duplicate page
#*If you do not find a note on your subject, click on the link: '''"Create the page on this wiki!"'''
#**Use the Boilerplate (Template) function for your type of note (see Templates below)
#Please follow formatting guidelines
#Put a category at the end of the entry
 
===Using a Boilerplate Page Template===
*You can auto-generate Boilerplate Templates when creating a new note (click on function at top of new note page)
*Contributors are encouraged to update old pages to the current templates, when applicable
*Current templates are:
**[[Template:Standard|Standard Template]]
**[[Template:JCReview|Journal Club Review]]
**[[Template:LitReview|Evidence-Based Lit Review]]
**[[Template:Ultrasound|Ultrasound Scan]]
**[[Template:Medication|Medication Template]]
**[[Template:Procedure|Procedure Template]]
**[[Template:ResidencyPage|Residency Page Template]]
 
*Boilerplate source (for adding new templates) is at [[MediaWiki:Multiboilerplate]]


==Editing Notes==
==Editing Notes==
#Find the note by searching or by category
#First search (upper right hand corner; login first) for the note that you want to edit
#After you click on the note click on "Edit" (found in the middle of the page above the note)  
#Once on the relevant page, click on the Edit button in the top right-hand corner to edit the page
#Edit away
#*'''If you do not see the edit button, you are probably not logged in!''' (login to see it)
##Please follow formatting guidelines below
 
==Basic Formatting==
<big>*Please read the '''[http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Formatting wikipedia tutorial]'''</big>
===Text Format===
*<nowiki>You type: '''Bold'''</nowiki>
**You see: '''Bold'''
*<nowiki>You type: ''Italics''</nowiki>
**You see: ''Italics''
 
===Headings===
*<nowiki>==Heading 1==</nowiki>
*<nowiki>===Heading 2===</nowiki>
*<nowiki>====Heading 3====</nowiki>
 
===Bullet points (Preferred)===
*<nowiki>*Level 1</nowiki>
**<nowiki>**Level 2</nowiki>
***<nowiki>***Level 3</nowiki>
****<nowiki>****Level 4</nowiki>
 
===Outline numbers (Less preferred than bullet points; see above)===
#<nowiki>#Level 1</nowiki>
##<nowiki>##Level 2</nowiki>
###<nowiki>###Level 3</nowiki>
####<nowiki>####Level 4</nowiki>
 
===Category===
*<nowiki>[[Category:NameOfCategory']] </nowiki>
*See list of [[Portal:Categories|categories]]
 
==Links to Other Pages==
 
===Internal Links===
*Standard: <nowiki>[[NameOfLinkedToNote]] </nowiki>
*Internal link with different label: <nowiki>[[NameOfLinkedToNote|LinkedNote]] </nowiki>
 
===External Links===
*Standard:  <nowiki>http://mediawiki.org </nowiki>
*External link with different label: <nowiki>[http://mediawiki.org MediaWiki]</nowiki>
 
==References==
===Footnote Referencing===
*Add the tags <code>&lt;ref></code>and <code></ref></code>on either side of the journal citation
*Place the tag <code>&lt;references/></code> at the bottom of the article in the Sources Section for auto-generated footnotes
*References follow a 1 author [http://www.lib.jmu.edu/citation/amaguide.pdf AMA style]: Spencer J. et al. Physician, heal thyself – but not on your own please. Med Educ. 2005; 89: 548-549.
*References should utilize primary literature whenever possible.
*Secondary and Tertiary (textbook) sources are permitted however they must be clearly referenced and follow the [http://www.lib.jmu.edu/citation/amaguide.pdf AMA style guide].


== Using the WikEM software ==
===Multiple Footnotes of Same Source===
#Click "Edit" in upper middle/right page heading
To give a footnote a unique identifier, use '''&lt;ref name="name">'''. You can then refer to the same footnote again by using a ref tag with the same name. The text inside the second tag does not matter, because the text already exists in the first reference. You can either copy the whole footnote, or you can use a terminated empty ref tag that looks like this: '''&lt;ref name="name" />'''. The quotes are not required (but still correct) if the name contains no embedded spaces. The space before the closing "/" may be omitted.
##Click "Rich Editor" if you don't want to use WikiMedia language
###Type away and use upper headings
##If you do not want to use the Rich Text Editor
###Type using WikiMedia language (prefered)
####Language is simple, you only need to know a few codes (don't type the quotes (")):
####Headings
#####"==Heading 1=="
#####"===Heading 2==="
#####"====Heading 3===="
####Bullet points
#####"*Level 1"
#####"**Level 2"
#####"***Level 3"
#####"****Level 4"
####Outline numbers/letters
#####"#Level 1"
#####"##Level 2"
#####"###Level 3"
#####"####Level 4"
####Category
#####"[[Category:'''NameOfCategory''']]"
####WikEM Link
#####"[[PageName]]


== General Comments  ==
===Citation Needed===
*Keep entries concise and as simple as possible
*Insert the following tag: <nowiki>{{Citation needed|reason=Reliable source needed|date=MONTH YEAR}}</nowiki>
*Preference is for notes, not chapters (i.e. think Pepid, not UpToDate)
**MONTH/YEAR = date of citation request inserted
*Remember that the user format is the smart phone (view it on your phone to see the final format)
*Focus on practical knowledge (with little to no pathophysiology or non-useful facts)
*Reference other notes if appropriate
*Put your source(s) at the bottom
*Put a category at the end of the entry (see example of how to add the category from other notes)
*Feel free to divide notes into several notes, or combine them if it makes them more useful
*Use one of the templates (see above) if appropriate
**You will need to copy the wikitext of the template onto your new entry


== Style Guidelines  ==
==Images==
All major headings should be set to Format: Heading 2. Headings should not be entered in all caps. A maximum of 3 indent levels should be used in all articles. Beyond 3 indent levels text becomes hard to read on mobile devices All tables should be sized to be 300px wide. If content is not readable in this size please consider reformatting to an outline or some another format. Valid text formatting includes: bold, underline, italics, strike through, foreground color, background color. Any other formatting may interfere with mobile display. Please note that text formatting is currently not available on the blackberry, so please use it sparingly (or not at all).  
===Finding Images===
*You can use most images from Wikipedia
*Search the web with [http://openi.nlm.nih.gov/ OPENi-An Open Access Biomedical Image Search Engine]


== Images  ==
===To upload an image to WikEM===
*Embedded images are now supported
*Log-in
**To upload an image to WikEM, (must first log-in) click on the link [[Special:Upload]] which appears under 'Toolbox' in the links on the left. The page also includes directions for how to use the images once uploaded. Please be considerate of the Style Guidelines. For formatting of the file (resizing, thumbnails, etc..) please refer here[http://www.mediawiki.org/wiki/Help:Images#Linking_to_an_image_without_displaying_it]*To see a list of uploaded images by WikEM users, see [[Special:ListFiles]]
*Click on the link [[Special:Upload]] which appears under 'Toolbox' in the links on the left
**Please cite the source of the image in the "Summary" section. (source webpage or article if from OPENi-An, website e.g. Wikimedia Commons, etc)
**If not from commonly used source (OPENi-An, Wikipedia, Wikimedia Commons), please also note the image license, if known (should be Creative Commons or similar)


== Standardized Abbreviations  ==
===To insert an image into a page===
*CXR Chest X-Ray / Radiograph
*Within the relevant file insert the following:
*DM Diabetes Mellitus
**Our standard '''<nowiki>[[File:Image-file-name.jpg|thumb|Writing that you want on the bottom of the photo]]</nowiki>'''
*HTN Hypertension
*DDx Differential Diagnosis


==Personal Notes==
===Other===
*'''These do not transfer to WikEM''' and are not transfered to future versions
*To see a list of uploaded images by WikEM users see [[Special:ListFiles]]
**Please consider making your additions to WikEM via the website (see previous)
*To direct link to the file without displaying the file use: '''<nowiki>[['''Media:File.ogg''']]</nowiki>'''


===Iphone===
==Tables==
*To create your note:
*Make a table in excel and copy all the cells
**Tap the Personal Notes icon
*Paste it into: http://wang.wustl.edu/mediawiki/extensions/index.php
**Tap the + icon in the upper right corner
*Then paste the text into the wiki page you are editing
**Type a note title, this cannot be changed
**Type a note body
*To delete your note
**Swipe over a note title in the list view or tap the edit button in the upper left corner


===Android===
==Redirects==
*Open a note
To make a redirect from some search term (e.g. Zofran) to a note (e.g. Ondansteron)
**On the bottom of the note it will say "type here for a custom note"
*Create a new page for "Zofran" (see above on how to create a new page)
**In the new page type the redirect code (and only the redirect code): '''<nowiki>#REDIRECT[[DestinationPageName]]</nowiki>'''
***Example:  '''<nowiki>#REDIRECT[[Ondansteron]]</nowiki>'''


==Templates in Text (Transposition)==
*Used to have the same text on multiple pages
**Used frequently in the Differential Diagnosis sections and then placed on the respective pages
*To make a template, place {{ symbol around it in the text
**Example: '''<nowiki>{{Template page name}}</nowiki>'''
*To search for template, use "Template:" before the template page name in the search bar (e.g. "Template:Template page name")
*'''There is a known issue with the template not immediately appearing on edited pages due to catching. Please give it a couple of minutes and it will eventually appear or just make another edit on the page.'''


== See Also ==
==Quizzes==
{| class="prettytable"
!wikitext!!rendering!!comments
|-
|valign="top"|
<pre>
  {Question
|type="()"}
+ The correct answer.
|| Feedback for correct answer.
- Distractor.
|| Feedback for distractor.
- Distractor.
|| Feedback for distractor.
- Distractor.
|| Feedback for distractor.
</pre>
|valign="top"|
{|width=250|
|
<quiz display=simple>
{Question
|type="()"}
+ The correct answer.
|| Feedback for correct answer.
- Distractor.
|| Feedback for distractor.
- Distractor.
|| Feedback for distractor.
- Distractor.
|| Feedback for distractor.
</quiz>
|}
|valign="top"|
*Feedback is text which is initially hidden, and then shown to the user when they submit the quiz for correction. Feedback typically serves the purposes of encouragement, explanation, congratulation and commiseration.
*Feedback is set with all types by using a double vertical line '''||''' immediately after a response.
*The pipes beginning the ''feedback'' section must be on a new line.
*Unlike some other quiz systems, '''all''' feedback items are displayed on correction. With other quiz systems, the norm is to display the feedback only for those items which were selected by the user.
*To try out the feedback effect, choose a response and click the correction button. The feedback will then appear.
|}


*[[Template 1 (General)]]
==See Also==
*[[Template 2 (Drug)]]  
*[[Helping out on WikEM]]
*[[Template 3 (List)]]  
*[[WikEM editorial levels]]
*[[Template 4 (DDx)]]
*[[Needed Pages]]


[[Category:WikEM]]
[[Category:WikEM]]

Revision as of 19:45, 5 April 2020

Getting Started

Thanks for wanting to help out on WikEM! People are the core of the wiki. Your knowledge translates into improved bedside practice for everyone.

To get started

If you are looking for ways to contribute

Also

General Guidelines

  • Keep entries concise yet informative
    • Preference is for notes, not chapters (i.e. think Pepid, not UpToDate)
  • Remember that the most common user format is the smart phone (view it on your phone to see the final format)
  • Focus on practical knowledge. Describe pathophysiology only when necessary for bedside treatment.
  • Link to other WikEM pages whenever possible
  • Reference your sources
    • This is particularly important when adding information to established pages or making any kind of claim that is not universally agreed upon by medical practitioners
  • Feel free to divide notes into several notes, or combine them if it makes them more useful

Creating a New Note

Step by Step

  1. YOU MUST FIRST LOGIN
    • See Create an Account
      • You must confirm your email address (check your email account) before the site will give you the ability to make changes.
  2. Search for the term in the search field in the upper right hand corner of the page
    • If you find a note with a similar theme, please edit it instead with your new content (see below) rather than making a duplicate page
    • If you do not find a note on your subject, click on the link: "Create the page on this wiki!"
      • Use the Boilerplate (Template) function for your type of note (see Templates below)
  3. Please follow formatting guidelines
  4. Put a category at the end of the entry

Using a Boilerplate Page Template

Editing Notes

  1. First search (upper right hand corner; login first) for the note that you want to edit
  2. Once on the relevant page, click on the Edit button in the top right-hand corner to edit the page
    • If you do not see the edit button, you are probably not logged in! (login to see it)

Basic Formatting

*Please read the wikipedia tutorial

Text Format

  • You type: '''Bold'''
    • You see: Bold
  • You type: ''Italics''
    • You see: Italics

Headings

  • ==Heading 1==
  • ===Heading 2===
  • ====Heading 3====

Bullet points (Preferred)

  • *Level 1
    • **Level 2
      • ***Level 3
        • ****Level 4

Outline numbers (Less preferred than bullet points; see above)

  1. #Level 1
    1. ##Level 2
      1. ###Level 3
        1. ####Level 4

Category

  • [[Category:NameOfCategory']]
  • See list of categories

Links to Other Pages

Internal Links

  • Standard: [[NameOfLinkedToNote]]
  • Internal link with different label: [[NameOfLinkedToNote|LinkedNote]]

External Links

  • Standard: http://mediawiki.org
  • External link with different label: [http://mediawiki.org MediaWiki]

References

Footnote Referencing

  • Add the tags <ref>and </ref>on either side of the journal citation
  • Place the tag <references/> at the bottom of the article in the Sources Section for auto-generated footnotes
  • References follow a 1 author AMA style: Spencer J. et al. Physician, heal thyself – but not on your own please. Med Educ. 2005; 89: 548-549.
  • References should utilize primary literature whenever possible.
  • Secondary and Tertiary (textbook) sources are permitted however they must be clearly referenced and follow the AMA style guide.

Multiple Footnotes of Same Source

To give a footnote a unique identifier, use <ref name="name">. You can then refer to the same footnote again by using a ref tag with the same name. The text inside the second tag does not matter, because the text already exists in the first reference. You can either copy the whole footnote, or you can use a terminated empty ref tag that looks like this: <ref name="name" />. The quotes are not required (but still correct) if the name contains no embedded spaces. The space before the closing "/" may be omitted.

Citation Needed

  • Insert the following tag: {{Citation needed|reason=Reliable source needed|date=MONTH YEAR}}
    • MONTH/YEAR = date of citation request inserted

Images

Finding Images

To upload an image to WikEM

  • Log-in
  • Click on the link Special:Upload which appears under 'Toolbox' in the links on the left
    • Please cite the source of the image in the "Summary" section. (source webpage or article if from OPENi-An, website e.g. Wikimedia Commons, etc)
    • If not from commonly used source (OPENi-An, Wikipedia, Wikimedia Commons), please also note the image license, if known (should be Creative Commons or similar)

To insert an image into a page

  • Within the relevant file insert the following:
    • Our standard [[File:Image-file-name.jpg|thumb|Writing that you want on the bottom of the photo]]

Other

  • To see a list of uploaded images by WikEM users see Special:ListFiles
  • To direct link to the file without displaying the file use: [['''Media:File.ogg''']]

Tables

Redirects

To make a redirect from some search term (e.g. Zofran) to a note (e.g. Ondansteron)

  • Create a new page for "Zofran" (see above on how to create a new page)
    • In the new page type the redirect code (and only the redirect code): #REDIRECT[[DestinationPageName]]
      • Example: #REDIRECT[[Ondansteron]]

Templates in Text (Transposition)

  • Used to have the same text on multiple pages
    • Used frequently in the Differential Diagnosis sections and then placed on the respective pages
  • To make a template, place {{ symbol around it in the text
    • Example: {{Template page name}}
  • To search for template, use "Template:" before the template page name in the search bar (e.g. "Template:Template page name")
  • There is a known issue with the template not immediately appearing on edited pages due to catching. Please give it a couple of minutes and it will eventually appear or just make another edit on the page.

Quizzes

wikitext rendering comments
 {Question
 |type="()"}
 + The correct answer.
 || Feedback for correct answer.
 - Distractor.
 || Feedback for distractor.
 - Distractor.
 || Feedback for distractor.
 - Distractor.
 || Feedback for distractor.

Question

The correct answer.
Distractor.
Distractor.
Distractor.

  • Feedback is text which is initially hidden, and then shown to the user when they submit the quiz for correction. Feedback typically serves the purposes of encouragement, explanation, congratulation and commiseration.
  • Feedback is set with all types by using a double vertical line || immediately after a response.
  • The pipes beginning the feedback section must be on a new line.
  • Unlike some other quiz systems, all feedback items are displayed on correction. With other quiz systems, the norm is to display the feedback only for those items which were selected by the user.
  • To try out the feedback effect, choose a response and click the correction button. The feedback will then appear.

See Also