Editing MEpedia talk:Manual of style

From MEpedia, a crowd-sourced encyclopedia of ME and CFS science and history
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 41: Line 41:
::Paging [[User:JaimeS]]... :)
::Paging [[User:JaimeS]]... :)
::[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 20:27, June 14, 2019 (EDT)
::[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 20:27, June 14, 2019 (EDT)
===Re: Where to attach citations? -- [[User:JaimeS|JaimeS]] ([[User talk:JaimeS|talk]]) 14:21, June 26, 2019 (EDT)===
===Re: Where to attach citations? -- [[User:JaimeS|JaimeS]] ([[User talk:JaimeS|talk]]) 14:21, June 26, 2019 (EDT)===
: Generally speaking, you don't cite after every sentence, but after a block of facts that are from the same source. A rule of thumb I learned is to make sure that all the facts from that citation are in the same paragraph -- and that *no other references are used in that paragraph*. Then, cite at the end of the paragraph.
: Generally speaking, you don't cite after every sentence, but after a block of facts that are from the same source. A rule of thumb I learned is to make sure that all the facts from that citation are in the same paragraph -- and that *no other references are used in that paragraph*. Then, cite at the end of the paragraph.
: Referencing the source by name early on is also a good tactic, as [[Notjusttired]] mentions.
: Referencing the source by name early on is also a good tactic, as [[Notjusttired]] mentions.
:: If a sentence or paragraph contains multiple items of information and a source only supports the first, place that reference right after the first piece of info (after the comma, not before). Try to avoid sentences where it is unclear if a source supports the whole sentence or only the last part of it. [[User:Guido den Broeder|Guido den Broeder]] ([[User talk:Guido den Broeder|talk]]) 20:50, September 15, 2019 (EDT)
:: If a sentence or paragraph contains multiple items of information and a source only supports the first, place that reference right after the first piece of info (after the comma, not before). Try to avoid sentences where it is unclear if a source supports the whole sentence or only the last part of it. [[User:Guido den Broeder|Guido den Broeder]] ([[User talk:Guido den Broeder|talk]]) 20:50, September 15, 2019 (EDT)
:::Has this issue been resolved?  Do we need to add anything to the page?
:::[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 13:38, October 24, 2019 (EDT)


==Spelling==
==Spelling==
We should add this before Dates and numbers, stating US spelling. [http://translation-clinic.com/spelling-medical-terms-british-american-english/ This list] of science ones might be helpful.  
We should add this before Dates and numbers, stating US spelling. [http://translation-clinic.com/spelling-medical-terms-british-american-english/ This list] of science ones might be helpful.  
Quote marks too, either " or ‟ ”, some languages eg German use different marks. [[User:Notjusttired|notjusttired]] ([[User talk:Notjusttired|talk]]) 17:25, August 10, 2019 (EDT)
Quote marks too, either " or ‟ ”, some languages eg German use different marks. [[User:Notjusttired|notjusttired]] ([[User talk:Notjusttired|talk]]) 17:25, August 10, 2019 (EDT)
:::Has this issue been resolved?  Do we need to add anything to the page?
:::[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 13:38, October 24, 2019 (EDT)


==Dates and numbers ==
==Dates and numbers ==
Line 87: Line 86:
:Thanks for looking these things up!  It certainly makes sense to include these. (in a concise way of course so as not to bore the reader!)
:Thanks for looking these things up!  It certainly makes sense to include these. (in a concise way of course so as not to bore the reader!)
:[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 21:03, September 9, 2019 (EDT)
:[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 21:03, September 9, 2019 (EDT)
:::Has this issue been resolved?  Do we need to add anything to the page?
:::[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 13:38, October 24, 2019 (EDT)


==Drug names ==
==Drug names ==
Line 128: Line 125:


:I think the bit on foreign languages might be a little too strong. I think it should be discouraged to refer to non-English sources, but in some cases, this is the only option. Some foreign researchers have made important or revealing statements in non-English languages only, for example Wyller supporting the Lightning process or Bleijenberg saying that severe ME/CFS patients do not want CBT because they prefer to have a stable situation. With google translate it's also becoming easier to check things in a language you're not fluent in. So in my view, referencing to a non-English source should be discouraged but allowed if it contains unique and important information.--[[User:Sisyphus|Sisyphus]] ([[User talk:Sisyphus|talk]]) 06:18, September 16, 2019 (EDT)
:I think the bit on foreign languages might be a little too strong. I think it should be discouraged to refer to non-English sources, but in some cases, this is the only option. Some foreign researchers have made important or revealing statements in non-English languages only, for example Wyller supporting the Lightning process or Bleijenberg saying that severe ME/CFS patients do not want CBT because they prefer to have a stable situation. With google translate it's also becoming easier to check things in a language you're not fluent in. So in my view, referencing to a non-English source should be discouraged but allowed if it contains unique and important information.--[[User:Sisyphus|Sisyphus]] ([[User talk:Sisyphus|talk]]) 06:18, September 16, 2019 (EDT)
::The exception you suggest sounds good Guido, although I think it useful to suggest adding a second source in the page language that cites it, which is extremely easy using [http://scholar.google.com Google scholar]'s "cited by" option or researchgate. It should not be interpreted as excluding research simply because of its publication language, but a case of trying to include verification in the correct language too. Many foreign language source have English abstracts, but that will be little use on say, German language pages. You make a good point about Google translate [[User:Sisyphus]], but some sources are video or radio interviews and I am not sure of the accuracy of Japanese translations.
::Points about ME Association purple book are irrelevant: we won't be creating a page for it and it's sent free to all UK doctors if a patient requests it. Having said that, I don't think a link directly to the book is important, although it should be mentioned since it's free service within the UK. Wikisage is Guido's personal website, as we know and Wikipedia is already disallowed as a source.
::Jodi is dead as I'm sure you know, and her Hummingbirds Foundation charity continues. The final wording should not imply that an open access is expected linking to abstracts or referring to book page numbers is fine. As for Myhill's website, most statements are unreferenced so should be referred to as her view only, although her mitochondria research is peer reviewed. [[User:Notjusttired|notjusttired]] ([[User talk:Notjusttired|talk]]) 10:15, September 16, 2019 (EDT)
:::Please make sure to sign your posts, or it is impossible to respond.
:::Wikipedia, Wikisage and other online encyclopediae are indeed not considered reliable sources, but they are valid links for 'Learn more' sections. FYI, Wikisage counts over 56,000 articles, created by some 600 users (and many more that worked on them on Wikipedia). I've only written a few dozen myself. Which articles we can or can't create is not for you to decide. [[User:Guido den Broeder|Guido den Broeder]] ([[User talk:Guido den Broeder|talk]]) 12:17, September 16, 2019 (EDT)


==Topics not covered here ==
==Topics not covered here ==
Line 139: Line 131:


:Agree with notjusttired that this the best option.--[[User:Sisyphus|Sisyphus]] ([[User talk:Sisyphus|talk]]) 06:18, September 16, 2019 (EDT)
:Agree with notjusttired that this the best option.--[[User:Sisyphus|Sisyphus]] ([[User talk:Sisyphus|talk]]) 06:18, September 16, 2019 (EDT)
== External links -- [[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 16:45, December 27, 2019 (EST) ==
I thought we had a section on this, but I guess we don't.  The MEpedia convention is to avoid using external links in a page, except for the "Talks and Interviews", "Online presence", and "Learn more" sections. External links in other sections are to be replaced with citations or internal links.  This should probably be formalized in the Manual of style.  We can just copy the good guidelines specified in [[MEpedia:External links]].
<br>[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 16:45, December 27, 2019 (EST)
== When and where to link -- [[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 19:18, January 15, 2020 (EST) ==
I propose the following subsection under the "Layout" section:
<pre>
===When and where to link to other pages===
When another page is mentioned, a link to that page can be created.  Typically, the other page will be linked to once if in the introductory section of an article, and then will be linked to once more the first time the page name appears in the rest of an article. However, there may be situations where more links are helpful. For instance, if an important page name is mentioned three times in the body of a very long article, it may serve the reader to create a link each time.
</pre>
[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 19:18, January 15, 2020 (EST)
== Layout- Displaying images -- [[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 18:03, January 27, 2020 (EST) ==
The following standard practice should be enshrined in the manual of style:
* All images displayed in an article should have a caption that, at a minimum, includes the author or citation for the image, as well as the copyright license of the image.  This information should be readily available from the image's "File:" page.
This is already discussed here: [[help:Images%23Displaying_an_image_on_a_page]]
<br>[[User:Pyrrhus|Pyrrhus]] ([[User talk:Pyrrhus|talk]]) 18:03, January 27, 2020 (EST)
== Colors --  ~[[User:Notjusttired|Njt]] ([[User talk:Notjusttired|talk]]) 01:10, August 22, 2020 (UTC) ==
I would like to add a section about the use of colors, including about how to use color which works with / adapts to the dark timeless skin. <s>I will try writing up a draft here later. The color contrast checkers [https://webaim.org/resources/contrastchecker/ 1] and [https://accessible-colors.com/ 2] calculate web accessibility (color contrast).  ~[[User:Notjusttired|Njt]] ([[User talk:Notjusttired|talk]]) 01:10, August 22, 2020 (UTC)</s>
'''To add:'''
===Colors===
====Backgrounds====
Suggested colors when many background colors are needed:<br />
*Orange, Gold, Plum, Tomato, LightGreen, CornflowerBlue, HotPink (HTML color names)
*Black text (not the default near-black since the dark Timeless skin will turn this white)
*Text-shadow set to none in the code (dark timeless compatibility)
<pre><code> style="background-color:LightGreen;color:black;text-shadow:none"
</code></pre>
Example: [[Canadian Consensus Criteria]]
{| class="wikitable"
| style="background-color: Orange;color:black;text-shadow:none" |1
| style="background-color: Gold;color:black;text-shadow:none" |2
| style="background-color: Plum;color:black;text-shadow:none" |3
| style="background-color: Tomato;color:black;text-shadow:none" |4
| style="background-color:LightGreen;color:black;text-shadow:none" |5
| style="background-color: CornflowerBlue;color:black;text-shadow:none" |6
| style="background-color: HotPink;color:black;text-shadow:none" |7
|}
====Text colors====
MEAction shades of red, blue, and dark or light gray use the templates, e.g. '''<nowiki>{{MEActionLGray|light gray text}}</nowiki>'''.
Other text colors should be rarely used, and only used for certain purposes e.g. using green for a positive symbol and red for a negative symbol on [[List of enterovirus infection studies]]. Text colors must use classes because this will allow the Timeless dark skin to adjust the shade of color for better visibility. Example code:
<pre><code>
This is <span class="green">'''+'''</span> green, <span class="red">'''-'''</span> red, <span class="blue">blue</span> and <span class="gray">gray</span>.
</code></pre>
Displays: This is <span class="green">'''+'''</span> green, <span class="red">'''-'''</span> red, <span class="blue">blue</span> and gray <span class="gray">gray</span>.
These colors are defined in [[MediaWiki:Common.css]] and [[MediaWiki:Timeless.css]].
Is this ok to add to the live documentation [[User:JaimeS]]?  ~[[User:Notjusttired|Njt]] ([[User talk:Notjusttired|talk]]) 19:00, October 13, 2020 (UTC)
Please make sure your edits are consistent with MEpedia's guidelines. By saving changes, you agree to the Terms of use, and you irrevocably agree to release your contribution under the CC BY-SA 3.0 License and the GFDL. You agree that a hyperlink or URL is sufficient attribution under the Creative Commons license.
Cancel Editing help (opens in new window)