buildmlearn / buildmlearn-toolkit

BuildmLearn Toolkit is an easy-to-use program that helps the users make mobile apps without any knowledge of application development.

BuildmLearn Toolkit

BuildmLearn Toolkit is an easy-to-use program that helps the users make mobile apps without any knowledge of application development.

Portage

Portage branch contains code developed by BuildmLearn development team and Martin Rotter. This code is developed as part of GSoC 2014 program by Martin Rotter.

Packages

You can use source code tarball available direct from here to build the software. Precompiled binary packages are available for some other platforms:

• OBS (Git version) ~Archlinux, openSUSE, Fedora, *Ubuntu, Debian,
• OBS (Stable version) ~Archlinux, openSUSE, Fedora, *Ubuntu, Debian,
• testing NSIS installers ~Windows (XP or newer),
• TBA ~OS/2 (eComStation),
• TBA ~OSX (Mac OS X).

How to build

Information regarding build process can be found in CMakeLists.txt file.

Links

• www.buildmlearn.org ~homepage,
• buildmlearn.github.io/BuildmLearn-Toolkit/docs/ ~API documentation,
• www.martin-rotter.8u.cz ~author's homepage,
• www.transifex.com/projects/p/buildmlearn-toolkit ~translations,
• [www.build.opensuse.org/project/show/home:skunkos:buildmlearn] (https://build.opensuse.org/project/show/home:skunkos:buildmlearn) ~OBS homepage,
• www.cmake.org ~build system,
• www.qt-project.org ~Qt libraries.

License for use and distribution

All the code in this repository (unless specified otherwise) is governed by the BSD (3-Clause) License quoted below.

Copyright (c) 2012, BuildmLearn Contributors listed at http://buildmlearn.org/people/ All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of the BuildmLearn nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

buildmlearn-toolkit's Issues

unicode character problem

Toolkit generated applications are unable to display Unicode characters properly, because .apk generators has a bug in it.

Note: Personally, I will not release a bug fix before 28th April to let other students have an opportunity to provide bug fixes to strengthen their proposals ;)

Basic mLearnings template

We should allow to add long texts (including paragraphs) for each item. The current implementation of the toolkit and simulator doesn't entertain any long description.

Let's convert the description LineEdit to TextEdit.

https://www.dropbox.com/sh/yu0v59jcwhoy19i/AACQDh0jTG78HoOpyKr0GuDIa/Screenshot%202014-08-14%2017.49.14.png?m=1

Optimize for low resolution computers

The toolkit runs but it's not a great experience for people who have low resolution. We should fix this.

File name problems when generating APKs

1. Start Quiz template (or any)
2. Fill the editor
3. Click generate APK
4. Dialog appears to enter name
5. Enter MyApplication.apk

The file is not saved as "MyApplication.apk" but it is saved as "application-quiz-DEFAULT-20140813T215803.apk" where DEFAULT is the Quiz name in the editor.

It should actually save the file with the name provided in the dialog.

Show news posts in the mainwindow

When the toolkit is launched, the main window is essentially empty. It would be great to have it populated with some news from BuildmLearn - best would be to populate it with BuildmLearn blog posts (with a specific tag). This isn't a necessary feature at this time but something that would be good to have... so anyone interested can take this up.

Icons and images missing

Icons from toolbar and in project menu,images from new project dialog and simulator skin are missing.

Template editor: Author name and Quiz name to be left blank

As discussed, let's just show the hint in these line edits - for all template editors.

New application dialog- can be more responsive

New application dialog - Set tab order + Add action on double-click list item.

Allow user to specify custom application ICON when uploading XML bundle.

1. Add "Application icon" with "browse" button in XML bundle upload dialog.
2. Add set of nice 128x128 (!!!) icons into the application.
3. Pass the base64-encoded contents of selected icon as new parameter.

Display msgbox when application uploaded to store.

The update checker has some bug

I compiled the toolkit on ubuntu 14.04 LTS. Few seconds after the toolkit starts, a small buildmlearn icon appears on the extreme left of the top navigation bar and stays there overlapping the first menu button on the bar. The icon also leaves a notification bubble saying no updates available, which too stays there forever.

Quiz template - option text should be wrapped if long

If he option text is long, it should be wrapped in the simulator.

Ideally, we should limit the input. I will comment here the limit shortly.

Localisation support + ability to disable

• Basic localisation support for the toolkit. Allow user to choose language on first launch and then available to switch in settings. Restart application on language change is OK.
• Use Transifex to translate strings
• Need to decide which languages to include (English and French are needed)
• Finally, have a flag to switch off localisation completely - this would switch to use default language (i.e. english). Also, would disable any visible settings for localisation.

Fixing limits for flashcard template

Question Limit - 100 characters
Hint Limit - 30 characters

Documentation should run on only src folder

Currently, the file structure reflects: data-> Martin -> Coding -> Projecty -> buildmlearn-toolkit-> portage ->src.
http://buildmlearn.github.io/BuildmLearn-Toolkit/docs/files.html

All the code is in src, so the documentation should only process src folder.

on closing the software ,it discards unsaved changes

When I close the application , it didn't ask for confirmation and simply closes the application discarding all unsaved changes.

LearnSpellings Template - Cannot play sound

I heard someone complaining that when clicking on the Listen button in the simulator, it shows a bubble. Cannot play sound as sound file for this platform was not downloaded. Why does this happen?

The person is trying on Windows and the sound did play for the first time he tried. Now it doesn't play and only displays the bubble message.

Flashcards simulator - Restart text not fitting the button

Let's add more padding. See the screenshot: https://www.dropbox.com/sh/yu0v59jcwhoy19i/AAD6bsx455UVW0U6dSAwSlQ9a/Screenshot%202014-08-14%2015.55.37.png

Template selection dialog keeps shifting on selection - Ubuntu

The template selection dialog needs a little tweaking. When a template is selected the selection box shifts to the right.
Screenshot: Red dashed line shows the shifting.
https://www.dropbox.com/s/ynu7y3dcngdbvq3/ScreenShot.png?dl=0

Quiz Template Issue

The issue is a typical radio button issue. Radio Button in a radio group is not accepting the same selected button.

Bug Detection Procedure:

1. Create a quiz of around 5 questions.
2. Install the apk and start the quiz.
3. Answer the question as any of the question ( I took Option C in my case)
4. Click Submit and then next.
5. As the next question arrives try to click on the same option button as in step 3 ( In My case again Option 3 )

Radio button will not be shown selected until some option other than previous one is selected,

External Web Browser in Tools settings

Usage of external web browser settings can be better explained by adding a short description.

Flashcard Template Simulator

In the Simulator - Let's show "Question # 1 of 5" like in the mobile app.

Help Option on dialogs not operational

On 'Check for Updates', 'Settings' and 'About' dialog, click on '?' i.e. help does nothing.

On APK generation show dialog

Current implementation shows a bubble. The problem with this is that sometimes it goes un-noticed and disappears before clicking.

With the bubble implementation, Ubuntu shows 'click here to copy output path to clipboard'. Clicking on the bubble doesn't do anything and the bubble disappears.

Let's convert it to a dialog?

Allow user to specify custom application APK file name for each separate generating.

Generate mobile application -> on click -> should show a text input dialog prefilled with the application name to be generated -> allow to edit -> give buttons for "Continue" and "Cancel".

MR: Good point.

Buttons size and visibility in ubuntu

Buttons resolution and size seems improper in Quiz and flashcard template. Info template start simulation button missing.Generate Application option not visible(Ubuntu)

Add setting for generation folder

This setting allows to choose a custom folder where the generated apps would be dropped.

untracked files shown when installing to a custom folder

untracked files are shown(i.e the build folder) when the build folder is not included in .gitignore. I used the following cmake command

cmake ../ -DCMAKE_BUILD_TYPE="relase" -DCMAKE_PREFIX_PATH=/prefix/path -DCMAKE_INSTALL_PREFIX=/install/prefix=/install/prefix/path -DUSE_QT_5="ON"

Bug with basic mLearning Project type

While using the toolkit i've encountered the bug described bellow.

Here are the steps i took to generate the problem:
1- Open the Toolkit
2- Created a new basic mLearning Project.
3- Created a random number of items, i've tested it with 5 items, 2 items and 10 items.
4- Deleted all of the items and the delete button stayed enabled.
5- Clicked once more on the delete button and the toolkit crashed.

Tab order not working in Template Editors

Pressing tab on a line edit should take you to the next line edit or button. The tab order is not set.

LearnSpellings Template - Need to ignore spelling case

The current implementation of simulator is case sensitive when comparing spelling with the given word.

If I write ‘Cat’ instead of cat, it says wrong spelling. We should make this comparison case insensitive like the mobile app does.

Flashcard APK problem

When flashcard APK is generated and installed on the phone, the question is displayed in place of hint and the hint is not displayed. This needs to be fixed by mobile client application developer.

NSIS installer tutorial blog post

Write a blog post on how to use NSIS. Would be great if the post would cover how you generated the installers for the toolkit and any special techniques used if any.

Author name and title limits for all template

Author name limit - 50 characters
Title limit - 100 characters

The simulator must be able to display this much characters without clipping, ideally should wrap.

Quiz Template on device - radio buttons don't get selected easily

Radio buttons do not get selected easily until you press and hold it hard on device.

Reported by Ashmita

Learn Spellings Template: Skip button doesn't work in simuator

The skip button doesn't do anything on click. I am testing on Ubuntu.

Must have consistent behaviour for downloading updates on all the OS's

User is directed to buildmlearn.org when user clicks on update for Ubuntu whereas directly downloads in case of windows. User should be directed to buildmlearn.org/downloads for all.

unicode problem

BuildmLearn Toolkit fails to save & load unicode characters to/from project files.

Application Pause State

The state of the application is sometimes lost if activity remains in a pause state for a longer duration.

Regardless of the last saved state when application is resumed and previous state is shown rather that the current state.

Test done of spelling test module. Complete the test your scored will be displayed . Press Home button to pause the application , resume after some time and your will observer that the first screen and set of questions (in my case last question) is displayed again.

New project dialog not pre-opened on application launch.

Currently shows blank window on application launch with menu on the top. If New application window is opened it will be more clear to user on how to proceed.(All the OS's)

Basic mLearning project template bug

One can generate the mobile application even without specifying Author and Collection Title
this bug exists in BuildmLearn toolkit 2.0.4 precompiled binary version.

Unable to play the sound file

When i click on the listen button ( spellings template) during simulation i get a pop up message saying "Sound cannot be played on this platform because sound file was not downloaded" , please tel me how to resolve this issue.

On flipping flashcard - can we show the border?

On flipping the flashcard, we show the answer.. which is fine. Can we also so the border of the card.. so that it looks like a card was flipped?

Project and Applications Menu should be merged

Project Menu is not required. All the actions should be moved to the Application Menu. Also they should be renamed to 'New Application', 'Save Application', 'Load Application', 'Save Application As...', 'Generate Application'. Provide generic keyboard shortcuts for new, save, quit, save as, help, etc.
Add 'How it works' link in Help menu.

Exception not properly handled in main.cpp

In try...catch of the main.cpp file, exceptions are (IMHO) not properly handled. Say in a rare case that an exception occurs, does the Window exit? No! The Main Dialogue does not seem to be able to be exited properly, it still continues execution despite the fact that "The toolkit will now close. Please relaunch the toolkit to create your apps," it doesn't "close && restart." It just stays there, waiting for the human intervention instead of exiting indicating failure on its part.

To fix, I suggest you return EXIT_FAILURE after the exception has been handled(on QMessageBox::Ok).

Build for Windows

Make a build for Windows available with the new added features (perhaps weekly).

Garbage characters appended to Build date in About Dialog

Check this screenshot: https://dl.dropboxusercontent.com/content_link/9XQ76X3IFKVVxGIE5OUm1LvfGolVLYOoyBKswzL7xVGAJzynIRaXyFpSQJsds4ZI

Wordwrap not enabled for the questions in quiz template(quizitem.ui file)

If the question is longer than the width of the device/simulator, it comes in a single line instead of multiple lines. As a result, the text which should in the second line gets hidden. I managed to solve this by enabling word-wrap property for the QLabel widget named 'm_lblQuestionText' in the file quizitem.ui line number 32.

Problem with QListWidget in InfoTemplate.cpp

I'm one of the applicants who is interested in applying for GSoC 2014 for your organization and I was going through the codes and the toolkit and discovered a bug.

When making an informative app, I found that when removing the last item from the item list the program crashes.

I have figured out that the slot

void InfoTemplate::on_itemList_selected()
{
        textEdit->setPlainText(iDescriptionList.at(itemList->currentRow()));
}

gets called after the last item is deleted from the (QListWidget) ItemList which then tries to access a null pointer (deleted item)

I solved it by adding a check for null pointer at the slot.

void InfoTemplate::on_itemList_selected()
{
    if(itemList->currentItem() != 0)
        textEdit->setPlainText(iDescriptionList.at(itemList->currentRow()));
}

there was also a problem with the remove function which removes the item in the ItemList and proceeds to remove other items from other lists with the index of the "deleted item".

I think by adding a temp integer which possesses the value of the item's index before deleting it fixes the issue.

void InfoTemplate::on_removedButton_cicked()
{  
    int temp = itemList->currentRow();
    itemList->takeItem(temp);
    itemList_phone->takeItem(temp);
    iTitleList.removeAt(temp);
    iDescriptionList.removeAt(temp);
}

I'm looking forward to working with you in the GSoC 2014!

Add titlebar and status bar to simulator

1. Check a generated application on mobile phone. There is a application title. We should add this to our simulator.
2. Is it possible to add a status bar like on the phone? Check this image: http://briefmobile.com/images/articles/2012/07/Samsung-Galaxy-Nexus-Android-4.1-Jelly-Bean-Screenshot-011.png
   What I mean is the top bar with digital time. We can cut and display from this image, however the time needs to be system time. This would give a real "phone" simulator feel. What do you think?