User:Joris Darlington Quarshie/Userscript/Keyword Highlighter/Documentation

The Wikinews Keyword Highlighter is a userscript designed to enhance the reading experience on Wikinews articles by allowing users to highlight specific keywords or phrases within the article content. This script enables customization of highlighted terms, aiding in better comprehension and focus on essential information.

Skills
To effectively use this userscript, familiarity with the following is recommended:
 * Basic proficiency in HTML, CSS, and JavaScript.
 * Understanding of userscript installation and configuration in browsers.

Accounts

 * Access to a compatible browser supporting userscripts.
 * Create a wikinews account

Installation and Setup

 * Userscript Extension: Ensure your browser supports userscripts and install the required extension.
 * Creating the Script: Copy the provided script and create a new userscript in your extension dashboard.
 * Configuration: Set the script to run on pages matching the URL pattern:

Customization

 * Define Keywords: Edit the `keywordsToHighlight` array to include specific words or phrases to be highlighted.
 * Target Element: Adjust the `articleBody` selector to accurately target the main article content.

Styling Customization
The highlighting style can be adjusted by modifying the CSS within the  '''function. Users can tailor the appearance by altering attributes like color, font-weight, or background color. '''

Note on Cache Bypass
To view changes after saving, bypass the browser's cache. Use browser-specific commands like  for Internet Explorer,   for various browsers, etc.

Troubleshooting

 * Keywords Not Highlighted: Ensure the specified keywords/phrases exist within the article body and match the case sensitivity, if relevant.
 * Styling Issues: Check for conflicts between the script's CSS and Wikinews' existing styles.
 * Compatibility: Verify the script's compatibility with your browser version and Wikinews site version.

Wikinews Editing Guidelines
Access the official Wikinews documentation for comprehensive guidelines on editing articles.

Userscript Communities and Forums
Engage with userscript communities and forums to seek assistance, share experiences, and find additional resources.

Support and Feedback
For any queries, feedback, or issues related to this userscript, please reach out to the author for dedicated support.