How to contribute?

 

 Essentials

Contributing to Respipedia is easy. Authors can create entire articles from the start or complete/edit articles already created by their peers. In both cases articles are validated by a page reviewer.

1- You need first to login with your myERS login details. Then click on "Topics" from the top menu bar.

2- Select a topic from the list of predefined topics

  • "+" button: this means that this topic has not been written yet and you will have the advantage of creating it using a template provided by the ERS.
  • edit button: this means that you can edit an existing article by adding sections or updating information.
  • Topic is greyed: this means that another author is editing the article. You will be able to edit the article once it is validated by the page reviewer.

Write an article

When you click on a topic to create an article from the start you first have to declare any conflict of interest relating to the topic of your article before editing it. Then you are directed to the editing area.

You will notice that your page is already structured and contains the main sections of the article. The "header" is an introductory text to highlight any definitions and key points regarding the topic. Then in the main text area of the editor you will have a template to follow. For example, the template for disease-based topics is structured like this:

1. Epidemiology
2. Aetiology
3. Prognosis
4. Diagnosis - How is the diagnosis made?
    4.1 History, signs and symptoms
    4.2 Physical examination findings
    4.3 Differential diagnosis
    4.4 Work-up
5. Risk stratification
6. Management
7. Prevention

You will have 4 weeks to complete your article. Please save your article continuously and don't forget to click on "submit for validation" in order for the "Reviewer" to receive your article and validate it.
It is mandatory to agree to the "Terms of use" before submitting the article for validation.

You will not be able to access your article after you have submitted it for validation. The reviewer can come back to you with a message indicating areas of improvement/corrections. You will then have access to your article again to implement the changes within a period of one week.

You don't need to complete the entire article. You can complete one section or a few sections, get them reviewed and validated and then allow your peers to complete the rest of the sections.
Your article doesn't need to be perfect. You may submit an initial version, which can be validated and edited again. The principle of a wiki is that knowledge is created in collaboration with peers in their field of interest. The sum of the knowledge created collectively is greater than the individual knowledge alone.

Use the "discuss" tool to communicate with your peers: indicate the rationale of your choices and discuss important issues on how to organise the article.

Edit existing articles

Editing existing article follows the same principle. When an article is published it is ready to be edited again.

You may find some sections to complete within a published Respipedia article. You may also add or change content or insert additional information, images and so on.

If you are a returning editor, the conflict of interest data you entered before will be displayed by default. Please check it and update it if necessary.

Collaborate with peers

Collaboration is the core component of  a wiki!

  • "Discuss" feature is made available for you to post your thoughts and communicate with peers on the topic you are building together.
    You can contribute on the go and communicate with peers on what you have done. You can explain the rationale of your choices: why did you insert certain information or add certain content.
  • Contact: you can also email any author by going on the Authors page from the top menu and clicking on "Contact"
  • Co-authoring: it is possible for a group of authors to work on the same article. When the author completes his part he can transfer the rights to the next co-author using the "transfer to another author" tool. 

How to use the Editor:

A simple editor is made available for you to easily edit text and also to assist you structuring your edits.

 As indicated in the figure below, the structure of the article is displayed in the editor with the related sections to be completed or edited.

editor

 A menu is automatically generated on the top of  your page based on the headlines inserted in your article. For this, please make sure  to use the right formats available in the editor in order to keep the formatting consistent all over Respipedia, and especially for the top menu to be generated automatically.

Formats:

Formats are accessible from the top menu of the Editor. These are the type of formats to be used:

  • Heading: level 1:is used for the big title of the section related to the structure of the article, for example "Diagnosis". Please refer to the structure above.
  • Heading: level 2:to be used for the subtitle related to the structure of the article, for example "History, signs and symptoms"
  • Heading: level 3: to be used for sub subheadline
  • Normal text format:Click on  this icon clear format to clear formatting and use normal text
  • "Image align left"and "Image align right":To align your  image left or right.

Inserting images:

  • image  by clicking on this icon on the top of the of the editor 
    • Add caption to an image: select the image after you inserted it and clik on this feature from the top menu

Inserting Links:whether external or internal (from an article to another)

  • link by clicking on  this icon on the top of the Editor or by right clicking on your mouse

Inserting a table:

  • table You can insert a simple pre-formatted table from the top menu or by right clicking on your mouse.
  •  bullet-points Bullet points and ordered lists can also be inserted

Citing and referencing in Respipedia:

  • cite button to be used to insert in-text citations. The citations are ordered starting from number 1 and automatically inserted as footnotes at the end of the document
  • Four options are available from the Cite button: external reference, ERS reference and linking to an existing reference previously inserted in the document. See figure below.

       select type citation

  •  Cite external: a template is provided in order to fill in the details of the reference:

      cite external

 Please fill in as much details as possible.You can search for the link to the article if the access is free on the internet and insert it in the related field. Click on Create Citation when you complete filling in details.

  • Cite Internal:You can reference any ERS publications, guidelines or resources from ERS Events (Congress, course, conference or seminars), as follows:
  1. Go to the ERS e-learning resources, do a search by keywords and locate your material to be referenced in Respipedia.
    LR cite in respipedia
  2. Click on the "Cite in Respipedia" button as indicated by the red arrow above 
  3. A window pops-up, copy the link provided in the window
    copy link
  4. Come back to Respipedia and click on Cite and choose Cite from ERS
  5. Paste the link you copied in the related field and click on "Create citation" as shown below:
    paste ERS url
  • Cite from Pubmed: just insert the PMID and create citation
    pubmed
  • Link to existing citation button allows you to link to previous citation without recreating the same citation.
  • Edit citation button makes it possible to make changes to inserted citations.