Consumer Action Taskforce:Tools for writing articles: Difference between revisions
clarifying how editing markdown works and how to use citations, as well as the importance of citations |
No edit summary |
||
Line 20: | Line 20: | ||
# '''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''' | # '''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''' | # '''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 ==== | ==== Issues with Markdown ==== | ||
MediaWiki uses wikisource text format, which is not Markdown and does not natively support 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 | 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 45: | Line 45: | ||
# '''Visual Editor''' | # '''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. | - 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. | |||
# '''Source Editor''' | # '''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? ==== | ==== 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 ==== | ==== Workflow Example ==== | ||
Line 81: | 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. | |||
# '''Copy-Paste''' | # '''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''' | # '''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. | |||
---- | ---- | ||
Line 141: | Line 141: | ||
# '''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. | |||
- 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. | |||
- 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: | |||
- '''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. | |||
# '''Position the Citation''' | # '''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''' | # '''Review and Save''' | ||
- Double-check that the citation is correctly formatted and supports the intended claim. | |||
- Save your changes once you're satisfied. | |||
---- | ---- |