Consumer Rights Wiki

Consumer Rights Wiki:Tools for writing articles: Difference between revisions

← Older edit
VisualWikitext
m Attempting to update formatting - not the most interesting edit in the world.
 
(30 intermediate revisions by 10 users not shown)
Line 1: Line 1:
= Contributing to Our Consumer Protection Wiki =
[[Category:Help]]
[[Category:CRW]]
=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 [https://discord.gg/ypUk97Fn79 here].


----
----


== 1. Choosing Your Editing Method ==
==Choosing how to edit==


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.
[[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 Use Ghostwriter or Typora? ====
====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 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.
#*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, 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.
#'''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'''.


* 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.
====Issues with Markdown====
* No need to rely on old, unreliable PHP-based editors that may lose your progress.


# '''See the Whole Article at Once''':
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.
  * 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''':
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.
  * 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 ==
===Using the Wiki editors===


* Bullet point 1
The Wiki offers two primary editors:
* Bullet point 2


== Section 2 ==
#'''Visual Editor'''
#*A "[[wikipedia:WYSIWYG|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.
#'''Source Editor'''
#*The "raw" editor where you can see and edit the underlying wiki markup.
#*Recommended for advanced users familiar with MediaWiki syntax.


Some text here.
====Why use Markdown editors for Visual Editor content?====
</markdown></nowiki>
</pre>


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


=== b. Using the Wiki Editors ===
*'''Live preview'''
**See how your content will appear as you write, helping you catch mistakes early.


The wiki offers two primary editors:
====Workflow example====


# '''Visual Editor''':
#Write your article in Typora, Ghostwriter, or a word processor.
  * A "What You See Is What You Get" (WYSIWYG) editor.
#Format your content visually in Typora.
  * Best for users unfamiliar with code or markup.
#Copy the clean, formatted content from Typora and paste it into the Visual Editor.
  * '''However''', the Visual Editor has some significant drawbacks:
#Save your work and enjoy the benefits of working offline while avoiding browser editor crashes.
    * 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.
  * 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 ====
===Writing in Word, Google Docs, or OpenOffice===


* '''Markdown is Portable''':
You can use word processors to draft your content. Here's how to ensure a smooth transition into the wiki:
  * 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''':
#'''Headings'''
  * Markdown is simpler and more intuitive than MediaWiki source syntax.
#*Use styles like '''Heading 1''', '''Heading 2''', etc., in your word processor. This creates a clear structure when pasted into the wiki.
  * 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.
#'''Copy and paste'''
#*Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting as needed.
#'''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 major sections.
#*Use '''Heading 2''' for subsections.
#*Use '''Heading 3''' for subsubsections.


* '''Better Tools for Markdown''':
----
  * 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? ====
==Understanding the basics of Wiki editing==


MediaWiki’s Source Editor supports Markdown within <nowiki><markdown></nowiki> tags, giving you the best of both worlds:
===Visual Editor vs. Source Editor===


* '''Fast and Lightweight''':
{| class="wikitable"
  * Instead of using the slow and buggy Visual Editor, you can write in Markdown and paste it directly into the 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, easily insert images
|Full control over structure and code
|-
|'''Recommended for'''
|Casual contributors
|Advanced users, Markdown writers
|}


* '''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''':
==Key concepts for new contributors==
  * 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 ====
*'''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.


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


# Write your article in Typora, Ghostwriter, or a word processor.
==Adding citations to Articles==
# Format your content using Markdown syntax.
# Copy the Markdown content into the Source Editor between <nowiki><markdown></nowiki> tags:
<pre>
<nowiki><markdown>
= Article Title =


== Section 1 ==
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.


* Bullet point 1
===Why add citations?===
* Bullet point 2


== Section 2 ==
Citations ensure that:


Some text here.
*'''Information is verifiable''': Readers can confirm that claims made in the article are supported by credible sources.
</markdown></nowiki>
*'''Content is reliable''': Sourced content builds trust and helps establish the Wiki as a credible resource.
</pre>
*'''The Wiki aligns with its [[Mission statement|mission]]''': Well-cited articles align with our mission to document systemic consumer issues with clarity and accuracy.
# 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.
===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.


=== c. Writing in Word, Google Docs, or OpenOffice ===
===Archived citations===
{{Main|Projects:Archive everything}}


You can use word processors to draft your content. Here’s how to ensure a smooth transition into the wiki:
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:


# '''Headings''':
*[https://archive.org WayBack Machine (archive.org)] - The most used and trustworthy resource for website archives.
  * Use styles like '''Heading 1''', '''Heading 2''', etc., in your word processor. This creates a clear structure when pasted into the wiki.
**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]])


# '''Copy-Paste''':
*[https://ghostarchive.org/ Ghost Archive (ghostarchive.org)] - An English alternative.
  * Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting if needed.
**Can archive nitter.net URLs to archive Twitter/X posts with comments included.


# '''Why Headings Matter''':
*[https://megalodon.jp/ megalodon.jp] - A Japanese alternative. Some web browsers, such as [[Mozilla Firefox]], have a built-in web page translation function
  * Headings are not just for style; they help organize your content, making it easier for readers to navigate.
**May have a better result if experiencing trouble with both the Wayback Machine and Ghost Archive.
  * Use '''Heading 1''' for the main topic (this should be the page title).
  * Use '''Heading 2''' for major sections.
  * Use '''Heading 3''' for subsections.


----
*[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.
== 2. Understanding the Basics of Wiki Editing ==
 
=== Visual Editor vs. Source Editor ===
 
{| class="wikitable"
|-
! 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.
|}
 
----


== 3. Key Concepts for New Contributors ==
*[https://webarchive.nla.gov.au/collection Australian Web Archive] - For Australian websites specifically.


* '''Headings''': Organize your article logically using headings ('''H1''', '''H2''', '''H3'''). This improves readability and helps readers jump to the sections they care about.
'''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.
* '''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.


----
----


== Final Tips for New Contributors ==
==Final tips for new contributors==


* '''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 Rights Wiki! Every edit helps build a better resource for everyone. For support, join our Discord at [https://wiki.rossmanngroup.com/chat Discord Support].
Retrieved from "https://consumerrights.wiki/w/Consumer_Rights_Wiki:Tools_for_writing_articles"