This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
guide:style [2015/09/29 06:13] – wes | guide:style [2023/12/20 18:20] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 5: | Line 5: | ||
These are the key points for wiki articles: | These are the key points for wiki articles: | ||
- | | + | - This wiki' |
- | | + | - Follow all section headers with text (not images, |
- | - Bulleted | + | - Use [[guide: |
- | - Each section of an article | + | - Anything in a table or list should |
- | - Typically this goes immediately after any section header. | + | - Don't put paragraphs in tables or bullet lists. |
- | - Articles should be internally consistent. | + | - Do not use forced line breaks unless necessary (such as in a table). |
- | - Articles of a common type (such as starships or guns) should adhere to a common format. | + | - Articles of a common type (e.g. guns) should adhere to the common format |
- | - See [[guide: | + | |
- | - Don't use force line breaks unless necessary (such as in a table). | + | |
===== Article Titles And Section Headings ==== | ===== Article Titles And Section Headings ==== | ||
Line 31: | Line 29: | ||
- 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 title unless they are part of an organization' | + | - Do not use an ampersand (&) or other special characters in a page name 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. | + | - Headers should be properly nested - e.g. H1 (title) should contain H2 sections, and they should contain H3 sections, etc. |
- | - Headers should be in order: | + | |
- | - Ordered lists are preferred to unordered lists. | + | |
===== Article Content ===== | ===== Article Content ===== | ||
Line 41: | Line 37: | ||
- [[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. | - In general, keep an encyclopedic tone. | ||
- Occasional jokes and humor are okay. | - Occasional jokes and humor are okay. | ||
- | - It's okay to add examples from RP or quotes to add flavor. | + | - You are encouraged |
+ | |||
+ | ==== 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 ===== | ===== Links ===== | ||
Line 52: | Line 51: | ||
- 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 |
- | - Admins | + | - Wiki admins |
===== Images ===== | ===== 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. |
- | - 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 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: | ||