This shows you the differences between two versions of the page.
Next revision | Previous revisionLast revisionBoth sides next revision | ||
guide:style [2011/02/03 07:09] – external edit | guide:style [2023/01/21 09:17] – [Links] wes | ||
---|---|---|---|
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. | ||
- | | :!: Work in Progress. Inspired by Wikipedia' | + | ===== General Principles ===== |
+ | These are the key points for wiki articles: | ||
- | ==== General Principles ==== | + | - This wiki's language is English (United States). American spellings are preferred. |
- | | + | |
- | | + | - 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). | ||
+ | | ||
- | ==== Article Titles And Section Headings === | + | ===== Article Titles And Section Headings |
- | * Titles and section headers should be concise. | + | Headers provide structure |
- | * Titles should be consistent with page URLs. | + | |
- | * 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 nouns or noun phrases. | + | |
- | * Article titles should not include " | + | |
- | * Do not use an ampersand (&) or other special characters in a title unless they are part of an organization' | + | |
- | * Leave space on either side of the title or section heading | + | |
- | ==== Article | + | - ALWAYS title your pages! The first header determined your page title and should generally match the page URL. |
- | | + | - Article |
- | * Avoid the use of second-person language | + | - Good: = Yamatai Star Empire |
+ | - Bad: = The Yamatai Star Empire | ||
+ | | ||
+ | * Good: 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!) | ||
+ | - Titles and section headers should be concise so they don't take up more than one line. | ||
+ | - Titles should be consistent with page URLs. | ||
+ | - 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. (" | ||
+ | - 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. | ||
- | ==== Links ==== | + | ===== Article Content ===== |
- | | + | This section covers what kind of content should and should not be in the wiki page. |
- | | + | |
- | | + | - [[guide: |
- | | + | - Avoid the use of second-person language (you, your) in articles other than instructions for the player. |
+ | - 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. | ||
+ | |||
+ | ==== Active Content ===== | ||
+ | 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 ===== | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | - Don't create pages that are not linked to from other wiki pages ([[wiki: | ||
+ | - Move pages using the page move tool so that backlinks are updated. | ||
+ | - Wiki admins can move wiki media/ | ||
+ | |||
+ | ===== Images ===== | ||
+ | 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. | ||
+ | |||
+ | 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. See [[wiki: | ||
+ | - 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 | ||
- | ==== Images ==== | ||
- | * Images should be less than 500 KB is size | ||
- | * 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. eg. |Really cool item | ||
===== Related ===== | ===== Related ===== | ||
+ | See also: [[doku> | ||
+ | |||
See also: [[wiki: | See also: [[wiki: | ||