Hey YOU, yeah YOU! Esportspedia is recruiting more contributors! Join our Discord server and apply to become part of our team, and gain valuable experience within esports and earn some awesome rewards! Apply now! We know you won't regret it!

Wiki Editing Guidelines

From League of Legends Wiki
Jump to: navigation, search

This page is here to document guidelines for editing the wiki, so that articles are as maintainable as possible.

Good Things To Do

Do remember that this is a wiki, not a wiki-like platform or a wiki that has been turned into something else. Be sure to follow wiki best practices and try to do everything 'the wiki way' as much as possible. This will allow others who are familiar with Wikipedia and MediaWiki to feel at home.

Do remember to focus on the content, rather than the presentation. We will gradually work on improving the ways to present certain content, but it's the content itself that is important, not how it happens to display on the page. We can write bots to do various things, but so far we don't have a bot that can write a solid player bio :)

Do make reasonable use of templates when necessary.

Do report bugs at https://bugs.esports.one for any weird issues you encounter, any feature requests you have, and for any mass-edits you need to have made. We want to fix bugs, add features you need, and write bots to do the heavy lifting of editing lots of pages so you don't have to. And remember: your wiki login credentials also log you in to the bug tracker!

Do use Edit with Form when available to maintain key templated information for players, teams and competitions. Use VisualEditor for a WYSIWYG experience, and use Edit Source when you need to get into the wikitext itself. The different editing tools are all suited to different types of edits. Use the right one for the job.

If you are aware of a template that is kind of redundant or should eventually be removed from the wiki, add the following text to the template definition so it can be tracked for removal: <noinclude>[[Category:Templates to delete]]</noinclude>. This will make it show up in the Category:Templates to delete category so we can track it.

Also note that we are actively migrating older Semantic MediaWiki templates to different technology. So some templates are broken right now, and this will get fixed in (relatively) short order. Our goal is not not require editors to painstakingly enter match history for major leagues and be able to pull this directly from our Esports One stats engine. But we still want to have all the cool stats displays that we're used to (crossboxes, etc.)

Bad Things To Do

Don't focus your efforts on updating player stats, match history or schedules as these are things that we will soon be pulling from Riot's API so that we don't need to enter them manually. We are currently in a 'transition period' of migrating from the old wiki where a lot of these things were hard-coded in the wikitext. We want to transition to a system where stats are live and match histories can be pulled from the Esports One stats engine to get away from the considerable effort to maintain these by hand.

Don't over-use templates as anything inside a template is hard to edit inside VisualEditor. Try not to put "regular wiki content" inside a template body, like {{mytemplate|content here blah blah blah}} because this shows up as a little puzzle piece in VisualEditor and to edit the wikitext, you need to open a pop-up and modify a template parameter. This is just how VisualEditor works and is unlikely to be changed (I've looked into it -- VisualEditor doesn't actually look at the "inside" of templates until you click on one of these puzzle pieces.)

Don't use inline HTML inside wiki pages, such as <div>, inline CSS, etc. If anywhere, these types of things should be stuffed inside templates so that they are easy to update globally.

Don't name your templates to refer to how the content will be displayed. A template should be general enough to not have names defining how content is displayed, and your templates should not be hacks designed to inject partial chunks of HTML into the page to get the desired result. This is not the right way to use templates and will make it extremely difficult to update the display of this data globally when desired. Put formatting inside templates themselves and have the template design not dictate a specific type of format.

With some rare exceptions, don't add "tabs" to wiki pages. Don't create any new templates for tabs. A wiki page should look like a printed document as much as possible.

With some rare exceptions don't add javascript doo-dads to the wiki page and instead rely on wikitext as much as possible to present the wiki page content.

Bad Templates

When creating a template and you need to pass a variable number of parameters, don't use this approach:

{{mytemplate|player1=foo|player2=bar|player3=oni}}

Instead, consider using the following nested format:

{{mytemplate|players={{player|foo}}{{player|bar}}{{player|oni}}}}

This is a better approach and is more compatible with MediaWiki extensions such as PageForms.

Style Guide

Long pages are OK
As much as possible, use Wikipedia as a guide for how to lay out pages. Also note that some Wikipedia pages are quite verbose, such as Lebron James' page for example, and this is considered a good thing. It contains lots of information and you can easily get to the information you want by looking at the headings. So don't necessarily conclude that a player, team or tournament page is "too long" if you have to do a lot of scrolling. This is not a bad thing and the more information you have, the more useful it will be to others and the more searchable it will be.
Summary sentences are great
Also, it is very good to try to at least add some summary sentence or paragraph at the top of the page. This will be picked up by the Popup extension so that people can hover over a link to your page and see a good summary of the page content.

We will add more information here as we continue to develop the style guide for Esportspedia.