Changeset 26521

Show
Ignore:
Timestamp:
27.11.2012 04:13:25 (7 years ago)
Author:
davidb
Message:

Updating of text to reflect the latest version of the scripts provided by this extension

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • gs3-extensions/i-jetty/trunk/src/README.txt

    r25768 r26521  
    2626Having sourced the setup file the two main steps are: 
    2727 
    28   1) Install i-jetty 
     28  1) Install i-jetty on the Android device 
    2929 
    30   2) Install Greenstone3 as a web-app  
    31      (converting any jar and class files to DEX format) 
     30  2) Install Greenstone3 as a web-app application on Andoird device 
    3231 
    33 The first step typically only needs to be done once. The second step is 
    34 composed of three sub-steps, and may require the last two sub-steps to 
    35 be repeated if the Java code has been modified. 
     32The first step typically only needs to be done once.  
     33 
     34 
     35The key task for the second step is to transfer greenstone3's "web" 
     36directory to /sdcard/jetty/webapps/ on the Android device.  In 
     37principle that would be: 
     38 
     39  <GSDL3SRCHOME>/web -> <ANDROID-DEVICE>:/sdcard/jetty/webapps/greenstone3 
     40 
     41However we need to convert all the Java code (which lurks in Jar 
     42files) in the "web" folder into DEX-byte-code equivalents first.  We 
     43therefore break this step of the installation down into sub-steps (see 
     44below).  In overview, we create a "webapps" folder in the *extension* 
     45folder, where we copy the static file content of "web" to (i.e., the 
     46non-Java stuff).  We then top that up with Dexified versions of the 
     47Java code.  Finally the whole "webapps/greenstone3" folder in the 
     48extensions area is copied over to the Android device. 
     49 
    3650 
    3751Step 1 
     
    7084-------- 
    7185 
    72 Transfer the bulk of the <GSDL3SRCHOME>/web structure to the  
    73 <SDCARD>/ijetty/webapps/greenstone3 with: 
     86Transfer the bulk of the <GSDL3SRCHOME>/web structure to the preparation 
     87area "webapps" with the extension foler (i.e., where you are running these 
     88scripts from) with: 
    7489 
    75  
    76   WEBAPP-ROOT-TO-SDCARD.sh 
     90  ./PREPARE-WEBAPPS-GREENSTONE-ROOT-FOR-IJETTY.sh 
    7791 
    7892This script skips any .svn files if present.  It also skips installing 
    79 'localsite' as this is rather large -- both in size and in terms of 
    80 the number of files invovled -- so copying is rather slow, and it is 
    81 probably not what you want anyway. 
    82  
     93the majority of 'localsite' as this can be rather large -- both in 
     94size and in terms of the number of files invovled -- so copying is 
     95rather slow, and it is probably not what you want anyway.  Only the 
     96'lucene-jdbm-demo' collection is copied to the preparation area. 
     97Any other collections you wish to add should be manually added to 
     98the "webapps/greenstone3/sites/localsite/collect/" area. 
    8399 
    84100Step 2.2 
     
    88104classs.dex with: 
    89105 
    90   JAVA-TO-DEX.sh   
     106  ./JAVA-TO-DEX.sh   
    91107 
    92 The finished file, which is also by this point zipped up, is left in 
    93 the 'lib' folder. 
     108The finished file, which is also by this point zipped up, is stored in 
     109the 'lib' folder (should you wish to inspect it).  It is also 
     110automatically copied to "webapps/greenstone3/WEB-INF/lib" which is 
     111where it needs to be to work when installed on the Android device. 
    94112 
    95113 
     
    97115-------- 
    98116 
    99 Copy classes.zip onto the Android's sd-card 
     117Copy Greenstone3's webapps folder onto the Android device's sd-card: 
    100118 
    101   DEX-TO-SDCARD.sh   
     119  ./IJETTY-PUSH.sh webapps/greenstone3 
    102120 
    103121This is the final step in getting Greenstone3 setup on an Andoird. 
    104122Switch off the USB disk mode on the Android device.  Note: it can take 
    105 a device minute or two "preparing" the sd-card.  This can be seen 
    106 on the notification view.  Alternativey, if you try to start i-jetty 
     123a device minute or two "preparing" the sd-card.  This can be seen on 
     124the notification view.  Alternativey, if you try to start i-jetty 
    107125before the card is ready, then i-jetty points this out, and offers you 
    108126a 'retry' button. 
     
    116134web-browser application.  We've tested the built-in web browser, and 
    117135Mobile Firefox 4. 
     136==== 
    118137 
    119  
    120 If the Java code to Greenstone3 is changed, then you need to repeat sub-steps 
    121 2.2 and 2.3 
    122  
     138If the compiled Java code to Greenstone3 has changed, then you need to 
     139repeat sub-steps 2.2 and 2.3.  Transfering just the newly 
     140dexified code can be achieved more quickly by entering: 
     141   
     142 ./IJETTY-PUSH.sh webapps/greenstone3/WEB-INF/lib 
    123143 
    124144 
     
    131151   support. 
    132152 
    133  
    1341532. Due to a runtime (reflection) error, we had to modify xalan.jar. 
    135    The modified version of this file is also in the 'jars' folder 
    136    used in this extension. 
     154   The modified version of this file is also in the 'modified-jars' 
     155   folder used in this extension. 
    137156 
    138157