Hercules Spark Javascript / Native App - Basic Rich Text support

Challenge Objectives

• Target: pxScene / Spark (http://pxscene.org) using Javascript
• Requirements: Implement basic rich text support

Project Background

“Sparkdown” refers to the processing and rendering of Markdown in Spark.  We implemented this successfully and markdown processing is part of the main Spark builds.

This challenge is the first of at least 2 challenges in this project to extend Spark to now also support rich text processing.

Technology Stack

"Spark" is the new name for the pxScene project we've done work for in the past.  The links below offer a lot more details on these particular technologies. pxCore is a C++ graphics library that is used on a wide variety of embedded devices that the client distributes.  pxScene is a wrapper application around pxCore that exposes the drawing APIs to Javascript through Node and V8.

This challenge will be in Javascript as much as possible.  We don’t want to change any native code.

Quirks:  Note that in this challenge we will be implementing the richtext processing and rendering only.  We won't worry about converting text from plain text to rich text, as described in the requirements.
 

Code access

Pxscene is a platform independent drawing platform / app that will be used on a wide variety of embedded devices for the Hercules client.  You can find more information here, and you can download the regular app to be used for testing: http://www.pxscene.org/.  Note that you should target the custom build provided in the forum - this information is just provided for reference.

The code for pxCore / pxscene is available in Github here: https://github.com/pxscene/pxCore

Build instructions can be found here:  

https://github.com/pxscene/pxCore/blob/master/examples/pxScene2d/README.md
 

Full requirements for this challenge:

https://github.com/johnrobinsn/sparkrichtext
 

CSS

Note that the CSS should be specified somehow in Spark.  Please follow the rest of the Spark app for embedding the CSS in the build.

Resizing

When the rich text is rendered, resizing the Spark window should update the layout of the rich text accordingly.  Don't assume that the window will always be a certain size.

Deployment guide and validation document

You must provide A README.md that covers:

• Deployment:  How do we deploy the custom Javascript created for the rich text support?  Ideally, this would just be an edited executable that can be double-clicked to run, with the edited shell.js and other files that support the required features.
• Configuration:  How do we theme the rich text CSS rendering?

You must provide a Validation.md that covers:

• Rich text validation validation:  What files can be dragged and dropped that the dispatcher can handle and render?  You should provide reasonable samples here to make review easy.
• Rich text processing:  Provide at least a couple rich text files that show the required features working properly.

 

Validation video / screencast

Please provide a short video / screencast that shows the rich text processing working.  Make sure to include the resizing functionality..

What To Submit

The updated app with new JS embedded in it

• A README.md
• A Validation.md
• A screencast or a link to the screencast showing the functionality working

 

Final Submission Guidelines

Please see above