Consumer Rights Wiki:Tools for writing articles: Difference between revisions
MoveLateral (talk | contribs) m Attempting to update formatting - not the most interesting edit in the world. |
MoveLateral (talk | contribs) m Attempting to update formatting - not the most interesting edit in the world. |
||
Line 17: | Line 17: | ||
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''': | |||
* 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, 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: | Here’s an example of how to format your Markdown: | ||
<pre> | <pre> | ||
<nowiki><markdown> | <nowiki><markdown> | ||
= Article Title = | |||
== Section 1 == | |||
* Bullet point 1 | |||
* Bullet point 2 | |||
== Section 2 == | |||
Some text here. | Some text here. | ||
Line 54: | Line 54: | ||
The wiki offers two primary editors: | The wiki offers two primary editors: | ||
# '''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 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 ==== | ==== 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''': | |||
* Markdown is simpler and more intuitive than MediaWiki source syntax. | |||
* 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. | |||
* '''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? ==== | ==== Why Use Markdown in MediaWiki? ==== | ||
Line 85: | Line 85: | ||
MediaWiki’s Source Editor supports Markdown within <nowiki><markdown></nowiki> tags, giving you the best of both worlds: | MediaWiki’s Source Editor supports Markdown within <nowiki><markdown></nowiki> tags, giving you the best of both worlds: | ||
* '''Fast and Lightweight''': | |||
* Instead of using the slow and buggy Visual Editor, you can write in Markdown and paste it directly into the Source Editor. | |||
* '''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 ==== | ||
Line 99: | Line 99: | ||
Here’s how to use Markdown in the wiki for a smooth editing experience: | Here’s how to use Markdown in the wiki for a smooth editing experience: | ||
# Write your article in Typora, Ghostwriter, or a word processor. | |||
# Format your content using Markdown syntax. | |||
# Copy the Markdown content into the Source Editor between <nowiki><markdown></nowiki> tags: | |||
<pre> | <pre> | ||
<nowiki><markdown> | <nowiki><markdown> | ||
= Article Title = | |||
== Section 1 == | |||
* Bullet point 1 | |||
* Bullet point 2 | |||
== Section 2 == | |||
Some text here. | Some text here. | ||
</markdown></nowiki> | </markdown></nowiki> | ||
</pre> | </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. | 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. | ||
Line 126: | Line 126: | ||
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''': | |||
* Use styles like '''Heading 1''', '''Heading 2''', etc., in your word processor. This creates a clear structure when pasted into the wiki. | |||
# '''Copy-Paste''': | |||
* Once your article is finished, copy the content into the '''Visual Editor'''. Adjust the headings, lists, or formatting if needed. | |||
# '''Why Headings Matter''': | |||
* Headings are not just for style; they help organize your content, making it easier for readers to navigate. | |||
* Use '''Heading 1''' for the main topic (this should be the page title). | |||
* Use '''Heading 2''' for major sections. | |||
* Use '''Heading 3''' for subsections. | |||
---- | ---- | ||
Line 150: | Line 150: | ||
! Source Editor | ! Source Editor | ||
|- | |- | ||
| | | '''Ease of Use''' | ||
| Beginner-friendly, like a word processor. | | Beginner-friendly, like a word processor. | ||
| Requires knowledge of wiki syntax. | | Requires knowledge of wiki syntax. | ||
|- | |- | ||
| | | '''Features''' | ||
| Simple text formatting, inserting images. | | Simple text formatting, inserting images. | ||
| Full control over structure and code. | | Full control over structure and code. | ||
|- | |- | ||
| | | '''Recommended For''' | ||
| Casual contributors. | | Casual contributors. | ||
| Advanced users, Markdown writers. | | Advanced users, Markdown writers. | ||
Line 167: | Line 167: | ||
== 3. Key Concepts for New Contributors == | == 3. 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. | |||
---- | ---- | ||
Line 175: | Line 175: | ||
== Final Tips for New Contributors == | == 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. | Thank you for contributing to our Consumer Protection Wiki! Every edit helps build a better resource for everyone. |