Please note that all submissions to the site are subject to the wiki's licence, CC 4.0 BY-SA, as found here

Tools for Writing Articles: Difference between revisions

From Consumer Action Taskforce
Jump to navigationJump to search
← Older edit
VisualWikitext
m Attempting to update formatting - not the most interesting edit in the world.
m Adding to policies category.
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Contributing to Our Consumer Protection Wiki =
[[Category:Help]]
[[Category:CAT]]
= Contributing to the Wiki =


Welcome to the '''Contributing Guide'''! We’re thrilled you want to share your knowledge. Editing a wiki can be intimidating for newcomers, so this guide will walk you through everything you need to know to start contributing with confidence.
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 at [https://wiki.rossmanngroup.com/chat Discord Support].


----
----


== 1. Choosing Your Editing Method ==
== Choosing Your Editing Method ==


There are multiple ways to create content for the wiki, depending on what you're comfortable with:
There are multiple ways to create content for the wiki, depending on what you're comfortable with.


=== a. 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.
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.
Line 17: Line 21:
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 You Go''':
# '''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 Whole Article at Once''':
  * Ghostwriter and Typora display the entire document in an easy-to-read format, helping 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.
 
# '''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.
  * Typora will display the entire article in Markdown format, allowing you to make final adjustments.
  * Once ready, copy the Markdown output and paste it into the '''MediaWiki Source Editor''' between <nowiki><markdown></nowiki> tags to avoid VisualEditor slowness and ensure perfectly consistent formatting.
 
Here’s an example of how to format your Markdown:
<pre>
<nowiki><markdown>
= Article Title =


== Section 1 ==
# '''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.
#* You can focus on writing without being distracted by loading delays or limited screen real estate.


* Bullet point 1
# '''Combining with Word Processors'''
* Bullet point 2
#* 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.
#* Once ready, copy the formatted version from Typora and paste it into the '''Visual Editor'''.


== Section 2 ==
==== Issues with Markdown ====


Some text here.
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.
</markdown></nowiki>
</pre>


This workflow ensures your content is safe, fast, and formatted perfectly before publishing.
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.


----
----


=== b. Using the Wiki Editors ===
=== Using the Wiki Editors ===


The wiki offers two primary editors:
The wiki offers two primary editors:


# '''Visual Editor''':
# '''Visual Editor'''
  * A "What You See Is What You Get" (WYSIWYG) editor.
#* A "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 like in modern tools.
#** 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''':
  * The "raw" editor where you can see and edit the underlying wiki markup.
  * Allows for full control over structure and formatting, including the use of <nowiki><markdown></nowiki> tags for Markdown content.
  * Recommended for advanced users or those familiar with Markdown or HTML.
 
==== Why Markdown Is Better Than Wiki Source ====
 
* '''Markdown is Portable''':
  * Markdown is widely supported across many platforms, making it easy to reuse your content in other tools or projects.
  * Wiki source, in contrast, is specific to MediaWiki and less versatile for non-wiki use cases.


* '''Easier to Write and Read''':
# '''Source Editor'''
  * Markdown is simpler and more intuitive than MediaWiki source syntax.
#* The "raw" editor where you can see and edit the underlying wiki markup.
  * Formatting in Markdown is less cluttered, and tools like Typora or Ghostwriter allow you to see exactly how your article will look as you write.
#* Recommended for advanced users familiar with MediaWiki syntax.


* '''Better Tools for Markdown''':
==== Why Use Markdown Editors for Visual Editor Content? ====
  * Markdown editors like '''Typora''' and '''Ghostwriter''' let you work offline, with auto-save and crash recovery features.
  * You can see a live preview of your work as you write, helping you catch mistakes early.


==== Why Use Markdown in MediaWiki? ====
* '''Safe Drafting Offline'''
** Markdown editors like Typora and Ghostwriter let you work offline with auto-save and crash recovery features.


MediaWiki’s Source Editor supports Markdown within <nowiki><markdown></nowiki> tags, giving you the best of both worlds:
* '''Clean Formatting'''
** Typora allows you to visually perfect your article before copying the content into the Visual Editor, avoiding errors from the browser editor.


* '''Fast and Lightweight''':
* '''Live Preview'''
  * Instead of using the slow and buggy Visual Editor, you can write in Markdown and paste it directly into the Source Editor.
** See how your content will appear as you write, helping you catch mistakes early.
 
* '''Ease of Use''':
  * Use Markdown’s simple syntax for formatting, headings, and lists, without having to learn or deal with wiki source.
 
* '''No Conversion Hassle''':
  * If you prefer writing in a word processor like '''LibreOffice''', '''OnlyOffice''', '''Word''', or '''Google Docs''', you can copy your content into Typora to quickly convert it to Markdown.
  * From there, paste the Markdown into the Source Editor within <nowiki><markdown></nowiki> tags. This avoids the slow and error-prone Visual Editor entirely.


==== Workflow Example ====
==== Workflow Example ====
Here’s how to use Markdown in the wiki for a smooth editing experience:


# Write your article in Typora, Ghostwriter, or a word processor.
# Write your article in Typora, Ghostwriter, or a word processor.
# Format your content using Markdown syntax.
# Format your content visually in Typora.
# Copy the Markdown content into the Source Editor between <nowiki><markdown></nowiki> tags:
# Copy the clean, formatted content from Typora and paste it into the Visual Editor.
<pre>
# Save your work and enjoy the benefits of working offline while avoiding browser editor crashes.
<nowiki><markdown>
= Article Title =
 
== Section 1 ==
 
* Bullet point 1
* Bullet point 2
 
== Section 2 ==
 
Some text here.
</markdown></nowiki>
</pre>
# Save your work and enjoy the benefits of Markdown’s simplicity and portability without the Visual Editor’s limitations.
 
This method ensures your work is safe, organized, and easy to maintain, all while avoiding the frustrations of older tools like the buggy Visual Editor.


----
----


=== c. 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-Paste''':
# '''Copy-Paste'''
  * Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting if needed.
#* Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting if 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.
#* 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 the main topic (this should be the page title).
#* Use '''Heading 1''' for the main topic (this should be the page title).
  * Use '''Heading 2''' for major sections.
#* Use '''Heading 2''' for major sections.
  * Use '''Heading 3''' for subsections.
#* Use '''Heading 3''' for subsections.


----
----


== 2. Understanding the Basics of Wiki Editing ==
== 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
Line 165: Line 120:
----
----


== 3. Key Concepts for New Contributors ==
== 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 Tools''': Use bold, italics, bullet points, and links to enhance your content. Visual Editor makes this straightforward.
* '''Formatting Tools''': Use bold, italics, bullet points, and links to enhance your content. Visual Editor makes this straightforward.
* '''Saving Your Work''': Save your progress regularly. If using the Source Editor, consider drafting offline to avoid losing work.
* '''Saving Your Work''': Save your progress regularly. If using the Source Editor, consider drafting offline to avoid losing work.
----
== Adding Citations to Articles ==
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 Add Citations? ===
Citations ensure that:
* '''Information is Verifiable''': Readers can confirm that claims made in the article are supported by credible sources.
* '''Content is Reliable''': Sourced content builds trust and helps establish the wiki as a credible resource.
* '''The Wiki Aligns with Its Mission''': Well-cited articles align with our mission to document systemic consumer issues with clarity and accuracy.
=== How to Add Citations in the Visual Editor ===
# '''Open the Article for Editing'''
#* 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.
# '''Insert a Citation'''
#* 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).
# '''Provide Source Information'''
#* A dialog box will appear. Fill in the relevant fields:
#** '''URL''': Paste the link to the source.
#** '''Title''': Provide the title of the source material.
#** '''Author/Publisher''': Include the author or publisher, if available.
#** '''Date''': Specify the publication date, if known.
#* Click "Insert" to add the citation to the text.
# '''Position the Citation'''
#* 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.
# '''Review and Save'''
#* Double-check that the citation is correctly formatted and supports the intended claim.
#* Save your changes once you're satisfied.


----
----
Line 176: Line 171:


* '''Take Your Time''': It's okay to draft and edit over several sessions.
* '''Take Your Time''': It's okay to draft and edit over several sessions.
* '''Ask for Help''': Reach out to the wiki community if you’re unsure about formatting or content.
* '''Ask for Help''': Reach out to the wiki community if you're unsure about formatting or content.
* '''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 Protection Wiki! Every edit helps build a better resource for everyone.
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].

Latest revision as of 19:09, 15 January 2025

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 page, will walk you through everything you need to know to start contributing!

If you need assistance, join our Discord community at Discord Support.

Choosing Your Editing Method

There are multiple ways to create content for the wiki, depending on what you're comfortable with.

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.

Why Use Ghostwriter or Typora?

Here are some benefits of using Markdown editors like Ghostwriter or Typora:

  1. 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.
    • No need to rely on old, unreliable PHP-based editors that may lose your progress.
  1. 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.
    • You can focus on writing without being distracted by loading delays or limited screen real estate.
  1. 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.
    • 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.

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.

To address this, we support both the Visual Editor and the wikisource editor. You can use pandoc to convert Markdown to MediaWiki text and use the Edit Source button, or copy and paste content from Typora into the Visual Editor.

Using the Wiki Editors

The wiki offers two primary editors:

  1. Visual Editor
    • A "What You See Is What You Get" (WYSIWYG) editor.
    • Best for users unfamiliar with code or markup.
    • 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.
      • 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.
  1. Source Editor
    • The "raw" editor where you can see and edit the underlying wiki markup.
    • Recommended for advanced users familiar with MediaWiki syntax.

Why Use Markdown Editors for Visual Editor Content?

  • Safe Drafting Offline
    • Markdown editors like Typora and Ghostwriter let you work offline with auto-save and crash recovery features.
  • Clean Formatting
    • Typora allows you to visually perfect your article before copying the content into the Visual Editor, avoiding errors from the browser editor.
  • Live Preview
    • See how your content will appear as you write, helping you catch mistakes early.

Workflow Example

  1. Write your article in Typora, Ghostwriter, or a word processor.
  2. Format your content visually in Typora.
  3. Copy the clean, formatted content from Typora and paste it into the Visual Editor.
  4. Save your work and enjoy the benefits of working offline while avoiding browser editor crashes.

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:

  1. Headings
    • Use styles like Heading 1, Heading 2, etc., in your word processor. This creates a clear structure when pasted into the wiki.
  1. Copy-Paste
    • Once your article is finished, copy the content into the Visual Editor. Adjust the headings, lists, or formatting if needed.
  1. 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.
    • Use Heading 1 for the main topic (this should be the page title).
    • Use Heading 2 for major sections.
    • Use Heading 3 for subsections.

Understanding the Basics of Wiki Editing

Visual Editor vs. Source Editor

Feature Visual Editor Source Editor
Ease of Use Beginner-friendly, like a word processor. Requires knowledge of wiki syntax.
Features Simple text formatting, inserting images. Full control over structure and code.
Recommended For Casual contributors. Advanced users, Markdown writers.

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.
  • Formatting Tools: Use bold, italics, bullet points, and links to enhance your content. Visual Editor makes this straightforward.
  • Saving Your Work: Save your progress regularly. If using the Source Editor, consider drafting offline to avoid losing work.

Adding Citations to Articles

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 Add Citations?

Citations ensure that:

  • Information is Verifiable: Readers can confirm that claims made in the article are supported by credible sources.
  • Content is Reliable: Sourced content builds trust and helps establish the wiki as a credible resource.
  • The Wiki Aligns with Its Mission: Well-cited articles align with our mission to document systemic consumer issues with clarity and accuracy.

How to Add Citations in the Visual Editor

  1. Open the Article for Editing
    • 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.
  1. Insert a Citation
    • 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).
  1. Provide Source Information
    • A dialog box will appear. Fill in the relevant fields:
      • URL: Paste the link to the source.
      • Title: Provide the title of the source material.
      • Author/Publisher: Include the author or publisher, if available.
      • Date: Specify the publication date, if known.
    • Click "Insert" to add the citation to the text.
  1. Position the Citation
    • 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.
  1. Review and Save
    • Double-check that the citation is correctly formatted and supports the intended claim.
    • Save your changes once you're satisfied.

Final Tips for New Contributors

  • Take Your Time: It's okay to draft and edit over several sessions.
  • Ask for Help: Reach out to the wiki community if you're unsure about formatting or content.
  • 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 Discord Support.

Retrieved from "https://wiki.rossmanngroup.com/index.php?title=Tools_for_Writing_Articles&oldid=971"