Updating and creating notes on WikEM: Difference between revisions

(Reverted edits by Dano (talk) to last revision by Smotov)
No edit summary
Line 1: Line 1:
<h2> General Comments  </h2>
== General Comments  ==
<ul><li>Keep entries concise and as simple as possible
*Keep entries concise and as simple as possible
</li><li>Preference is for notes, not chapters (i.e. think Pepid, not UpToDate)  
*Preference is for notes, not chapters (i.e. think Pepid, not UpToDate)  
</li><li>Remember that the user format is the smart phone (view it on your phone to see the final format)  
*Remember that the user format is the smart phone (view it on your phone to see the final format)  
</li><li>Focus on practical knowledge (with little to no pathophysiology or non-useful facts)  
*Focus on practical knowledge (with little to no pathophysiology or non-useful facts)  
</li><li>Reference other notes if appropriate
*Reference other notes if appropriate
<ul><li>Use internal links and a "See Also" section
**Use internal links and a "See Also" section
</li><li>Format for internal links is "[[<b>NameOfLinkedToNote</b>]]" see also <i>Using the WikEM Webpage to Edit and Write Notes</i> section below
**Format for internal links is "[['''NameOfLinkedToNote''']]" see also ''Using the WikEM Webpage to Edit and Write Notes'' section below
</li></ul>
*Put your source(s) in a "Sources" section
</li><li>Put your source(s) in a "Sources" section
*Put a category at the end of the entry  
</li><li>Put a category at the end of the entry  
**Format for categories is "[[Category:'''NameOfCategory''']]" see also ''Using the WikEM Webpage to Edit and Write Notes'' section below
<ul><li>Format for categories is "[[Category:<b>NameOfCategory</b>]]" see also <i>Using the WikEM Webpage to Edit and Write Notes</i> section below
*Feel free to divide notes into several notes, or combine them if it makes them more useful  
</li></ul>
*Use one of the templates (see Templates below) if appropriate
</li><li>Feel free to divide notes into several notes, or combine them if it makes them more useful  
**You will need to copy the wikitext of the template onto your new entry  
</li><li>Use one of the templates (see Templates below) if appropriate
 
<ul><li>You will need to copy the wikitext of the template onto your new entry  
== Style Guidelines  ==
</li></ul>
*All major headings should be set to Format: Heading 2
</li></ul>
*Headings should not be entered in all caps
<h2> Style Guidelines  </h2>
*A maximum of 3 indent levels should be used in all articles
<ul><li>All major headings should be set to Format: Heading 2
**Beyond 3 indent levels text becomes hard to read on mobile devices  
</li><li>Headings should not be entered in all caps
*All tables should be sized to be 300px wide
</li><li>A maximum of 3 indent levels should be used in all articles
**If content is not readable in this size please consider reformatting to an outline or some another format
<ul><li>Beyond 3 indent levels text becomes hard to read on mobile devices  
*Valid text formatting includes: bold, underline, italics, strike through, foreground color, background color
</li></ul>
**Any other formatting may interfere with mobile display
</li><li>All tables should be sized to be 300px wide
**Please note that text formatting is currently not available on the blackberry, so please use it sparingly (or not at all)
<ul><li>If content is not readable in this size please consider reformatting to an outline or some another format
 
</li></ul>
== Creating a New Note  ==
</li><li>Valid text formatting includes: bold, underline, italics, strike through, foreground color, background color
#'''YOU MUST FIRST LOGIN'''
<ul><li>Any other formatting may interfere with mobile display
##See [[Create an Account]]
</li><li>Please note that text formatting is currently not available on the blackberry, so please use it sparingly (or not at all)
###'''You must confirm your email address (check your email account) before the site will give you the ability to make changes.'''
</li></ul>
#Search for the term in the search field in the upper right hand corner of the page  
</li></ul>
##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
<h2> Creating a New Note  </h2>
##If you don't find a note on your subject, click on the link: "Create the page on this wiki!"  
<ol><li><b>YOU MUST FIRST LOGIN</b>
#Please follow formatting guidelines below
<ol><li>See &lt;a _fcknotitle="true" href="Create an Account"&gt;Create an Account&lt;/a&gt;
 
<ol><li><b>You must confirm your email address (check your email account) before the site will give you the ability to make changes.</b>
==Editing Notes==
</li></ol>
#Find the note by searching or by category
</li></ol>
#After you click on the note click on "Edit" (found in the middle of the page above the note)  
</li><li>Search for the term in the search field in the upper right hand corner of the page  
#Edit away
<ol><li>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
##Please follow formatting guidelines below
</li><li>If you don't find a note on your subject, click on the link: "Create the page on this wiki!"  
 
</li></ol>
== Using the WikEM Webpage to Edit and Write Notes ==
</li><li>Please follow formatting guidelines below
 
</li></ol>
#Click "Edit" in upper middle/right page heading  
<h2>Editing Notes</h2>
##Click "Rich Editor" if you don't want to use WikiMedia language  
<ol><li>Find the note by searching or by category
###Type away and use upper headings  
</li><li>After you click on the note click on "Edit" (found in the middle of the page above the note)  
###It is preferred, for simple text or lists, that you do as much writing as possible NOT using the Rich Editor (it transfers better to the Apps), but using the WikiMedia language (see following)  
</li><li>Edit away
##If you do not want to use the Rich Text Editor  
<ol><li>Please follow formatting guidelines below
###Type using WikiMedia language (prefered)  
</li></ol>
####Use toolbar on top for bold, italics, and internal links  
</li></ol>
####Language is simple, you only need to know a few codes (don't type the quotes (")):  
<h2> Using the WikEM Webpage to Edit and Write Notes </h2>
####Headings  
<ol><li>Click "Edit" in upper middle/right page heading  
#####"==Heading 1=="  
<ol><li>Click "Rich Editor" if you don't want to use WikiMedia language  
#####"===Heading 2==="  
<ol><li>Type away and use upper headings  
#####"====Heading 3===="  
</li><li>It is preferred, for simple text or lists, that you do as much writing as possible NOT using the Rich Editor (it transfers better to the Apps), but using the WikiMedia language (see following)  
####Bullet points  
</li></ol>
#####"*Level 1"  
</li><li>If you do not want to use the Rich Text Editor  
#####"**Level 2"  
<ol><li>Type using WikiMedia language (prefered)  
#####"***Level 3"  
<ol><li>Use toolbar on top for bold, italics, and internal links  
#####"****Level 4"  
</li><li>Language is simple, you only need to know a few codes (don't type the quotes (")):  
####Outline numbers/letters  
</li><li>Headings  
#####"#Level 1"  
<ol><li>"==Heading 1=="  
#####"##Level 2"  
</li><li>"===Heading 2==="  
#####"###Level 3"  
</li><li>"====Heading 3===="  
#####"####Level 4"  
</li></ol>
####Category  
</li><li>Bullet points  
#####"[[Category:'''NameOfCategory''']]"  
<ol><li>"*Level 1"  
####Internal Link  
</li><li>"**Level 2"  
#####"[['''NameOfLinkedToNote''']]"  
</li><li>"***Level 3"  
####Images  
</li><li>"****Level 4"  
#####Upload image in .jpg or .png format using the "Upload file" on the left. All images should be "creative commons" licensed  
</li></ol>
#####[['''File:FILENAME.jpeg|thumbnail''']]
</li><li>Outline numbers/letters  
 
<ol><li>"#Level 1"  
== Images  ==
</li><li>"##Level 2"  
#Embedded images are now supported
</li><li>"###Level 3"  
##To upload an image to WikEM
</li><li>"####Level 4"  
###Log-in
</li></ol>
###Click on the link [[Special:Upload]] which appears under 'Toolbox' in the links on the left
</li><li>Category  
####The page also includes directions for how to use the images once uploaded
<ol><li>"[[Category:<b>NameOfCategory</b>]]"  
####Please be considerate of the Style Guidelines
</li></ol>
####For formatting of the file (resizing, thumbnails, etc..) please refer to http://www.mediawiki.org/wiki/Help:Images#Linking_to_an_image_without_displaying_it
</li><li>Internal Link  
##To see a list of uploaded images by WikEM users see [[Special:ListFiles]]
<ol><li>"[[<b>NameOfLinkedToNote</b>]]"  
 
</li></ol>
== Standardized Abbreviations  ==
</li><li>Images  
*CXR Chest X-Ray / Radiograph  
<ol><li>Upload image in .jpg or .png format using the "Upload file" on the left. All images should be "creative commons" licensed  
*DM Diabetes Mellitus  
</li><li>[[<b>File:FILENAME.jpeg|thumbnail</b>]]
*HTN Hypertension  
</li></ol>
*DDx Differential Diagnosis  
</li></ol>
 
</li></ol>
==Personal Notes==
</li></ol>
*Use of the Personal Note function is discouraged, '''these do not transfer to WikEM''' and are not transferred to future versions
</li></ol>
*Please instead make your additions to WikEM via the website
<h2> Images  </h2>
 
<ol><li>Embedded images are now supported
===Iphone===
<ol><li>To upload an image to WikEM
*To create your personal note:  
<ol><li>Log-in
**Tap the Personal Notes icon  
</li><li>Click on the link &lt;a _fcknotitle="true" href="Special:Upload"&gt;Special:Upload&lt;/a&gt; which appears under 'Toolbox' in the links on the left
**Tap the + icon in the upper right corner  
<ol><li>The page also includes directions for how to use the images once uploaded
**Type a note title, this cannot be changed  
</li><li>Please be considerate of the Style Guidelines
**Type a note body
</li><li>For formatting of the file (resizing, thumbnails, etc..) please refer to http://www.mediawiki.org/wiki/Help:Images#Linking_to_an_image_without_displaying_it
*To delete your note
</li></ol>
**Swipe over a note title in the list view or tap the edit button in the upper left corner
</li></ol>
 
</li><li>To see a list of uploaded images by WikEM users see &lt;a _fcknotitle="true" href="Special:ListFiles"&gt;Special:ListFiles&lt;/a&gt;
===Android===
</li></ol>
*Open a note
</li></ol>
**On the bottom of the note it will say "type here for a custom note"
<h2> Standardized Abbreviations  </h2>
 
<ul><li>CXR Chest X-Ray / Radiograph  
== See Also  ==
</li><li>DM Diabetes Mellitus  
*[[Template 1 (General)]]
</li><li>HTN Hypertension  
*[[Template 2 (Drug)]]
</li><li>DDx Differential Diagnosis  
*[[Template 3 (List)]]
</li></ul>
*[[Template 4 (DDx)]]
<h2>Personal Notes</h2>
*[[Template 5 (Evidence Based Question)]]
<ul><li>Use of the Personal Note function is discouraged, <b>these do not transfer to WikEM</b> and are not transferred to future versions
*[[Template 6 (Procedure)]]
</li><li>Please instead make your additions to WikEM via the website
*[[Template 7 (GEMC)]]
</li></ul>
[[Category:WikEM]]
<h3>Iphone</h3>
<ul><li>To create your personal note:  
<ul><li>Tap the Personal Notes icon  
</li><li>Tap the + icon in the upper right corner  
</li><li>Type a note title, this cannot be changed  
</li><li>Type a note body
</li></ul>
</li><li>To delete your note
<ul><li>Swipe over a note title in the list view or tap the edit button in the upper left corner
</li></ul>
</li></ul>
<h3>Android</h3>
<ul><li>Open a note
<ul><li>On the bottom of the note it will say "type here for a custom note"
</li></ul>
</li></ul>
<h2> See Also  </h2>
<ul><li>&lt;a _fcknotitle="true" href="Template 1 (General)"&gt;Template 1 (General)&lt;/a&gt;
</li><li>&lt;a _fcknotitle="true" href="Template 2 (Drug)"&gt;Template 2 (Drug)&lt;/a&gt;
</li><li>&lt;a _fcknotitle="true" href="Template 3 (List)"&gt;Template 3 (List)&lt;/a&gt;
</li><li>&lt;a _fcknotitle="true" href="Template 4 (DDx)"&gt;Template 4 (DDx)&lt;/a&gt;
</li><li>&lt;a _fcknotitle="true" href="Template 5 (Evidence Based Question)"&gt;Template 5 (Evidence Based Question)&lt;/a&gt;
</li><li>&lt;a _fcknotitle="true" href="Template 6 (Procedure)"&gt;Template 6 (Procedure)&lt;/a&gt;
</li><li>&lt;a _fcknotitle="true" href="Template 7 (GEMC)"&gt;Template 7 (GEMC)&lt;/a&gt;
</li></ul>
<p>&lt;a _fcknotitle="true" href="Category:WikEM"&gt;WikEM&lt;/a&gt;
</p>

Revision as of 20:05, 13 August 2013

General Comments

  • Keep entries concise and as simple as possible
  • Preference is for notes, not chapters (i.e. think Pepid, not UpToDate)
  • 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
    • Use internal links and a "See Also" section
    • Format for internal links is "'''NameOfLinkedToNote'''" see also Using the WikEM Webpage to Edit and Write Notes section below
  • Put your source(s) in a "Sources" section
  • Put a category at the end of the entry
    • Format for categories is "" see also Using the WikEM Webpage to Edit and Write Notes section below
  • Feel free to divide notes into several notes, or combine them if it makes them more useful
  • Use one of the templates (see Templates below) if appropriate
    • You will need to copy the wikitext of the template onto your new entry

Style Guidelines

  • 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)

Creating a New Note

  1. YOU MUST FIRST LOGIN
    1. See Create an Account
      1. 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
    1. 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
    2. If you don't find a note on your subject, click on the link: "Create the page on this wiki!"
  3. Please follow formatting guidelines below

Editing Notes

  1. Find the note by searching or by category
  2. After you click on the note click on "Edit" (found in the middle of the page above the note)
  3. Edit away
    1. Please follow formatting guidelines below

Using the WikEM Webpage to Edit and Write Notes

  1. Click "Edit" in upper middle/right page heading
    1. Click "Rich Editor" if you don't want to use WikiMedia language
      1. Type away and use upper headings
      2. It is preferred, for simple text or lists, that you do as much writing as possible NOT using the Rich Editor (it transfers better to the Apps), but using the WikiMedia language (see following)
    2. If you do not want to use the Rich Text Editor
      1. Type using WikiMedia language (prefered)
        1. Use toolbar on top for bold, italics, and internal links
        2. Language is simple, you only need to know a few codes (don't type the quotes (")):
        3. Headings
          1. "==Heading 1=="
          2. "===Heading 2==="
          3. "====Heading 3===="
        4. Bullet points
          1. "*Level 1"
          2. "**Level 2"
          3. "***Level 3"
          4. "****Level 4"
        5. Outline numbers/letters
          1. "#Level 1"
          2. "##Level 2"
          3. "###Level 3"
          4. "####Level 4"
        6. Category
          1. ""
        7. Internal Link
          1. "'''NameOfLinkedToNote'''"
        8. Images
          1. Upload image in .jpg or .png format using the "Upload file" on the left. All images should be "creative commons" licensed
          2. thumbnail

Images

  1. Embedded images are now supported
    1. To upload an image to WikEM
      1. Log-in
      2. Click on the link Special:Upload which appears under 'Toolbox' in the links on the left
        1. The page also includes directions for how to use the images once uploaded
        2. Please be considerate of the Style Guidelines
        3. For formatting of the file (resizing, thumbnails, etc..) please refer to http://www.mediawiki.org/wiki/Help:Images#Linking_to_an_image_without_displaying_it
    2. To see a list of uploaded images by WikEM users see Special:ListFiles

Standardized Abbreviations

  • CXR Chest X-Ray / Radiograph
  • DM Diabetes Mellitus
  • HTN Hypertension
  • DDx Differential Diagnosis

Personal Notes

  • Use of the Personal Note function is discouraged, these do not transfer to WikEM and are not transferred to future versions
  • Please instead make your additions to WikEM via the website

Iphone

  • To create your personal note:
    • Tap the Personal Notes icon
    • Tap the + icon in the upper right corner
    • 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

  • Open a note
    • On the bottom of the note it will say "type here for a custom note"

See Also