[[PageOutline(2-5, Table of Contents, floated)]]

= Papywizard User Guide =

''This documentation refers to the release 1.0''.

For installation instructions, see [InstallationGuide here].

== Usage overview ==

Papywizard is very easy to use, and I hope the GUI is intuitive enough.

The first thing to do is to edit the configuration, to reflect you camera/lens/head/hardware config. Basic settings are the delay to wait after moving (to let the head stop shaking), the delay to wait while shooting (camera Tv value), and the number of pictures to take at each position (bracketing). See below for specific mode settings.

Second, you need to connect to the hardware (Menu ''Hardware > Connect''). If you use the bluetooth driver (default config), you need to enter the correct address of your adapter. Alternatively, you can get a list of all available bluetooth devices arround, and select the correct one.

Then, just move the head either using the big GUI arrows, or using the shortcuts (see below), and set the start/end positions.

Once it is done, just open the shooting dialog and launch the entire process. That's it!

== Advanced usage ==

Papywizard has now 2 modes: ''Mosaic'' mode, and ''Preset'' mode. The first one is mainly used for partial panos, and is especially designed for hi-res panos, using a large tele-lens. The second one is designed for full-spherical panos, using a wide-lens or a fisheye.

=== Mosaic mode ===

The mosaic mode computations are based on the following parameters:

 * minimum overlap
 * camera orientation
 * sensor coef. and ratio
 * focal lens

So, these settings must exactly reflect your configuration.

It also needs the start/end positions, which are two opposite corners of the pano you want to shoot. It does not matter which corner you use for start or end, but it will influence the direction the pano will be shot. Note that, depending of the settings, Papywizard can start shooting from the start position, or from the end position. This is usefull to avoid the head to go back to the opposite corner before shooting (which takes time and uses batteries).

It is also possible to choose the initial shooting direction. Using ''yaw'' will shoot row by row; using ''pitch'' will shoot column by column. Same, the head can go back to the begining of the row (column) before shooting the next one. See [#Tipsandtricks Tips and tricks] for advices.

=== Preset mode ===

This mode is very simple, and does not use any particular settings; it just shoots at all positions defined in the selected template. The only thing to do is to set the ''home'' position of the head (zero), which will be the reference for the template positions. In case the camera/lens can't be moved in all positions, it is possible to set some limits, to avoid potential colisions.

== Reference manual ==

=== Main window ===

==== Menus ====

 * '''File > Quit''': exit from Papywizard [[BR]]
 * '''Hardware > Connect''': connect to the head hardware [[BR]]
 * '''Hardware > Set limit...''': set the selected limit to curent position [[BR]]
 * '''Hardware > Clear limits''': reset all limits [[BR]]
 * '''Hardware > Reset''': reset the head hardware [[BR]]
 * '''Help > Manual''': show manual (not yet implemented) [[BR]]
 * '''Help > View log...''': open log window [[BR]]
 * '''Help > About''': show the about dialog [[BR]]

==== buttons ====

 * '''Mosaic/Preset''': switch between mosaic and preset mode
Mosaic mode:
 * '''Yaw/Pitch/Both''': set the start (end) shooting positions from current position [[BR]]
Preset mode:
 * '''Template''': template defining all positions
All modes:
 * '''Left/Right Yaw arrows''': move head on yaw axis [[BR]]
 * '''Left/Right pitch arrows''': move head on pitch axis [[BR]]
 * '''Set origin''': set the current position as origin (yaw=0.0°, pitch = 0.0°) [[BR]]
 * '''Configuration...''': open the config. dialog [[BR]]
 * '''Shoot...''': open the shooting dialog [[BR]]

==== displays ====

Mosaic mode:
 * '''Start''': start shooting position [[BR]]
 * '''End''': end shooting position [[BR]]
 * '''Total Fov''': total shooting field of view [[BR]]
 * '''Nb picts''': shooting number of pictures [[BR]]
 * '''Real overlap''': real shooting overlap [[BR]]
Preset mode:
 * '''Template''':
All modes:
 * '''Position''': current position of the head [[BR]]

=== Configuration dialog ===

==== Shooting tab ====

 * '''Stab. delay''': delay to wait after the head has stopped, and before shooting, to let the head stablizing [[BR]]
 * ''' Overlap''': minimum wanted overlap¹ [[BR]]
 * '''Orientation''': camera orientation on the head¹ [[BR]]
 * '''Start from''': start position¹ [[BR]]
 * '''Initial direction''': initial moving direction¹ [[BR]]
 * '''CR''': if set, go back to the start of the row/columns before starting a new one¹

''¹: only usefull in mosaic mode.''

==== Camera/lens tab ====

 * '''Time value''': shooting time (Tv camera value) [[BR]]
 * '''Number of pictures''': number of pictures to take at each position (bracketing) [[BR]]
 * '''Sensor coef.''': ratio to 24x36 sensor size
 * '''Sensor ratio''': width/height sensor ratio
 * '''Lens focal''': real focal of the lens

==== Hardware tab ====

 * '''Driver''': hardware driver to use [[BR]]
 * '''BT device address''': bluetooth device address for 'bluetooth' driver [[BR]]
 * '''Choose...''': list all available bluetooth devices, and allow to select one [[BR]]
 * '''Serial port''': serial device port for 'serial' driver
 * '''Auto-connect''': if set, try to automatically connect to the head at startup

==== Misc tab ====

 * '''Logger level''': level of informations to log
 * '''Data file format''': format to use for the output data file name. The final name is {{{papywizard_<format>.xml}}}
  * {{{%(date)s}}}: expands to current date
  * {{{%(time)s}}}: expands to start shooting time
  * {{{%(date_time)s}}}: same as {{{%(date)s_%(time)s}}}
  * {{{%(mode)s}}}: expands to shooting mode

==== buttons ====

 * '''OK''': validate settings and close dialog
 * '''Cancel''': revert to previous settings and close dialog

=== Shoot dialog ===

==== buttons ====

 * '''Manual shooting''': if checked, automatically go to suspend mode at the end of each move, before shooting [[BR]]
 * '''Data file enable''': if checked, write a xml data file in the current directory (for APP) [[BR]]
 * '''Start''': start shooting process [[BR]]
 * '''Suspend/Resume''': suspend/resume shooting process [[BR]]
 * '''Stop''': cancel shooting process
 * '''Done''': close shooting dialog

==== displays ====

 * ''shooting area'': display the shooting position
 * ''progress bar'': shooting process progression

== Keyboard shortcuts ==

Papywizard main target is ''Nokia Internet Tablets'', so keyboard shortcuts are dedicated for that plateform (but works fine with normal PC). Here are defined shortcuts:

 * In main window:
||'''Nokia'''||'''PC'''||'''Function'''||
||[[Image(Right.png, 24, nolink)]]||Right|| Turn the head right (Yaw +)||
||[[Image(Left.png, 24, nolink)]]||Left||Turn the head left (Yaw -)||
||[[Image(Up.png, 24, nolink)]]||Up||Move the head up (Pitch +)||
||[[Image(Down.png, 24, nolink)]]||Down||Move the head down (Pitch -)||
||[[Image(F7-increase.png, 24, nolink)]]||Home||Set current position as start position||
||[[Image(F8-decrease.png, 24, nolink)]]||End||Set current position as end position||
||[[Image(Return.png, 24, nolink)]]||Return||Open shooting dialog||

 * In shooting dialog:
||'''Nokia'''||'''PC'''||'''Function'''||
||[[Image(Return.png, 24, nolink)]]||Return||Start/pause shooting||
||[[Image(Escape.png, 24, nolink)]]||Escape||Stop shooting - Return to main window||

 * In all dialogs:
||'''Nokia'''||'''PC'''||'''Function'''||
||[[Image(F4-menu.png, 24, nolink)]]||F10||Show menu||
||[[Image(F5-home.png, 24, nolink)]]||-||Standard maemo behaviour||
||[[Image(F6-fullscreen.png, 24, nolink)]]||F6||Toggle fullscreen mode (no more activated)||