This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
guide:style [2013/10/02 15:38] – wes | guide:style [2023/12/20 18:20] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 2: | Line 2: | ||
The Style Guide is an ongoing attempt to build a reference resource for use by authors of Star Army articles. | The Style Guide is an ongoing attempt to build a reference resource for use by authors of Star Army articles. | ||
- | ==== General Principles ==== | + | ===== General Principles |
- | - **All articles | + | These are the key points for wiki articles: |
- | - All sections of articles should generally contain prose. | + | |
- | - Articles should be internally consistent. | + | |
- | - Articles of a common type (such as starships or guns) should adhere to a common format. | + | |
- | - Don't use force line breaks unless necessary (such as in a table). | + | |
+ | - This wiki's language is English (United States). American spellings are preferred. | ||
+ | - Follow all section headers with text (not images, lists, or tables). | ||
+ | - Use [[guide: | ||
+ | - Anything in a table or list should be very short. | ||
+ | - Don't put paragraphs in tables or bullet lists. | ||
+ | - Do not use forced line breaks unless necessary (such as in a table). | ||
+ | - Articles of a common type (e.g. guns) should adhere to the common format (see [[: | ||
+ | ===== Article Titles And Section Headings ==== | ||
+ | Headers provide structure for wiki pages and divide them into index and easily-read sections. | ||
- | ==== Article Titles And Section Headings === | ||
- ALWAYS title your pages! The first header determined your page title and should generally match the page URL. | - ALWAYS title your pages! The first header determined your page title and should generally match the page URL. | ||
- Article titles should not include " | - Article titles should not include " | ||
+ | - Good: = Yamatai Star Empire = | ||
+ | - Bad: = The Yamatai Star Empire = | ||
- When you create a page, the URL should generally be the same as the title (or a short form), including spaces. Don't create pages with URLs that are all a big blob. | - When you create a page, the URL should generally be the same as the title (or a short form), including spaces. Don't create pages with URLs that are all a big blob. | ||
- | * stararmy: | + | * Good: stararmy: |
- | * stararmy: | + | * Also okay: stararmy: |
+ | * Bad: stararmy: | ||
- On starship classes: The format is Classname-class Shiptype, always with a hypen OR Classname Shiptype. This should be the case in both URL and in article content. Examples: Nozomi-class Scout (GOOD) Plumeria Gunship (GOOD) Nozomi class Scout (BAD!) | - On starship classes: The format is Classname-class Shiptype, always with a hypen OR Classname Shiptype. This should be the case in both URL and in article content. Examples: Nozomi-class Scout (GOOD) Plumeria Gunship (GOOD) Nozomi class Scout (BAD!) | ||
- | - Titles and section headers should be concise. | + | - Titles and section headers should be concise |
- Titles should be consistent with page URLs. | - Titles should be consistent with page URLs. | ||
- In general, abbreviations should not be used as titles (use Imperial Registry Number, not IRN). | - In general, abbreviations should not be used as titles (use Imperial Registry Number, not IRN). | ||
- Article titles should be capitalized but not in all caps. (" | - Article titles should be capitalized but not in all caps. (" | ||
- | | + | - Do not use an ampersand (&) or other special characters in a page name unless they are part of an organization' |
- | | + | - Headers should be properly nested - e.g. H1 (title) should contain H2 sections, and they should contain H3 sections, etc. |
- | - Leave space on either side of the title or section | + | |
+ | ===== Article Content ===== | ||
+ | This section | ||
- | ==== Article Content ==== | ||
- [[guide: | - [[guide: | ||
- Avoid the use of second-person language (you, your) in articles other than instructions for the player. | - Avoid the use of second-person language (you, your) in articles other than instructions for the player. | ||
- | - [[guide: | + | - Use proper plurals |
+ | - In general, keep an encyclopedic tone. | ||
+ | - Occasional jokes and humor are okay. | ||
+ | - You are encouraged to add examples from RP or quotes to add flavor. | ||
- | ==== Links ==== | + | ==== Active Content ===== |
- | - Proper nouns should be linked in their first usage for each page (or major section, if preferred). | + | You can embed active content into your wiki pages. For example, you can place an RSS feed of your plot's posts into your plot wiki page. For more information, |
+ | |||
+ | ===== Links ===== | ||
+ | |||
+ | - Proper nouns should be linked in their first usage for each page (or first use in each major section, if preferred). | ||
- Never use a full URL (starting with http) to link to an internal page when an internal link will do. | - Never use a full URL (starting with http) to link to an internal page when an internal link will do. | ||
- Use spaces rather than underscores in links. | - Use spaces rather than underscores in links. | ||
- " | - " | ||
- | - Don't create pages that are not linked to from other wiki pages (orphans). Create the link first, then follow it and create the page. Stray pages will be deleted! | + | - Don't create pages that are not linked to from other wiki pages ([[wiki: |
- | - If you move a page, first use the backlink link (at the bottom of every wiki page) to see what pages are linking to it. ALL OF THOSE PAGES SHOULD BE UPDATED! If not, you are creating broken links. Do not move a page unless you're willing to do the work of updating all those pages. | + | - Move pages using the page move tool so that backlinks |
- | - Ordered lists are preferred to unordered lists. | + | - Wiki admins can move wiki media/ |
- | ==== Images ==== | + | ===== Images ===== |
- | - Images should be less than 500 KB is size | + | As of 7/7/2018 the first image on a wiki article must be an image about the actual subject of the article. Don't use corporate logos, etc, as the first image on the page. This helps with indexing and page previews. |
- | - Images should be less than 700px wide | + | |
- | - Images should have an alternate text value to help visually impaired people who use page readers. Place a | after the image file name, and then type a short meaningful text description. | + | Please only use file names that make sense and are easily read. Badly named images make images difficult to find, and they make understanding the image difficult or impossible for blind and low-vision roleplayers who have to rely on the text being read to them. |
+ | |||
+ | It is also nice, but not required, to credit the artist in the file name if it was a commission (e.g. hanako_by_zairyo.png) . You can also credit artists on the pages the image is used on, or in the image itself if it doesn' | ||
+ | |||
+ | In addition: | ||
+ | |||
+ | - Images should be less than 2 MB in size | ||
+ | - Images should be less than 700px wide on the wiki article (uploaded images can be larger) | ||
+ | - Images should have an alternate text value to help visually impaired people who use page readers. Place a | after the image file name, and then type a short meaningful text description. | ||
- Only images hosted on Star Army should be used on Star Army wiki pages. Images hosted on third-party sites such as imageshack and photobucket will be edited out of articles. | - Only images hosted on Star Army should be used on Star Army wiki pages. Images hosted on third-party sites such as imageshack and photobucket will be edited out of articles. | ||
+ | - Images must be properly cropped. Huge borders of blank space should be avoided. | ||
+ | - Use transparent backgrounds so the image looks good in all Dokuwiki templates (styles) | ||
+ | - We strongly prefer color artwork | ||
===== Related ===== | ===== Related ===== | ||
+ | See also: [[doku> | ||
+ | |||
See also: [[wiki: | See also: [[wiki: | ||