wiki/Article_styling_criteria/Formatting/en.md CHANGED
@@ -16,7 +16,7 @@ Listed below are the properly-supported locales for the wiki:
16
16
  | `cs.md` | Czech | Česky |
17
17
  | `da.md` | Danish | Dansk |
18
18
  | `de.md` | German | Deutsch |
19
- | `gr.md` | Greek | Ελληνικά |
19
+ | `el.md` | Greek | Ελληνικά |
20
20
  | `es.md` | Spanish | Español |
21
21
  | `fi.md` | Finnish | Suomi |
22
22
  | `fr.md` | French | Français |
@@ -63,7 +63,7 @@ When adding this tag to an article, [comments](#comments) should also be added t
63
63
 
64
64
  *Note: Avoid translating English articles with this tag. If the English article has this tag, the translation must also have this tag.*
65
65
 
66
- Translated articles that are outdated must use the `outdated` tag when the English variant is updated. English articles may also become outdated when the content they contain is misleading or no longer relevant. This tag must be written as shown below:
66
+ English articles may become outdated when the content they contain is misleading or no longer relevant. These should receive an `outdated` tag, which must be written as shown below:
67
67
 
68
68
  ```yaml
69
69
  outdated: true
@@ -71,6 +71,20 @@ outdated: true
71
71
 
72
72
  When adding this tag to an article, [comments](#comments) should also be added to explain what needs to be updated to remove the tag.
73
73
 
74
+ ### Outdated translations
75
+
76
+ Translated articles that are outdated must use the `outdated_translation` tag when the English variant is updated, except for minor wording, grammar changes, and the like, that do not affect the meaning of the article.
77
+
78
+ ```yaml
79
+ outdated_translation: true
80
+ ```
81
+
82
+ When outdating translations, they must also receive an `outdated_since` tag that points to the first commit where the English version is updated.
83
+
84
+ ```yaml
85
+ outdated_since: 29eac89cd535f8b071ca000af8fe4f0be22bdc9b
86
+ ```
87
+
74
88
  ### Tagging articles
75
89
 
76
90
  Tags help the website's search engine query articles better. Tags should be written in the same language as the article and include the original list of tags. Tags should use lowercase letters where applicable.
@@ -284,7 +298,7 @@ The first occurrence of an abbreviation, acronym, or initialism may be italicise
284
298
 
285
299
  Italics may also be used to provide emphasis or help with readability.
286
300
 
287
- Names of work or video games should be italicised. osu!—the game—is exempt from this.
301
+ Names of work or video games should be italicised. osu! — the game is exempt from this.
288
302
 
289
303
  As an example, when referring to songs in the format of `{artist} - {title}`, the whole part is a reference to the work and should therefore be italicised:
290
304
 
@@ -324,8 +338,7 @@ Headings must not exceed a heading level of 5 and must not be used to style or f
324
338
 
325
339
  ### Titles
326
340
 
327
- *See also: [Article naming](#article-naming)*
328
-
341
+ *See also: [Article naming](#article-naming)*\
329
342
  *Caution: Titles are parsed as plain text; they must not be escaped.*
330
343
 
331
344
  The first heading in all articles must be a level 1 heading, being the article's title. All headings afterwards must be [section headings](#sections). Titles must not contain formatting, links, or images.
@@ -505,6 +518,8 @@ Preformatted text (also known as code blocks) must be fenced using three grave m
505
518
 
506
519
  ## Links
507
520
 
521
+ *See also: [Footnotes](#footnotes)*
522
+
508
523
  There are two types of links: inline and reference. Inline has two styles.
509
524
 
510
525
  The following is an example of both inline styles:
@@ -652,6 +667,8 @@ There are two types of image links: inline and reference. Examples:
652
667
 
653
668
  Images should use the inline linking style. Reference link definitions must be placed at the bottom of the article.
654
669
 
670
+ All block images on the page (that have nothing else on the same line) are combined into a single gallery, which can be navigated using arrow icons on both sides of the screen, keyboard shortcuts, or screen swipes on mobile devices<!-- https://github.com/ppy/osu-web/pull/8126 -->.
671
+
655
672
  ### Alternative and title text
656
673
 
657
674
  The text in the first pair of square brackets (*alternative text*) should describe the image literally. It is used by screen readers or when the image fails to load. It can be omitted if it is identical to the title text or if the image is included only for decorative purposes.
@@ -662,9 +679,9 @@ The text in the quotation marks (*title text*) should give additional context to
662
679
 
663
680
  If an image is the sole content of a paragraph, it displays as a centred block. Otherwise, it flows with the surrounding inline text.
664
681
 
665
- Block images with title text display the title text as a caption below the image.
682
+ Block images with title text display the title text as a caption below the image. Avoid adding [HTML comment](#comments) or any other text on the same line as the image, as this will cause the caption not to be rendered.
666
683
 
667
- Block images are commonly paired with infobox<!-- TODO: link me! --> formatting to reduce their initial size and float them to the side of other content:
684
+ Block images are commonly paired with [infobox](#infoboxes) formatting to reduce their initial size and float them to the side of other content:
668
685
 
669
686
  ```markdown
670
687
  ::: Infobox
@@ -746,25 +763,15 @@ You must set these settings before taking a screenshot of the game client (setti
746
763
 
747
764
  Images must not be part of a link text.
748
765
 
749
- Flag icons next to user links must be separate from the link text. See the following example:
750
-
751
- ```markdown
752
- ![][flag_AU] [peppy](https://osu.ppy.sh/users/2)
753
- ```
766
+ ## Flag icons
754
767
 
755
- ### Flag icons
756
-
757
- *For a list of flag icons, see: [issue \#328](https://github.com/ppy/osu-wiki/issues/328)*
758
-
759
- The flag icons use the two letter code (in all capital letters) and end with `.gif`. When adding a flag inline, use this format:
768
+ The flag icons use the two letter code (in all capital letters) to match a certain territory. When adding a flag inline, use this format:
760
769
 
761
770
  ```markdown
762
- ![](/wiki/shared/flag/xx.gif)
771
+ ::{ flag=XX }::
763
772
  ```
764
773
 
765
- Where `xx` is the [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) two-lettered country code for the flag.
766
-
767
- The full country name should be added in the title text. The country code in the alternate text is optional, but must be applied to all flag icons in the article.
774
+ Where `XX` is the [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) two-lettered country code for the flag.
768
775
 
769
776
  ## Tables
770
777
 
@@ -792,9 +799,87 @@ The following is an example of what a table should look like:
792
799
  | Maria | No Contest | Mocha | |
793
800
  ```
794
801
 
802
+ ## Infoboxes
803
+
804
+ An infobox is a fixed-width block which is aligned to the right side of the article. It may contain a relevant image, which explains the surrounding text, or a block of navigation that links to other articles from the same category.
805
+
806
+ Example use, rendered on the right:
807
+
808
+ <!-- The real infobox is added for illustrative purposes, with Markdown syntax duplicated below for clarity. -->
809
+
810
+ ::: Infobox
811
+ ![](/wiki/shared/mods/SD.png "Sudden Death mod icon")
812
+ :::
813
+
814
+ ```markdown
815
+ ::: Infobox
816
+ ![](/wiki/shared/mods/SD.png "Sudden Death mod icon")
817
+ :::
818
+ ```
819
+
820
+ Infoboxes should be used with caution in the following cases:
821
+
822
+ - Short sections: the next section's heading appears below any infoboxes, leaving a large gap after the text.
823
+ - Several images at once: instead, use individual infoboxes for better design.
824
+
825
+ ## Footnotes
826
+
827
+ Footnotes are short notes located at the end of the page. They are used for citing sources, or providing background information that would otherwise disrupt the flow of the article. Footnotes may contain text formatting and links.
828
+
829
+ In the osu! wiki, footnotes are implemented using special syntax (`[^identifier]`). Footnotes can use any identifier, but they will automatically be rendered as superscripts with increasing numbers in order of their first appearance. Translations must not modify identifiers of footnotes.
830
+
831
+ Footnote references are placed directly after the words, phrases, or sentences they explain, with no space in between. These references must be placed after punctuation, except for parentheses, when they pertain to the contents inside, and dashes.<!-- Taken from https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation_and_footnotes -->
832
+
833
+ The footnotes themselves must be placed in a separate second-level heading at the end of the article. Depending on the content, the heading used may be `References`, `Notes`, or `Notes and references`.
834
+
835
+ Correct usage examples:
836
+
837
+ ```markdown
838
+ The osu! wiki is a project that was meant to replace the old FAQ system.[^wiki-faq] It was named after the rhythm game osu![^osu] and the largest open online encyclopedia, Wikipedia. From the very start, it had attracted skillful translators[^wiki-tl] and editors.
839
+
840
+ ## References
841
+
842
+ [^wiki-faq]: https://osu.ppy.sh/community/forums/topics/68525
843
+ [^wiki-tl]: https://osu.ppy.sh/community/forums/posts/1177500
844
+ [^osu]: https://osu.ppy.sh/community/forums/posts/1178153
845
+ ```
846
+
847
+ ### Citations
848
+
849
+ Citations, or references, are used to identify a source of information. Citations via footnotes should be preferred over inline links.
850
+
851
+ References should whenever applicable specify author, date, service/platform, and title. The exact format may vary depending on the referenced material with a preference for brevity.
852
+
853
+ Examples:
854
+
855
+ ```markdown
856
+ The first version of the osu!api was made available on July 2, 2013.[^api-first-usage] It had received critical acclaim from users.[^api-praise] A new version of API, released several years later, contains many more capabilities.[^api-v2-2020] Endpoint versioning is common among web APIs.[^web-api]
857
+
858
+ ## References
859
+
860
+ [^api-first-usage]: [Forum thread by peppy (2013-07-02) "osu!api open beta"](https://osu.ppy.sh/community/forums/posts/2403913)
861
+ [^api-praise]: [Forum post by Menchi (2013-11-02) in "osu!api open beta"](https://osu.ppy.sh/community/forums/posts/2662247)
862
+ [^api-v2-2020]: [Tweet by @ppy (2020-03-20)](https://twitter.com/ppy/status/1263083636363948032)
863
+ [^web-api]: ["Web API" on Wikipedia](https://en.wikipedia.org/wiki/Web_API)
864
+ ```
865
+
866
+ ### Notes
867
+
868
+ Footnotes may be used for storing explanations or tangential remarks which cannot be inlined without worsening the article's readability, or are less significant than the article itself. Such footnotes may use free-form text.
869
+
870
+ Example:
871
+
872
+ ```markdown
873
+ A tournament must not be organised and run by an inexperienced team of unaccomplished and irreputable staff.[^staff]
874
+
875
+ ## Notes
876
+
877
+ [^staff]: An *inexperienced* staff member is loosely defined as someone who has been playing osu! for less than an hour in total.
878
+ ```
879
+
795
880
  ## Blockquotes
796
881
 
797
- The blockquote is limited to quoting text from someone. It must not be used to format text otherwise. The name of the quoted person that follows the quote must be prepended by an em dash (`—`) as follows:
882
+ The blockquote is limited to [quoting someone or something](/wiki/Article_styling_criteria/Writing#block-quotation). It must not be used to format text otherwise.
798
883
 
799
884
  ```markdown
800
885
  > plz enjoy game