Wavu:Contributing: Difference between revisions

From Wavu Wiki, the 🌊 wavy Tekken wiki
No edit summary
(14 intermediate revisions by the same user not shown)
Line 5: Line 5:
== Scope ==
== Scope ==


{{SITENAME}} is a game guide for Tekken. Its goal is to be the definitive source of knowledge for how to play the game. Anything related to Tekken's lore, art, development, or community is within scope but not the primary focus. Anything else is out of scope.
{{SITENAME}} is a game guide for ''Tekken 7''. Its goal is to be the definitive source of knowledge for how to play the game, with all information on the site being in service of this goal. Anything else is out of scope.


As this wiki describes the game, the main source of truth is the game itself. Any dispute over game mechanics can be resolved with video recordings from the game, supplemented by tools such as [https://github.com/WAZAAAAA0/TekkenBot TekkenBot] and [https://github.com/TekkenOverlay/TekkenOverlay TekkenOverlay].
Anything related to ''Tekken'''s lore, art, or development should go to [https://tekken.fandom.com/wiki/Tekken_Wiki the Tekken Wiki on Fandom].
 
Anything related to the competitive scene should go to [https://liquipedia.net/fighters/Main_Page the Fighting Games Wiki on Liquipedia].
 
== Verifiability ==
 
As this wiki describes the game, the main source of truth is the game itself.
 
Editors writing anything regarding frame precise details should familiarize themselves with [https://github.com/WAZAAAAA0/TekkenBot TekkenBot] (in particular the frame-by-frame command input overlay) and [https://github.com/TekkenOverlay/TekkenOverlay TekkenOverlay]. Common wisdom on this subject should not to be trusted nor relied on.


== Style ==
== Style ==


Keep it short and get to the point. A page which says something in 5 sentences is usually better than another which says it in 10. Respect the reader's time.
Keep it short and get to the point. A page which says something in 5 sentences is usually better than another which says it in 10. Respect the reader's time.
Techniques should be described in terms of ''necessary inputs'' only. Only after that should placebo inputs which can help perform the input be mentioned.
=== Jargon ===
Jargon should be avoided where possible, but not if doing so would make the writing less clear. Make sure any terms used are defined in [[jargon]].
=== Notation ===
Notation should be self-consistent, explicit, short, easy to read, intuitive, and unambiguous. Precedent and consistency with other resources is preferred, but not if doing so is contrary to these goals.
When other sources use different notation to refer to something, this should be noted once where the notation is defined in the wiki, preferably in a footnote, and not be used anywhere else in the wiki.
Avoid using abbreviations if they aren't necessary. If an abbreviation is defined on a page, it should be glossed only once. Make sure any stance abbreviations used are defined in [[Stances|Stances]]. Character-specific stance abbreviations do not need to be unique.
Make sure there's a redirect page for any abbreviations ''not'' defined in [[Notation]].
Don't capitalize a term just because it has an abbreviation.
Don't bother making up notation to describe how something looks. It'll never be sufficient, and it's immediately obvious to players anyway. Use videos instead.


=== Videos ===
=== Videos ===
Line 17: Line 45:
Pages should make liberal use of videos. A single, short clip can add substantial clarity to otherwise dry text. See [[Snake Edge]] for an example. Tekken is a visual game, so most pages without visuals are missing something important.
Pages should make liberal use of videos. A single, short clip can add substantial clarity to otherwise dry text. See [[Snake Edge]] for an example. Tekken is a visual game, so most pages without visuals are missing something important.


See [[T7Wiki:Videos]] for technical details on recording videos for this wiki.
Videos should—
 
* Like the text, be short and to the point, usually between 2 to 5 seconds. Anything longer than that is probably lacking in focus.
* Contain only what they mean to communicate, and nothing more. For example, [[:File:Kuma-Lee-wall-D4444.mp4]] starts at the wall combo rather than at the wall splat, since the splat itself is not relevant to the video.
* Usually not contain anything beyond a raw recording of game visuals. Any supplemental notes or annotations should be in the page text itself.
 
See [[Wavu:Videos]] for technical details on recording videos for this wiki.


=== Color ===
=== Color ===


{{SITENAME}} has a dark mode, which depends on every use of color indicating its behavior in both light and dark mode. As such, any change to colors should be done through the color classes defined in [[MediaWiki:Common.css]]. These are currently:
Color should be used sparingly. Its main use is to make reading large tables easier and to communicate something visually in a figure.


{| class="wikitable
{{SITENAME}} has a dark mode, which depends on every use of color indicating its behavior in both light and dark mode. As such, any use of color should be done through the color classes defined in [[MediaWiki:Common.css]].
 
If color communicates something not communicated otherwise, add the "pattern" class to aid color blind readers.
 
<div style="display: flex; flex-flow: row wrap; gap: 0 1em">
 
{| class="wikitable"
!Class
!Class
!Result
!Result
|-
| bg-red
| class="bg-red" | Text
|-
| bg-orange
| class="bg-orange" | Text
|-
| bg-yellow
| class="bg-yellow" | Text
|-
|-
| bg-green
| bg-green
| class="bg-green" | Text
| class="bg-green" | Text
|-
|-
| bg-yellow
| bg-teal
| class="bg-yellow" | Text
| class="bg-teal" | Text
|-
|-
| bg-red
| bg-blue
| class="bg-red" | Text
| class="bg-blue" | Text
|-
|-
| hover-bg-blue-muddy-05
| bg-purple
| class="hover-bg-blue-muddy-05" | Text
| class="bg-purple" | Text
|}
|}


These colors are defined with the [https://www.hsluv.org/ HSLuv] color space so that they have uniform lightness across different hues. As such, the "yellow" is often more of an orange.
{| class="wikitable"
!Class
!Result
|-
| bg-red pattern
| class="bg-red pattern" | Text
|-
| bg-orange pattern
| class="bg-orange pattern" | Text
|-
| bg-yellow pattern
| class="bg-yellow pattern" | Text
|-
| bg-green pattern
| class="bg-green pattern" | Text
|-
| bg-teal pattern
| class="bg-teal pattern" | Text
|-
| bg-blue pattern
| class="bg-blue pattern" | Text
|-
| bg-purple pattern
| class="bg-purple pattern" | Text
|}
</div>


If you want a color class added, message RogerDodger#2731 on Discord.
{{Navbox wavu}}

Revision as of 05:13, 12 January 2022

Contributing to Wavu Wiki is as simple as going ahead and doing it. Reading this page and others like it is recommended, but not required. If you think something should be added or changed, just do it.

Unless specified otherwise, Wavu Wiki defers to Wikipedia's policies and guidelines.

Scope

Wavu Wiki is a game guide for Tekken 7. Its goal is to be the definitive source of knowledge for how to play the game, with all information on the site being in service of this goal. Anything else is out of scope.

Anything related to Tekken's lore, art, or development should go to the Tekken Wiki on Fandom.

Anything related to the competitive scene should go to the Fighting Games Wiki on Liquipedia.

Verifiability

As this wiki describes the game, the main source of truth is the game itself.

Editors writing anything regarding frame precise details should familiarize themselves with TekkenBot (in particular the frame-by-frame command input overlay) and TekkenOverlay. Common wisdom on this subject should not to be trusted nor relied on.

Style

Keep it short and get to the point. A page which says something in 5 sentences is usually better than another which says it in 10. Respect the reader's time.

Techniques should be described in terms of necessary inputs only. Only after that should placebo inputs which can help perform the input be mentioned.

Jargon

Jargon should be avoided where possible, but not if doing so would make the writing less clear. Make sure any terms used are defined in jargon.

Notation

Notation should be self-consistent, explicit, short, easy to read, intuitive, and unambiguous. Precedent and consistency with other resources is preferred, but not if doing so is contrary to these goals.

When other sources use different notation to refer to something, this should be noted once where the notation is defined in the wiki, preferably in a footnote, and not be used anywhere else in the wiki.

Avoid using abbreviations if they aren't necessary. If an abbreviation is defined on a page, it should be glossed only once. Make sure any stance abbreviations used are defined in Stances. Character-specific stance abbreviations do not need to be unique.

Make sure there's a redirect page for any abbreviations not defined in Notation.

Don't capitalize a term just because it has an abbreviation.

Don't bother making up notation to describe how something looks. It'll never be sufficient, and it's immediately obvious to players anyway. Use videos instead.

Videos

Pages should make liberal use of videos. A single, short clip can add substantial clarity to otherwise dry text. See Snake Edge for an example. Tekken is a visual game, so most pages without visuals are missing something important.

Videos should—

  • Like the text, be short and to the point, usually between 2 to 5 seconds. Anything longer than that is probably lacking in focus.
  • Contain only what they mean to communicate, and nothing more. For example, File:Kuma-Lee-wall-D4444.mp4 starts at the wall combo rather than at the wall splat, since the splat itself is not relevant to the video.
  • Usually not contain anything beyond a raw recording of game visuals. Any supplemental notes or annotations should be in the page text itself.

See Wavu:Videos for technical details on recording videos for this wiki.

Color

Color should be used sparingly. Its main use is to make reading large tables easier and to communicate something visually in a figure.

Wavu Wiki has a dark mode, which depends on every use of color indicating its behavior in both light and dark mode. As such, any use of color should be done through the color classes defined in MediaWiki:Common.css.

If color communicates something not communicated otherwise, add the "pattern" class to aid color blind readers.

Class Result
bg-red Text
bg-orange Text
bg-yellow Text
bg-green Text
bg-teal Text
bg-blue Text
bg-purple Text
Class Result
bg-red pattern Text
bg-orange pattern Text
bg-yellow pattern Text
bg-green pattern Text
bg-teal pattern Text
bg-blue pattern Text
bg-purple pattern Text