Free editor and Markdown update - eduSteem

Repository

https://github.com/bflanagin/eduSteem

Continuing the overall interface of eduSteem has become the theme the last few updates.

New Feature: Advanced Editor

New editor with side preview

Non-preview editor

Another "small update" that ended up touching almost every aspect of the program the new editor layout and tool bar adds a much more familiar look to the interface. Now both students and teachers can use the tool bar to help them make their posts really pop.

Implementation

pull request (65)

This update carries with it a lot of minor changes to a lot of the files found through out the program. However the new code is concentrated in EditorOpts.qml and markdown.js both of which can be viewed in their entirety by clicking on the links.

In EditorOpts we are simply setting up the buttons in a row. When an option is selected the required markdown formatting is inserted where ever the cursor is located within the document similar to the what you would expect in any word processor. However, hotkeys couldn't be added to this file due to the way key events are designed in QT. To remedy this we add the code snippet below.

property bool controlDown: false

Keys.onPressed: if (event.key === Qt.Key_Control) {
                   controlDown = true
                }
Keys.onReleased: {
            if (controlDown === true) {
                        switch (event.key) {
                        case Qt.Key_B:
                            if (editorOpts.bold === true) {
                                editorOpts.bold = false
                            } else {
                                editorOpts.bold = true
                            }
                            break
                        case Qt.Key_I:
                            if (editorOpts.italic === true) {
                                editorOpts.italic = false
                            } else {
                                editorOpts.italic = true
                            }
                            break
                        case Qt.Key_T:
                            if (editorOpts.strike === true) {
                                editorOpts.strike = false
                            } else {
                                editorOpts.strike = true
                            }
                            break
                        }
                        controlDown = false
                    }
                }
            }

Now we can use standard control+ operations as we would in other editors.

The real work was done in markdown.js as nearly every line was rewritten. The code in markdown.js was originally designed to be simple and quick. Taking into account the major features of the format and converting them into a qml friendly format (instead of html). This of course has many benefits given QT's rendering pipeline and ability to intelligently load and unload media. The new markdown.js abilities include:

• Multiple nested format marks. Like Bold+Italic.
• Better handling of images.
• Better end mark algorithm that fails less often.
• Rudimentary hyperlink support.

New Feature: Free Posts

When I first started working on eduSteem I had a set workflow in mind. There would be a balance between working as a class and working at the student's own pace. At the end of the week a report would be generated based on the work they submitted and then that report would be uploaded to STEEM as "Proof of Work / Proof of brain." These posts could be viewed by the parents and family of the child and they could upvote the posts as a way to support the child's education. However, what I did not expect was how many times I wouldn't have a set assignment for a task. Free Post is what the interface now defaults to when an lesson doesn't have an assignment attached to it.

Implementation

The FreePost.qml file was added to the assignments wizard and set as the default option in the switch statements that control what template is loaded for the student. The full source code for FreePost.qml can be found here.

Find out more

This project is first and foremost for my classroom and the benefit of my students. It is my hope that when complete other families and schools will adopt the software, and use it in their homes as well. The feature list isn't set in stone but here are a few of its current and planned features:

• School management including calendars, Courses, Students, and Teachers
• Lesson plan creation and publishing to STEEM and to an in application store for other teachers to download
• Student reports created and published by the students through an semi-automated process
• Auto review (Quizzes) based on review questions added to lessons
• media storage via IPFS
• Student rewards based on completion of assignments
• Micro-scholarships provided by the up-votes the student receives on their weekly posts

As with all my projects eduSteem is open source. Most if not all proceeds from utopian and steem are used for the continued development of this and my other software's and projects.

For further reading check out these other posts here on Steemit.

I also have a Patreon page here if you would like to show your support for the project. The proceeds will be used to maintain the house and my students education as Steemit and Patreon are my sole sources of income.

As always it is my hope that this software along with any of the other projects I have undertaken will be found useful to the community. I do this for the love of the challenge and the need for the software.

• Introduction
• Week 1
• Week 2
• Week 3a
• Week 3b
• Week 4
• Student DashBoard
• Student Interaction
• IPFS support
• Week 6
• Mobile Unit
• Spell Check

GitHub Account

https://github.com/bflanagin