Path of Exile Wiki talk:Manual of Style: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
(Modified proposed Lists and Tables section to discuss Template:List-only article)
(→‎Template usage: new section)
Line 41: Line 41:
**When viewed on its own this way, the list-only article will show an explanation, an optional link to an article explaining the concept behind the list, and the list itself.
**When viewed on its own this way, the list-only article will show an explanation, an optional link to an article explaining the concept behind the list, and the list itself.
**Or another article can incorporate the list itself -- without the explanation or the link -- by using transclusion:<br /><code><nowiki>{{:List of Delve encounters}}</nowiki></code>
**Or another article can incorporate the list itself -- without the explanation or the link -- by using transclusion:<br /><code><nowiki>{{:List of Delve encounters}}</nowiki></code>
== Template usage ==
Please provide guidance on some of the other style templates and their usage (e.g. "Path of Exile specific editing") or provide an explicit link to [[Help:Templates]]:
* [[Template:Tip]]
* [[Template:Warning]]
There are a lot of them.  I'm not even sure how to query a comprehensive list or which are more important.

Revision as of 20:57, 4 January 2023

Capitalise Proper Nouns And Special Words

To be consistent with in-game text, use capital letters for proper nouns and other special words where possible.

e.g.: Cursed Enemies you Kill have a 1% chance to Explode, dealing a quarter of their maximum Life as Chaos Damage.

—The preceding unsigned comment was added by Niightblade‎ (talkcontribs)

Niightblade(t) — Apologies, I assumed there was already a consensus on this, based on the discussion here: Archive_6#Naming_scheme_for_items.
Niightblade(t) — Any objections/feedback?
I can agree on when quoting stat text like that example seems to be. I probably would like it to be styled with {{c}} as well or just use {{ml}} instead. But I don't think it should be necessary for general text. Unlike the game the wiki has a great way of indicating special meaning already and that's wikilinks. --Illviljan (talk) 12:46, 8 September 2019 (UTC)
Niightblade(t) — Ok, so just to be clear, you're saying general text that isn't wikilinked or otherwise marked-up should not need to use caps at all? Or just words that aren't proper nouns?

Considerations

  • Most pages already conform to this guideline (as far as I can tell).
  • May need to update the wording to show that the focus of this guideline is more toward general text with no special markup or wikilinks (my example text isn't ideal).

Proposed new section:Lists and tables

The nature of this wiki leads to lots of long lists and tables of data. I think we should have some advice on how to keep the articles readable. Proposed text follows; make changes boldly. :)

  • Articles often include lists of items, skills, modifiers, etc. These lists provide invaluable data. But when an article includes multiple lists, and especially when the article mixes long lists and tables with other information, readability and navigability can suffer.

Managing articles that include long lists or tables

  • Consider the needs of the reader. Some readers may want to pore over every bit of the list. Others may just want to understand the concept(s) you're discussing, without wading into the detail. Your goal should be to let both of them read and navigate the article effectively.
    • If you don't see how that can be done, that's often a good sign that the article itself is too complex, and needs to be split into smaller and more digestible articles.
  • Articles that discuss several concepts, and that includes one or more lists or tables after the discussion of each concept, can be particularly problematic. A reader that doesn't care about the detail in the tables will still need to scroll past them to read the discussions of the contexts.
  • In some cases, putting the lists or tables into sections that are collapsible or collapsed by default -- using the {{cot}} tag, for example -- can help. But bear in mind that collapsible sections are difficult to deal with on some browsers, and particularly by readers who use accessibility features in their browsers. And for articles with multiple lists and tables, collapsing those tables by default can introduce the opposite problem; now a reader who wants to absorb all the details must expand all the tables.
  • Putting all the lists and tables at the bottom of the article can benefit the less detail-oriented reader by letting them just read the other information at the top. But it can inconvenience the more detail-oriented reader by making them jump back and forth.

Create list-only articles for lists and tables

  • It's often a good idea to put individual lists and tables -- especially long ones, and ones that may need to be used in multiple places -- into their own articles. This lets readers read them individually, and lets other articles either link to the list or transclude it, whichever works better for each article.
  • It's best to only include one list or table in each article. If you want readers to be able to read lots of lists in one browser page, create another article that transcludes all the individual list articles that you want to combine.
  • Use the {{List-only article}} template for these articles. It takes care of a lot of details of making the article work well both when it's read on its own and when it's transcluded into a larger article. It also automatically puts the article into Category:List-only articles so that other editors can find and use it. See the [[Template:List-only article/doc|documentation.
  • If understanding the list requires explanation of a concept, don't explain the concept in the list-only article. Find or create an article explaining the concept, and add that article's title to the {{List-only article}} template.
  • For example, here is what you would add at the beginning of a "List of Delve encounters" list-only article:
    {{List-only article|subject=encounters that can occur at the end of a Delve|article=Delve}}.
    • Now another article can link to this list-only article in the usual way:
      [[List of Delve encounters]]
    • Or a reader can find it in the search box.
    • When viewed on its own this way, the list-only article will show an explanation, an optional link to an article explaining the concept behind the list, and the list itself.
    • Or another article can incorporate the list itself -- without the explanation or the link -- by using transclusion:
      {{:List of Delve encounters}}

Template usage

Please provide guidance on some of the other style templates and their usage (e.g. "Path of Exile specific editing") or provide an explicit link to Help:Templates:

There are a lot of them. I'm not even sure how to query a comprehensive list or which are more important.