Difference between revisions of "Projects/Marble/GoMarble/JJ"

Revision as of 15:34, 27 March 2010

Marble Junior Jobs

If you are new to Marble then you want to check this page. We list a few things you can do which are easy tasks and introduce you to Marble development.

Quality Assurance / Documentation

We want our Marble source code to look good. The documentation should be concise and helpful and the comments shouldn't have spelling errors. Also it shouldn't have any obvious "formal" bugs. Help us to improve our code quality. This is an easy job that helps you to get familiar with the source code. It's the first thing that absolute beginners usually want to look at. We list a few important issues that need to be checked for regularly:

• Try to find spelling errors in the source code comments and in Marble UI strings. (EASY)
• KDE Krazy check: Have a look at the results of the static code checker: http://www.englishbreakfastnetwork.org/krazy/reports/kde-4.x/kdeedu/marble/index.html. Try to understand possible problems and create a fix for them. (EASY/MEDIUM)
• Get rid of compile warnings: Compile Marble from scratch and check all the warnings that possibly appear. Try to get rid of the warnings by adding fixes. If parameters are not used, examine why and either remove them or hide the warning or leave it as it is. (EASY-MEDIUM)
• Compile marble with the cmake option -DPEDANTIC=ON. Fix all errors that come up until Marble compiles through (MEDIUM).
• Add comments. You don't understand some source code in Marble? Then probably other people won't either. Try to understand it and ask Marble developers. The add some comments so that the next person will be able to understand the source code much easier (MEDIUM).
• Create API-Documentation (EASY).
• Review the API. Make sure that the API is Qt-ish (MEDIUM). Read http://qt.gitorious.org/qt/pages/ApiDesignPrinciples and read the Marble source code. Try to find cases which seem to be non-standard. (MEDIUM)
• Read our Marble Coding Standards: http://websvn.kde.org/trunk/KDE/kdeedu/marble/CODING?revision=700337&view=markup. Ensure that the Marble source code follows it (EASY).
• Help to translate Marble into your own language. Try to find "weird" translations or translations that don't express things in words that a normal user would understand and correct/report them (MEDIUM).

• Check KDE's Bugzilla for any open Marble bugs: https://bugs.kde.org/buglist.cgi?quicksearch=Marble. Try to reproduce the bugs and check whether the bugs are still valid. Remove them if they're not valid anymore and seem to be fixed already (EASY). Try to fix them if they are still valid (MEDIUM/HARD).

If you come across a problem don't hesitate to ask us (there are no stupid questions, just people who are afraid of asking for stupid reasons ;-) If you want to send in your patch for review, please send it to our mailing list marble-devel@kde.org.

KML

This section deals with junior jobs that deal with Marble's data structure:

Implement a "simple" tag for KML support (e.g. LookAt)

The <LookAt> tag in KML should be quite easy to implement -- at least compared to the other tags. Alternatively you can try to find a different tag that looks like it would be easy to implement, however you need to check in the handler or data directory whether it is implemented already.

• Have a look at the KML reference:

http://code.google.com/apis/kml/documentation/kmlreference.html#lookat

• Have a look at Marble's geodata source (in marble/src/lib/geodata).
• Try to understand what the parser, the handler and the data stuff does.
• Create a new handler (EASY)
• Connect Marble's MarbleMap::setLookAt() command to execute the lookat command

Create an "Open Recent ..." menu entry

In marble/src/KdeMainWindow.cpp use

http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKRecentFilesAction.html

to create an open recent menu entry for the KDE version of Marble. Adding the same functionality to the Qt version of Marble is a bonus task.

Displaying Debug Info on request

• One could change the MarbleWidget::setTileId method to a

MarbleWidget::setDebugInfo( DebugFlags )

method where DebugFlags is using QFlags

http://doc.trolltech.com/4.5/qflags.html

One could then set enable the qDebug messages by e.g. setting

m_widget->setDebugInfo( DebugText | ShowTileID );

Level of difficulty: EASY

Adding Bookmarks

Gaurav is already working on this one.

• It would be nice if Marble had its own bookmark feature: Like in Konqueror you'd be able to click Bookmark->Add Bookmark and the current position and zoom value would get stored as a bookmark. Once the user would click the bookmark item the original coordinate and zoom value would get restored. You can use MarbleWidget::centerLongitude(), MarbleWidget::centerLatitude(), MarbleWidget::zoom() and the setters for the same properties to retrieve and set the coordinates.

Level of difficulty: HARD

Reload Maps in the Qt Application

The KDE Marble application has a menu entry to reload maps. The same functionality is available in the context menu on the Marble Widget, but the Qt Marble application is currently missing the "Reload Map" menu entry. Please add it and connect it to the appropriate slot (see MarbleWidgetInputHandler).

Level of difficulty: EASY

Add more Plugin Icons

Marble's plugin API lets plugins define an icon which is shown in the menu for activating plugins. Only a few plugins use icons so far however. Please locate appropriate plugin icons (chances are high the oxygen project already has some) and add them. A good start would be the Photos Online Service Plugin.

Level of difficulty: EASY

Add support for 23 to marble's Photos Online Service Plugin

Marble's Photos Online Service Plugin currently displays photos downloaded from Flickr. As 23 also provides flickr API, it should be possible to display images from 23 as well.

Level of difficulty: HARD