Merge branch 'qml' of ssh://drop.maemo.org/git/mdictionary into qml
[mdictionary] / www / screenshots_list_guide
diff --git a/www/screenshots_list_guide b/www/screenshots_list_guide
new file mode 100644 (file)
index 0000000..deb8b29
--- /dev/null
@@ -0,0 +1,138 @@
+Copyright (C) 2007 ComArch S.A
+
+       author          : Dariusz Wiechecki
+       contact         : dariusz (dot) wiechecki (at) comarch (dot) com
+       date            : 11/7/2007
+       version         : 0.1
+
+                      WhiteStork Screenshots List
+
+Abstract
+       This document describe what screenshots are needed for each version of
+WhiteStork. Furthemore, there are presented tools that can be used to take
+screenshots on maemo platform in this document.
+
+1. Introduction
+       
+
+2. Tools
+       There are few applications and tools that can be used for taking
+screenshots on maemo platform based system. Some are listed here.
+
+   2.1 osso-screenshot-tool
+       It is the best method to make a screenshots, but only when You have got
+access to the devica through SSH. Executing command:
+osso-screenshot-tool file.png
+will result in taking immediately screenshots and putting it into file.png. So
+it is possible to give a file particular, specyfic name and place it in any
+directory You want. When there is no SSH access it will need XTerminal installed
+on the system and make it harder to specify a name. To download tool go to page:
+http://repository.maemo.org/pool/maemo/ossw/o/osso-screenshot-tool (11/7/2007)
+or google for phrase "osso-screenshot-tool".
+
+   2.2 HM Shot Tool
+       On page http://inz.fi/blog/2007/06/21/screenshooting-made-easy-ish/ You
+will find out more about this tool. There is a big disadvantage of MH Shot Tool
+- it does not support (11/7/2007) delayed screenshot.
+
+   2.3 Maemo Screengrabber
+       Go to http://tuomas.kulve.fi/blog/2007/01/17/maemo-screen-grabber/ or to
+http://maemo.org/downloads/product/OS2007/maemo-screengrabber/ for
+more information. It is wrapper for osso-screenshot-tool that allow you to
+take a screenshot by activating menu position in task navigator. It will wait
+for 5 seconds and take a screenshot, placing it in Image folder.
+
+   2.4 load-applet-run
+       This tool can be downloaded from 
+https://garage.maemo.org/projects/load-applet/. After instaling load-applet, You
+should place it in status bar. It allows for delayed screenshots, but there is
+no option to change defualt folder for images (Images).
+
+   2.5 Using VNC
+       It is possible to install VNC Server on the device
+(http://mike.saunby.googlepages.com/x11vncfornokia7702). If server is running it
+is easy to connect to it from Your host computer and take a screenshots directly
+from Gnome/KDE/Ms Windows system.
+
+   2.6 Scratchbox
+       If application is able to run on scratchbox, screenshots could be taken
+from it. This method is not recomended as far as sometimes applications looks
+different on scratchbox and on device. Furthemore scratchbox does not have all
+functionalities that is accessible on maemo platform, so not always there will
+be option to show all application's functions. At last, but not at least,
+screenshots taken on real device looks muche better than ones taken on
+scratchbox.
+
+3. Screenshots List
+       For each version of WhiteStork there could be different functionalities,
+so it is needed to distinguish them (versions) in screenshots list. Newer
+version has always all screenshots from the previous one (unless there is 
+straightforward specified that some screenshots are not actual in new version)
+plus some new, presenting functions and GUI parts tha were not present in old
+version. Furthemore, from time to time it is helpfull to put complete list of
+screenshots for particular version, to prevent the user from browsing whole
+document and assemble full screenshots list from many versions - such a list
+is titled: "WhiteStork [COMPLETE LIST] (version x.y.z)"
+
+   3.1 WhiteStork [COMPLETE LIST] (version 1.1.0)
+       3.1.1 [ Installing ]
+          3.1.1.1 
+          3.1.1.2 
+          3.1.1.3 
+          3.1.1.4 
+          3.1.1.5 
+          3.1.1.6 
+          3.1.1.7 
+          3.1.1.8 
+          3.1.1.9 
+          3.1.1.10 
+          3.1.1.11 
+          3.1.1.12 
+          3.1.1.13 
+          3.1.1.14 
+          3.1.1.15 
+          3.1.1.16 
+          3.1.1.17 
+          3.1.1.18 
+          3.1.1.19 
+          3.1.1.20 
+       3.1.2 [ Platform Integration ]
+       3.1.3 [ Main View ]
+       3.1.4 [ Application Menu ]
+       3.1.5 [ Context-Sensitive Menu (CSM) ]
+       3.1.6 [ Dictionaries Managing ]
+       3.1.7 [ About and License Dialog ]
+
+   3.2 WhiteStork (2.0.0 - not available yet!)
+
+4. Final Word
+
+5. Additional informations
+
+   5.1 Creating thumbnails from image set
+       You will need to have a convert command in order to be able to use this
+method. It is available with package imagemagick (in Ubuntu distro:
+ sudo apt-get install imagemagick).
+       With convert You can execute below script in directory with all images
+You want to thumbnail:
+
+for f in *.png
+do
+  fn="thumbnails/${f%%.png}_thumb.png"
+  echo "converting: $f -> $fn"
+  convert -scale 120x50 ${f} ${fn}
+done
+
+       Of course You can change scale, files extension, target directory or
+name.
+
+   5.2 Creating web page gallery with screenshots
+for f in *.png
+do
+  fn="thumbnails/${f%%.png}_thumb.png"
+  echo "<a href=screen/OS2008/${f} target=_blank><img src=screen/OS2008/${fn} /></a>"
+done
+
+5. Note
+   5.1 Generating list of numbers:
+       for n in `seq 1 20`; do echo -e "3.1.1.$n"; done;
\ No newline at end of file