Common Kit
FREE/LINE/PLUS

own iPhone apps
w/o programming

Quick Start
Manual
V1.3






Finger Screen Control in SHOW mode:
- single tap by 1 finger turns over question
  side and answer side;
- horizontal moving by 1 finger leafs over
  page-by-page;
- horizontal moving by 2 fingers leafs fast
  over pages;
- vertical moving by 1 finger scrolls text;
- vertical moving by 2 fingers (on left screen
  side) changes transparency of picture or
  (on right screen side) text;
- moving by 3 fingers changes background
  and text shadow color;
- moving by 4 fingers changes text color;
- double tap by 1 finger temporary shows
  page, picture, text, and pauses/resumes
  playback;
- triple tap by 1 finger restarts last playback;
- single tap by 2 fingers or i-button click calls
  the page URL link and settings;
- p-button click shows Project Picker and
  accepts new project;
- shake switches shuffle (@) / non-stop ($)
  modes.




This Universal Tool allows anyone without programming to create any own Interactive Books, Tests, Quizzes, FAQs, Riddles, Flash Cards, Training audio-visual Aids, Business Presentations, Art, Photo, Musical Albums, etc., i.e. any your interactive audio-visual Collections, Knowledge and Media Data Bases for entertainment, education, or business.

Everyone has unique experience, taste, and knowledge! Create your projects and publish them on your WEB server for yourself and your friends.

You can do it easy and fast in EDIT mode on your PC and then use it in SHOW mode on your iPhone/iPod/iPad with WiFi/Internet or even without.

How to do it? Just read this my manual and see other examples in my Collection on http://barixa.net/kit (click i-button to see).



Any human Knowledge can be split up small parts with a page size and usually it is binary info (Question / Answer or Term / Explanation). Therefore each page of your Album has two sides too, and each side can include any text, picture, sound and external link to see, listen, and understand this info totally. You have only to insert the necessary data and this Common Kit will do a rest automatically.


To get it you do the following easy steps:

1. run a local Web server on your PC;
2. create directory for your project;
3. add configuration file (optional);
4. add background picture (optional);
5. add your picture, text, sound, and link
    for each side of each page (all optional);
6. setup your iPhone to see your project
    and tune it by iteration of points 3-5;
7. download project into iPhone (optional).



1. Run a local Web server on your PC

2. Create directory for your project

You can use any Web server in Internet (if you have access) but the best way for fast development of your projects is to use a local Web server on your PC. For example, for Windows XP you can use WWW Service of built Internet Information Services (IIS).

If you have MAC PC, go to "System Preferences", "Sharing", and set "Web Sharing" (see picture below). Then http://<IP address> on right side of this panel is in your LAN the URL of your local Web server on your PC with root in directory "Library/WebServer/Documents". For example, if you want to create your project with name "myProject", I recommend to create in this directory the subdirectory "kit/myProject" for future development.

Click i-button for more detail explanations.




3. Add configuration file (optional)


The optional configuration file with fixed name "ckit.cfg" defines some start default values for your project. For example, this manual has the following configuration:
--------------------------
10,Arial,
jpg,txt,m4a,url,
0.05,0.26,0.82,1.00,
1.00,0.95,0.34,1.00,
#end
--------------------------
It means:
"10" is maximum page number (default 999),
"Arial" is default font,
"jpg" is picture file extension,
"txt" is text file extension,
"m4a" is sound file extension,
"url" is external link file extension,
"0.05,0.26,0.82,1.00" background color,
"1.00,0.95,0.34,1.00" foreground color.



Colors are given as HSBA (Hue, Saturation, Brightness, Alpha) values. The Common Kit uses these new colors from configuration file if the previous colors had defaults values too. However, if you already changed colors by finger control, the changed colors are used until you click "Restore original screen colors" button in Settings (see picture below).




If this file is absent the Common Kit will use global defaults (the same values excepting maximum page number that is 999).

You can use other extensions (especially for pictures and sounds) that are supported by iPhone OS, but then your project must use ONLY these types of files and it must be explicitly defined in this configuration file.



4. Add background picture (optional)


The optional background picture is file with fixed name "bgnd.png". For example, this manual has the background picture with my labrador Bari. This file has always PNG format because must include the Alpha channel (Transparency data).

You can use any own picture to convert it for background. I would recommend using the great & free GIMP software (click i-button to see web site). Open any your picture in GIMP and add Alpha channel (Layer/Transparency / Add Alpha Channel). Then you can adjust transparency (Colors / Levels) by setting Output Levels for Alpha Channel and then save it as PNG with name "bgnd.png".

NB! Unlike foreground picture you cannot tune the transparency of this background picture by finger control in SHOW mode.



5. Add your picture, text, sound, and link

   for each side of each page (all optional)

All files are optional and have fixed names by the following rules:
1. first char is side of page: "q" (Question,
    frontside of page) and "a" (Answer,
    backside of page);
2. 3-digits number of page from "000" (for
    title page) to "999" (for maximal default
    page number);
3. the proper file extension from
    configuration file or by default ("jpg" for
    foreground picture, "txt" for text, "m4a" for
    sound, and "url" for URL link to external
    resource).

For example, "q000.txt" is the text on title page 0, "a002.jpg" is the picture on backside of page 2, "q000.m4a" is the sound for title page 0 (here W.A.Mozart, A little night music), and "a002.url" is external URL link for backside of page 2.



5.1 Add foreground picture (optional)


The optional foreground picture is file with fixed name for proper side of proper page and fixed extension from configuration file or by default. For example, "a002.jpg" is the JPG picture on backside (Answer side) of page with number 2.

You can use any own picture to convert it to proper format. Default format is JPG because it provides usually a minimal file size and network traffic. I would recommend using the great & free GIMP software (click i-button to see web site) for handling and converting your pictures.

NB! For foreground picture you can tune the transparency on the fly in SHOW mode by vertical moving by 2 finger on left screen side. This trick allows temporary to hide picture (for example, to read easier a covering text or to play games & riddles).



The current version of Common Kit does not support zooming and just places your picture "as is" in center. Therefore you should prepare a picture in advance. Usually it means Crop (Tools / Transform Tools / Crop) and Resize (Image / Scale Image).


Crop allows to cut a necessary part of your original picture. If you want to use the picture for whole iPhone screen (320 x 480) you should only save the proper aspect ratio (2/3) with cropping.

Then this image you should resize to iPhone screen size (320 x 480) by scaling. A good idea is remaining some edges also. If your picture has another aspect ratio you should resize this image proportionally to fit horizontal or vertical size of screen. Additional effects could be used with overlaying background and foreground pictures. Feel free!



5.2 Add foreground text (optional)


The optional foreground text is file with fixed name for proper side of proper page and fixed extension from configuration file or by default. For example, "q000.txt" is the UTF-8 text on frontside (Question side) of title page with number 0.

You can use any Text Editor (for example, TextEdit on MAC) to prepare the text that will cover the background and foreground pictures. By default this text will use center alignment, font and colors from configuration file (or by default) for text and shadow.

NB! For foreground text you can tune the transparency on the fly in SHOW mode by vertical moving by 2 finger on right screen side. This trick allows temporary to hide text (for example, to show clearly a covered picture or to play games & riddles).



By default the Common Kit will automatically calculate the font size in order to fit this text on screen (to cover whole screen by this text). Therefore you always can get necessary font size and text allocation on iPhone screen by inserting some additional spaces and CRs.

Beside that you can:
1. change alignment for this page by first
   control char ("<" for left alignment and
   ">" for right alignment);
2. set necessary font name (optionally) and
   font size (optionally) for this page by
   following tag "[font_name, font_size]"
   (unfortunately it works correctly
   not for all fonts).

If you have given the font size the Common Kit will calculate a new vertical size of text area. To see all text you can scroll text by vertical moving by 1 finger.

For example, this page text starts with
"<[Times New Roman,17] . . ."

Also additionally you always can change text and shadow colors in order to highlight text on picture background. Feel free!




5.3 Add sound (optional)


The optional sound is file with fixed name for proper side of proper page and fixed extension from configuration file or by default. For example, "q000.m4a" is the sound for frontside (Question side) of title page with number 0.

You can use any sound or music to convert it to proper format. Default format is M4A because it provides usually a minimal file size and network traffic. I would recommend using the great & free Audacity software (click i-button to see web site) for handling and converting your sounds.

NB! You can pause / resume / restart the playback by double & triple taps by 1 finger on the fly in SHOW mode. This trick allows also temporary to show picture, text, current and maximal page number, shuffle mode, and network source.



Usually for acceptable sound quality (typically for voice comments) you can use mono M4A format with rate 16000 Hz. For example, use standard Dictaphone app on your iPhone to record your comments for proper page. Then upload the Voice Memo to PC and open this file in Audacity.


1. Change project rate to 16000 Hz;

2. Convert stereo to mono (Tracks /
    Stereo Track to Mono);

3. Optionally normalize sound (Effects /
    Normalize) and use other possible
    effects (for example, Fade In/Out, etc);

4. Export in "M4A (ACC) Files (FFmpeg)"
    format with proper name (for example,
    "a007.m4a" for this page)





5.4 Add external URL link (optional)


The optional external URL link is file with fixed name for proper side of proper page and fixed extension from configuration file or by default. For example, "a002.url" is external URL link for backside of page 2.

Really this link is just UTF-8 text of proper URL, i.e. "http://..." You can use any Text Editor (for example, TextEdit on MAC) to prepare this text reference that will be called with clicking i-button on this page. By default (if this link is absent) the Common Kit calls own Web page (http://barixa.net/ckit.html).

NB! Obviously that this link can call also any your own Web page on your Web server where you can allocate any additional info (including other your own or external Web references, Wiki info, YouTube video, etc.), i.e. any necessary resources of Internet.



At last, by clicking i-button you always call just built Web browser and can use it independently on this prescribed URL link. Just press right "goGoogle" (Search) button on the top panel (see picture below) and find any other necessary Web resources by searching your request.




Also you can use "goBack" (Rewind) button in order to return to previous Web pages. To finish Web surfing just press "Done" button in order to return to your interactive Book.

Feel free!



6. Setup your iPhone to see your project


With startup the Common Kit uses Source URL of this manual (that is just example of project too): "barixa.net/kit/manual".




Just press "Settings" button and change it to URL of your project. For example, if your PC (with Web server) has IP address "192.168.1.60" you can correct it like this picture (prefix "http://" can be omitted).










After
pressing
"Done" the
Common Kit will
automatically start
this new project, i.e.
use your data from directory
"kit/myProject" of your Web server.
You should just see and test your project page-by-page, and correct your data if need. Of course, at first time you will spend rather long time (especially for text correction and alignment, inserting additional spaces and CRs, and according picture and text), but anyway it is a creative work of designer, not programmer. Feel free to do it with pleasure!



7. Download project into iPhone (optional)

(LINE version does not support download)

Thus, this manual is also one of examples and has right 11 pages, and you can read it on-line or download to use off-line (even for FREE version). Therefore a good start is firstly to download this manual.

1. Before downloading any project must be
    started on-line;
2. Then press i-button and "Download"
    (Organize) button (must be enabled);
3. After "Copying..." press "Settings" button
    and switch "Source URL" OFF.

After pressing "Done" the Common Kit will automatically start this downloaded project. Now (depending on state of "Source URL" switch) you can use either this downloaded project (even without WiFi/Internet) or any on-line project from Source URL setting.



In my public Collection (barixa.net/kit) you can find some ready projects:


- manual, This Quick Start Guide
  (11 pages);
- music, The Best Classical Music
  (102 pages);
- zagadki, Russian folklore riddles for Kids
  (151 pages);
- prikoly, Russian folklore riddles for Adult
  (61 pages).

I would recommend to use these examples as start point for your projects. You can take these projects as ZIP archives and firstly try to start it on your local Web server.

After creating your own collections (if you would like to share it worldwide) you could also send it to me as ZIP archive in order to add your projects to this public collection.

Sincerely yours,  Andrew Kazantsev