MEpedia:How to contribute

From MEpedia, a crowd-sourced encyclopedia of ME and CFS science and history
Revision as of 11:30, April 30, 2018 by Ollie (talk | contribs) (→‎Mark pages as needing cleanup: Update date in cleanup template example)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Contribute to MEpedia today! Anyone can create pages, write content, add links/citations, fact-check, or even just fix typos. Everyone has something to offer, whatever your skills & experience, even if you have never edited a wiki (like Wikipedia) before. Get involved and help the patient community identify all of the best and most important resources for our disease and its research, treatment and history.

To get started, read our Editorial Guidelines and find more information about how to edit MEpedia below. Please join the MEpedia online forum or the Facebook Group. You can also follow MEPedia on Facebook, Twitter and subscribe to us on Reddit.

Pages that are a red link have not been created yet and need to be populated. Pages that have been created (blue links) but need to be expanded are marked as stubs - a full list of all stubs can be found here. We also have a list of priority pages for expansion.

All we ask is that you read the guidelines (see below) before you edit.

Pages that have problems such as incorrect information, formatting issues, or a lack of citations are marked with a cleanup note. A full list of pages requiring cleanup can be found here.

Have any questions after reading the below? Email mepedia@meaction.net.

Rules & Guidelines[edit | edit source]

Small steps still move MEpedia forward[edit | edit source]

Only have a five minute spoon to give? Here is a list of small tasks you can help us with in roughly one to ten minutes of time.

A note on ME v. CFS[edit | edit source]

We have separate pages for Myalgic Encephalomyelitis, ME/CFS and Chronic Fatigue Syndrome as well as SEID. The convention is that the terminology used in an ME-pedia article should match the terminology used in the underlying source. Where there is a tension between the term used in the source and the definition (e.g., ME defined by the Oxford criteria or CFS defined by the Canadian Consensus Criteria), it may be useful for clarity to mention the definition used.

How do I create a new page?[edit | edit source]

Simply type in the title of your new page and hit "create page." You'll want to search the existing database of pages to make sure that your page or a similar page does not already exist.

How do I edit existing pages?[edit | edit source]

There are two types of editor on this wiki, the Visual editor, which operates more like your word processing or email program, and the Source editor, which uses a special kind of wiki code. Most users will prefer to use the Visual editor, but for more advance applications or if the Visual editor is "down" (as happens from time to time), the resources below will help you learn how to navigate both.

Look for the "edit" (Visual editor) or "edit source" (Source editor) links at the top of the page (to edit the whole page) and next to each section heading (to edit just that section).

After you've made your changes, scroll down to the 'Show Preview' section, add a comment, preview your changes, then save them.

Getting started with the Visual editor[edit | edit source]

Getting started with the Source editor[edit | edit source]

It's easy to get started.

Lesson 1[edit | edit source]

  • Browse the existing pages: find topics that interest you - perhaps your local advocacy group, a favourite doctor.
  • Create a user profile: click on the 'Create Account' link near the top right hand corner of the page. Follow the steps.
  • Make your first edit: choose a page, click on the 'Edit' link (in the row of text ABOVE the page title). Add a few words, or a sentence.
    • You'll notice that the text looks different - less formatted / pretty - with strange characters (eg [ Fred Smith ] or = = Heading = =) - ignore these for the moment.
  • Preview your edit: scroll down to the bottom of the page, and find the 'Show Preview' button.
    • Add a short description of your change in the 'Comment' section (eg 'add comment about NIH study').
    • Click the 'Show Preview' button. You will now see the text in the 'prettier' format. Make sure your changes look okay.
  • Save your edit: Click the 'Save Page' button.
  • CONGRATULATIONS !! you've just made your first ME-Pedia edit.  :)

Lesson 2[edit | edit source]

  • Learn about formatting: there are special characters to create headings, italics, bolding, indented lists, etc.
  • Include references: if you're quoting a research study, or referring to an external website, include a hyperlink to the research study or website, using square brackets around the hyperlink - eg [ http://http://www.local.gov/about/ ].
    • Don't worry that it's not a full citation yet - there are other people who can do the complicated technical formatting
  • Experiment on your personal 'talk page': click on your 'user profile' link (near the top right), then click on the 'Create' link. Now you can safely experiment with your new formatting skills.


links used to edit ME-pedia


Lesson 3[edit | edit source]

  • Learn about the Edit History: choose any MEpedia page, and click on the 'View History' link near the top right.
    • You will see a list of all changes to the page, showing the date, time, user, and a brief description.
    • You can select (click on) two different edits, then click 'Compare Selected Revisions', to see a side-by-side comparison of the old text and the new text.
    • There are options to show/hide your own changes, or minor changes, etc
    • Be aware that it's possible to 'rollback' (reverse) an edit if something has gone drastically wrong. if in doubt, ask someone with technical skills to do this.
  • There is also a 'Recent Changes' link on the left-hand side of the page - this lists recent changes on ALL ME-pedia pages.

Lesson 4[edit | edit source]

  • Learn about the Discussion pages: choose any MEpedia page, and click on its 'Discussion' link near the top left.
    • You will see a list of comments by other users, including suggestions, discussion, criticisms, etc
    • To add your own comments - click on 'edit', add your comments at the end, add your signature and date stamp (see button)

CONGRATULATIONS - you now have the basic skills to edit ME-Pedia, and make it more wonderful !


Text formatting with the Source editor[edit | edit source]

Description What you type What you see
Italic text
''italic text''
italic text
Bold text
'''bold text'''
bold text
Bulleted list
* Item 1
* Item 2
* Item 3
  • Item 1
  • Item 2
  • Item 3
Numbered list
# Electrolytes
# Cytokines
## Cytokine subgroups
### Cytokine sub-sub-groups
# Bananas
  1. Electrolytes
  2. Cytokines
    1. Cytokine subgroups
      1. Cytokine sub-sub-groups
  3. Bananas
Indented text
: cytokines
:: interleukins
::: IL-6
: leukocytes
cytokines
interleukins
IL-6
leukocytes
Block quotes
 <blockquote> this paragraph will be indented </blockquote> 

this paragraph will be indented

Headings of different levels
==Heading text==
===Heading text===
====Heading text====
(not illustrated)
Link to another ME-Pedia page
 [[Pace trial]] 
Pace trial
Link to an external page
[https://en.wikipedia.org/wiki/Mitochondrion Wikipedia - Mitochondrion]
Wikipedia - Mitochondrion

Images[edit | edit source]

To add an image use the "Upload a file" link on the left of any page, and make a note of the file name, then add it to the page. Add right or left, and a width (with a px suffix) to set the size):

[[File:Nancy klimas.jpg|200px|right]]


References - basic[edit | edit source]

The mitochondria produce ATP.<ref>[https://en.wikipedia.org/wiki/Mitochondrion Wikipedia - Mitochondrion]</ref>

The mitocondria produce ATP.[1]

...

References

<references />


References - citing a published study[edit | edit source]

In the body text where you want to reference a study, refer to the citation using the name you give it:

The study showed that X is an effective treatment.<ref name="pace_trial" />

Then at the bottom of the page, define the citation within the References section like this:

==References==
<references>
<ref name="pace_trial">{{Citation
| last1   = White             | first1 = Peter              | authorlink1 = Peter White   
| last2   = Chalder           | first2 = Trudie             | authorlink2 = Trudie Chalder
| last3   = Sharpe            | first3 = Michael            | authorlink3 = Michael Sharpe
| last4   = McCrone           | first4 = Paul               | authorlink4 = Paul McCrone
| display-authors = 3
| title   = Comparison of adaptive pacing therapy, cognitive behaviour therapy, graded exercise therapy, and specialist medical care for chronic fatigue syndrome (PACE): a randomised trial
| journal = The Lancet | volume = 1 | issue = 3 | page = 123-150
| date    = 13 Jan 2011
| pmid    = 21334061
| doi     = 10.1016/S0140-6736(11)60096-2
}}</ref>
</references>

Which when added to a page is displayed like this in the References sections (the PACE trial is shown as an example):

White, Peter; Chalder, Trudie; Sharpe, Michael; et al. (January 13, 2011), "Comparison of adaptive pacing therapy, cognitive behaviour therapy, graded exercise therapy, and specialist medical care for chronic fatigue syndrome (PACE): a randomised trial", The Lancet, 1 (3): 123-150, doi:10.1016/S0140-6736(11)60096-2, PMID 21334061


The "authorlink" fields specify the name of the MEpedia article to go to when that author is clicked. The PMID number is the PubMed study ID. The doi is the unique reference for the study, and when provided means the citation will include a link to the study, wherever it is published. All fields are mandatory, except for 'display-authors', which should only be included if you wish to hide some of the author's names. The documentation for the Citation template is here.

There is an optional field, 'display-authors', which should only be used if you wish to hide some of the author names.

Here is a blank template to copy-and-paste into pages:

<ref name="">
{{Citation
| last1   =                   | first1 =                    | authorlink1 = 
| last2   =                   | first2 =                    | authorlink2 = 
| last3   =                   | first3 =                    | authorlink3 = 
| last4   =                   | first4 =                    | authorlink4 = 
| last5   =                   | first5 =                    | authorlink5 = 
| last6   =                   | first6 =                    | authorlink6 = 
| last7   =                   | first7 =                    | authorlink7 = 
| last8   =                   | first8 =                    | authorlink8 = 
| display-authors = 3
| title   = 
| journal =     | volume =    | issue =    | page = 
| date    = 
| pmid    = 
| doi     = 
}}
</ref>

More help[edit | edit source]

  • View a video tutorial
  • Click "edit" on pages which are not locked (or "view source" on those which are) and:
  • Look at the "wiki code" responsible for creating the page. This may help you learn how to edit since the "code" is, in large part, pretty intuitive and easy to learn if you look back and forth between the article and the code responsible for it.
  • All edit pages have a "Help" link in the toolbar which can lead you to this page (and our link below to editing references).
  • Look at the formatting cheatsheet

How can I contribute?[edit | edit source]

Make a suggestion[edit | edit source]

Almost everyone working on MEpedia is sick, including bed-bound patients. Although we welcome suggestions please, please if you possibly can, create/edit the page yourself. It is very easy to add a new page or make an improvement – be bold! Together we are stronger as a community. If you REALLY can't edit the page, then you can go to the MEpedia suggestions page, click Edit, and add your suggestion to the list for someone else to consider implementing in future.

Implement a suggestion[edit | edit source]

If you want to contribute but aren't sure where to start, try looking at the MEpedia suggestions and consider implementing an improvement suggested by others.

Create a new article[edit | edit source]

To create a new article, simply search for the title of the article you wish to create. If a page does not already exist, you will see an option to create the page. Alternatively if you see a red link to the page, that means it does not yet exist. Just click the red link to create the page.

Once you have a blank editable article open, consider copying-and-pasting an outline into it for that type of article, so you have a set of headings to prompt writing. See MEpedia article outlines

Remember that articles must use strong citations. For example if you write "ME/CFS can be successfully treated with XYZ", you MUST provide a reference to evidence, ideally a high quality (randomized, placebo-controlled) published study. If there is no evidence, the wording must reflect this, for example "ME/CFS is sometimes treated using XYZ, but currently there is no good evidence for its use".

Expand a topic[edit | edit source]

Pages with blue links (as opposed to red) exist already, and can be proof-read, improved and extended. Remember statements need to be supported by the best available evidence or source, for example a published quote by a person, or a paper in a scientific journal.

Check our references[edit | edit source]

You can make sure facts are properly cited and references are in correct format.

We aim to serve a general audience, a research audience, and a patient audience. All entries should be cited and make clear to distinguish what has and has not been established by peer-reviewed research findings. Articles should aim to provide both a general overview of a specific topic as well as discuss its implications or applications in ME and CFS.

Correct typos[edit | edit source]

You can also copy-edit existing articles for typos and edit for clarity.

Clean-up poor pages[edit | edit source]

Some pages are inconsistently formatted, too long, are presented badly, need partially rewriting, or suffer from other problems. Those pages are marked as needing clean-up, and are listed under all articles needing cleanup.

Mark pages as needing cleanup[edit | edit source]

If you see a problem with a page, it needs clean-up, and you are not able to resolve it, mark the page as needing cleaning by adding a marker like this including a description of the problem:

{{Cleanup | reason=the article is full of incorrect capitalization | date=August 2018}}

For more details see Cleanup.

Other Resources[edit | edit source]