GSoC/GCI Archive
Google Code-in 2010 Haiku

Create Haiku User Guide page for ShowImage and MediaPlayer

completed by: Szymon Barczak

mentors: humdinger

The Haiku User Guide describes the system and all the included applications and preferences.

The chapters on the image viewer ShowImage and MediPlayer are still missing. This task is to add these chapter showing all the relevant features, functions and settings together with meaningful screenshots. Style and detail should fit into the rest of the user guide, see especially the chapters about the other applications.

ShowImage hints:

  • Either activate "Selection mode" to select with the left mouse button, or use CTRL+left mouse button
  • Drag&drop selection to desktop, use right mouse button to specify format.
  • "High-quality zooming does very fast bilinear filtering.



MediaPlayer hints:

  • Double left-click for fullscreen
  • Double right-click to hide interface
  • Subtitles are supported in SRT format, the subtitle menu item depends on the SRT filename, e.g. to show "english" there
  • Shortcuts: space == play/pause, Z (or Y, depending on your keymap) == track prev, X == play, C == pause, V == track next
  • More shortcuts: Cursor left/right == seek, ALT+left+right == seek 10 sec., up/down volume, ALT+up/down == track prev/next


Videos or images as part of a screenshot have to be under a compatible license, e.g. Creative Commons, or better,  take your own imge or video clip (or fake some photo into the MediaPlayer window...).

Documentation should be done using a current nightly image (r39567 is quite stable, when in doubt). As these don't contain the browser Web+ by default, you can install it manually by typing in a Terminal window "installoptionalpackage WebPositive".


You'll find links to the User Guide at ~/config/settings/WebPositive/LoaderPages/ that load pages directly from SVN if there's no guide installed on your hard disk.


The final page will be in HTML. If you're comfortable editing in very simple HTML you can do so and do the necessary formatting yourself. The alternative is providing your work as plain text file plus screenshots in PNG format. In any case, have a look at this style guide.


Applicants have to

  • have Haiku up and running and already had a look at the apps to be described.
  • have a very good grasp of the English language.
  • have read a fair amount of the user guide and be able to mimic its style and detail.
  • be open to suggestions and the occasional rewrite of a section.