This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
brightshore:rules:wiki_guide [2019/11/26 12:18] jude [Character Naming Conventions] |
brightshore:rules:wiki_guide [2020/03/17 16:53] jude |
||
---|---|---|---|
Line 6: | Line 6: | ||
* [[wiki:dokuwiki|DokuWiki How To]] | * [[wiki:dokuwiki|DokuWiki How To]] | ||
* [[wiki:syntax|Wiki Syntax]] | * [[wiki:syntax|Wiki Syntax]] | ||
+ | |||
+ | =====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 ( === ). | ||
=====Link Syntax===== | =====Link Syntax===== | ||
- | 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. 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." | + | 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.) | 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.) | ||
Line 15: | Line 34: | ||
====Character Naming Conventions==== | ====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. | + | 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|brightshore:npcs:sol_hafthorsson]]." | For example, the page for Captain Sol (an NPC) is "[[brightshore:npcs:sol_hafthorsson|brightshore:npcs:sol_hafthorsson]]." | ||
Line 22: | Line 41: | ||
For example, Felfix Triyaris Eiliwyse Newcinder Glory Minmiphi can be found at "[[brightshore:npcs:felfix_minmiphi|brightshore:npcs:felfix_minmiphi]]." | For example, Felfix Triyaris Eiliwyse Newcinder Glory Minmiphi can be found at "[[brightshore:npcs:felfix_minmiphi|brightshore:npcs:felfix_minmiphi]]." | ||
+ | |||
+ | ====In-Text Links==== | ||
+ | |||
+ | 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|brightshore:cultures_factions:stalwart_shield]]." | ||
=====Outline===== | =====Outline===== | ||
Line 35: | Line 60: | ||
* See category page for detailed list. | * See category page for detailed list. | ||
- | [[brightshore:events]]. Lore detailing important events that have occurred (or are believed to have occurred) in the campaign setting, including current events, historical backstory, and myths. | + | [[brightshore: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. | * See category page for detailed list. | ||
Line 47: | Line 72: | ||
* See category page for detailed list. | * See category page for detailed list. | ||
- | [[brightshore:npcs]]. Lore about characters controlled by DMs. Does not include the DMs' player characters, which are found in the "pcs" category instead. | + | [[brightshore: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. | * See category page for detailed list. | ||
+ | |||
+ | [[brightshore:objects]]. Lore about important objects in the Brightshore campaign. | ||
+ | * See category page for detailed list. | ||
+ | |||
+ | [[brightshore: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_area:other_worlds|DM version of this page]] includes more extensive information.) | ||
[[brightshore:pantheon]]. Information about the four main gods in the campaign setting and their temples. | [[brightshore:pantheon]]. Information about the four main gods in the campaign setting and their temples. | ||
- | * [[brightshore:pantheon:ava]]. Goddess of fire, summer, destruction, and creativity. | + | * See category page for detailed list. |
- | * [[brightshore:pantheon:menran]]. God of wind, autumn, chaos, and fortune. | + | |
- | * [[brightshore:pantheon:olteus]]. God of water, spring, life, and healing. | + | |
- | * [[brightshore:pantheon:unre]]. Goddess of stone, winter, law, and death. | + | |
[[brightshore:pcs]]. Information about player characters, including PCs controlled by DMs. | [[brightshore:pcs]]. Information about player characters, including PCs controlled by DMs. | ||
* See category page for detailed list. | * See category page for detailed list. | ||
- | |||
- | [[brightshore:planes]]. Information about lore outside of the Material Plane in this campaign setting. (Note: There is not much information here as lore on the other planes is sparse at the moment. The [[dm_area:planes|DM version of this page]] includes more extensive information.) | ||
[[brightshore:rules]]. Rules for player conduct and resolving common in-game actions not covered in the D&D sourcebooks. | [[brightshore:rules]]. Rules for player conduct and resolving common in-game actions not covered in the D&D sourcebooks. | ||
- | * [[brightshore:rules:businesses]]. How to create and operate a player business in the game. | + | |
- | * [[brightshore:rules:character_creation]]. How to create a character for this campaign. | + | * See category page for detailed list. |
- | * [[brightshore:rules:downtime]]. How to calculate and spend downtime days between adventures. | + | |
- | * [[brightshore:rules:drafts]]. Rough drafts of rules before they become formalized. | + | |
- | * [[brightshore:rules:player_conduct]]. Rules regarding player behavior at the table and on social media. | + | |
- | * [[brightshore:rules:property]]. How to acquire and maintain player property in the game. | + | |
- | * [[brightshore:rules:reclaiming_ruins]]. How to clear, hold, and develop areas of the ruins near Brightshore. | + | |
- | * [[brightshore:rules:wiki]]. (This page.) Guidelines for editing the wiki. | + | |
[[brightshore:town]]. Lore about the town in general. Pages under this category detail the town's 8 districts. | [[brightshore:town]]. Lore about the town in general. Pages under this category detail the town's 8 districts. | ||
- | * [[brightshore:town:crossroads_district]]. | ||
- | * [[brightshore:town:dockyards_district]]. | ||
- | * [[brightshore:town:gate_district]]. | ||
- | * [[brightshore:town:market_district]]. | ||
- | * [[brightshore:town:park_district]]. | ||
- | * [[brightshore:town:temple_district]]. | ||
- | * [[brightshore:town:tower_district]]. | ||
+ | * See category page for detailed list. | ||
[[brightshore:weavers]]. A page for each of the 7 World Weavers (founding DMs) of the Brightshore campaign. | [[brightshore:weavers]]. A page for each of the 7 World Weavers (founding DMs) of the Brightshore campaign. | ||
- | * [[brightshore:weavers:davidson]]. | ||
- | * [[brightshore:weavers:james]]. | ||
- | * [[brightshore:weavers:jude]]. | ||
- | * [[brightshore:weavers:mark]]. | ||
- | * [[brightshore:weavers:marty]]. | ||
- | * [[brightshore:weavers:shaun]]. | ||
- | * [[brightshore:weavers:rebecca]]. | ||
- | =====Headings===== | + | * See category page for detailed list. |
- | ====Page Title==== | + | =====DM Wiki===== |
- | 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. | + | When creating a page for the [[:dm_area|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. |
- | ====Section Headings==== | + | For example, [[dm_area:npcs:armastus|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|brightshore:npcs:armastus]]. |
- | 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. | + | 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. |
- | ====Subsection Headings==== | + | 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. |
- | 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 ( === ). | + |