Consumer Rights Wiki:Tools for writing articles: Difference between revisions
m →Why use Ghostwriter or Typora?: Fix numbering |
|||
| (19 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Help]] | [[Category:Help]] | ||
[[Category: | [[Category:CRW]] | ||
=Contributing to the Wiki= | =Contributing to the Wiki= | ||
Welcome to the '''Contributing Guide'''! Editing a wiki can be difficult and confusing for newbies, so this guide, along with our [[How to help|How to help]] page, will walk you through everything you need to know to start contributing! | Welcome to the '''Contributing Guide'''! Editing a wiki can be difficult and confusing for newbies, so this guide, along with our [[How to help|How to help]] page, will walk you through everything you need to know to start contributing! | ||
If you need assistance, join our Discord community | If you need assistance, join our Discord community [https://discord.gg/ypUk97Fn79 here]. | ||
---- | ---- | ||
| Line 34: | Line 34: | ||
====Issues with Markdown==== | ====Issues with Markdown==== | ||
MediaWiki uses | MediaWiki uses wikitext text format, which is not Markdown and does not natively support Markdown. While a plugin can enable support for Markdown between `<markdown></markdown>` blocks, it disrupts the Visual Editor and prevents proper editing. | ||
To address this, we support both the Visual Editor and the | To address this, we support both the Visual Editor and the wiktext editor. You can use [https://pandoc.org/try/ pandoc] to convert Markdown to MediaWiki text and use the '''Edit Source''' button, or copy and paste content from Typora into the Visual Editor. | ||
---- | ---- | ||
| Line 51: | Line 51: | ||
#**If your browser crashes or the connection is lost, you can easily lose work since there's no auto-save or recovery feature. | #**If your browser crashes or the connection is lost, you can easily lose work since there's no auto-save or recovery feature. | ||
#*While it's convenient for quick edits, it's not ideal for creating long or detailed articles. | #*While it's convenient for quick edits, it's not ideal for creating long or detailed articles. | ||
#'''Source Editor''' | #'''Source Editor''' | ||
#*The "raw" editor where you can see and edit the underlying wiki markup. | #*The "raw" editor where you can see and edit the underlying wiki markup. | ||
| Line 82: | Line 81: | ||
#'''Headings''' | #'''Headings''' | ||
#*Use styles like '''Heading 1''', '''Heading 2''', etc., in your word processor. This creates a clear structure when pasted into the wiki. | #*Use styles like '''Heading 1''', '''Heading 2''', etc., in your word processor. This creates a clear structure when pasted into the wiki. | ||
#'''Copy and paste''' | #'''Copy and paste''' | ||
#*Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting as needed. | #*Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting as needed. | ||
#'''Why headings matter''' | #'''Why headings matter''' | ||
#*Headings are not just for style; they help organize your content, making it easier for readers to navigate and enabling the clickable table of contents for the article. | #*Headings are not just for style; they help organize your content, making it easier for readers to navigate and enabling the clickable table of contents for the article. | ||
| Line 143: | Line 140: | ||
#*Navigate to the page you want to edit and click the "Edit" button at the top of the page. | #*Navigate to the page you want to edit and click the "Edit" button at the top of the page. | ||
#*If you're using a mobile device, tap the pencil icon. | #*If you're using a mobile device, tap the pencil icon. | ||
#'''Insert a Citation''' | #'''Insert a Citation''' | ||
#*Go to the '''Insert''' button at the top of the editor. On smaller screens, this may appear as a "+" symbol. | #*Go to the '''Insert''' button at the top of the editor. On smaller screens, this may appear as a "+" symbol. | ||
#*Click on '''Basic reference''' or use the keyboard shortcut ''Ctrl + Shift + K'' (or ''Cmd + Shift + K'' on Mac). | #*Click on '''Basic reference''' or use the keyboard shortcut ''Ctrl + Shift + K'' (or ''Cmd + Shift + K'' on Mac). | ||
#'''Provide Source Information''' | #'''Provide Source Information''' | ||
#*A dialog box will appear. Fill in the relevant fields: | #*A dialog box will appear. Fill in the relevant fields: | ||
| Line 155: | Line 150: | ||
#**'''Date''': Specify the publication date, if known. | #**'''Date''': Specify the publication date, if known. | ||
#*Click "Insert" to add the citation to the text. | #*Click "Insert" to add the citation to the text. | ||
#'''Position the Citation''' | #'''Position the Citation''' | ||
#*Place the cursor where you want the citation to appear and insert it. | #*Place the cursor where you want the citation to appear and insert it. | ||
#*Citations are usually placed at the end of a sentence or paragraph to support the preceding claim. | #*Citations are usually placed at the end of a sentence or paragraph to support the preceding claim. | ||
#'''Review and Save''' | #'''Review and Save''' | ||
#*Double-check that the citation is correctly formatted and supports the intended claim. | #*Double-check that the citation is correctly formatted and supports the intended claim. | ||
#*Save your changes once you're satisfied. | #*Save your changes once you're satisfied. | ||
===Archived citations=== | |||
{{Main|Projects:Archive everything}} | |||
To maintain verifiability for our articles, archiving these citations are crucial in case websites go offline temporarily or permanently (also known as {{Wplink|link rot}}). Here are resources for archiving websites yourself or acquiring past archives: | |||
*[https://archive.org WayBack Machine (archive.org)] - The most used and trustworthy resource for website archives. | |||
**Websites retain interactable aspects | |||
**Some websites such as [[X]] cannot be archived by this resource, or are [[List of companies that block Internet Archive|specifically excluded]] (''e.g.'' [[Bambu Lab]]) | |||
**Honors [[DMCA]] take-down requests (see [[Internet Archive#Archived website removal]]) | |||
*[https://ghostarchive.org/ Ghost Archive (ghostarchive.org)] - An English alternative. | |||
**Can archive nitter.net URLs to archive Twitter/X posts with comments included. | |||
*[https://megalodon.jp/ megalodon.jp] - A Japanese alternative. Some web browsers, such as [[Mozilla Firefox]], have a built-in web page translation function | |||
**May have a better result if experiencing trouble with both the Wayback Machine and Ghost Archive. | |||
*[https://preservetube.com/ PreserveTube (preservetube.com)] – Used for archiving YouTube videos | |||
**While the WayBack Machine might have some older videos archived, that is often not the case for newer and larger sized videos. | |||
*[https://webarchive.nla.gov.au/collection Australian Web Archive] - For Australian websites specifically. | |||
'''IMPORTANT:''' Archive.today is no longer used for archiving due to its owner {{Wplink|Wikipedia:Requests for comment/Archive.is RFC 5|weaponizing the website}} against a blog writer, which involved exploiting unknowing users to initiate {{Wplink|DDoS}} attacks and editing the content of archived pages. | |||
---- | ---- | ||
| Line 172: | Line 188: | ||
*'''Experiment safely''': Create a personal sandbox page to practice editing without affecting live articles. | *'''Experiment safely''': Create a personal sandbox page to practice editing without affecting live articles. | ||
Thank you for contributing to our Consumer | Thank you for contributing to our Consumer Rights Wiki! Every edit helps build a better resource for everyone. For support, join our Discord at [https://wiki.rossmanngroup.com/chat Discord Support]. | ||