Consumer Action Taskforce:Tools for writing articles: Difference between revisions
m Adding to policies category. |
m Proofreading |
||
Line 1: | Line 1: | ||
[[Category:Help]] | [[Category:Help]] | ||
[[Category:CAT]] | [[Category:CAT]] | ||
= 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! | ||
Line 9: | Line 9: | ||
---- | ---- | ||
== Choosing | ==Choosing how to edit== | ||
There are multiple ways to create content for the | There are multiple ways to create content for the Wiki, depending on what you're comfortable with. | ||
=== Writing in Markdown === | ===Writing in Markdown=== | ||
Markdown is a simple text format that converts easily into clean, structured content. Many contributors prefer writing in Markdown using offline tools to avoid the quirks (and potential crashes) of the browser's editor. | [[wikipedia:Markdown|Markdown]] is a simple text format that converts easily into clean, structured content. Many contributors prefer writing in Markdown using offline tools to avoid the quirks (and potential crashes) of the browser's editor. | ||
==== Why | ====Why use Ghostwriter or Typora?==== | ||
Here are some benefits of using Markdown editors like '''Ghostwriter''' or '''Typora''': | Here are some benefits of using Markdown editors like '''Ghostwriter''' or '''Typora''': | ||
# '''Save as | #'''Save as you go''' | ||
#* These editors allow you to save your work locally as you go, avoiding the buggy and slow '''MediaWiki VisualEditor''', which can crash if your browser unexpectedly closes or fails. | #*These editors allow you to save your work locally as you go, avoiding the buggy and slow '''MediaWiki VisualEditor''', which can crash if your browser unexpectedly closes or fails. | ||
#* No need to rely on old, unreliable PHP-based editors that may lose your progress. | #*No need to rely on old, unreliable, PHP-based editors that may lose your progress. | ||
# '''See the | #'''See the whole article at once''' | ||
#* Ghostwriter and Typora display the entire document in an easy-to-read format, so you maintain a clear overview of your structure and content. | #*Ghostwriter and Typora display the entire document in an easy-to-read format, so you maintain a clear overview of your structure and content. | ||
#* You can focus on writing without being distracted by loading delays or limited screen real estate. | #*You can focus on writing without being distracted by loading delays or limited screen real-estate. | ||
# '''Combining with | #'''Combining with word processors''' | ||
#* If you prefer writing in a word processor like '''Word''', '''Google Docs''', or '''OpenOffice''', you can paste your completed draft into Typora. | #*If you prefer writing in a word processor like '''Word''', '''Google Docs''', or '''OpenOffice''', you can paste your completed draft into Typora. | ||
#* Typora will display the entire article visually, allowing you to make final adjustments. | #*Typora will display the entire article visually, allowing you to make final adjustments. | ||
#* Once ready, copy the formatted version from Typora and paste it into the '''Visual Editor'''. | #*Once ready, copy the formatted version from Typora and paste it into the '''Visual Editor'''. | ||
==== Issues with Markdown ==== | ====Issues with Markdown==== | ||
MediaWiki uses wikisource 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. | MediaWiki uses wikisource 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 wikisource 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. | To address this, we support both the Visual Editor and the wikisource 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 42: | Line 42: | ||
---- | ---- | ||
=== Using the Wiki | ===Using the Wiki editors=== | ||
The | The Wiki offers two primary editors: | ||
# '''Visual Editor''' | #'''Visual Editor''' | ||
#* A "What You See Is What You Get" (WYSIWYG) editor. | #*A "[[wikipedia:WYSIWYG|What You See Is What You Get]]" (WYSIWYG) editor. | ||
#* Best for users unfamiliar with code or markup. | #*Best for users unfamiliar with code or markup. | ||
#* However, the Visual Editor has some significant drawbacks: | #*However, the Visual Editor has some significant drawbacks: | ||
#** It relies on old PHP code running in a web browser, making it buggy and prone to crashing. | #**It relies on old PHP code running in a web browser, making it buggy and prone to crashing. | ||
#** 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. | ||
#* Recommended for advanced users familiar with MediaWiki syntax. | #*Recommended for advanced users familiar with MediaWiki syntax. | ||
==== Why | ====Why use Markdown editors for Visual Editor content?==== | ||
* '''Safe | *'''Safe drafting offline''' | ||
** Markdown editors like Typora and Ghostwriter let you work offline with auto-save and crash recovery features. | **Markdown editors like Typora and Ghostwriter let you work offline with auto-save and crash recovery features. | ||
* '''Clean | *'''Clean formatting''' | ||
** Typora allows you to visually perfect your article before copying the content into the Visual Editor, avoiding errors from the browser editor. | **Typora allows you to visually perfect your article before copying the content into the Visual Editor, avoiding errors from the browser editor. | ||
* '''Live | *'''Live preview''' | ||
** See how your content will appear as you write, helping you catch mistakes early. | **See how your content will appear as you write, helping you catch mistakes early. | ||
==== Workflow | ====Workflow example==== | ||
# Write your article in Typora, Ghostwriter, or a word processor. | #Write your article in Typora, Ghostwriter, or a word processor. | ||
# Format your content visually in Typora. | #Format your content visually in Typora. | ||
# Copy the clean, formatted content from Typora and paste it into the Visual Editor. | #Copy the clean, formatted content from Typora and paste it into the Visual Editor. | ||
# Save your work and enjoy the benefits of working offline while avoiding browser editor crashes. | #Save your work and enjoy the benefits of working offline while avoiding browser editor crashes. | ||
---- | ---- | ||
=== Writing in Word, Google Docs, or OpenOffice === | ===Writing in Word, Google Docs, or OpenOffice=== | ||
You can use word processors to draft your content. Here's how to ensure a smooth transition into the wiki: | You can use word processors to draft your content. Here's how to ensure a smooth transition into the wiki: | ||
# '''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 | #'''Copy and paste''' | ||
#* Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting | #*Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting as needed. | ||
# '''Why | #'''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. | ||
#* Use '''Heading 1''' for | #*Use '''Heading 1''' for major sections. | ||
#* Use '''Heading 2''' for | #*Use '''Heading 2''' for subsections. | ||
#* Use '''Heading 3''' for | #*Use '''Heading 3''' for subsubsections. | ||
---- | ---- | ||
== Understanding the | ==Understanding the basics of Wiki editing== | ||
=== Visual Editor vs. Source Editor === | ===Visual Editor vs. Source Editor=== | ||
{| class="wikitable" | {| class="wikitable" | ||
! Feature | !Feature | ||
! Visual Editor | !Visual Editor | ||
! Source Editor | !Source Editor | ||
|- | |- | ||
| '''Ease of | |'''Ease of use''' | ||
| Beginner-friendly, like a word processor | |Beginner-friendly, like a word processor | ||
| Requires knowledge of | |Requires knowledge of Wiki syntax. | ||
|- | |- | ||
| '''Features''' | |'''Features''' | ||
| Simple text formatting, | |Simple text formatting, easily insert images | ||
| Full control over structure and code | |Full control over structure and code | ||
|- | |- | ||
| '''Recommended | |'''Recommended for''' | ||
| Casual contributors | |Casual contributors | ||
| Advanced users, Markdown writers | |Advanced users, Markdown writers | ||
|} | |} | ||
---- | ---- | ||
== Key | ==Key concepts for new contributors== | ||
* '''Headings''': Organize your article logically using headings ('''H1''', '''H2''', '''H3'''). This improves readability and helps readers jump to the sections they care about. | *'''Headings''': Organize your article logically using headings ('''H1''', '''H2''', '''H3'''). This improves readability and helps readers jump to the sections they care about. | ||
* '''Formatting | *'''Formatting tools''': Use bold, italics, bullet points, and links to enhance your content. Visual Editor makes this straightforward. | ||
* '''Saving | *'''Saving your work''': Save your progress regularly. If using the Source Editor, consider drafting offline to avoid losing work. | ||
---- | ---- | ||
== Adding | ==Adding citations to Articles== | ||
Citations are the backbone of a reliable and trustworthy | Citations are the backbone of a reliable and trustworthy Wiki. By providing sources, you help readers verify the accuracy of information and maintain the integrity of the Wiki. | ||
=== Why | ===Why add citations?=== | ||
Citations ensure that: | Citations ensure that: | ||
* '''Information is | *'''Information is verifiable''': Readers can confirm that claims made in the article are supported by credible sources. | ||
* '''Content is | *'''Content is reliable''': Sourced content builds trust and helps establish the Wiki as a credible resource. | ||
* '''The Wiki | *'''The Wiki aligns with its [[Mission statement|mission]]''': Well-cited articles align with our mission to document systemic consumer issues with clarity and accuracy. | ||
=== How to | ===How to add citations in the Visual Editor=== | ||
# '''Open the Article for Editing''' | #'''Open the Article for Editing''' | ||
#* 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: | ||
#** '''URL''': Paste the link to the source. | #**'''URL''': Paste the link to the source. | ||
#** '''Title''': Provide the title of the source material. | #**'''Title''': Provide the title of the source material. | ||
#** '''Author/Publisher''': Include the author or publisher, if available. | #**'''Author/Publisher''': Include the author or publisher, if available. | ||
#** '''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. | ||
---- | ---- | ||
== Final | ==Final tips for new contributors== | ||
* '''Take | *'''Take your time''': It's okay to draft and edit over several sessions. | ||
* '''Ask for | *'''Ask for help''': Reach out to the wiki community if you're unsure about formatting or content. | ||
* '''Experiment | *'''Experiment safely''': Create a personal sandbox page to practice editing without affecting live articles. | ||
Thank you for contributing to our Consumer Protection Wiki! Every edit helps build a better resource for everyone. For support, join our Discord at [https://wiki.rossmanngroup.com/chat Discord Support]. | Thank you for contributing to our Consumer Protection Wiki! Every edit helps build a better resource for everyone. For support, join our Discord at [https://wiki.rossmanngroup.com/chat Discord Support]. |