Help:Naming Conventions

From BtS Wiki
Revision as of 16:20, 5 April 2013 by Sgryphon (talk | contribs) (Fix heading level for 'Templates')
Jump to navigation Jump to search

Contents | Structure | Naming Conventions | Templates | Editing | Images | Colours

The Help pages are to provide help on the creation and development of pages on the Beyond the Sunset wiki. Please note that all pages are currently under development.


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/Group (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 Page (Genre))

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 (describing the topic) 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).

When there is a conflict between genres (where they have groups or powers of the same name) the genre can be referenced after the name in brackets as this is secondary. The decision on whether to do this is the value in keeping the categories separate, where a group (e.g. clan) may need a separate category whereas a power (e.g. discipline) may not. In this case the main category (without the genre) is to have both options listed, as such requiring another step to access the page should only the main category be referenced. This has yet to be confirmed.

Examples:

  • Category: Autumn Court
  • Category: Carthian Movement
  • Category: Cruac (Requiem)
  • Category: Beasts
  • Category: Dominate (Masquerade)
  • Category: Lancea Sanctum
  • Category: Nosferatu (Masquerade)
  • Category: Nosferatu (Requiem)
Please note that for Vampire some clans and disciplines are cross-genre, where as covenants are not. For this reason all clans and disciplines have the genre after the name in brackets as above.
Powers (e.g. Disciplines) may not require a Category page, where the contents of the page would cover both genres if it is a cross-genre name. Example, Cruac for Requiem only, and Dominate covering both Masquerade and Requiem.
Sub-breed (e.g. Bloodlines) may require a Category page to list the players of that particular sub-breed, alternatively redirecting to the clan page which would list all bloodlines and the known bloodlines of characters.

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
  • Cruac Guide
  • Resources Images
  • New Player Guide

Files

Files should be short but descriptive be named, with spaces, where each word starts with a capital letter. Spaces are required to allow searching, but will be replaced with an underscore '_' when it is to be used. The File List is the best location to search for files.

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 if needed.
  • 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:

  • 'Lost Skull' (Lost_Skull.jpg) - skull logo for Changeling the Lost.
  • 'Requiem Carthian Movement' (Requiem_Carthian_Movement.png) - logo for the Carthian Movement.
  • 'Requiem Ventrue 70' (Requiem_Ventrue_70.gif) - 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 'Character Photo' or 'Chibi' does not lend itself to a particular character.

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

Templates

  • Template names should be short but descriptive, with spaces, where each word starts with a capital letter. Spaces are replaced with an underscore '_' when the template is to be used.
  • Template parameters should be in lower case, with no spaces, e.g. "order", "consiliumstatus", "stemail".

Please note that this was based on recent templates.

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:

Redirection to page

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]]

Redirection to category without genre (not cross-genre)

The page for Carthian Movement is redirected to the 'Carthian Movement' category as it will contain information on the covenant and list all other pages (characters, lineages and powers) that have 'Carthian Movement' as a category. There is no need for the genre (Requiem) as covenants are not cross-genre.

Wiki code for the page: #REDIRECT [[:Category:categoryname]]

Redirection to category with genre (cross-genre)

The page for Nosferatu holds links for both Nosferatu (Masquerade) and Nosferatu (Requiem), where each are redirected to the 'Nosferatu (Masquerade)' and 'Nosferatu (Requiem)' categories. Each separate category contains information on the clan (with specifics or the Masquerade and Requiem setting) and list all other pages (characters, lineages and powers) that have 'Nosferatu (Genre)' as a category. There is a need for genre (Requiem) as some clans are cross-genre.

Wiki code for the page: #REDIRECT [[:Category:categoryname (genre)]]

Searching