| 1 | TIPPLE README
|
|---|
| 2 | -------------
|
|---|
| 3 |
|
|---|
| 4 | 1. SVN checkout this URL to somewhere (from now on I will call this "somewhere" the "root" dir):
|
|---|
| 5 | http://svn.greenstone.org/other-projects/tipple-android/
|
|---|
| 6 |
|
|---|
| 7 | The layout of the folder you checked out is as follows:
|
|---|
| 8 | tipple-lib (main Tipple library)
|
|---|
| 9 | tipple-standalone (main implementation of Tipple that references tipple-lib)
|
|---|
| 10 | osmosis (plugin to create your own 2D map files for Tipple, see PDF file "mapsforge-getting-started.pdf" inside this folder)
|
|---|
| 11 | mixare-fixes (optional fixes for Mixare)
|
|---|
| 12 | i-greenstone-server-files (things for i-greenstone-server)
|
|---|
| 13 |
|
|---|
| 14 | 2. Assuming you have at least Android 2.3.3 SDK installed, import into Eclipse the folders
|
|---|
| 15 | tipple-lib, tipple-standalone
|
|---|
| 16 |
|
|---|
| 17 | Eclipse > File > Import > Android > Existing Android Code into Workspace
|
|---|
| 18 |
|
|---|
| 19 | 3. Edit setup.sh if necessary in order to put the Android SDK "platform-tools" folder
|
|---|
| 20 | on the classpath, then type into cygwin terminal:
|
|---|
| 21 |
|
|---|
| 22 | source ./setup.sh
|
|---|
| 23 |
|
|---|
| 24 | 4. Unzip/untar "mixare-development" into the same directory as mixare-fixes.sh, and
|
|---|
| 25 | rename it to "mixare".
|
|---|
| 26 |
|
|---|
| 27 | (Latest repo of Mixare is probably here, in case you do want to work with the latest version:
|
|---|
| 28 | https://github.com/DevBinnooh/mixare)
|
|---|
| 29 |
|
|---|
| 30 | IMPORTANT NOTE:
|
|---|
| 31 | If by step 9, there's no tipple-android/mixare/plugins/mixare-library/bin/mixarelib.jar
|
|---|
| 32 | and it complains about this, then, in the unzipped mixare-development.zip, you will find
|
|---|
| 33 | a build.xml in the mixare-development/plugins/mixare-library folder.
|
|---|
| 34 | The 'dist' target will generate the mixarelib.jar. So run 'ant dist' from
|
|---|
| 35 | mixare-development/plugins/mixare-library.
|
|---|
| 36 |
|
|---|
| 37 | Wendy explained that for this to work, she needed to compile (mixare? or tipple?) from
|
|---|
| 38 | eclipse to set up the proper "gen" directory and that ant did not do this for us.
|
|---|
| 39 |
|
|---|
| 40 | 5. In the root directory of trunk, execute this .sh script in your cygwin terminal by typing:
|
|---|
| 41 |
|
|---|
| 42 | ./mixare-fixes.sh
|
|---|
| 43 |
|
|---|
| 44 | 6. Launch Eclipse, and import:
|
|---|
| 45 | mixare (this requires you to select "mixare/" in the import projects window)
|
|---|
| 46 | mixare-lib (this requires you to select "mixare/plugins" in the import projects window)
|
|---|
| 47 |
|
|---|
| 48 | (If Eclipse complains about one of these projects not having a "res" folder, just create
|
|---|
| 49 | a blank folder called "res" for the project in Eclipse)
|
|---|
| 50 |
|
|---|
| 51 | Mixare needs Google APIs level 10. Run the Android SDK Manager (button in toolbar
|
|---|
| 52 | in Eclipse) and tick Android 2.3.3 (API 10) -> Google APIs.
|
|---|
| 53 |
|
|---|
| 54 | Within Eclipse, run as "Android Application" the mixare project (not mixare-lib).
|
|---|
| 55 | This will install it onto your phone. Now with that done, the only thing left
|
|---|
| 56 | to do is run as "Android Application" the project:
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | 7. Type into cygwin terminal (with Android device connected with USB):
|
|---|
| 60 |
|
|---|
| 61 | adb install i-greenstone-server-files/i-jetty-3.1-aligned.apk
|
|---|
| 62 |
|
|---|
| 63 | This will install i-greenstone-server on your phone. Then launch the
|
|---|
| 64 | application *at* *least* *once* and wait for it to set itself up.
|
|---|
| 65 |
|
|---|
| 66 | Then do:
|
|---|
| 67 |
|
|---|
| 68 | pushd i-greenstone-server-files/greenstone/webapps/
|
|---|
| 69 | tar xvzf greenstone3.tar.gz
|
|---|
| 70 | popd
|
|---|
| 71 |
|
|---|
| 72 | adb push i-greenstone-server-files/greenstone/webapps/greenstone3/sites/localsite/collect/tipple-universe /sdcard/greenstone/webapps/greenstone3/sites/localsite/collect/tipple-universe
|
|---|
| 73 |
|
|---|
| 74 | (For the sake of being conservative, I have given you my own development files to push over. If you want to
|
|---|
| 75 | start from scratch and compile your own i-greenstone-server and generate your own "latest and greatest" GS3
|
|---|
| 76 | webapp on it, then I suggest you check out on the Greenstone SVN the extensions "i-greenstone-server" and
|
|---|
| 77 | "android-war", found in the folder "gs3-extensions".)
|
|---|
| 78 |
|
|---|
| 79 | 8. Open i-greenstone-server, and click "Start Greenstone".
|
|---|
| 80 |
|
|---|
| 81 | 9. In Eclipse, run "Tipple" (not "Tipple Library") as an Android application, and hopefully everything works out!
|
|---|
| 82 |
|
|---|
| 83 | (You will see one marker on campus with the i-greenstone-server turned on, and you'll see six markers with the pre-built hamilton.loc XML file.
|
|---|
| 84 | If you change your GPS location to Whangarei (i.e. with a fake GPS application) you should see more!)
|
|---|
| 85 |
|
|---|
| 86 | If not, immediately shoot me an email at [email protected]. Do not hesitate!
|
|---|
| 87 |
|
|---|
| 88 |
|
|---|
| 89 | ADDITIONAL INFORMATION
|
|---|
| 90 | ----------------------
|
|---|
| 91 |
|
|---|
| 92 | - I have included a folder with the Tipple SVN called "osmosis", if you are
|
|---|
| 93 | interested in building your own .map file for Tipple. Because I had issues
|
|---|
| 94 | with the latest version of Osmosis, I put on SVN the version of Osmosis
|
|---|
| 95 | I used + a saved version of the "getting started" webpage as a PDF. You only
|
|---|
| 96 | really need to use the "getting started" PDF in order to find out how to install
|
|---|
| 97 | the Mapsforge plugin for Osmosis. Once you have the Mapsforge plugin installed, go to osmosis/bin
|
|---|
| 98 | and look at the example compile.bat I have created in order to generate your
|
|---|
| 99 | own .map file.
|
|---|
| 100 |
|
|---|
| 101 | - Even if the GPS is turned on and you turn on AR View (Mixare) in Tipple, it may
|
|---|
| 102 | say something like "Connection error occured - please make sure you are connected
|
|---|
| 103 | to internet" or something like that. You just have to keep hitting "Retry" until it
|
|---|
| 104 | works (it will disappear when Mixare gets a GPS location fix).
|
|---|
| 105 |
|
|---|
| 106 | - When you query from i-greenstone-server, all "locations" have the same marker radius, which is
|
|---|
| 107 | actually quite big. This is because originally my articles in the collection "tipple-universe"
|
|---|
| 108 | did not have the "Radius" metadata in them. So if you put a "Radius" metadata in an article,
|
|---|
| 109 | my GreenstoneXMLRetriever.java should map that to "radius", as long as you remove
|
|---|
| 110 | the exact line I used to hardcode the radius.
|
|---|
| 111 |
|
|---|
| 112 | BUGS
|
|---|
| 113 | ----
|
|---|
| 114 |
|
|---|
| 115 | - i-greenstone-server may randomly stop hosting sometimes. Logcat logs indicate
|
|---|
| 116 | the OS is trying to get rid of it. Or maybe it's a problem I caused. Definitely look into this.
|
|---|
| 117 |
|
|---|
| 118 | - Whenever Tipple removes all the markers and displays new ones (i.e. when your location has
|
|---|
| 119 | changed sufficiently), if you go into one of the new locations and the phone vibrates, you
|
|---|
| 120 | won't see the yellow marker with the '+' symbol telling you you're currently in this location.
|
|---|
| 121 |
|
|---|
| 122 | -------
|
|---|
| 123 | CONTACT
|
|---|
| 124 | -------
|
|---|
| 125 |
|
|---|
| 126 | If you are confused about any of this or want more info, do not hesitate to email me at:
|
|---|
| 127 | [email protected]
|
|---|
