Difference between revisions of Help:How to contribute

Jump to navigation Jump to search
No edit summary
 
(26 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[File:Kermit the frog typing.gif|right]]
{{EM help}}
{{gif fixer|[[File:Kermit the frog typing.gif]]|right}}
<center>'''Looking for [[EndMyopia:Policies|wiki policies]]?'''</center>
<center>'''Looking for [[EndMyopia:Policies|wiki policies]]?'''</center>
'''If it ain't broke, don't fix it'''. That is the guiding principle behind this help article ;)
'''If it ain't broke, don't fix it'''. That is the guiding principle behind this help article ;)
'''Notice:''' Editing the wiki is temporarily not available, until we update legal policies, disclaimers and a number of articles.  This has become necessary as some had expressed concerns about various contents, and unlimited public access without possibly necessary limitation and disclaimers.  Jake, who created all of the endmyopia resources had been entirely uninvolved in wiki moderation, which has since caused some issues.
Luckily we've been able to clear the hurdle of being able to have the wiki online.  It'll take some time to get all wiki contents and details in line with updated policies, at which time we hope to be able to re-enable editing.  ❤️


The wiki runs on [https://www.mediawiki.org/wiki/MediaWiki MediaWiki], the same wiki software that powers Wikipedia and probably every other wiki you've come across on the internet. As a result, '''countless other people have written guides far better than we could ever hope to write about how to contribute to the wiki'''. So, no point in reinventing the wheel with this one.
The wiki runs on [https://www.mediawiki.org/wiki/MediaWiki MediaWiki], the same wiki software that powers Wikipedia and probably every other wiki you've come across on the internet. As a result, '''countless other people have written guides far better than we could ever hope to write about how to contribute to the wiki'''. So, no point in reinventing the wheel with this one.


Please try to keep in mind the specifics of how contribution will work here. None of the policies of Wikipedia or any other wiki applies here, we have our own policy articles. We are not written from a neutral point of view, referencing guidelines are fairly relaxed and humour is encouraged in articles wherever possible for entertainment value to the reader. But as for syntax and the technicalities of editing, you can't get much better than what's already written.
Please try to keep in mind the specifics of how contribution will work here. None of the policies of Wikipedia or any other wiki applies here, we have our own policy articles. We are [[EM:Biased point of view|not written from a neutral point of view]], referencing guidelines are fairly relaxed and humour is encouraged in articles wherever possible for entertainment value to the reader. But as for syntax and the technicalities of editing, you can't get much better than what's already written.


Remember that if you're using templates such as <nowiki>{{templatenamehere}}</nowiki>, a lot of them will not work unless the template has been copied over to here in the Template namespace. Bear that in mind if something doesn't work properly :)
Remember that if you're using templates such as <nowiki>{{templatenamehere}}</nowiki>, a lot of them will not work unless the template has been copied over to here in the Template namespace. Bear that in mind if something doesn't work properly :)
==Formatting==
==Formatting==
===Using Wikitext===
===Using Wikitext===
Line 27: Line 31:


Definitely feel free to ignore anything that is more related to being an encyclopedia, we are not an encyclopedia, we are a vision improvement resource, first and foremost, full of funny jokes. You will find a lot of information about how to stylise articles in a cool way there though.
Definitely feel free to ignore anything that is more related to being an encyclopedia, we are not an encyclopedia, we are a vision improvement resource, first and foremost, full of funny jokes. You will find a lot of information about how to stylise articles in a cool way there though.
====EndMyopia specifics====
There is an apparent consensus at the time of writing that 'EndMyopia' should be the consistent capitalisation of how the name is referenced. Please refrain from using different capitalisations when referring to EndMyopia in articles. Consistency is important.
==Creating new pages==
===Creating a new article===
To create a new article, enter in the URL of the article you would like to create. You'll be taken to a page where you will be asked to create the article if it doesn't exist already.
Alternatively, create a redlink, [[MediaWiki:like this|like this]]. Then click on the redlink to create the article. You can place loads of redlinks in articles that are already written to indicate to others the articles that need writing.
===Creating a redirect===
Redirects move anyone who lands at that page to another page. This is used for terms that are similar, like [[Myopia]] and [[Shortsightedness]]. This is really important in preventing duplicate articles covering the same topic, and to aid in navigation of the wiki.
To create a redirect, type the following in the entire body of an article, and nothing else:


<code><nowiki>#redirect [[ArticleName]]</nowiki></code>
====Using images====
{{Main|Help:Pictures}}
You can upload images to this site using the "upload file" tool in the left panel. (That tool also provides a link to enumerate uploaded fles.)


==Using talk pages==
But even better than that, the "InstantCommons" feature seems to be enabled, which means you can access images directly from commons without having to copy them to here. See https://www.mediawiki.org/wiki/InstantCommons#Using_files_via_InstantCommons
Talk pages are 100% completely identical to normal pages in how they work. You can use all wikitext markup tricks in talk pages, the software does not handle them differently. The following are the basics:


Reply under subject headers. Indent your messages in responding to other editors using colons. Sign off your posts with your signature of <nowiki>~~~~</nowiki> as standard. Be sure to notify users using the template <code><nowiki>{{re|User}}</nowiki></code>. For example, a fictional conversation between two editors you might find on the [[Differentials]] talk page:
====Writing maths====
To write maths, enclose text in <code><nowiki><math></math></nowiki></code> tags.


<code><nowiki>==Difference between diffs and normalised==</nowiki><br>
<code><nowiki><math>(5+12)/(41.9999)</math></nowiki></code> displays as
<nowiki>Hey guys, what should be the advice given about differentials? ~~~~</nowiki><br>
<nowiki>:{{re|User}} Differentials should be 1-2 diopters below your normalised prescription. We should put this in the lead section of the article. ~~~~</nowiki><br>
<nowiki>::{{re|OtherUser}} Oh great, many thanks! ~~~~</nowiki></code>


'''Will be rendered as (with the heading removed):'''
<math>(5+12)/41.9999</math>


Hey guys, what should be the advice given about differentials? [[User:User|User]] ([[User talk:User|talk]]) 13:58, 20 May 2020 (UTC)
You can use fancy formatting too!
:{{re|User}} Differentials should be 1-2 diopters below your normalised prescription. We should put this in the lead section of the article. [[User:Other User|OtherUser]] ([[User talk:OtherUser|talk]]) 14:08, 20 May 2020 (UTC)
::{{re|OtherUser}} Oh great, many thanks! [[User:User|User]] ([[User talk:User|talk]]) 14:11, 20 May 2020 (UTC)


You can also press the 'Add topic' button so you don't have to type <code><nowiki>==Topic title==</nowiki></code> before your messages.
<code><nowiki><math>\frac{1}{2}e^{i\pi} = \frac{-1}{2}</math></nowiki></code> displays as


As you can see, using talk pages is ridiculously easy. Just remember though: [https://en.wikipedia.org/wiki/Help:Talk_pages anything you can do, Wikipedia can do better Click here for Wikipedia's explanation about talk pages.].
<math>\frac{1}{2}e^{i\pi} = \frac{-1}{2}</math>
===Signatures===
Signatures can be configured using the Preferences button in the top right. It's better to keep this as simple as possible, and there's literally nothing wrong with the default signature. Definitely check out [https://en.wikipedia.org/wiki/Wikipedia:Signatures Wikipedia's page on how to customise signatures] if you want to leave your mark a bit more on every talk page you visit. Who doesn't like a colourful talk page?


Again, none of WPs policies apply to signatures, except please do not include images or files in your signatures as they cause unnecessary server load and make talk pages look horrible.
For way too much detail on how to write and display formulae, see [https://en.wikipedia.org/wiki/Help:Displaying_a_formula Wikipedia's guide on how to render mathematical formulae].


Posts can be signed off with four tidles or three. Four is by definitely what most people should use in most circumstances. Here's the difference:
====Citing papers====
We want to cite scientific research where possible to justify this approach. One way is to use the ''''proveit'''' gadget that should appear in the bottom right corner while editing - see the video tutorials mentioned above for more details.


<nowiki>~~~~</nowiki>  
=====Repeating references=====
:[[User:User|User]] ([[User talk:User|talk]]) 14:08, 20 May 2020 (UTC)
It is possible to reference the same document several times from within an article. On the first one, give the reference a tag : <nowiki><ref name="habits">citation here</ref></nowiki>.  Then subsequent mentions can simply use the tag with an empty body : <nowiki><ref name="habits"></ref></nowiki>  or xml shorthand <nowiki><ref name=habits" /></nowiki>


<nowiki>~~~</nowiki>  
=====Biomedical citation maker=====
:[[User:User|User]] ([[User talk:User|talk]]) 14:08, 20 May 2020 (UTC)
Another (external) tool is http://sumsearch.org/cite/ - if you have a unique reference for the journal in one of various formats (such as a <nowiki>https://doi.org/...</nowiki> url), you can enter that into the box and will generate a fancy '''<nowiki><ref>{{cite...}}</ref></nowiki>''' sequence with title, authors, journal, etc. that you can simply paste in.


Forgetting to use signatures will leave everyone confused really quickly, so please make it a habit to include <nowiki>~~~~</nowiki> at the end of all your messages on talk pages! :)
It provides a bookmarklet which allows you to generate a citation by simply selecting the doi using mouse, and pressing a button.
===Notifying other users===
When you reply to a user on any other talk page aside from their own talk page, they won't be notified unless you remember to send a notification template to them. This is super easy to do!!


When responding to people, type the following at the beginning of your message:
====EndMyopia specifics====
There is an apparent consensus at the time of writing that 'EndMyopia' should be the consistent capitalisation of how the name is referenced. Please refrain from using different capitalisations when referring to EndMyopia in articles. Consistency is important.


<code><nowiki>{{re|User}}</nowiki></code>
==Creating new pages==
===Creating a new article===
To create a new article, enter in the URL of the article you would like to create. You'll be taken to a page where you will be asked to create the article if it doesn't exist already.


{{re|User}} is how it is displayed. This will send a notification to the user through the notification system.
Alternatively, create a redlink, [[MediaWiki:like this|like this]]. Then click on the redlink to create the article. You can place loads of redlinks in articles that are already written to indicate to others the articles that need writing.
===Creating a redirect===
Redirects move anyone who lands at that page to another page. This is used for terms that are similar, like [[Myopia]] and [[Shortsightedness]]. This is really important in preventing duplicate articles covering the same topic, and to aid in navigation of the wiki.


You can also use <code><nowiki>{{u|User}}</nowiki></code>
To create a redirect, type the following in the entire body of an article, and nothing else:


{{u|User}} is how this one looks, and can be used to mention someone's username without the @ symbol.
<code><nowiki>#redirect [[ArticleName]]</nowiki></code>
==Using talk pages==
{{bigger|See [[Help:Talk pages]]}}

Latest revision as of 12:48, 28 May 2023

Kermit the frog typing.gif
Looking for wiki policies?

If it ain't broke, don't fix it. That is the guiding principle behind this help article ;)

Notice: Editing the wiki is temporarily not available, until we update legal policies, disclaimers and a number of articles. This has become necessary as some had expressed concerns about various contents, and unlimited public access without possibly necessary limitation and disclaimers. Jake, who created all of the endmyopia resources had been entirely uninvolved in wiki moderation, which has since caused some issues.

Luckily we've been able to clear the hurdle of being able to have the wiki online. It'll take some time to get all wiki contents and details in line with updated policies, at which time we hope to be able to re-enable editing. ❤️

The wiki runs on MediaWiki, the same wiki software that powers Wikipedia and probably every other wiki you've come across on the internet. As a result, countless other people have written guides far better than we could ever hope to write about how to contribute to the wiki. So, no point in reinventing the wheel with this one.

Please try to keep in mind the specifics of how contribution will work here. None of the policies of Wikipedia or any other wiki applies here, we have our own policy articles. We are not written from a neutral point of view, referencing guidelines are fairly relaxed and humour is encouraged in articles wherever possible for entertainment value to the reader. But as for syntax and the technicalities of editing, you can't get much better than what's already written.

Remember that if you're using templates such as {{templatenamehere}}, a lot of them will not work unless the template has been copied over to here in the Template namespace. Bear that in mind if something doesn't work properly :)

Formatting

Using Wikitext

Wikilinks

Try to use wikilinks when writing articles. You can write wikilinks like this:

[[Article]]

That will produce Article. You can also produce red links, that look like this - this is good for indicating to other editors that an article on this topic needs to be written, and doesn't exist yet.

Wikitext guides

You can find all the information you've ever wanted on how to use Wikitext to write articles effectively at Wikipedia.

Wikipedia help article on how to format articles using Wikitext (very recommended)

Styling of articles

You can find a far, far better crafted Manual of Style at Wikipedia than we could ever have the time or enthusiasm to write. Here it is, in all of its glory.

Definitely feel free to ignore anything that is more related to being an encyclopedia, we are not an encyclopedia, we are a vision improvement resource, first and foremost, full of funny jokes. You will find a lot of information about how to stylise articles in a cool way there though.

Using images

You can upload images to this site using the "upload file" tool in the left panel. (That tool also provides a link to enumerate uploaded fles.)

But even better than that, the "InstantCommons" feature seems to be enabled, which means you can access images directly from commons without having to copy them to here. See https://www.mediawiki.org/wiki/InstantCommons#Using_files_via_InstantCommons

Writing maths

To write maths, enclose text in <math></math> tags.

<math>(5+12)/(41.9999)</math> displays as

You can use fancy formatting too!

<math>\frac{1}{2}e^{i\pi} = \frac{-1}{2}</math> displays as

For way too much detail on how to write and display formulae, see Wikipedia's guide on how to render mathematical formulae.

Citing papers

We want to cite scientific research where possible to justify this approach. One way is to use the 'proveit' gadget that should appear in the bottom right corner while editing - see the video tutorials mentioned above for more details.

Repeating references

It is possible to reference the same document several times from within an article. On the first one, give the reference a tag : <ref name="habits">citation here</ref>. Then subsequent mentions can simply use the tag with an empty body : <ref name="habits"></ref> or xml shorthand <ref name=habits" />

Biomedical citation maker

Another (external) tool is http://sumsearch.org/cite/ - if you have a unique reference for the journal in one of various formats (such as a https://doi.org/... url), you can enter that into the box and will generate a fancy <ref>{{cite...}}</ref> sequence with title, authors, journal, etc. that you can simply paste in.

It provides a bookmarklet which allows you to generate a citation by simply selecting the doi using mouse, and pressing a button.

EndMyopia specifics

There is an apparent consensus at the time of writing that 'EndMyopia' should be the consistent capitalisation of how the name is referenced. Please refrain from using different capitalisations when referring to EndMyopia in articles. Consistency is important.

Creating new pages

Creating a new article

To create a new article, enter in the URL of the article you would like to create. You'll be taken to a page where you will be asked to create the article if it doesn't exist already.

Alternatively, create a redlink, like this. Then click on the redlink to create the article. You can place loads of redlinks in articles that are already written to indicate to others the articles that need writing.

Creating a redirect

Redirects move anyone who lands at that page to another page. This is used for terms that are similar, like Myopia and Shortsightedness. This is really important in preventing duplicate articles covering the same topic, and to aid in navigation of the wiki.

To create a redirect, type the following in the entire body of an article, and nothing else:

#redirect [[ArticleName]]

Using talk pages

See Help:Talk pages