User Tools

Site Tools


Action disabled: source
brightshore:rules:wiki_guide

Wiki Editors' Guide

This guide will help us to keep our pages looking consistent.

Helpful Resources

Headings

Page Title

The first line of each page should be the title for the whole page. Without a title, it's easy for users to get confused about what page they've ended up at, depending on the link they followed.

Use 6 equals signs ( ====== ) before and after the title.

Section Headings

Each major heading on the page should have 5 equals signs ( ===== ) before and after it.

This will automatically generate a Table of Contents at the top of the page, with a link for each heading. This makes it easier for users to navigate the page.

Subsection Headings

If you need to create smaller subsections within a major section, simply use descending numbers of equals signs for each subsection level.

For example, a subsection within a major section would have 4 equals signs ( ==== ) before and after it. A “sub-subsection” would have 3 equals signs ( === ).

Each link consists of a “base,” a “category,” and a “page.” Each of these elements is separated by a colon (:) in the link text.

For example, this page's address is brightshore:rules:wiki_guide. The base is “brightshore” (indicating the public player-facing wiki, as opposed to the DM's private “dm_area” base), the category is “rules,” and the page is “wiki_guide.”

Each base and category also has a page of its own. The “brightshore” base page is the wiki welcome page. Currently there is no “rules” category page, but if it did exist, it would contain links to all the rules pages. (Those links are currently contained on the welcome page, so there is no need for a rules page.)

Character Naming Conventions

For NPCs and PCs, the page link should be the character's full known name with an underscore between each word. Do not include any of the character's titles (captain, chancellor, sir, etc.) in the link, unless doing so is the only way to distinguish between two or more different characters with similar names.

For example, the page for Captain Sol (an NPC) is “brightshore:npcs:sol_hafthorsson.”

If the character has a very long name, you can abbreviate.

For example, Felfix Triyaris Eiliwyse Newcinder Glory Minmiphi can be found at “brightshore:npcs:felfix_minmiphi.”

You can make wiki pages more integrated by including in-text links. A good policy to follow is the first time something with a page attached to it is mentioned in the text, include a link to the corresponding page.

For example, if the name “Stalwart Shield” comes up in the text of a page, the first time that happens, turn the text into a link to “brightshore:cultures_factions:stalwart_shield.”

Outline

The public, player-facing “brightshore” wiki is currently laid out according to the following plan of categories and pages. When creating new pages, please stick to the current outline as closely as possible.

council. Information about the past and current government of Brightshore and its customs, laws, and policies.

  • actions. A page for keeping track of official actions the Council has undertaken.
  • calendar. The official calendar of Brightshore adopted by the First Council.
  • laws. The formal laws of Brightshore, enacted and enforced by the Council.

cultures_factions. Lore about the various cultures, guilds, nations, organizations, and races in the Brightshore campaign setting.

  • See category page for detailed list.

events. Lore detailing important events that have occurred (or are believed to have occurred) in the campaign setting, including current events, historical backstory, myths, and rumors.

  • See category page for detailed list.

foreign_lands. Lore about lands outside of the continent of Lorica.

  • See category page for detailed list.

homebrew. Lore and stats regarding custom items and alterations to standard game mechanics that were created for this campaign setting.

  • See category page for detailed list.

lorica. Lore about locations found on the continent of Lorica (but not inside the town of Brightshore itself).

  • See category page for detailed list.

npcs. Lore about characters controlled by DMs. Also includes the DMs' player characters, which are found in the “pcs” category as well.

  • See category page for detailed list.

objects. Lore about important objects in the Brightshore campaign.

  • See category page for detailed list.

other_worlds. Information about worlds beyond the main planet and the Material Plane in this campaign setting. (Note: There is not much information here as not much lore about other worlds has been revealed to the players yet. The DM version of this page includes more extensive information.)

  • See category page for detailed list.

pantheon. Information about the four main gods in the campaign setting and their temples.

  • See category page for detailed list.

pcs. Information about player characters, including PCs controlled by DMs.

  • See category page for detailed list.

rules. Rules for player conduct and resolving common in-game actions not covered in the D&D sourcebooks.

  • See category page for detailed list.

town. Lore about the town in general. Pages under this category detail the town's 8 districts.

  • See category page for detailed list.

weavers. A page for each of the 7 World Weavers (founding DMs) of the Brightshore campaign.

  • See category page for detailed list.

DM Wiki

When creating a page for the DM wiki, try to keep only secret information on the dm_area page and put information that has already been revealed to the players at large on the player-facing page.

For example, dm_area:npcs:armastus includes only information about Armastus that is exclusive DM knowledge. Basic information about the character, such as the fact that he is a vampire and lives in the Dark Forest should be kept on brightshore:npcs:armastus.

In order to make it easier for DMs to navigate back and forth between public information and DM information, it's a good idea to add a link to the player page at the bottom of the DM page and vice versa.

When adding secret information to the wiki, make sure you are editing the “dm_area:” page and not the “brightshore:” page! In order to make it easier to see the difference, it's helpful to include something like “DM Lore” in the title of the DM page.

brightshore/rules/wiki_guide.txt · Last modified: 2020/03/17 16:53 by jude