FlightGear wiki:Howto: Wiki addon development

Revision as of 07:17, 18 February 2018 by Hooray (Talk | contribs) (Related)

Revision as of 07:17, 18 February 2018 by Hooray (Talk | contribs) (Related)

This article is a stub. You can help the wiki by expanding it.
Screenshot showing the web-extension port of the InstantRefs user-script in FireFox.

Status

Objective

Background

dot_sent came up with a tool for editing the FlightGear wiki, it's written in Perl and the source code is on Github, feel free to lurk around and modify to your taste if you feel like it: https://github.com/dot-sent/FlightGearWikiClient[1]

In addition, there is the Instant-Cquotes script (written in JavaScript) which started out as a userscript (via GreaseMonkey), which got meanwhile ported to the Web extension framework. dot_sent mentioned plans to also use JavaScript for his tool.

Originally, Instant-Cquotes started out as JavaScript-based tool to edit the FlightGear wiki which was created over the years to aggregate community discussions, i.e. to help bootstrap new wiki articles and help maintain those articles that are no longer actively maintained. It's a rather simple piece of code actually that grew over time - originally it was just a UserScript using Greasemonkey - more recently, it's been ported to the Web Extension framework.[2]


We're now exploring if it makes sense to integrate both "scripts" to grow a library of useful tools and APIs.

Requirements

For the sake of simplicity, it's recommended to have the following tools installed:

  • git (version control)
  • npm (package manager, used to install web-ext)
  • node.js (javascript for the console)
  • web-ext (tool used to actually develop/test web extensions)

Testing the extension

WIP.png Work in progress
This article or section will be worked on in the upcoming hours or days.
See history for the latest developments.
  • download the ZIP file
  • extract it to a new directory
  • execute web-ext run
  • go to a supported forum/mailing list URL
  • make a selection

Known Issues

Development

Related

References
  1. dot_sent  (Feb 1st, 2018).  My personal solution to Wiki bugs .
  2. Hooray  (Feb 2nd, 2018).  Re: My personal solution to Wiki bugs .