Contributor guide

From WikiAnesthesia
Revision as of 15:25, 1 June 2021 by Barrett Larson (talk | contribs) (Removed the warning regarding "Prevent this page from being updated", as that option has been removed from the Page Settings.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

WikiAnesthesia is an open platform in which anyone is welcome to contribute. Our philosophy is that knowledge should be freely accessible and that sharing information is most successful when barriers to contribution are reduced. Similar to Wikipedia and other medical wikis, WikiAnesthesia is based on the idea that a dedicated community will self-regulate to produce high-quality, accurate, and useful content.

Getting started

Create an account

To give credit for contributions and help prevent spam, an account must be created in order to contribute to WikiAnesthesia.

  1. Create an account. We ask for users' real name and credentials to attribute credit appropriately and facilitate growth of the WikiAnesthesia community.
  2. Confirm your email address (required before creating content). If you do not receive a confirmation email, check your spam folder. You can also resend the email from the email options section of your preferences.

New users can create and edit most articles on the site immediately. To combat spam, any changes made by new users will be visible to that user, but not immediately reflected to the public until they are reviewed by an editor. Once a new user has made several successful edits, their account will be promoted to the contributor level which will bypass editor review of future contributions.

Contributing content

General guidelines

Our goal is for WikiAnesthesia to be readily useful in the clinical environment. We suggest that articles:

  • Strive to be comprehensive but concise
  • Reflect current evidence-based best practices
  • Include appropriate reference citations
  • Place the most high-yield content in the article's infobox
  • Use bulleted lists and tables whenever feasible

Creating a new article

WikiAnesthesia_Create_Article_From_Redlink.gif
Creating a new article from a red link
WikiAnesthesia_Create_Article_From_Search.gif
Creating a new article using search

Before creating an article, be sure you are logged in. New articles can be created in two ways:

  • Click any red link to start the creation of a new article with the link's title. We highly recommend you create articles by following links from either:
    • The homepage, which lists articles which have been prioritized for development
    • The table of contents, which lists many more articles planned for future development
  • If an appropriate listing is not available in the table of contents, an article with any title can be created:
    1. Input the exact title for the article you wish to create into WikiAnesthesia's search bar and hit enter. Article titles should:
      • Use the most commonly-recognized formal name for the topic (i.e. how the topic would be named in a journal article)
      • Capitalize only the first word and proper nouns
    2. On the search results page, a link to start the creation of the article will be shown in the text "Create the page "[...]" on this wiki!"

Using page templates

WikiAnesthesia_Create_Article_Page_Templates.gif
Applying a page template to a new article
WikiAnesthesia_Create_Article_Infobox.gif
Editing the article infobox

New articles should use a predefined page template whenever possible. Page templates can be accessed from the page templates menu (Page templates menu icon) of the editor. When using a page template:

  • Fill out the applicable standardized fields of the infobox
    • The infobox should contain the article's highest-yield content in the most concise form possible
  • The predefined structure should serve a basis for the article, but can be freely modified as warranted by the content

The new article will not be permanently saved on the wiki until you click "Save Page..." in the upper-right corner of the editor. If you are a new contributor to WikiAnesthesia, your article will not appear publicly until it has been reviewed by an editor.

Editing an existing article

Most articles can be edited by any registered user. When logged in, open the page menu in the upper-right corner of the article and click "Edit" which will load the editor. After making a revision, click "Save changes..." in the upper-right corner of the editor. Briefly describe the changes made in the summary box and click "Save changes" to save the article.

Using the article editor

Switching between "visual" and "source" editing

The article editor can operate in two modes, which can be switched at anytime using the Switch editor menu icon menu in the editor toolbar:

  • "Visual editing" (default), in which the editor behaves similar to word processing software. This mode is easy to use and effective for most situations.
  • "Source editing", in which the underlying WikiText markup may be directly edited. This mode may be preferred by advanced users, and may be necessary for more complex editing tasks.
    • Detailed documentation of WikiText markup can be found here

Adding media to an article

Images and videos can be uploaded directly to WikiAnesthesia for inclusion in articles. This can be done directly from the editor in most circumstances using the "Insert" menu of the editor toolbar and selecting "Images and media". Adding images to an infobox is less streamlined, and requires the file be uploaded separately from the editing process:

  1. Open the tools menu by clicking the toolbox icon on the right side of the navigation bar
  2. Click "Upload file"
  3. Upload the file to be included in the infobox and copy the uploaded file name to your clipboard.
  4. Return to the editor for the article and open the infobox editor
  5. Paste the newly uploaded filename into the image filename field for the infobox
  6. Click "Apply changes" and save the page
Embedding external videos

When videos already exist on an external site like YouTube, we recommend embedding those videos rather than reuploading content to WikiAnesthesia when possible. External video embedding requires use of the "source editing" mode of the editor, and uses the syntax described in detail here.

Citing references

Effective citation of references is critical to ensure the validity of content on WikiAnesthesia.

Automatic citation generation
WikiAnesthesia_Citoid.gif
Using the automatic citation tool

To simplify citation management, the article editor provides a citation tool which can automatically populate citation data from a variety of unique identifiers including:

  • Digital Object Identifier (DOI)
  • International Standard Book Number (ISBN)
  • PubMed IDs (PMID/PMCID)
  • A URL to a web resource

To insert a citation using one of these identifiers:

  1. Place the cursor at the location in the article where the citation should be inserted.
  2. Click the "Cite" menu of the editor toolbar
  3. On the "Automatic" tab of the cite menu, input either a link to the resource or the raw identifier. For example, any of the following inputs will generate a citation to the same article:
  4. Click "Generate"
    • Citation generation may take a few seconds. If the citation matches the intended reference, click "Insert" to add it.
    • If any red error text appears at the end of the citation (e.g. "Check date values in |date="), one or more of the generated values does not match the expected formatting of the field. To fix this, while in "visual editing" mode:
      1. Click on the newly inserted citation in the article which will open a preview of the reference, with the option to edit the citation data
      2. Click "Edit" to open the citation editor
      3. Edit the value of field listed in the error message to match the expected formatting and click "Apply changes"
Manual citation

If a reference does not have a unique identifier or URL for automatic citation generation, citation data can be manually entered.

  1. Place the cursor at the location in the article where the citation should be inserted.
  2. Click the "Cite" menu of the editor toolbar
  3. Click the "Manual" tab of the cite menu and select the type of reference
  4. Complete the fields for the reference and click "Insert"

Discussing an article

All articles have a corresponding "Talk" page where any editorial discussion of the article's content should take place. The talk page can be accessed using the page menu and clicking "Discussion"

Watching an article

To be notified when an article is revised, users can "watch" articles. This feature can be accessed from the page menu or when saving an article in the editor.

Organizing content

Adding categories to articles

WikiAnesthesia_Article_Categories.gif
Adding article categories

WikiAnesthesia uses categories to organize content on the site. The list of categories for an article are displayed at the bottom of the article, where categories can be clicked on to see all the articles and/or subcategories they contain. The hierarchy of the table of contents provides a suggested framework for article categories.

To add categories to an article, in the editor:

  1. Click "Categories" in the page options menu (Page options menu icon)
  2. Start typing the category to be added. If the category already exists on the site, it will appear as an autocompleted suggestion.
    • If the category is new, be sure to follow the style guidelines for titles, which capitalize only the first word and proper nouns
  3. Click "Apply changes"
  4. Click "Save page..."

Adding redirects (aliases) to articles

WikiAnesthesia_Create_Article_Redirect.gif
Creating a redirect for an article

Articles may have commonly-recognized alternative names, abbreviations, or may fully cover a more specific subtopic with a different name. In this situation, the use of "redirects" will allow articles to be found using these alternative titles. Some examples would include:

If you feel that an article has a commonly used alias, please consider adding a redirect from the alias to the primary title. The primary article should use the most commonly-recognized, formal name for the topic (i.e. how the topic would be named in a journal article). To add an alias for an article, start the creation process for a new article using the alias to be added as the title. In the editor of the alias article:

  1. Click "Page settings" in the page options menu (Page options menu icon)
  2. Check the box for "Redirect this page to" and start typing the title of the primary article
    • Note: The primary article should appear as an autocompleted suggestion. If the primary article is not suggested:
      • Confirm that you are generating the redirect in the correct direction (i.e. redirecting from the alias to the primary article)
      • Confirm that the primary article already exists
  3. Click "Apply changes"
  4. Click "Save page..."

Getting credit for contribution

Contributions to WikiAnesthesia are automatically associated with user accounts in several ways.

Contribution scores

Every user has a user profile which shows the number of pages edited, the total number of edits, and an overall contribution score which is defined as:

(number of unique pages edited) + 2 * square root ((number of edits) - (number of unique pages edited))

Article contributors

The top contributors are listed at the bottom of each article.

Editorial levels

WikiAnesthesia has several user levels which are reflected on users' profile pages and determine access to editorial and site administration tools.

  • User: The default user group assigned to new accounts. Users can create and edit most articles, but changes will not appear publicly until reviewed by an Editor.
  • Contributor: Contributors can create and edit articles without editor review (changes appear publicly immediately). Users are promoted to Contributor by Editors after one or more substantive contributions have been made.
  • Editor: Editors can approve or reject pending contributions from Users, promote users to Contributors, and edit most protected pages. Users are promoted to editor at the discretion of the editorial board.
  • Administrator: Administrators can edit all protected pages and modify site-wide configuration.