# The &marble; Handbook

Torsten
Rahn

    &Torsten.Rahn.mail;

2005
2006
2007
&Torsten.Rahn;
&FDLNotice;
2008-08-24
0.6

&marble; is a geographical atlas and a virtual desktop globe which lets you quickly explore other places on our home planet. You can use &marble; to look up places, to easily create maps, measure distances and to retrieve detail information about locations that you have just heard about in the news or on the Internet. The user interface is clean, simple and easy to use.

KDE
education
earth
globe
geography
marble

## Introduction

&marble; logo
&marble; logo

Welcome to &marble;, a small interactive globe and geographical atlas that puts the world at your fingertips. Just like a real atlas or a conventional globe &marble; allows you to freely move across its map and lookup places. Furthermore &marble; allows you to zoom in and have many different views on the surface of the Earth. In its default configuration &marble; offers 11 different views: Atlas, Open Street Map, Satellite View, Earth at Night, Historical Map 1689, Moon, Plain Map, Precipitation (December), Precipitation (July), Temperature (December) and Temperature (July).

&marble; comes with a small database of more than 12,000 locations (cities, mountains, volcanoes) which can be searched for and which are partially integrated with the popular Internet encyclopedia Wikipedia. Additionally you can measure distances using &marble; between multiple measure points which can be set freely.

&marble; is free software and licensed under the &GNU; Lesser General Public License.

## &marble; quick start guide: Navigation

Here is &marble; the first time you run it, either with Applications Edutainment Science Desktop Globe Marble from the &kmenu; or with &Alt;F2 and entering `marble` into the field.

&marble; main window
&marble; main window

On the right you can see a topographical map of our beautiful home planet. To allow for better orientation the map offers a scale bar in the lower left corner as well as a windrose on the top right. To navigate and to control the view you can use the toolbox on the left: Press the arrow buttons to rotate the globe. The Up and Down arrow buttons will tilt the earth axis back and forth. The Left and Right arrow buttons will make the earth spin around its physical axis.

You can accomplish the same behaviour by pressing the &LMB; somewhere on the globe and by moving the mouse while keeping the &LMB; pressed. Using this drag and drop style navigation will allow you to adjust the viewing angle much easier and more precisely. The cursor keys on your keyboard offer another alternative way to quickly change directions.

Zoom in and out by moving the vertical slider up and down. If your mouse has got a mouse wheel you can use that one instead - or you just hold the &LMB; and the &RMB; down both at once while moving the mouse up and down. Changing the zoom level step by step can be done via the Zoom In and Zoom Out buttons which are placed above and below the zoom slider (or using the + and - keys on your keyboard.

Depending on the map's resolution zooming in will provide you with more detail. Smaller cities will appear and using the topographic map you might notice that coastlines are provided as vector graphics.

In case you should get lost you can always reset the viewing angle and zoom level back to the point where we started off: Just hit the Home button (or the Home button on your keyboard).

## Choosing different map views for &marble;

&marble; comes with 11 different views: Atlas, Open Street Map, Satellite View, Earth at Night, Historical Map 1689, Moon, Plain Map, Precipitation (December), Precipitation (July), Temperature (December) and Temperature (July). You can choose among these by pressing the Map View tab on the bottom of &marble;'s toolbox:

&marble; map views
&marble; Map Views

- Atlas: A classic topographic map. It uses vector lines ( "MicroWorldDataBase II" ) to mark coastlines, country borders &etc; and bitmap graphics ( "SRTM30" ) to create the height relief.

- Open Street Map: A global roadmap created by the OpenStreetMap (OSM) project. OSM is an open community which creates free editable maps. The OSM data was rendered using Mapnik.

- Satellite View: Earth as seen from Space. The map is based on NASA's beautiful "Blue Marble Next Generation" pictures. Credits: NASA’s Earth Observatory

- Earth at Night: This image of Earth’s city lights was created with data from the Defense Meteorological Satellite Program (DMSP) Operational Linescan System (OLS).

- Historical Map 1689: A historical world map from the year 1689 created by G. van Schagen in Amsterdam.

- Moon: A map of the moon. The map is based on data from the Clementine Moon mission (UVVIS Basemap Mosaic). Credits: NASA/SDIO, Courtesy USGS Astrogeology Research Program.

- Plain Map: A plain map. It uses vector lines to mark coastlines and country borders &etc;

- Precipitation (December): A map which shows the average precipitation in December.

- Precipitation (July): A map which shows the average precipitation (rain/snow/hail/etc) in July.

- Temperature (December): A map which shows the average temperature in December.

- Temperature (July): A map which shows the average temperature in July.

## Searching places using &marble;

&marble; comes with a small database of more than 12,000 cities ( from http://www.worldgazetteer.com ) and a few mountains and volcanoes. You can find a location by entering its name into the search line on the top of the toolbox. If you're unsure about the spelling (&marble; always uses the native name in latin letters) you can choose the location browser below the search line as well: A double click on the respective entry will instantly display the matching place on the map.

&marble; searching places
&marble; Searching Places

Once you found your city on the map you can click on its label or its symbol using the &LMB;. A popup menu will appear which allows you to retrieve more information about the city. This popup menu can also be used to find out the coordinates for any point on the globe as the coordinates always get displayed at the bottom of the popup menu. After clicking the name of the location on the popup menu a data sheet dialog will appear, like this:

&marble; Data Sheet
&marble; Data Sheet

On the first tab of the dialog some very basic data is provided, like the name, coordinates and flag of the country the place belongs to. In addition, population numbers for cities get shown, as well as the elevation for mountains. If your computer is connected to the Internet and if you're online &marble; will try to connect to the popular Internet encyclopedia Wikipedia. If a matching Wikipedia article is available &marble; will display it on the second tab of the dialog.

## Measuring distances with &marble;

As mentioned already &marble; always displays a dynamic scale bar on the lower left to estimate distances on the map. Together with the windrose in the top right corner these overlays are provided for better orientation. But there's more: &marble; allows you to measure distances between two or more points on earth. To do so click the respective points in correct order on the globe using the &RMB;. On each click a popup menu will appear which allows you to add a measure point (Add Measure Point) or to remove all measure points altogether (Remove Measure Points):

&marble; measuring
&marble; measuring distances

Once you have added at least two measure points, the total distance will be displayed in the top left corner of the map. &marble; will assume a spherical earth for all measurements which should be accurate enough for most cases.

## Command Reference

### Menus and shortcut keys

#### The File Menu

&Ctrl;O File Open Map...

  Opens a map file.

&Ctrl;N File Download New Data...

  Displays the Get Hot New Stuff! dialog to download additional maps for &marble;.

&Ctrl;S File Export Map...

  Exports a screenshot of &marble;'s map to an image file.

&Ctrl;P File Print...

  Prints a screenshot of &marble;'s map.

&Ctrl;Q File Quit

  Quits &marble;

#### The Edit Menu

&Ctrl;C Edit Copy Map

  Copies a screenshot of &marble;'s map to the global clipboard.

Edit Copy Coordinates

  Copies the current coordinates the global clipboard.

#### The View Menu

View Show Statusbar

  Toggle the display of the status bar.

F9 View Show Navigation Panel

  Toggle the display of the navigation panel.

View Infoboxes

  In this submenu you can to lock the position of the infoboxes and show or hide the plugins you have enabled in the Plugins page of &marble;s configuration dialog.

View Clouds

  Show real time cloud cover. A real time cloud map that gets updated every 3 hours. It uses GOES, METEOSAT, and GMS satellite imagery downloaded from the Geostationary Satellite Imagery page at Dundee University. Credits: Hari Nair, Xplanet Project

View Atmosphere

  Show the diffuse reflection of the atmosphere around the earth.

View Sun Control

  Displays the Sun Control where you can set date and time, the simulation time speed, the Sun Shading and center the map on sun position.

#### The Settings Menu

Settings Show Toolbar

  Toggle the display of the toolbar.

Settings Show Statusbar

  Toggle the display of the status bar.

F9 Settings Show Navigation Panel

  Toggle the display of the navigation panel on the left side of the main window.

&Ctrl;&Shift;F Settings Full Screen Mode

  Switches between normal view and full screen view. In full screen view, the titlebar is hidden and the actual application window is resized to the entire screen.

Settings Configure &marble; Desktop Globe...

  Display the &marble; configuration dialog.

#### The Help Menu

&help.menu.documentation;

## Configuring &marble;

### View Configuration

The View configuration dialog
The View configuration dialog

Distance

  The unit that gets used to measure altitude, lengths and distances (&eg; km, mi, ft).

Angle

  Specifies the notation of angles in coordinates: By default the Degree-Minute-Second notation (e.g. 54°30'00" ) gets used. As an alternative you can choose decimal degrees (e.g. 54.5°).

Still image

  Specifies the map quality that gets displayed while there is no user input. Usually this allows for high map quality as speed is no concern.

During animations

  Specifies the map quality that gets displayed during map animations (e.g. while dragging the globe). Especially on slow machines it is advisable to set this option to Low Quality as this will give better speed.

Place names

  Places often have different names in different languages. The label on the map can show the name in the user's language. Alternatively it can display the name in the official language and glyphs of that place.

Default Map Font

  The default font that gets used on the map.

### Navigation Configuration

The Navigation configuration dialog
The Navigation configuration dialog

Drag location

  While dragging the mouse there are two standard behaviours when dealing with a virtual globe: The location below mouse pointer will follow the cursor exactly: As a result e.g. the north pole will not stay at the top which can lead to confusion. By default Marble makes sure that north is always up which results in a dragging behaviour where the location below the mouse pointer slightly "detaches" from the cursor.

On Startup

  By default Marble will display the home location immediately after the application has started. As an alternative it can also show the last position that was active when the user left the application.

Animate voyage to the target

  When searching for a location Marble can either move instantly to the new location or it can show a travel animation from the previous place to the new place.

### Cache & Proxy Configuration

The Cache & Proxy configuration dialog
The Cache & Proxy configuration dialog

Cache

  There are two caches being used for &marble;: The physical memory which is needed to keep map data in the computer's memory. Increasing the value will make the application more responsive. The hard disc memory cache is used by download contents from the Internet (e.g. Wikipedia data or map data). Decrease this value if you want to save space on the hard disc and if high usage of the Internet is not an issue.

Proxy

  Proxy settings for your local intranet. Please leave empty if there is no proxy.

### Plugins Configuration

The Plugins configuration dialog
The Plugins configuration dialog

Compass

  This is a float item that provides a compass.

Scale Bar

  This is a float item that provides a map scale.

Overview Map

  This is a float item that provides an overview map.

Stars Plugin

  A plugin that shows the Starry Sky.

## Questions and Answers

I cannot see my house on the map / Why should I use &marble; if there is Google Earth already?

&marble; aims to be a lightweight fast educational geographical browser that easily runs on any plattform that is supported by &Qt;. While higher resolution maps would be nice to have they aren't necessary for every user and every use case (just like you don't use a full blown text processor each time you just need a simple editor). Also notice &marble; is free software and is based on data that can be freely redistributed in the same way that applies to Free Software.

Why is &marble; so fast although I don't have hardware acceleration enabled? / Why doesn't &marble; run smoothly on my expensive 3D graphics card?

Despite depicting the earth as a globe &marble; doesn't make use of any 3D hardware acceleration. This has the advantage of running at a decent speed on any plattform and hardware supported by &Qt;. However it has the disadvantage that it doesn't run as smoothly as it could if it used hardware accelerated OpenGL. &marble; just uses plain 2D graphics and therefore requires a graphics adapter that is fast at drawing 2D graphics. We plan to add an optional OpenGL backend in the future.

Will I ever have to pay for &marble;?

No, never. But the authors always welcome feedback. &marble; is licensed under the LGPL, so you will never have to pay for this program.

How can I contribute?

&marble; is not only an application but also a Free Software project. As such it's easy to join: just contact us via the kde-edu mailing list (kde-edu@kde.org).

## Credits and License

&marble;

Program Copyright, 2005-2007 &Torsten.Rahn; &Torsten.Rahn.mail;

Contributors:

- &Torsten.Rahn; &Torsten.Rahn.mail;

- Inge Wallin inge@lysator.liu.se

&underFDL; &underLGPL;

## Installation

### How to obtain &marble;

&install.intro.documentation;

### Requirements

&marble; itself can be found on the &marble; home page and is part of the &kde;-Edu project

You can find a list of changes in the file `ChangeLog` in the distribution of &marble;.

### Compilation and Installation

&marble; can be compiled as a &Qt; 4-only version as well as featuring &kde; 4 support. To compile &marble; with &Qt; 4-only support check out &marble; from &kde; SVN into ~/marble and just do: `cmake -DQTONLY=ON ~/marble` and `sudo make install`. To compile &marble; with &kde; support check instructions on how to compile &kde; applications at &kde;'s TechBase.

&documentation.index;