Help:Style guide - Revision history

Tark: Sync

2024-06-25T03:03:47Z

Sync

Headquarter8302: /* Unique cases */

2020-06-19T08:06:07Z

Unique cases

← Older revision		Revision as of 08:06, 19 June 2020
Line 104:		Line 104:
	In order to avoid ambiguity, certain considerations should be followed for specific topics and words.		In order to avoid ambiguity, certain considerations should be followed for specific topics and words.

	*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "~~hit~~ mouse1 to fire a blue portal" would be more appropriately phrased "~~fire~~ a blue portal (default key mouse1 on PC, left trigger on XBox 360, R1 on PS3)" or, if recently described with key bindings already, simply "~~fire~~ a blue portal."		*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "Hit mouse1 to fire a blue portal" would be more appropriately phrased "Fire a blue portal (default key mouse1 on PC, left trigger on XBox 360, R1 on PS3)" or, if recently described with key bindings already, simply "Fire a blue portal."

	== See also ==		== See also ==

I-ghost: /* Portal Wiki */

2011-08-26T18:02:52Z

Portal Wiki

← Older revision		Revision as of 18:02, 26 August 2011
Line 73:		Line 73:

	;Short hand: Portal Wiki		;Short hand: Portal Wiki
	;Long hand: ~~Ppoorrttaall Wwiikkii~~		;Long hand: The Unofficial Portal Wiki

	===Classes, items, and terms===		===Classes, items, and terms===

Kazikg: /* Unique cases */

2011-06-18T03:39:07Z

Unique cases

← Older revision		Revision as of 03:39, 18 June 2011
Line 104:		Line 104:
	In order to avoid ambiguity, certain considerations should be followed for specific topics and words.		In order to avoid ambiguity, certain considerations should be followed for specific topics and words.

	*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "hit mouse1 to fire a blue portal" would be more appropriately phrased "fire a blue portal (default key mouse1 on PC, left trigger on XBox 360, L2 on PS3)" or, if recently described with key bindings already, simply "fire a blue portal."		*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "hit mouse1 to fire a blue portal" would be more appropriately phrased "fire a blue portal (default key mouse1 on PC, left trigger on XBox 360, R1 on PS3)" or, if recently described with key bindings already, simply "fire a blue portal."

	== See also ==		== See also ==

RJackson: /* Specific wording */ + Co-op bots re: gender wording.

2011-05-01T18:44:36Z

Specific wording: + Co-op bots re: gender wording.

← Older revision		Revision as of 18:44, 1 May 2011
Line 96:		Line 96:
	<!--Unsure how to adapt the following to Portal series. <br />		<!--Unsure how to adapt the following to Portal series. <br />
	Many strategies will be impossible to cite, so use judgment. The best strategy entries will apply universally and will not require enemy players to be stupid, inexperienced or foolish. For example, strategies requiring deception are poor advice because they will never work against excellent players. Success in general can be a poor measuring stick, since any strategy will work against sufficiently poor enemies. Give advice that would succeed against the best possible foes.-->		Many strategies will be impossible to cite, so use judgment. The best strategy entries will apply universally and will not require enemy players to be stupid, inexperienced or foolish. For example, strategies requiring deception are poor advice because they will never work against excellent players. Success in general can be a poor measuring stick, since any strategy will work against sufficiently poor enemies. Give advice that would succeed against the best possible foes.-->

			=== [[Co-op]] bots ===
			[[Atlas]] and [[P-body]] are designed to appear masculine and feminine, respectively; these are traits and not an identification of gender. As such, when referring to the bots the terms ''he'', ''she'' and variants thereof should be avoided.

	===Unique cases===		===Unique cases===
Line 102:		Line 105:

	*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "hit mouse1 to fire a blue portal" would be more appropriately phrased "fire a blue portal (default key mouse1 on PC, left trigger on XBox 360, L2 on PS3)" or, if recently described with key bindings already, simply "fire a blue portal."		*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "hit mouse1 to fire a blue portal" would be more appropriately phrased "fire a blue portal (default key mouse1 on PC, left trigger on XBox 360, L2 on PS3)" or, if recently described with key bindings already, simply "fire a blue portal."

	~~<!--Can below text be used for anything else?<br />~~
	*'''"Pipe bomb":''' The phrase "pipe bomb" and similar terms should be avoided. Many players think of the [[Grenade Launcher]] upon reading the phrase, while game coding uses the phrase "pipes" to describe [[Sticky Bomb Launcher\|stickies]]. For example, phrases like "pipes do not suffer damage fall-off" and "use cloak to get past pipes" would be more appropriately phrased "Grenades do not suffer damage fall-off" and "use cloak to get past Stickies."-->

	== See also ==		== See also ==

Alex2539: /* General writing style */ Switched out some TF2 stuff to Portal stuff

2011-04-25T07:30:26Z

General writing style: Switched out some TF2 stuff to Portal stuff

← Older revision		Revision as of 07:30, 25 April 2011
Line 42:		Line 42:
	*Emoticons - :)		*Emoticons - :)
	*Excessive punctuation - !!!		*Excessive punctuation - !!!
	*Sentences starting with lowercase - "place the ~~sentry~~ in the corner"		*Sentences starting with lowercase - "place the portal in the corner"

	===Overlinking and underlinking===		===Overlinking and underlinking===
Line 55:		Line 55:
	The guidelines for linking are:		The guidelines for linking are:
	*No more than 10 percent of the words in an article are contained in links.		*No more than 10 percent of the words in an article are contained in links.
	*Two links should not be next to each other in the text, so that it looks like one link - such as [[~~Spy\|Spy's~~]] [[~~disguise~~]].		*Two links should not be next to each other in the text, so that it looks like one link - such as [[Aperture Science]] [[Material Emancipation Grill]].
	*Links for any single term should not be excessively repeated in the same article. Excessive linking is more than once for the same term, in a line or a paragraph, which will almost certainly appear needlessly on the viewer's screen. Remember, the purpose of links is to direct the reader to a new spot at the point(s) where the reader is most likely to take a temporary detour due to needing more information.		*Links for any single term should not be excessively repeated in the same article. Excessive linking is more than once for the same term, in a line or a paragraph, which will almost certainly appear needlessly on the viewer's screen. Remember, the purpose of links is to direct the reader to a new spot at the point(s) where the reader is most likely to take a temporary detour due to needing more information.
	*Duplicating an important link distant from a previous occurrence in an article may well be appropriate. If an important term appears many times in a long article, but is only linked once at the very beginning of the article, it may actually be underlinked. Indeed, readers who jump directly to a subsection of interest must still be able to find a link. But take care in fixing such problems, the distance between duplicate links is an editor's preference, however if in doubt duplicate the term further down the article.		*Duplicating an important link distant from a previous occurrence in an article may well be appropriate. If an important term appears many times in a long article, but is only linked once at the very beginning of the article, it may actually be underlinked. Indeed, readers who jump directly to a subsection of interest must still be able to find a link. But take care in fixing such problems, the distance between duplicate links is an editor's preference, however if in doubt duplicate the term further down the article.

RJackson: /* Classes, items, and terms */ Mentioned exempting "Aperture Science" prefix from object names.

2011-04-25T05:33:40Z

Classes, items, and terms: Mentioned exempting "Aperture Science" prefix from object names.

← Older revision		Revision as of 05:33, 25 April 2011
Line 77:		Line 77:
	===Classes, items, and terms===		===Classes, items, and terms===
	{{rewrite}}		{{rewrite}}
	Names of the ''Portal'' [[Characters]] will generally be capitalized ([[Chell]], [[GLaDOS]], etc). Normally English nouns within a sentence are lowercased (atlas and p-body); however, when referred to within the context of ''Portal'', they are treated as [[Wikipedia:Noun#Proper nouns and common nouns\|proper nouns]] and thus capitalized. Words and abbreviations of specific names should be capitalized unless referring to things that have become general types ~~(see health example below)~~. This will also apply to names of [[Cubes]], [[Items]] and terms (''see [[:Category:Glossary\|glossary]]'') within ''Portal'', however if the name has more than one word, any successive words should be title-cased.		Names of the ''Portal'' [[Characters]] will generally be capitalized ([[Chell]], [[GLaDOS]], etc). Normally English nouns within a sentence are lowercased (atlas and p-body); however, when referred to within the context of ''Portal'', they are treated as [[Wikipedia:Noun#Proper nouns and common nouns\|proper nouns]] and thus capitalized. Words and abbreviations of specific names should be capitalized unless referring to things that have become general types. This will also apply to names of [[Cubes]], [[Items]] and terms (''see [[:Category:Glossary\|glossary]]'') within ''Portal'', however if the name has more than one word, any successive words should be title-cased.

			In the case of items prefixed with "Aperture Science", for example: "Aperture Science Handheld Portal Device", we require the "Aperture Science" be exempt from the article name and references to the object of topic. The correct version of the above example would be: "Handheld Portal Device".

	Also keep in mind to avoid using and including unnecessary definite articles. For instance, avoid creating pages with titles such as; "The Enrichment Centre" etcetera. Instead use titles such as the following; "Enrichment Centre" etcetera.		Also keep in mind to avoid using and including unnecessary definite articles. For instance, avoid creating pages with titles such as; "The Enrichment Centre" etcetera. Instead use titles such as the following; "Enrichment Centre" etcetera.

Darkstar516: Changing TF refrences to Portal refrences.

2011-04-23T18:15:28Z

Changing TF refrences to Portal refrences.

← Older revision		Revision as of 18:15, 23 April 2011
Line 99:		Line 99:
	In order to avoid ambiguity, certain considerations should be followed for specific topics and words.		In order to avoid ambiguity, certain considerations should be followed for specific topics and words.

	*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "hit ~~mouse2 and sneak around them~~" would be more appropriately phrased "~~sneak around them by using cloak~~ (default key ~~mouse2~~ on PC, left trigger on XBox 360, L2 on PS3)" or, if recently described with key bindings already, simply "~~sneak around them by using cloak~~."		*'''"Binds":''' Many players don't play on PC, and even those that do often times don't use default key assignments. References to commands should refer to those commands in simple, bind-neutral terms, including default key assignments only as extra information (possibly added in parentheses, and not repeated at additional mentions of the same command within the article). For example, "hit mouse1 to fire a blue portal" would be more appropriately phrased "fire a blue portal (default key mouse1 on PC, left trigger on XBox 360, L2 on PS3)" or, if recently described with key bindings already, simply "fire a blue portal."
	*'''"Pipe bomb":''' The phrase "pipe bomb" and similar terms should be avoided. Many players think of the [[Grenade Launcher]] upon reading the phrase, while game coding uses the phrase "pipes" to describe [[Sticky Bomb Launcher\|stickies]]. For example, phrases like "pipes do not suffer damage fall-off" and "use cloak to get past pipes" would be more appropriately phrased "Grenades do not suffer damage fall-off" and "use cloak to get past Stickies."
	*'''"Primary" and "Secondary" weapons''': ''Team Fortress 2'' is inconsistent in the ordering of weapons, particularly those of [[Demoman]] and [[Spy]]. Using the phrases "primary" and "secondary" to describe their weapons should be avoided. For example, "switch to primary weapon to fight nearby enemies" would be more appropriately phrased "switch to Grenade Launcher to fight nearby enemies."		<!--Can below text be used for anything else?<br />
			*'''"Pipe bomb":''' The phrase "pipe bomb" and similar terms should be avoided. Many players think of the [[Grenade Launcher]] upon reading the phrase, while game coding uses the phrase "pipes" to describe [[Sticky Bomb Launcher\|stickies]]. For example, phrases like "pipes do not suffer damage fall-off" and "use cloak to get past pipes" would be more appropriately phrased "Grenades do not suffer damage fall-off" and "use cloak to get past Stickies."-->

	== See also ==		== See also ==

Darkstar516: /* Strategy pages */

2011-04-23T18:10:05Z

Strategy pages

← Older revision		Revision as of 18:10, 23 April 2011
Line 92:		Line 92:
	Strategy pages contain advice instead of neutral statements about gameplay, so writing "you," giving commands, being accurate and being brief are preferred to encyclopedic language. Whenever applicable, the scope of a strategy should be specified. In some cases, this will require phrases that are normally weasel words, such as "probably" and "on occasion."		Strategy pages contain advice instead of neutral statements about gameplay, so writing "you," giving commands, being accurate and being brief are preferred to encyclopedic language. Whenever applicable, the scope of a strategy should be specified. In some cases, this will require phrases that are normally weasel words, such as "probably" and "on occasion."

	Many strategies will be impossible to cite, so use judgment. The best strategy entries will apply universally and will not require enemy players to be stupid, inexperienced or foolish. For example, strategies requiring deception are poor advice because they will never work against excellent players. Success in general can be a poor measuring stick, since any strategy will work against sufficiently poor enemies. Give advice that would succeed against the best possible foes.		<!--Unsure how to adapt the following to Portal series. <br />
			Many strategies will be impossible to cite, so use judgment. The best strategy entries will apply universally and will not require enemy players to be stupid, inexperienced or foolish. For example, strategies requiring deception are poor advice because they will never work against excellent players. Success in general can be a poor measuring stick, since any strategy will work against sufficiently poor enemies. Give advice that would succeed against the best possible foes.-->

	===Unique cases===		===Unique cases===

Darkstar516: Changing TF refrences to Portal refrences.

2011-04-23T18:05:12Z

Changing TF refrences to Portal refrences.

← Older revision		Revision as of 18:05, 23 April 2011
Line 87:		Line 87:

	===Patches===		===Patches===
	When adding data that has been recently changed or added via patch, do not add a note stating that it was added on the '[Date] Patch' but write as if the new data was always the norm, unless the old data is somehow relevant. This is to avoid pages that talk about "recently patched data" which is now years old, as well as articles that have long sections of outdated information followed by "However this was patched and now does not work". ~~Team Fortress 2~~ is constantly being patched and updated, and changes to aspects of the game become all too frequent to mention specifically.		When adding data that has been recently changed or added via patch, do not add a note stating that it was added on the '[Date] Patch' but write as if the new data was always the norm, unless the old data is somehow relevant. This is to avoid pages that talk about "recently patched data" which is now years old, as well as articles that have long sections of outdated information followed by "However this was patched and now does not work". The Portal series is constantly being patched and updated, and changes to aspects of the game become all too frequent to mention specifically.

	===Strategy pages===		===Strategy pages===