Difference between revisions of "Resources Naming Conventions"

From BtS Wiki
Jump to navigation Jump to search
m
Line 59: Line 59:
 
* New Player Guide
 
* New Player Guide
  
===Files===
+
===[[Special:ListFiles|Files]]===
 
Files should generally be named as a single file name, without spaces, where each word starts with a capital letter. Names should be short but descriptive. A list of all files can be found [[Special:ListFiles|here]].
 
Files should generally be named as a single file name, without spaces, where each word starts with a capital letter. Names should be short but descriptive. A list of all files can be found [[Special:ListFiles|here]].
  

Revision as of 20:18, 17 February 2013

IN DEVELOPMENT


The following conventions should be used as a guide when naming pages on the Beyond the Sunset Wiki.

Below are the naming conventions for pages based on their purpose and level within the clubs structure (starting from the characters to National level). The convention is listed next to each title, where "Page" represents the sections name.

For example "Domain Genre Page" would be the domain name, followed by the genre name and lastly the section name. Where the a page for the list of characters in the Sydney Vampire the Requiem game would have a name of Sydney Requiem Characters.

In general page names should be full words, rather than abbreviations or acronym, unless it is a commonly used term (such as IC, OOC, DC, VST, BTS) or would otherwise be unsuitable to have the full word. Each word is to start with a capital letter with the remaining letters in lower case, unless it is required such as for acronyms or character names.

  • Domains should be the city name in full (e.g. Canberra or Sydney).
  • Genres should be the unique name in full (e.g. Forsaken or Requiem).

Character/Lineage (Page)

These pages are for characters, lineages and any other IC group. Consideration should be made for other characters, so the full name (with title, first name and/or last name) should be used when available. Creating a page for a character called John Smith named 'John' may not be available or would restrict others, so 'John Smith' or 'Brother John' may be a better option.

Examples:

  • Arlington Family
  • Doubting Thomas
  • Father Constantine
  • Patrick Lucan

Venue Level Page (Domain Genre Page)

Venue level pages that are used for the local games, covering pages for characters, locations, IC history and even the VSS (Venue Style Sheet).

Examples:

  • Armidale Lost VSS
  • Canberra Masquerade History
  • Perth Forsaken Locations
  • Sydney Requiem Characters
  • Sydney Requiem Reset Characters

Domain Level Pages (Domain Page)

Domain level pages relating to administration or other non-in-game related purposes, covering position holders, game locations, position holders or DSS (Domain Style Sheet).

Examples:

  • Melbourne DSS
  • National Council
  • Perth Venue Locations
  • Sydney Position Holders

National Level Categories (Category: Page or Genre Page)

National pages that are used as categories (listed at the bottom of each page) and cover genre groups (clans, lodges), mechanics, powers or any other categories. These pages can have body content (which cold describe the in-character group or power) and list all pages that have this category. References to these pages can be [[::Carthian Movement]] or [[Carthian Movement]] (if there is a redirection). The alternative is to have a normal page (as that below).

Examples:

  • Category: Autumn Court
  • Category: Carthian Movement
  • Category: Cruiac
  • Category: Dominate (dual page, covering both Masquarade and Requiem)
  • Category: Nosferatu (dual page, covering both Masquarade and Requiem)

National Level General Page (Page)

National pages that are not used as categories and cover national guides, player references and general information pages. The alternative is to have a 'Category' page (above).

Examples:

  • Character Development Document
  • Cruiac Guide
  • Resources Images
  • New Player Guide

Files

Files should generally be named as a single file name, without spaces, where each word starts with a capital letter. Names should be short but descriptive. A list of all files can be found here.

Common images are those for use by all and relate to genres or groups within a genre. The naming convention is to follow a hierarchy of keywords to help with identification.

  • Genre - the unique name of the genre for the image.
  • Name - the actual identifier for the image.
  • Size - inclusion of a size reference, where this should only be included to help differentiate between multiple files.
    • Pixel reference such as 70 (70x70px) and 100 (100x100px).
    • Comparative reference such as 'Small' or 'Large' if there are two versions.

Examples:

  • 'LostSkull' - skull logo for Changeling the Lost.
  • 'RequiemCarthianMovement' - logo for the Carthian Movement.
  • 'RequiemVentrue70' - 70px logo fr the Ventrue if there is also a 100px version.

Unique images are those for particular pages, whether they be for characters, groups or venues. These are files that are not likely to be used by others. Naming is up to the user, so long as they are short but descriptive. Character, groups, or venue names should be used, as an example a file name such as 'CharacterPhoto' does not lend itself to a particular character.

Please note that this was based on a review of existing files.

Reference

Domains

Domain names should be listed as the city name in full, as opposed to their operating names (e.g. Sydney rather than Syd, Harbour of Darkness or HOD).

  • Adelaide
  • Armidale
  • Brisbane
  • Canberra
  • Melbourne
  • Perth
  • Sydney
  • Toowoomba

Genres

The genre name should be listed on pages as the unique name, as opposed to the supernatural types. This will assist in consistency across venues and domains, and avoid confusion between the Old WOD and New WOD settings.

  • Changeling the Lost
  • Mage the Awakening
  • Vampire the Masquerade
  • Vampire the Requiem
  • Werewolf the Apocalypse
  • Werewolf the Forsaken

Redirects

Category pages and normal pages can be redirected to the other. The approach taken is dependant on the usefulness of having information on the category page and the listing of pages within the category. This is easily changed in the future.

As example:

  • The category 'Sydney' is redirected to the Sydney page, as it is a location for general information for the domain and acts as a portal for other pages through its content.
Wiki code for the category: #REDIRECT [[pagename]]
  • The page for Nosferatu is redirected to the 'Nosferatu' category as it will contain information on the clan (with specifics or the Masquerade and Requiem setting) and list all other pages (characters, lineages and powers) that have 'Nosferatu' as a category.
Wiki code for the page: #REDIRECT [[:Category:categoryname]]