Difference between revisions of "Help:Style"

The official GemStone IV encyclopedia.
Jump to: navigation, search
(Created page with "This page lays out some of the rough style and layout guidelines we use on this Wiki. The purpose of these isn't to force everyone to look the same, it's to make the informat...")
 
(Created)
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page lays out some of the rough style and layout guidelines we use on this Wiki.  The purpose of these isn't to force everyone to look the same, it's to make the information organized and easier for people to discover, so feel free to object to any you feel don't achieve that goal.
+
This page lays out some of the rough style and layout guidelines we use on this Wiki.  The purpose of these isn't to force everyone to look the same, it's to make the information organized and easier for people to discover
 
 
== NPOV and IUHPOV ==
 
 
 
Articles written for Krakiipedia which are purely mechanical in nature should be written with a Neutral Point of View (NPOV), that is without bias or extensive use of subjective language.  For mechanics articles, this is not generally an issue, as applying bias to mechanics is difficult at best, but the policy should be kept in mind none-the-less.
 
 
 
Example areas of concern include commenting on the usefulness of skills, spells or other mechanical systems in-general or in comparison to others or comparing professions or races, and features there-of, to one another.
 
 
 
Articles on topics not relating purely to mechanics, such as those about people, places and things, should not only be written with adherence to NPOV, but also adhere to an In-Universe Historical Point of View (IUHPOV).
 
 
 
The IUHPOV dictates that articles which fall under it must be ''primarily'' written from the point of view of a person existing in the GemStone game world, and be written in the narrative past tense.  This allows for articles to be built upon in the future with less hassle, and also unifies the overall flow of articles.
 
 
 
Articles which fall under IUHPOV, but could or should include information that is considered out-of-character, such as directly-related mechanics or mechanical constructs, may include a section titled Behind the Scenes, using <nowiki>== Behind the Scenes==</nowiki>, below which the IUHPOV does not apply and information may be presented from a player perspective.  The inclusion of such a section is not mandatory for an article to be considered complete (i.e. not a stub.)
 
 
 
An example of the use of IUHPOV along with a BtS section could be an article about an NPC in a town, where the main article includes information about the character the mechanical NPC represents while the BtS section provides information such as the mechanical description of the NPC in-game, the DESCRIBE or LOOK of the NPC, lists of lazy actions the NPC performs (though these may be expressed in narrative form in the main article), valid ASK options for the NPC, and so forth.
 
 
 
Articles need not be explicitly updated to retroactively adhere to either NPOV or IUHPOV policy, though any editor who makes edits after the institution of this policy should ensure that article meets this requirement.  Articles edited to adhere to NPOV or IUHPOV should include the appropriate term in their edit comment.
 
 
 
== Linking ==
 
 
 
In order to avoid having the text become distracting, articles need only be linked to the first time they are encountered.  Thus, a paragraph that mentions a spell several times need only have the first instance linked.  If it has been a long time (several paragraphs or a screen worth of text) since something was last linked, it can be useful to link it a second time, but it doesn't need to be linked each time it appears.
 
 
 
== Naming ==
 
 
 
Like on [http://en.wikipedia.org Wikipedia], article names should have the first letter capitalized and the remaining words in lowercase (such as [[SGE protocol saved post]]) unless the topic is a proper noun, in which case it should be in title case like usual (such as [[Wehnimer's Landing]]).  The reason for this is so that if you link a title in the middle of a word, the link looks appropriate without any extra massaging.
 
 
 
Similarly, article names should be singular ([[Rogue]] instead of Rogues) unless the item being discussed is always plural (such as the [[Elven Nations]]).
 
 
 
=== Verb names ===
 
 
 
Verb names should be the full name of the verb in capitals followed by (verb), for example the page for the INVENTO verb would be named "INVENTO (verb)".  Remember that verbs are truncated to seven (7) characters in length, for example the verb INVENTORY is in fact INVENTO.  In cases where the intuitive verb name is longer than the actual verb name (such as with INVENTO), there should be a redirect from the intuitive verb name to the real verb name.
 
 
 
See [[Help:Style (verbs)]] for more information on verb entries.
 
 
 
=== Skill names ===
 
 
 
Skill names should be the full name of the skill in title case.
 
 
 
See [[Help:Style (skills)]] for more information on skill entries.
 
 
 
=== Spell names ===
 
 
 
Spell names should be the name of the spell followed by the number of the spell in parentheses (such as [[Mana Leech (516)]]).  A redirect page should exist for both the spell number ([[516]]) and the spell name ([[Mana Leech]]).  Spells are proper nouns and thus should be in title case.
 
 
 
See [[Help:Style (spells)]] for more information on spell entries.
 
 
 
== Scripts ==
 
 
 
Scripts can be added to Krakiipedia following these guidelines.
 
 
 
=== Naming ===
 
 
 
Script articles should be named with a descriptive name for the script's function or content followed by the string "(script)".  For example, you might name a script for traveling around the Elven Nations "Elven Nations travel (script)" or a script for getting deeds in the city of Ta'Illistim "Ta'Illistim deeds (script)".
 
 
 
=== Formatting ===
 
 
 
The article should start with the script template as a header (see [[Template:Script]] for details) and be followed with the contents of the script file enclosed within the &lt;pre&gt; and &lt;/pre&gt; HTML elements, which will preserve the formatting of the text (including white space and newlines.)  Inclusion of the template will automatically add the article to [[:Category:Scripts]].
 
 
 
An example of how to format a script article:
 
 
 
&lt;pre&gt;
 
# This is an example script.
 
 
if_1 goto %1%
 
echo Syntax: .example {argument}
 
exit
 
 
option1:
 
echo This is option 1.
 
exit
 
 
labelError:
 
echo The option you entered was not valid.
 
exit
 
&lt;/pre&gt;
 
  
 
== Saved Posts ==
 
== Saved Posts ==
  
Saved posts should be on their own page, which should be just the text of the saved post preceeded by the post date and poster's account and followed by <nowiki>[[Category:Saved Posts]]</nowiki> and possibly other categories which apply.  The saved post template (see [[Template:Saved-post]] for details) simplifies this process, as well as automatically including the article in the Saved Posts category.
+
Saved posts should be on their own page, which should be just the text of the saved post followed by <nowiki>[[Category:Saved Posts]]</nowiki>, and possibly other categories which apply.  Saved posts should be named something like "SGE Protocol Saved Post". For pages in which you would like to include a saved post along with other text, put the saved post on its own page and use <nowiki>{{:Topic Saved Post}}</nowiki> to include it in the main article.  See the [[SGE Protocol]] article for an example.
 
 
Saved posts should be named something like "SGE protocol (saved post)", with a title describing the most relevant topic of the post followed by the string "(saved post)", and if there are multiple posts on the same topic, they can be named "Topic 1 (saved post)", "Topic 2 (saved post)", etc..
 
 
 
For pages in which you would like to include a saved post along with other text, put the saved post on its own page and use <nowiki>{{:Topic (saved post)}}</nowiki> to include it in the main article (see the [[SGE protocol]] article for an example).  In other cases, a link at the bottom to any related posts will be sufficient.
 
 
 
== Signatures ==
 
 
 
If you edit an article on Krakiipedia, please refrain from including a signiture (generally using the <nowiki>~~~~</nowiki> Wikitext markup) in the article.  The history feature of MediaWiki does an exemplary job of keeping track of edits and who last edited a particular article.
 
 
 
== Copyrights ==
 
 
 
Remember that if something is written by someone else, they own the [http://en.wikipedia.org/wiki/Copyright copyright] to it, even if there is no copyright notice posted in relation to it.  Unless you have permission from the author, you may not use that text directly.  Most importantly, this includes the official [[Simutronics]] website.
 
 
 
Equally important to remember is that ideas are not copyrighted, only the expression of those ideas.  So just because the Simutronics website has a page on a subject doesn't mean there can't be one here as well.  It does mean that you can't copy portions of the text from that page over to the page here, though.
 
 
 
== Categories ==
 
 
 
When creating new articles, or even updating older ones, please take a moment and check the [[Special:Categories|category list]] and determine if any existing categories are appropriate for the article being edited.
 
 
 
== Tips and tricks ==
 
 
 
See the [[Help:Tips and tricks|tips and tricks]] page for some advanced editing techniques.
 

Revision as of 12:55, 19 December 2005

This page lays out some of the rough style and layout guidelines we use on this Wiki. The purpose of these isn't to force everyone to look the same, it's to make the information organized and easier for people to discover

Saved Posts

Saved posts should be on their own page, which should be just the text of the saved post followed by [[Category:Saved Posts]], and possibly other categories which apply. Saved posts should be named something like "SGE Protocol Saved Post". For pages in which you would like to include a saved post along with other text, put the saved post on its own page and use {{:Topic Saved Post}} to include it in the main article. See the SGE Protocol article for an example.