guide:style
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| guide:style [2017/03/19 09:06] – [Article Content] wes | guide:style [2018/11/09 12:55] – implemented approved update frostjaeger | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Style Guide ====== | ====== Style Guide ====== | ||
| - | 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 ===== | ||
| Line 10: | Line 10: | ||
| - **Each section** of an article should generally contain prose **immediately after any section header**. | - **Each section** of an article should generally contain prose **immediately after any section header**. | ||
| - Articles should be internally consistent. | - Articles should be internally consistent. | ||
| - | - Articles of a common type (such as starships or guns) should adhere to the common format (see [[guide: | + | - Articles of a common type (such as starships or guns) should adhere to the common format (see [[: |
| - **Do not use forced line breaks** unless necessary (such as in a table). | - **Do not use forced line breaks** unless necessary (such as in a table). | ||
| + | - Tables should be used **sparingly** in articles and may not be used to replace parts of a template. | ||
| ===== Article Titles And Section Headings ==== | ===== Article Titles And Section Headings ==== | ||
| Line 27: | Line 28: | ||
| - Titles and section headers should be concise so they don't take up more than one line. | - Titles and section headers should be concise so they don't take up more than one line. | ||
| - Titles should be consistent with page URLs. | - Titles should be consistent with page URLs. | ||
| - | - In general, abbreviations should | + | - Abbreviations may **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 title unless they are part of an organization' | - Do not use an ampersand (&) or other special characters in a title unless they are part of an organization' | ||
| - Leave a space on either side of the title or section heading and a blank line before them. | - Leave a space on either side of the title or section heading and a blank line before them. | ||
| - Headers should be in order: H1 (title) should contain H2 sections, and they should contain H3 sections, etc. | - Headers should be in order: H1 (title) should contain H2 sections, and they should contain H3 sections, etc. | ||
| - | - Ordered lists are preferred to unordered lists. | ||
| ===== Article Content ===== | ===== Article Content ===== | ||
| Line 55: | Line 55: | ||
| ===== Images ===== | ===== Images ===== | ||
| - | Please only use file names that make sense and are easily read. Badly named images make images difficult to find, and they make understanding | + | As of 7/7/2018 the first image on a wiki article must be an image of 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. |
| - | 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' | + | Please only use file names that make sense and are easily read. Badly named images are 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: | In addition: | ||
| - | - Images should be less than 2 MB in size | + | - 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 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: | - 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. | - 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. | - 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) | + | - Use transparent backgrounds so the image looks good in all Dokuwiki templates (styles). |
| - | - We strongly prefer color artwork | + | - We strongly prefer color artwork. |
| ===== Related ===== | ===== Related ===== | ||
| Line 75: | Line 76: | ||
| See also: [[wiki: | See also: [[wiki: | ||
| - | + | ===== OOC Notes ===== | |
| + | [[user: | ||
guide/style.txt · Last modified: 2023/12/20 18:20 by 127.0.0.1