Difference between revisions of "Best Practices"
Emilyanthony (talk | contribs) |
|||
| (28 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
A comprehensive guide regarding creating articles can be found at [[Wikipedia:Help:Your_first_article]]. | A comprehensive guide regarding creating articles can be found at [[Wikipedia:Help:Your_first_article]]. | ||
| − | =Choosing a Topic= | + | |
| − | ==The beauty of specificity== | + | |
| + | ==Choosing a Topic== | ||
| + | ===The beauty of specificity=== | ||
Entering the rabbithole of a wiki means exploring as deeply as the wiki allows. Short, complete articles about a specific subject are more effective at communicating information than [[wikipedia:War and Peace]] regarding [[Tyres]] (or [[Tires]], if you prefer. They both go to the same place). Write about a small topic first. | Entering the rabbithole of a wiki means exploring as deeply as the wiki allows. Short, complete articles about a specific subject are more effective at communicating information than [[wikipedia:War and Peace]] regarding [[Tyres]] (or [[Tires]], if you prefer. They both go to the same place). Write about a small topic first. | ||
| − | ==Search for an existing article== | + | ===Search for an existing article=== |
There are several ways to do this. The search bar at the top of the page is a good start. In addition, you may browse the categories below: | There are several ways to do this. The search bar at the top of the page is a good start. In addition, you may browse the categories below: | ||
<code>[[:Category:Team]]</code> | <code>[[:Category:Team]]</code> | ||
| − | |||
<code>[[:Category:Competition]]</code> | <code>[[:Category:Competition]]</code> | ||
| − | |||
<code>[[:Category:Vehicle]]</code> | <code>[[:Category:Vehicle]]</code> | ||
Not all articles are categorized (even though they should be). Navigate to [[Special:AllPages]] to see all articles. | Not all articles are categorized (even though they should be). Navigate to [[Special:AllPages]] to see all articles. | ||
| + | |||
| + | |||
==Gather reference information== | ==Gather reference information== | ||
| + | This is not a soapbox. Reinforce the information that you write with references. | ||
===Citations=== | ===Citations=== | ||
There is an extension for this! When you write a paragraph and wish to cite something, use the <code><nowiki><ref>CITATION HERE</ref></nowiki></code> Function. Then, at the bottom of the page (in a "references" or "notes" section), write <code><nowiki><references /></nowiki></code>. It'll spit out everything you've cited above in a footnote format. | There is an extension for this! When you write a paragraph and wish to cite something, use the <code><nowiki><ref>CITATION HERE</ref></nowiki></code> Function. Then, at the bottom of the page (in a "references" or "notes" section), write <code><nowiki><references /></nowiki></code>. It'll spit out everything you've cited above in a footnote format. | ||
| + | |||
====Reference Format==== | ====Reference Format==== | ||
This is [[Wikipedia:APA Style]] formatting. | This is [[Wikipedia:APA Style]] formatting. | ||
| + | |||
| + | |||
{| class="wikitable" style="width: 1028px;" data-mce-style="width: 1028px;" | {| class="wikitable" style="width: 1028px;" data-mce-style="width: 1028px;" | ||
|- | |- | ||
| Line 26: | Line 32: | ||
| style="width: 900.2px;" data-mce-style="width: 900.2px;"|Format | | style="width: 900.2px;" data-mce-style="width: 900.2px;"|Format | ||
|- | |- | ||
| − | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Book | + | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Book |
| style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A. (year). Chapter title. In E. Editor (Ed.).''Title of the book''(pp. page-range). Location: Publisher. | | style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A. (year). Chapter title. In E. Editor (Ed.).''Title of the book''(pp. page-range). Location: Publisher. | ||
|- | |- | ||
| − | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Ebook | + | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Ebook |
| style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A. (year).''Title of the book''(xth ed.) [eBook version]. Location: Publisher. Retrieved from URL | | style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A. (year).''Title of the book''(xth ed.) [eBook version]. Location: Publisher. Retrieved from URL | ||
|- | |- | ||
| − | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Online Journal | + | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Online Journal |
| style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A., & Author, A. A. (year). Title of the article.''Title of the Journal, volume''(issue), page-page. Retrieved from http://www.hompageofjournal.com | | style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A., & Author, A. A. (year). Title of the article.''Title of the Journal, volume''(issue), page-page. Retrieved from http://www.hompageofjournal.com | ||
|- | |- | ||
| − | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Print Journal | + | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Print Journal |
| style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A., & Author, A.A. (year). Title of the article.''Title of the Journal, volume''(issue), page-page. | | style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A., & Author, A.A. (year). Title of the article.''Title of the Journal, volume''(issue), page-page. | ||
|- | |- | ||
| − | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Webpage | + | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Webpage |
| + | |Author, A. A. (year, Month day). Title of the webpage. Retrieved from Site Name website: http://url | ||
|- | |- | ||
| − | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Blog | + | | style="width: 112.8px;" data-mce-style="width: 112.8px;"|Blog |
| style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A. (Year, Month Day). Title of the blog post [Blog post]. Retrieved from http://www.entirewebaddress.com | | style="width: 900.2px;" data-mce-style="width: 900.2px;"|Author, A. A. (Year, Month Day). Title of the blog post [Blog post]. Retrieved from http://www.entirewebaddress.com | ||
|- | |- | ||
| Line 48: | Line 55: | ||
| style="width: 112.8px;" colspan="2" data-mce-style="width: 112.8px;"|More can be found at the Broadview website at https://library.broadviewuniversity.edu/apa/references. | | style="width: 112.8px;" colspan="2" data-mce-style="width: 112.8px;"|More can be found at the Broadview website at https://library.broadviewuniversity.edu/apa/references. | ||
|} | |} | ||
| + | |||
===Can I upload this?=== | ===Can I upload this?=== | ||
| − | + | Figures, images, pdfs, sound bytes, and other files are welcome to be uploaded and linked in articles. The following are not allowed to be uploaded to FSwiki and linked to an article: | |
| − | + | * Videos of any type | |
| − | + | * Proprietary, copyrighted, classified or otherwise restricted content | |
| − | + | * Files behind paywalls | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ====Files==== | ||
| + | Documentation is an excellent complement to an article. Files may be uploaded at [[Special:Upload]]. When including files, attach them in the following format at the bottom of the page: | ||
| + | {| class="wikitable" style="width: 1382.2px;" data-mce-style="width: 1382.2px;" | ||
| + | |- | ||
| + | |File | ||
| + | |Abstract/Synopsis | ||
| + | |Notes | ||
| + | |- | ||
| + | | style="width: 195px;" data-mce-style="width: 195px;"|https://fswiki.us/File:IMG_0135.jpg | ||
| + | | style="width: 279px;" data-mce-style="width: 279px;"|This is my dog | ||
| + | | style="width: 839.2px;" data-mce-style="width: 839.2px;"|Use the direct link to the file; do not use the square bracket syntax. Using the square bracket syntax embeds the file. | ||
| + | |- | ||
| + | | style="width: 195px;" data-mce-style="width: 195px;"|<br /> | ||
| + | | style="width: 279px;" data-mce-style="width: 279px;"|<br /> | ||
| + | | style="width: 839.2px;" data-mce-style="width: 839.2px;"|<br /> | ||
| + | |- | ||
| + | | style="width: 195px;" data-mce-style="width: 195px;"|<br /> | ||
| + | | style="width: 279px;" data-mce-style="width: 279px;"|<br /> | ||
| + | | style="width: 839.2px;" data-mce-style="width: 839.2px;"|<br /> | ||
| + | |} | ||
| + | The following file restrictions are in place: | ||
| + | # Upload limit = 20MB | ||
| + | # Permitted file types: png, gif, jpg, jpeg, webp, flac, mp3, oga, ogg, ogv, wav, webm. | ||
| + | ==Write== | ||
| + | ===Build an outline=== | ||
| + | Build an outline for the article with headings and subheadings that make sense. For a good example, examine the [[Sensors]] page. | ||
| + | ===Continue to make improvements=== | ||
| + | Wikis are community built; therefore, not all the work should be done yourself. After writing the initial article, upload and seek feedback on it. Other users can discuss potential changes in the Discussion panel of any article and implement when a consensus is reached. | ||
| + | ====Avoid Orphaned Articles==== | ||
| + | Your article won't go anywhere if it isn't linked elsewhere in the site. Add links to the article using the double square bracket syntax or hyperlinks when the article title is used in other parts of the wiki. | ||
| + | Add the article to an appropriate Category. Category flags are case sensitive. | ||
| − | [[Category:FSWiki]] | + | ==References== |
| + | <br />[[Category:FSWiki]] | ||
Latest revision as of 14:57, 16 May 2020
A comprehensive guide regarding creating articles can be found at Wikipedia:Help:Your_first_article.
Contents
Choosing a Topic
The beauty of specificity
Entering the rabbithole of a wiki means exploring as deeply as the wiki allows. Short, complete articles about a specific subject are more effective at communicating information than wikipedia:War and Peace regarding Tyres (or Tires, if you prefer. They both go to the same place). Write about a small topic first.
Search for an existing article
There are several ways to do this. The search bar at the top of the page is a good start. In addition, you may browse the categories below:
Category:Team
Category:Competition
Category:Vehicle
Not all articles are categorized (even though they should be). Navigate to Special:AllPages to see all articles.
Gather reference information
This is not a soapbox. Reinforce the information that you write with references.
Citations
There is an extension for this! When you write a paragraph and wish to cite something, use the <ref>CITATION HERE</ref> Function. Then, at the bottom of the page (in a "references" or "notes" section), write <references />. It'll spit out everything you've cited above in a footnote format.
Reference Format
This is Wikipedia:APA Style formatting.
| Type | Format |
| Book | Author, A. A. (year). Chapter title. In E. Editor (Ed.).Title of the book(pp. page-range). Location: Publisher. |
| Ebook | Author, A. A. (year).Title of the book(xth ed.) [eBook version]. Location: Publisher. Retrieved from URL |
| Online Journal | Author, A. A., & Author, A. A. (year). Title of the article.Title of the Journal, volume(issue), page-page. Retrieved from http://www.hompageofjournal.com |
| Print Journal | Author, A. A., & Author, A.A. (year). Title of the article.Title of the Journal, volume(issue), page-page. |
| Webpage | Author, A. A. (year, Month day). Title of the webpage. Retrieved from Site Name website: http://url |
| Blog | Author, A. A. (Year, Month Day). Title of the blog post [Blog post]. Retrieved from http://www.entirewebaddress.com |
| Video [1] | Author, A. A. (Year, Month day).Title of video[Video file]. Retrieved from http://www.entirewebaddress.com |
| More can be found at the Broadview website at https://library.broadviewuniversity.edu/apa/references. | |
Can I upload this?
Figures, images, pdfs, sound bytes, and other files are welcome to be uploaded and linked in articles. The following are not allowed to be uploaded to FSwiki and linked to an article:
- Videos of any type
- Proprietary, copyrighted, classified or otherwise restricted content
- Files behind paywalls
Files
Documentation is an excellent complement to an article. Files may be uploaded at Special:Upload. When including files, attach them in the following format at the bottom of the page:
| File | Abstract/Synopsis | Notes |
| https://fswiki.us/File:IMG_0135.jpg | This is my dog | Use the direct link to the file; do not use the square bracket syntax. Using the square bracket syntax embeds the file. |
The following file restrictions are in place:
- Upload limit = 20MB
- Permitted file types: png, gif, jpg, jpeg, webp, flac, mp3, oga, ogg, ogv, wav, webm.
Write
Build an outline
Build an outline for the article with headings and subheadings that make sense. For a good example, examine the Sensors page.
Continue to make improvements
Wikis are community built; therefore, not all the work should be done yourself. After writing the initial article, upload and seek feedback on it. Other users can discuss potential changes in the Discussion panel of any article and implement when a consensus is reached.
Avoid Orphaned Articles
Your article won't go anywhere if it isn't linked elsewhere in the site. Add links to the article using the double square bracket syntax or hyperlinks when the article title is used in other parts of the wiki.
Add the article to an appropriate Category. Category flags are case sensitive.
References
- ↑ APA Citation Guide: 2. Reference List. Broadview University Library Connect website: https://library.broadviewuniversity.edu/apa/references