YPPedia:Style guide

From YPPedia
(Redirected from Style guide)

Defer questions of style to Style and How-to directories. If you're new to the wiki way, take a look at Notes for New Users for some useful links.

Article Names

Everything should follow:

Pirate articles need to follow YPPedia policies in regards to creation/content and article names should be in-game capitalization (First letter capitalized and no spaces) such that a person could /who <articlename>.

File Names

Uploaded files should be named clearly and plainly. All images should have the appropriate image tag included in the file description. For images created by the YPP community, please follow the following naming conventions:

  • Avatar-Artistname-filename - used for images used as avatars on the YPP Forums.
  • Art-Artistname-filename - used for images that are uploaded as fan art or entries for artistic contests not including the portrait background contests. Artistname should be replaced with the forum or account name of the artist and filename is the original name of the file.
  • Building-Ocean-Buildingname-Islandname - used for building images. Islandname is only used if the building name appears more than once on the same ocean.
  • Crews-crewname - used for portrait images illustrating crew articles.
  • Event-eventname-filename - used for images needed for event articles.
  • Flags-flagname - used for portrait images illustrating flag articles.
  • GCPP-codename-filename - used for images illustrating Grand Crafting Puzzle Project entries.
  • Monthly_artistname_file_name - used for images that are uploaded as entries for the Portrait Background Contest. Artistname should be replaced with the pirate name of the artist and file_name is the original name of the file.
  • Pirates-piratename - used for portrait images illustrating pirate articles.
  • Puzzle-puzzlename-filename - used for puzzling images.
  • Tutorial-tutorialname-filename - used for images illustrating tutorials.

Categories

Link to the appropriate categories page at the bottom of an article. For example, insert [[Category:Midnight Ocean pirates]] at the bottom an article about a pirate from the Midnight Ocean.

  • Commodities are Category:Commodities (see the category page for subcategories)
  • Crews should use the {{Infobox crew}} (Usage) template to add the appropriate category to the page.
  • Flags will be added to the proper categories using the {{Infobox flag}} (Usage) template.
  • Buildings should use the {{Infobox building}} (Usage) template to add page to the appropriate category.
  • Pirates should use the {{Oceans}} (Usage) template to note the oceans on which they play.

Capitalization

When referring to a puzzle as a noun, it should be capitalized. Other forms (verbs, gerunds, etc.) should be lower-case. Hearts, spades, and poker should be lower-case. If the puzzle is the first word in a sentence, it should be capitalized. Examples:

  • He is navigating the ship.
  • She enjoys the Navigation puzzle.
  • They were playing hearts.

Pirate names should be capitalized as they are in-game. The first letter is capitalized and the rest are lower-case. Crew, flag, and shoppe names should be capitalized exactly as they are in-game, no matter how unusual.

The word "atlantean" should be lowercase when referring to the atlantean shade of blue found in clothing and trinkets as in, "The pirate won an atlantean spiky coral." It should be capitalized when used to describe the source of the item as in, "The pirate won an Atlantean trinket." To avoid ambiguity, both of those sentences could be rewritten as, "The pirate won an atlantean-colored spiky coral," and "The pirate won a trinket from Atlantis."

Sample Pages

Because many pages contain information about similar topics, editors have created sample pages of these that can be used as a basis, without having to remember so many templates and formatting styles. These pages are guides only, and need not be used exactly. A good page layout always fits the information it provides.

Templates

How To for templates: Wikipedia:Help:Template

(for comments on individual templates go to their discussion pages)

Everyday Infoboxes

These infoboxes are used on everyday articles about flags, crews, buildings and pirates. Refer to the accompanying "Use" page for instructions on how to use them.

Main Page & YPPedia Namespace Pages

WARNING: These templates feed the main page of YPPedia and vandalism on these pages is NOT taken lightly.

General

  • {{CobCriVir}} (Usage) - for Cobalt/Crimson/Viridian disambiguation
  • {{CompactTOC}} (Usage) - for a horizontal, rather than the default vertical, table of contents.
  • {{CompactTOC2}} (Usage) - for a horizontal table of contents (also contains anchors to see also and external links sections).
  • {{Disambig}} - notice for disambiguation pages
  • {{Fn}} (Usage) - footnotes
  • {{Release}} (Usage) - for release date links (see the comment inside the template for more information).
  • {{Release-beta}} (Usage) - for Beta release date links (see the comment inside the template for more information).
  • {{Release-alpha}} (Usage) - for Alpha release date links (see the comment inside the template for more information).
  • {{Technical issue}} (Usage) - for technical issues
  • {{TOCright}} (Usage) - to create a right-aligned table of contents (see example at Midnight blockade history).
  • {{wrongtitle}} (Usage) - to indicate a title which cannot be properly replicated due to technical limitations

Comments

  • {{Cleanup}} (Usage) - for articles that need to be cleaned up to a higher standard of quality.
  • {{Cleanupfor}} (Usage) - for providing a more information on areas that need cleaning.
  • {{Disputed}} (Usage) - for articles that contain factual inaccuracies or questionable statements with no references.
  • {{Dubious}} (Usage) - this should be used in conjunction with {{Disputed}} (Usage); insert the template after the dubious statement. Voice your opinion on the article's talk page.
  • {{Lowres}} (Usage) - for images whose resolution makes it unsuitable.
  • {{Indevelopment}} (Usage) - for templates currently in development; a 'template in beta' message
  • {{Inuse}} (Usage) - for articles currently undergoing a major edit by an editor; you can also use {{Inusefor}} (Usage) or {{Inuseuntil}} (Usage) as necessary.
  • {{NPOV}} (Usage) - for articles (likely flag or island histories) where a neutral point of view may not be present.
  • {{Testing}} (Usage) - for things being tested on Ice that haven't been implemented yet.
  • {{Third person}} (Usage) - for articles that need to be rewritten in third person.

Article/Image Sources

For a complete list of image tags, please see YPPedia:Image tags.

  • {{Contestentry}} (Usage) - Artist attribution notice for fan art images entered in contests.
  • {{Fanart}} (Usage) - Artist attribution notice for fan art images.
  • {{Avatar}} (Usage) - Artist and user attribution for avatars used on the YPP forums.

Static Infoboxes

These infoboxes are used for more static pages. The information contained in these infoboxes rarely changes, if ever.

Blockades, Islands, Commods, Buildings

Puzzles

Charts

  • Chart - creating charts and maps

Inventory Navigational Templates

Deletion

  • Various assorted templates for marking pages for deletion can be found under deletion.

Language

  • Various templates for languages on user pages can be found at Help:Language.
  • The template for adding language templates to the Help:Language page is {{Languages}} (Usage) (see instructions on talk page).
  • The template for adding language boxes like the one seen at Category:User es can be found at {{UsersSpeak}} (Usage) (see instructions on talk page).

Stubs

  • {{buildingstub}} (Usage) - For building articles that need fleshing out.
  • {{crewstub}} (Usage) - For crew articles that need fleshing out.
  • {{flagstub}} (Usage) - For flag articles that need fleshing out.
  • {{piratestub}} (Usage) - For pirate articles that need fleshing out.
  • {{sectstub}} (Usage) - For sections of articles that need fleshing out.
  • {{stub}} (Usage) - For other articles that need fleshing out.

Warnings for talk pages

These templates should be used with the subst: keyword preceding the template name. This copies the text to the including page, rather than transcluding it.

  • {{Butchery Crew}} (Usage) - For warning people to mark a crew page as defunct, rather than blanking (Works for flag pages as well)
  • {{Butchery Pirate}} (Usage) - For warning people to mark a pirate page as defunct, rather than blanking.
  • {{Frequency}} (Usage) - For cases of unusually frequent article editing, rather than previewing.
  • {{Test}} (Usage) - For lightly warning people for vandalism.
  • {{Test2}} (Usage) - For a second vandalism warning.
  • {{Test3}} (Usage) - For a third vandalism warning.
  • {{Test4}} (Usage) - For a fourth and final vandalism warning, not to be taken lightly.
  • {{Test explain}} (Usage) - Allows adding of extra explanation to the standard test template.
  • {{Trophy warning}} (Usage) - For warning people for editing the trophy page without consensus being reached on the forums.

See also

Retrieved from "https://yppedia.puzzlepirates.com/index.php?title=YPPedia:Style_guide&oldid=679215"