All The Tropes:Style Guide: Difference between revisions

(42 intermediate revisions by 2 users not shown)
Line 1:
{{cleanup|This document provides inconsistent formatting advice, with some examples assuming the now-deactivated visual interfaceeditor and others assuming the source code interfaceeditor. WeVisual editor examples need to settlebe onrewritten onefor andthe make sure it's used everywhere. (Or provide instructions forsource ''both''editor.) }}
{{shortcut|ATT:STYLE}}This page documents the house style for [[All The Tropes:About|All The Tropes]]. If you have a question about how to write and present information, you should find answers here.<ref>If you don't find a relevant answer here, please ask [[User:Robkelk]], who is by default in charge of All The Tropes's documentation.</ref>
 
Line 13:
 
== The Basics ==
All The Tropes aims to present a casual but reliable image. Please write in the third person, without using [[Sesquipedalian Loquaciousness]] or being formal. (This is a wiki, not a classroom.)
 
Short paragraphs are good for showing a casual style. If people have to read through a [[Wall of Text]], most of them will give up partway through. "Casual" includes knowing when to give people a chance to catch their breath.
Line 22:
 
Please also use italics, not all-caps, for emphasis. Since the days of [[UseNet]], all-caps has meant "shouting" on the 'net, and most people avoid shouting in casual conversation.
 
Also, be aware that we have a number of templates used to insert standard markup into trope pages, like the examples and tropelist banners and the top-of-page elements specific to the various page types. Many of these will be automatically inserted into pages created in the Trope Workshop or with the ATT Page creator, but there are others which you can use to add features to your pages which will automatically conform to this guide. If you want to find out more about these, and learn what other templates might be available to you, see our page [[All The Tropes:Our Custom Templates]].
 
=== Adding Examples to Tropes ===
When you add an example to a trope page, take care to put it in the proper section. Don't, for example, add an item for a film to an example for the book that inspired it just because they are related works. Put the new example under "Film" (and make sure it links to the page for that film, and not the book or a disambiguation page).
 
If there isn't a section for the particular kind of media your example comes from, feel free to add it! (We have a [[Template:Media Headers|standard list of media types]] we're trying to make sure is used everywhere, consult it if you need help.) Oh, and if you do add a new section, do make sure it's in proper alphabetical order ''vis-à-vis'' the other sections on the page. ("Other Media" and "Real Life" go at the end of the list, however, out of alphabetical order. Some tropes may have a "General" or "Meta" section; this will go at the top ''before'' the other sections. Occasionally a [[Trope Namer]] or [[Trope Codifier]] will be so substantial and/or influential that it, too, will get its own section at the top.)
 
If your example is an elaboration or another instance of the trope in a work that already has an entry in an existing section, that's something that sometimes gets called a "subexample" around here. Feel free to add it as a secondary bullet point under the "main" example.
 
If you're adding an entirely new example to an existing section, put it at the end of the section. (This is to make it easier for readers to find new material.) If you just drop it in at the top (or worse, at random in the middle for no good reason), an admin will probably move it to the end of the section within a day or so, so it'll end up there anyway, so why not start with it in the right place?
 
Some pages, by their nature, do not have sections -- either they are tropes specific to a particular medium, or they are medium-specific subpages of example-overloaded tropes. In these cases, add your example to the bottom of the page. (Yes, we know that many of these are alphabetized; they came that way from TV Tropes. However, we feel that ease of finding new entries outweighs the aesthetic value of an alphabetized page.)
 
Make sure your example is properly marked up -- the work name should be a link and emphasized as is proper for the kind of work it is (see the other sections on this page for what you need to do if you don't already know). ''Do'' make sure you're linking to the right page, not a redirect, a disambiguation page, or a page for a different version of the work (or a different work entirely that has the same name). ''Don't'' bury the link to the work in a pothole on a character name or phrase that will not be obvious to the casual reader or viewer who might not know the work, or which will fall out of common knowledge in five or ten years.<ref>The wiki's content is old enough that this is a ''constant'' problem -- few people these days remember the main character or key catch phrase of the hot new show of 2005, for example. Or even what that hot new show ''was''.</ref>
 
For more information on how to write a good example, see [[All The Tropes:How to Write An Example|How to Write An Example]].
Line 45 ⟶ 47:
Let's take this one part at a time.
 
First, there's an asterisk. This creates the bullet point that sets the new trope off from its neighbors. It's followed by a space to improve the readability of the page source.
 
Second, the trope name, surrounded by double square brackets. The brackets turn the name into a link as noted elsewhere. If when you save the page this is a [[Red Link]], you've done something wrong -- either you've used a trope that doesn't exist on this site<ref>Not uncommon when the editor is a recent refugee from [[TV Tropes]]</ref>, you misspelled something, or you got the capitalization wrong. We have a hints system that pops up a progressive list of possible links for you in the upper right corner of the edit window; make use of that to avoid problems. It's also a good idea to make sure the link you're using is the actual name of the trope you want,<ref>Which is another thing that sometimes trips up recent refugees from TV Tropes. For example, our page about [[sobriquet]]s is called "Sobriquet", not "Red Baron". Our page Red Baron is about the [[Red Baron]]. Similarly, our page [[Mata Hari]] is about the woman who used that name, while the character type can be found under [[Seductive Spy]].</ref> and not a redirect, a disambiguation page, or a work. (We have more than a few works whose titles ''sound'' like trope names; every once in a while a mod has to remove a trope entry that points to one of them.)
 
Immediately after the trope link is a colon (":"). Don't forget it, or you may get a little note from a mod or another user who's had to go in and add them to your work. Don't use dashes or long dashes or anything else here. And it, too, gets followed by a space -- that's a general punctuation rule, not just for readability here.
 
Finally, the explanation of how the trope applies to the work. This is ''mandatory''. [[Zero Context Example]]s are subject to deletion. Work pages with nothing but Zero Context Examples are themselves subject to deletion if no one chooses to rescue them.<ref>Assuming we have time. Usually they just get tagged with {{tl|trope list needs context}}, which puts them onto [[:Category:Trope list needs context|this "cleanup" list]].</ref> One of the most valid criticisms of troping is that what we do is nothing but mindless cataloguing. If you don't explain how the trope functions (and why) in this work, then you're confirming that criticism. Put thought into writing a description that not only explains where in a work the trope is found, but how it works as a part of the story, and what makes it important.
 
Finally, your trope should be inserted in proper alphabetical order. Most of the time this should be obvious if you're a frequent user of the Latin alphabet, but there are edge situtationssituations and unclear cases. If you need help, see "Alphabetization", below, or our page [[All The Tropes:How to Alphabetize Things|How to Alphabetize Things]].
 
And if you think we're belaboring things here by going into absurd levels of detail... well, no, we're not. Over the years we have had to clean up after literally hundreds of users who couldn't even look at the other trope entries on a page to see how things were done, and just dumped in plain text apparently thinking everything else would be done for them by magic -- or because they thought the [[Wiki Magic]] exists to save them the trouble. Don't be like them.
Line 62 ⟶ 64:
* Capitalize all major words, and both words in hyphenated compounds.
* Always capitalize the first word of a title, and any word after a colon or dash.
* Conjunctions (and/, but, or/, nor), articles (a, an, the), and short prepositions (on, in, to, by, for, at, of, as, etc.) should be lowercased.
* Longer prepositions (4four or more letters) should be capitalized (with, from, whereas, etc.).
 
Capitalization of page titles for [[works]] should match the original marketing as nearly as possible -- and preferably the English-language marketing. (If you're uncertain, copying the page name Wikipedia uses is usually safe, plus it will make the Wikipedia tab found in the "work" and "creator" page templates work perfectly.)
Line 77 ⟶ 79:
 
== Page boilerplate ==
We have a [[All The Tropes:Page Templates|large selection of boilerplates]] that you canshould use to make a new page look like other pages on All The Tropes.
 
Typically, you'll find something appropriate in the dropdown menu that appears above the edit window when you create a page, or it will preload when you select something from the Add Page menu. But if that doesn't work, you'll find something on [[All The Tropes:Creating a Page by Hand]] that you can use to do things the hard way.
 
== External Links ==
First off, for users new to MediaWiki, external links are formed in the source editor with single square brackets, and a space separating the URL from the link text. For example, <code><nowiki>[https://www.example.com This is an example]</nowiki></code> results in [https://www.example.com This is an example].
 
That said, how to use them:
 
[[Pothole]]s are good, while [[sinkhole]]s are bad.
 
Line 90 ⟶ 96:
To summarize:
* https://www.example.com, without any markup at all, looks like crap;
* [https://www.example.com] or [https://www.example.com here] isare bad and exclude people with accessibility issues;
* [https://www.example.com example] is better;
* [https://www.example.com This is an example] is best.
 
Potholing ''part'' of a word is an accessibility sin, especially if different parts of the same word are potholed to different links. Not only is it difficult for somebody with less-than-perfect motor control to select a small target link in the middle of other links, it looks bad in the default wiki interface because the wiki flags external links. Multiple external links in a single word can make the word [https://www.example.com un][https://www.example.org read][https://www.example.net a][https://www.example.com ble], so don't do it.
Finally, don't link to TV Tropes for any reason. Some of the staff there still go into frothing apoplexy at the very thought of All The Tropes' mere existence, and we don't want to stress the poor simple dears any more than they already are. If we absolutely need to link to TV Tropes (such as on the work page for that site), a mod has already done so.
 
Finally, '''don't link to TV Tropes for ''any'' reason'''. Some of the staff there still go into frothing apoplexy at the very thought of All The Tropes' mere existence, and we don't want to stress the poor simple dears any more than they already are. If we absolutely need to link to TV Tropes (such as on the work page for that site), a mod has already done so. If you want to list a trope they have and we don't, which you think is absolutely indispensable, create your own version of it in the [[:Category:Trope Workshop|Trope Workshop]] and link to ''that'' when it passes muster. And ''don't'' link to a TV Tropes page because you can't be bothered to find the page here because it's been renamed or we've capitalized or punctuated it differently.<ref>Don't laugh. This has happened.</ref>
 
== Internal Links (Wicks) ==
Again, for those unfamiliar with MediaWiki, some notes on markup. Most importantly MediaWiki does not use [[CamelCase]] for its page names, and thus for its links. MediaWiki page names allow spaces, almost all punctuation, and non-English characters -- and to turn a page name into a link, just put it as-is in double square brackets (<code><nowiki>[[</nowiki></code> and <code><nowiki>]]</nowiki></code>) when using the source editor. If you want to add a pothole or link text, you separate it from the link itself with a vertical bar ("|"). So, for instance, a link to the classic British comedy series ''[['Allo 'Allo!]]'' would be coded <code><nowiki>[['Allo 'Allo!]]</nowiki></code>. But if you wanted to pothole it to the text "that classic British series", you would code it like so: <code><nowiki>[['Allo 'Allo!|that classic British series]]</nowiki></code>, which produces "[['Allo 'Allo!|that classic British series]]".
When it comes to links to other pages on the wiki, the guidelines are a little different -- and for the most part, looser, mainly because you can't make an internal link quite as confusing or unintelligible as an external link can be without really ''working'' at it.<ref>No, that is not a challenge.</ref>
 
WhenThat said, when it comes to links to other pages on the wiki, the guidelines are a little different -- and for the most part, looser, mainly because you can't make an internal link quite as confusing or unintelligible as an external link can be without really ''working'' at it.<ref>No, that is not a challenge.</ref>
 
The only real style requirements exist for work names. Wherever possible, the first occurrence of a work name in an example or a description should also be a link. This requires that you use the name of a work as it appears on the work page, matching punctuation and capitalization exactly. That's usually not to hard to determine -- if you don't already know it off the top of your head, you can use the wiki's search function to find it. (However, always click through a search result. You may have found a disambiguation or franchise page or a redirect and not the actual work page; clicking through will make sure you get to the right name, eventually.)
 
Once you have the right name, insert it into your edit with the appropriate markup. Right off the bat, of course, it should be in link markup, (<code><nowiki>[[</nowiki></code>as anddescribed <code><nowiki>]]</nowiki></code>)above. Of course, we don't have a page for every existing work on the wiki. But even if there isn't a page for it here, we still want the work name to be a link -- it might inspire another troper to write that page. So even if you can't find a page, mark up the work name as a link anyway.
Of course, we don't have a page for every existing work on the wiki. But even if there isn't a page for it here, we still want the work name to be a link -- it might inspire another troper to write that page. So if you can't find a page, mark up the work name as a link anyway.
 
Most work names should then be put italics markup (two single quotes/apostrophes before and after the link markup). There are exceptions to this -- short stories, individual songs, and other short-format works get double quotes instead of italics -- but in general italics are a safe choice.
 
Sometimes you might think it's necessary (or more attractive) to use a pothole with a work name. For instance, the ''[[HarryThe Hitchhiker's Guide to the PotterGalaxy]]'' novels are all described on subpages under [[HarryThe Hitchhiker's Guide to the PotterGalaxy]], like ''[[HarryThe Hitchhiker's Guide to the PotterGalaxy/HarrySo PotterLong, andAnd TheThanks Philosopher'sFor All The StoneFish]]''; potholing that link to ''[[HarryThe Hitchhiker's Guide to the PotterGalaxy/HarrySo PotterLong, andAnd TheThanks Philosopher'sFor StoneAll The Fish|HarrySo PotterLong, andAnd TheThanks Philosopher'sFor All The StoneFish]]'' just looks better. Go ahead and do that. Just be careful not to misspell or otherwise mangle the work name in the pothole. And once more, if you're not sure how to code a pothole, the markup is <code><nowiki>[[link|pothole text]]</nowiki></code> -- the link, a vertical bar, and then the text you want to have go to that link.
 
While you can pothole a plural version of a page name, you don't need to. Both <code><nowiki>[[Gasshole|Gassholes]]</nowiki></code> and <code><nowiki>[[Gasshole]]s</nowiki></code> create the link [[Gasshole]]s, and the shorter version is easier to read in the source editor.
 
Again, [[Pothole]]s are good, while [[sinkhole]]s are bad. Potholes and Sinkholes where different parts of ''the same word'' link to different pages are horrid - there's no way for a casual reader to know (or even suspect) that there's more than one link in the word. Unless you happen to take advantage of the wiki's color-coded internal links, but then it looks [[It Gets Worse|rid]][[From Bad to Worse|icul]][[It Got Worse|ous.]] It's also an [http://blogaccessibility.com/sin-2-of-inaccessible-blogs-using-consecutive-one-worded-links/ accessibility sin].
Line 117 ⟶ 128:
 
== Section Headers ==
MediaWiki is capable of displaying five levels of headers, analogous to HTML's "H2" through "H6". (The equivalent to H1 is reserved for page titles.) To mark text as a section header of a given level, put that many equals signs in a row before and after the text, with a single space before and after the header text. Also, there should be nothing else on a line that has header text.
 
The headers are designed to be "nested"; that is, an H2 should come before the H3s that are subsets of the same topic, an H3 should come before the H4s that are subsets of the same subtopic, and so on. While you won't break the wiki by ignoring this, not nesting the headers as expected does nasty things to some screen-reader software and thus limits how much of the wiki blind people can access. Besides, it looks ugly. (Due to a bug in our import software back in 2013, a lot of pages were brought in with their header levels ''inverted''. Almost all of them have been fixed over the ensuing years, but occasionally one pops up that we missed (especially in Characters subpages); if you come across one of these, please fix it!)
Line 132 ⟶ 143:
** Punctuation and other symbols (#, @, etc.) that appear after the first character come after the space but before numerals.
* Numerals (0-9) come after symbols and before letters.
* It should go without saying, but the order is ''not'' case-sensitive. "AA" comes before "ab"; "aa" comes before "AB".<ref>The Windows application "Notepad++" will ignore this rule if you choose the wrong sort operation. If you copy text to Notepad++ and sort it there, make sure you use one of the "Ignoring Case" options; otherwise you'll need to fix the sort before copying it back to the wiki.</ref>
* Finally, ignore leading articles ("a", "an" and "the"). This means [[The Cape (trope)]] will sort between [[Can't Argue with Elves]] and [[Car Bomb]].
 
Line 151 ⟶ 162:
Any kind of emphasis you want to make should default to ''mixed or lower case in italics''. Italics markup, as noted elsewhere on this page, is accomplished with two single quotes/apostrophes before and after the text to be emphasized.
 
Also, please don't use '''boldface''' (generated with three single quotes) for emphasis. Bold text should be reserved for emphasis within block-quotes that are already in italics and for minor subheads in the main text. Also, the first time a work page mentions the work's name in its description text, the name should be marked up in bold ''and'' italics (unless it's a short story or a single song, in which case it should be in boldface and quotes).<ref>If you can't find the page's title in the description, add a [[Title Drop]]. Do not boldface the page's name in the tropelist or the example list.</ref> There are almost no other cases when boldface is an appropriate style choice, and boldface plus italics should ''never'' be used for emphasis because it's nearly as bad as ALL CAPS.<ref>Okay, there are a few rare instances where it could be used, such as an escalating series of emphasis (like, "Bad. ''Bad.'' '''''Bad!'''''"). But just because you don't think italics by themselves cut it? No. Don't.</ref>
 
There are situations where you will want to put an apostrophe immediately after a word in italics, in order to indicate a possessive. This puts three apostrophes in a row, which is the markup for boldface text. In order to prevent the three apostrophes from being treated as boldface markup, put the third apostrophe in double braces, like so: {{tl|'}}. (The "nowiki" markup used on other wikis should not be used on All The Tropes as a matter of wiki style.) ''We have become aware that the visual editor does not follow the wiki's style in this case.''
Line 173 ⟶ 184:
 
== Numbers and Numerals ==
We follow the [https://www.chicagomanualofstyle.org/home.html Chicago Manual of Style] when it comes to numerals and numbers. The default Chicago style for numbers one through one hundred is to spell them out. Use numerals for 101 and larger numbers. Also use numerals for years, times and percentages.
 
When writing [[w:Ordinal numeral|ordinal numeral]]s, do not abbreviate: "first", not "1st"; "second", not "2nd".
Line 181 ⟶ 192:
Do not use fractions as words -- spell out "half" or "one-half", for example, instead of using "1/2".
 
However, when referring to seasons or episodes of a show -- "[[Star Trek: The Original Series/Recap/S3|Season 3]] of ''[[Star Trek: The Original Series]]''", "[[RWBY/Recap/V02/E12 Breach|V2E12]] of ''[[RWBY]]''" -- numerals should be used.
 
In all cases if the title of a work employs a usage that conflicts with these style rules (for instance, ''[[Nineteen Eighty-Four (Literature)|Nineteen Eighty-Four]]'' by George Orwell, the film ''[[42nd Street]]'', or the manga ''[[Ranma ½]]''), we do ''not'' correct the title.
 
== Footnotes ==
Line 223 ⟶ 234:
 
Don't put quotation marks around the lines of dialogue, or put them in italics.
 
Also! Don't "translate" prose into dialogue format by stripping out everything in the passage except what people said. Just quote the whole passage, as described below.
 
=== Song Lyrics and Poetry ===