Items tagged “style guide”
47 results found
Article
References
References are essential to the pursuit of the high academic standards of Radiopaedia.
Any recommendations for patient care must be based on current science, evidence, and clinical reasoning while avoiding advocating for or promoting, practices that are not, or not yet, adequately based on cur...
Article
Articles
Articles form the encyclopaedic component of Radiopaedia.org and are collaborative efforts to create atomic reference articles for anything related to the practice of radiology. Unlike a textbook, journal publication or a written encyclopaedia, Radiopaedia.org articles allow you and other users ...
Article
Spelling (general)
Correct spelling, also known as orthography in formal usage, is crucial to ensuring that the site is easy to read and trusted. There are a number of troublesome examples that are either frequently written incorrectly, misunderstood or where multiple forms are accepted. In the latter case, we jus...
Article
Capitalisation
Capitalisation is a potential area where style differences can make a significant difference to the content at Radiopaedia.org, and as usual, a consistent style is crucial for uniformity of the site.
Titles and subheadings
Article titles and case titles, as well as subheadings, should be in s...
Article
General overview of Radiopaedia.org
Radiopaedia.org is a rapidly growing peer-reviewed open-edit radiology resource primarily compiled by radiologists and radiology residents/registrars and fellows from across the globe. The site aims to create the best radiology reference available, and to make it available for free, forever and ...
Article
Linking
Linking one article or case to other articles is an integral part of building a cohesive resource.
Blue links and grey links
Links on Radiopaedia are of two colours:
blue links are links to existing articles on Radiopaedia
grey links are links to yet-to-be-written articles - as soon as that...
Article
Interventional procedure article structure
Interventional procedure articles necessarily require a different structure to other articles. It is important for them to have a consistent structure to maintain uniformity across the site. The suggested structure and headings (and heading size) are as follows:
================================...
Article
Why upload cases to Radiopaedia.org
Radiopaedia.org is more than just a collaborative resource, it is also the perfect place to keep your case library. Best of all, your cases help your colleagues from all over the world learn on their own and teach each other.
Your cases remain yours, but you can share them with the rest of the...
Article
When to use bold
Making a decision about when to use bold in an article is important since we know that adding bold and italics to articles reduces its readability.
There are very few examples of when to use bold in an article on Radiopaedia.org and as such, if you're unsure, it's probably worthwhile not using ...
Article
Case title
Each case should have a case title which can be entered in its dedicated box - a clear and concise case title is vital to having the educational case library well-organised and easy to navigate.
Format
The case title is best labelled as just the diagnosis of the case:
Hepatoma
NOT
Interest...
Article
Findings (cases)
The findings section of cases is where the description of that particular study is described. This section is located immediately below each study and findings contribute to case completeness.
What it should contain
The findings section should contain a concise description of the whole study t...
Article
Case discussion
Case discussion refers to relevant teaching points and imaging features relating to your particular case (but not of that particular condition); this section is below your images and you can link related articles into this section.
If you are struggling to write a case discussion remember it c...
Article
Bullet points in radiographic appearances
Bullet points in radiographic appearances have an important part to play, particularly where there are multiple series, e.g. MRI.
When listing MRI appearances, use a new bullet for each sequence and embolden the sequence name. If the sequence name has indented bullets below it, do not add a tra...
Article
Using e.g.
Using e.g. in Radiopaedia.org articles is common and good practice. However, it is important to use e.g. consistently across the site.
Standard use
It should be remembered that when using e.g., the user is trying to give an example, not an exhaustive list.
Example
There are many causes of m...
Article
Style guide
Our style guide is a set of articles that outline the basic "rules" about how to write content on Radiopaedia.org.
Hopefully, you already know that Radiopaedia.org consists of articles, cases and multiple-choice questions.
Style
Our writing style is similar to scientific journals with the m...
Article
Mnemonics article structure
Mnemonics articles are a special type of article with specific style requirements outlined below.
=======================================================================
Acceptable mnemonics
Mnemonics have a long tradition in the teaching of medicine and many of the most memorable ones are a...
Article
Non-English articles
Radiopaedia.org is at present only accepting articles in English.
One day, we'd love to have the site translated into many languages, but for now, we are simply not able to provide enough editorial control over contributions that are not written in English.
If your first language is not Engli...
Article
Video
Video files are useful in a limited number of situations, but should not be used for routine stacks of scrollable images (such as CT or MRI). The reasons to use video include:
ultrasound cine clips
cardiac MRI
some dynamic barium studies
At present video support is limited. Currently, the v...
Article
Slash
A slash (the forward slash in English is formally called the solidus) is used mainly as a substitute for the word 'or'. Radiopaedia.org follows standard English style with no space either preceding or following a slash. A slash is often used to avoid indicating a preference for one of the terms ...
Article
Practical points (article structure)
Practical points is a special part of some articles. It is a section to highlight key features of the condition being discussed, which aid in diagnosis or interpretation (pearls) as well as some of the mistakes to be avoided (pitfalls). When present, it is one of the main subheadings.
Location
...