Browse files

fixed spelling in rhodes docs

  • Loading branch information...
1 parent ee97c8a commit 084d52c52e89e2bbc4712e1d136dbc2405a15226 @davstrom davstrom committed Aug 25, 2012
Showing with 82 additions and 82 deletions.
  1. +14 −14 doc/build.txt
  2. +3 −3 doc/configuration.txt
  3. +1 −1 doc/connect-to-web-services.txt
  4. +24 −24 doc/device-caps.txt
  5. +11 −11 doc/linea.txt
  6. +2 −2 doc/nfc.txt
  7. +4 −4 doc/release.txt
  8. +6 −6 doc/rhom.txt
  9. +12 −12 doc/rhostudio-test-plan.txt
  10. +2 −2 doc/simulator.txt
  11. +1 −1 doc/syncengine-ajax-api.txt
  12. +2 −2 doc/ui.txt
View
28 doc/build.txt
@@ -226,12 +226,12 @@ The default build.yml settings generated for iphone are:
* emulatortarget: device family for simulator (iphone/ipad)
* BundleIdentifier: bundle identifier - used in provisioning profile
* BundleURLScheme: bundle URL scheme of your app (used for opening your application from another application by using custom URL scheme)
-* entitlements_file: path of your custom Entitlements.plist (if you want use own instead of default) - you also can just put Entitlements.plist file into root folder of your application and it will be automaticallly used during build
+* entitlements_file: path of your custom Entitlements.plist (if you want use own instead of default) - you also can just put Entitlements.plist file into root folder of your application and it will be automatically used during build
* production: section used only for Ad Hoc distribution, contain some specific options for prepare .plist and *.ipa files etc.
* app_plist_title: title in plist file (application name by default)
* app_plist_subtitle: subtitle in plist file (application name by default)
-* app_plist_icon_url: icon url writed in plist file
-* app_plist_ipa_url: IPA file url writed in plist file
+* app_plist_icon_url: icon url written in plist file
+* app_plist_ipa_url: IPA file url written in plist file
* ipa_itunesartwork_image: path to iTunesArtwork image included into IPA file (must be 512x512 JPG image)
@@ -296,7 +296,7 @@ Download and unzip the [Android NDK](http://developer.android.com/sdk/ndk/index.
** NOTE: You need to update Android SDK platforms and Android NDK to latest ones as you update to new rhodes **
-In RhoStudio -> Preferences on the Macintosh or Winndows -> Preferences on Windows, open Rhomobile->Android and set the paths to your Android SDK and NDK installations.
+In RhoStudio -> Preferences on the Macintosh or Windows -> Preferences on Windows, open Rhomobile->Android and set the paths to your Android SDK and NDK installations.
<img src="http://rhodocs.s3.amazonaws.com/rhostudio-tutorial/preferences-android-sdk.png"/>
@@ -311,7 +311,7 @@ In case you are planning to work with native geo mapping (the MapView interface)
android:
apikey: "GOOGLE-API-KEY-FOR-ANDROID"
-* Enable 'mapping' in your application's `build.yml` (or in `<rhodes-root>/rhobuild.yml`). In RhoStudio, you can double-click on your application's build.yml and edit from the text editor; otherwise, you can edit rhobuil.yml or build.yml from another text editor.
+* Enable 'mapping' in your application's `build.yml` (or in `<rhodes-root>/rhobuild.yml`). In RhoStudio, you can double-click on your application's build.yml and edit from the text editor; otherwise, you can edit rhobuild.yml or build.yml from another text editor.
android:
mapping: yes
@@ -335,13 +335,13 @@ Otherwise your css files will not be loaded in Android 1.5 (and higher).
### Device capabilities settings in build.yml
-On Android, you must specify your device capabilities the your application will use. By default, these capabiliteis are NOT enabled.
+On Android, you must specify your device capabilities the your application will use. By default, these capabilities are NOT enabled.
In RhoStudio, you can double-click on your application's build.yml file, then click the Rhobuild setting tab, then click the Capabilities: Add button. You will see a list of capabilities you can check to activate for your application.
<img src="http://rhodocs.s3.amazonaws.com/rhostudio-tutorial/select-capabilities.png"/>
-You can also edit the build.yml file directly with a text editor. Here is a list of capabilites you can add to the capabilities section in your application build.yml file.
+You can also edit the build.yml file directly with a text editor. Here is a list of capabilities you can add to the capabilities section in your application build.yml file.
audio
camera
@@ -394,7 +394,7 @@ In the Run Configurations window, select Android in Platform, and Device in Simu
#### Reading the Log File with RhoStudio
-After you run your applciation in RhoStudio, your application log file, rholog.txt, is stored in your application directory. You can open and read rholog.txt in RhoStudio by double-clicking on it in the Project Explorer.
+After you run your application in RhoStudio, your application log file, rholog.txt, is stored in your application directory. You can open and read rholog.txt in RhoStudio by double-clicking on it in the Project Explorer.
### Building and Running Your Android Application from the Command Line
@@ -518,7 +518,7 @@ Now you are ready to install your application on your device and/or emulator.
In case of troubles in Eclipse while setting up the Android SDK and target, try "Rhodes project context menu" > "Android Tools" > "Fix Project Properties".
-It is possible your application has stopped unexpectedly just after the first build. In this case try to copy autogenerated java source files from the application folder <app>/bin/tmp to the Rhodes project.
+It is possible your application has stopped unexpectedly just after the first build. In this case try to copy auto-generated java source files from the application folder <app>/bin/tmp to the Rhodes project.
### Getting application log from device or emulator
@@ -565,7 +565,7 @@ Before you build edit build.yml from the application directory. Set the bbver to
bbver: 5.0
#### To build and run using Blackberry simulator 5.0 and higher
-Starting from Blackberry JDE 5.0, simulator supports loading application cod-files to simulator without restart. This feature greatly improve Blackberry development perfomance.
+Starting from Blackberry JDE 5.0, simulator supports loading application cod-files to simulator without restart. This feature greatly improve Blackberry development performance.
There are 2 possible scenarios available:
* Load application cod-file manually using Simulator menu: 'File\Load Blackberry application or theme...':
@@ -725,7 +725,7 @@ The log.txt file is the extracted log and should appear on the `C:\` drive.
* Run eclipse and choose rhodes\platform\bb as a workspace directory. Do not create workspace!
* Open menu Window\Preferences
- * Blackberry java plug-in\Warnings - check all 3 chekboxes to suppress all warnings
+ * Blackberry java plug-in\Warnings - check all 3 checkboxes to suppress all warnings
* Java\Compiler - set Compiler compliance level to 1.4
* Go to File\Import... menu. Select `General\Existing projects into Workspace` workspace node. Press Next.
* Browse for `<rhodes>\platform\bb\RubyVM`. Press Finish. The project will be automatically build.
@@ -794,7 +794,7 @@ You can find installation files in QT SDK folder like below:
For Symbian 9.4
QT - C:/QtSDK/Symbian/sis/Symbian1/Qt/4.7.3/qt.sis
- (install it only on disc C:, before install pls close all opened applications)
+ (install it only on disc C:, before install please close all open applications)
QT WebKit - C:/QtSDK/Symbian/sis/Symbian1/Qt/4.7.3/qtwebkit.sis
QT Mobility - C:/QtSDK/Symbian/sis/Symbian1/QtMobility/1.1.3/qtmobility.sis
@@ -819,7 +819,7 @@ NOTE: You have to install Rhodes on the same local disk with QtSDK!
### Build application from the command line
-Add pathes to Qt SDK and MS Visual Studio 2005 to rhobuild.yml in the Rhodes folder:
+Add paths to Qt SDK and MS Visual Studio 2005 to rhobuild.yml in the Rhodes folder:
env:
paths:
@@ -1114,7 +1114,7 @@ On 64-bit platform:
* Application Readme file can be provided by application developer. If file with README.html name exists in the root of application folder when Installer will display show readme at the final page of the Installer
* Application Icon should be used for Installer and application exe
-To build intaller bundle use command:
+To build installer bundle use command:
:::term
$ rake device:win32:production
View
6 doc/configuration.txt
@@ -138,7 +138,7 @@ Set this option to 1 in order to open Rhodes app in full screen mode. Default is
full_screen = 1
-Set this option to 1 in order to enable WebView zoom (Android only). Defauld is 0
+Set this option to 1 in order to enable WebView zoom (Android only). Default is 0
enable_screen_zoom = 1
@@ -189,12 +189,12 @@ To use only models from bulk database. If true, application will not create mode
use_bulk_model = true
-Disable WebView to check SSL sertificate (Android). Used to allow proced with self signed sertificates. Use at your own risk. This configuration option works well for any Android version except 2.3.3/2.3.4 (due to Android WebView behavior).
+Disable WebView to check SSL certificate (Android). Used to allow proceed with self signed certificates. Use at your own risk. This configuration option works well for any Android version except 2.3.3/2.3.4 (due to Android WebView behavior).
no_ssl_verify_peer = 1
### Last Visited Page
-To save/restore last visited page use WebView.current_location in on_ui_created/on_ui_destroyed of [AppAplication class](application#appapplication-class).
+To save/restore last visited page use WebView.current_location in on_ui_created/on_ui_destroyed of [AppApplication class](application#appapplication-class).
### Application Database Version
If you want the next version of your application to start from a clean database, set app_db_version in rhoconfig.txt.
View
2 doc/connect-to-web-services.txt
@@ -3,7 +3,7 @@ Connecting Directly to Web Services with Rhodes
Rhodes provides another utility for connecting to backend services besides the [`SyncEngine`](/rhodes/synchronization) called `AsyncHttp`. Your application can use the `AsyncHttp` library to interact with web services, pull remote images, etc.
## AsyncHttp API
-Below is the list of available `AsyncHttp` methods you can use to asyncrhonously make calls to http(s) services:
+Below is the list of available `AsyncHttp` methods you can use to asynchronously make calls to http(s) services:
### Common Parameters
* `:url` - URL of the request.
View
48 doc/device-caps.txt
@@ -235,7 +235,7 @@ To show currency (see rails analog for details):
Geolocation information is available in two ways: as an asynchronous service through Ajax calls to a predefined local URL, or in a controller using Ruby calls to the GeoLocation class.
-You need to enable the GPS capability to use GeoLocaiton. This is done by adding the following line to build.yml:
+You need to enable the GPS capability to use GeoLocation. This is done by adding the following line to build.yml:
:::yaml
capabilities:
@@ -452,7 +452,7 @@ These two parameters are used to paginate contacts list. If used with :count exa
The next parameters are available at Android only.
- * :select - list of contact properties have to be selected from phonebook (Use it to enchance query performance)
+ * :select - list of contact properties have to be selected from phonebook (Use it to enhance query performance)
* :conditions - hash of conditions to query contacts. Look for more details below.
**NOTE: It is allowed to pass additional params hash at all platforms. Platforms that has no extended functionality will just skip these**
@@ -534,11 +534,11 @@ Condition like
:::ruby
{:phone => 'not_nil'}
will select all contacts which has at least one phone.
-The next conditions are currently suported:
+The following conditions are currently supported:
- 'not_nil'
- 'is_nil'
-**NOTE: It may be useful to sort received contacts (espessially if paginated). Contacts is ordered by 'display_name' column and then splitted for pages. Unfortunately the order inside page is lost while passing the list to ruby**
+**NOTE: It may be useful to sort received contacts (especially if paginated). Contacts is ordered by 'display_name' column and then split for pages. Unfortunately the order inside page is lost while passing the list to ruby**
:::ruby
@count = Rho::RhoContact.find(:count, :conditions => {:phone => 'not_nil'})
@@ -619,10 +619,10 @@ On iPhone and Android additional event properties are supported. These are:
Recurrence properties:
"recurrence", "frequency"('daily', 'weekly', 'monthly', 'yearly'), "interval", "count", "end_date"
-"count" and "end" rucurrence properties are mutual exclusive. "end" is date/time beyond last event occurence but within same day.
+"count" and "end" recurrence properties are mutual exclusive. "end" is date/time beyond last event occurrence but within same day.
### Recurrence properties
-Recurrence properties are groupped in separate hash stored as single event property (event[Rho::RhoEvent::RECURRENCE]).
+Recurrence properties are grouped in separate hash stored as single event property (event[Rho::RhoEvent::RECURRENCE]).
### Names of properties
There are helper constants defined in Rho::RhoEvent which can be used to address event values and as predefined set of values (for frequency).
@@ -749,15 +749,15 @@ The Barcode API allows to try recognize barcode on an image:
:::ruby
Barcode.barcode_recognize(image_file_full_path)
-Barcode recognition functionality realized as Rhode Native extension. You should add "Barcode" to extension list in build.yml located in your application folder. `Barcode.barcode_recognize(image_file_full_path)` return string with recognized code or emty string if not any recognized barcodes on the image. You can combine Camera for get picture with Barcode recognition for process barcode data - see sample below.
+Barcode recognition functionality realized as Rhode Native extension. You should add "Barcode" to extension list in build.yml located in your application folder. `Barcode.barcode_recognize(image_file_full_path)` return string with recognized code or empty string if not any recognized barcodes on the image. You can combine Camera for get picture with Barcode recognition for process barcode data - see sample below.
For barcode recognition we use Zbar library (iPhone, and Windows Mobile platforms) and ZXing library (Android and BlackBerry platforms). In this case we support next barcode types :
* WM platform: UPC-A, UPC-E, EAN-8, EAN-13, Code 39, Code 128 .
* iPhone platform: UPC-A, UPC-E, EAN-8, EAN-13, Code 39, Code 128, QR Code .
* Android and BlackBerry platforms: UPC-A, UPC-E, EAN-8, EAN-13, Code 39, Code 128, Code 93, QR Code, ITF, Codabar
-**NOTE: We are very sorry, but we are removed ZBar source code from our project by ZBar license requirements. For build Barcode extension for WM, you should download ZBar sources from http://zbar.sourceforge.net/ and copy to [rhodes root]/lib/extensions/barcode/ext/barcode/shared/zbar/zbar/ folder "include" and "zbar" folders from ZBar sources. Also you should fix ZBar sources for building by Microsoft Visual Studio (move define of inner function variables to begin of functions, etc.). See detailed instructon in your Rhodes installation at /lib/extensions/barcode/ext/barcode/shared/zbar/zbar/README.TXT**
+**NOTE: We are very sorry, but we are removed ZBar source code from our project by ZBar license requirements. For build Barcode extension for WM, you should download ZBar sources from http://zbar.sourceforge.net/ and copy to [rhodes root]/lib/extensions/barcode/ext/barcode/shared/zbar/zbar/ folder "include" and "zbar" folders from ZBar sources. Also you should fix ZBar sources for building by Microsoft Visual Studio (move define of inner function variables to begin of functions, etc.). See detailed instructions in your Rhodes installation at /lib/extensions/barcode/ext/barcode/shared/zbar/zbar/README.TXT**
On Android and iOS (not supported on iPhone 2G and iPhone 3G !) now supported real-time barcode recognizing (second parameter is hash with options):
:::ruby
@@ -767,7 +767,7 @@ On Android also you can use front camera for take_barcode :
:::ruby
Barcode.take_barcode(url_for(:action => :take_callback), {:camera => 'front'})
-This code open special UI for real-time barcode recognizing from camera. If any barcode found recognizing stopped and user can select - confirm recognizing barcode or continue recognizig. If user confirmed or cancelled the callback will be called.
+This code open special UI for real-time barcode recognizing from camera. If any barcode found, recognizing stopped and user can select - confirm recognizing barcode or continue recognizing. If user confirmed or cancelled the callback will be called.
In callback are these parameters.
* "status" - "ok" or "cancel"
@@ -1043,7 +1043,7 @@ You can find complete example of using Bluetooth API in [Rhodes-System-Api-Sampl
## NFC
NFC (Near Field Communication). NFC API provide access to NFC functionality. You can check NFC availability on current device and register callback for listen event when NFC tag near of device. Currently NFC supported only on Android. And also Android version must be 2.3.3 or later.
-NFC API implemented in native extension. You should add "nfc" to extension list in your nuild.yml before start using NFC in your application. Please see detailed doc: [Rhodes NFC extension](/rhodes/nfc).
+NFC API implemented in native extension. You should add "nfc" to extension list in your build.yml before start using NFC in your application. Please see detailed doc: [Rhodes NFC extension](/rhodes/nfc).
**NOTE: As of Rhodes version 3.3.3, the [NFC](/rhodes/nfc) API is removed from Rhodes. This feature is only supported in Motorola RhoMobile Suite. If you wish to use this feature, you will need to [upgrade to RhoMobile Suite](/rhoelements/rhoelements-install). Your application's build.yml will also need to be modified to [indicate the application type is 'Rhoelements'](/rhoelements/rhoelements2-native#enabling-motorola-device-capabilities). Additionally, a [RhoElements license](/rhoelements/licensing) is required.**
@@ -1076,7 +1076,7 @@ See controller and view in the /app/Ringtones folder of the [System API Samples
## Printing
### Printing on iOS
-iOS inlude printing support. You should prepare File for printing and open it by standart platform - use:
+iOS include printing support. You should prepare File for printing and open it by standart platform - use:
:::ruby
System.open_url(file_full_path)
@@ -1092,7 +1092,7 @@ Android do not support printing. You can use any third-party application for pri
You should prepare file for printing and open it by standart platform - use:
:::ruby
System.open_url(file_full_path)
-Android platfrom open that file in application registered for file extension or show select dialog for manually choose application if there are more than one application registered for this extension.
+Android platform opens that file in application registered for file extension or show select dialog for manually choose application if there are more than one application registered for this extension.
We recommend prepare PDF. You can use PDF-Writer pure Ruby library for it - we include it into rhodes - just include "pdf-writer" and "thread" extensions to your application extension list in build.yml.
:::yaml
@@ -1225,7 +1225,7 @@ If no push notification mode is specified in build.yml then no notifications are
### BlackBerry
<a id="blackberry-push-setup"></a>Notifications to BlackBerry are sent using PAP 2.0 message through a BES/MDS server.
-On the simulator, this is done via the MDS simulator tool (which you've probably already seen in the form of a console window everytime you do 'rake run:bb'). On the device, this is done through the BES/MDS server that the phone is configured to use.
+On the simulator, this is done via the MDS simulator tool (which you've probably already seen in the form of a console window every time you do 'rake run:bb'). On the device, this is done through the BES/MDS server that the phone is configured to use.
These instructions assume you are familiar with BES/MDS concepts (for more information please see [here](http://na.blackberry.com/eng/services/business/server/full/)).
@@ -1464,7 +1464,7 @@ It is possible to customize the URI with build.yml settings. Default Rhodes URI
- host name
- path prefix
- optional path and query
-You can customize sheme and host name parts with following build.yml parameters:
+You can customize scheme and host name parts with following build.yml parameters:
:::ruby
android:
URIScheme: myapp
@@ -1513,7 +1513,7 @@ In application you can get start params by
For previous example start params will be "string_with_params".
-For execute you rhodes based application from enother rhodes based application use next code:
+For execute you rhodes based application from another rhodes based application use next code:
:::ruby
System.open_url('myapp:string_with_params')
@@ -1574,12 +1574,12 @@ Map settings:
* [latitude,longitude,latitudeDelta,longitudeDelta]. The area currently displayed by the map view. The region encompasses both the latitude and longitude point on which the map is centered and the span of coordinates to display. The span values provide an implicit zoom value for the map. The larger the displayed area, the lower the amount of zoom. Similarly, the smaller the displayed area, the greater the amount of zoom.
* latitude,longitude - map coordinate of the region center
* latitudeDelta - the amount of north-to-south distance (measured in degrees) to display on the map. Unlike longitudinal distances, which vary based on the latitude, one degree of latitude is always approximately 111 kilometers (69 miles).
- * longitudeDelta - the amount of east-to-west distance (measured in degrees) to display for the map region. The number of kilometers spanned by a longitude range varies based on the current latitude. For example, one degree of longitude spans a distance of approximately 111 kilometers (69 milies) at the equator but shrinks to 0 kilometers at the poles.
+ * longitudeDelta - the amount of east-to-west distance (measured in degrees) to display for the map region. The number of kilometers spanned by a longitude range varies based on the current latitude. For example, one degree of longitude spans a distance of approximately 111 kilometers (69 miles) at the equator but shrinks to 0 kilometers at the poles.
* {:center => center, :radius => radius}. Another way to define area displayed by the map view.
* center - string describing center of area. Can be any string allowed by google geocoding service. Examples: "1 infinite loop, cupertino, ca 95014", "California, USA", "37.365519,-121.982918"
* radius - radius of displayed area measured in degrees
* zoom_enabled - true if zoom of the map is enabled
-* scroll_enabled - true if scrool of the map is enabled
+* scroll_enabled - true if scroll of the map is enabled
* shows_user_location - true if current user location is displayed on the map
* api_key - Maps JavaScript API Key ([sign up for it here](http://code.google.com/apis/maps/signup.html)). Note that this parameter is ignored on Android! For Android you should get another key and specify it in the app's build.yml as described [here](build#Prerequisites_5)
@@ -1696,7 +1696,7 @@ Application can creates folders and files under apps and db roots.
# for file paths from camera callback etc: Rho::RhoApplication::get_blob_path(relative_file_path);
# to create file path for blob: Rho::RhoApplication::get_blob_folder()
-On iOS platform only files stored in /Documents/ bakuped in iCloud etc.
+On iOS platform only files stored in /Documents/ backup in iCloud etc.
Before Rhodes 3.3.2 all files stored in /Documents/ but Apple require do not placing files in Documents folder except user produced files.
Now all files except databases stored in /Library/Caches/Private Documents/ - files in this folder do not bakup.
If you want make any files should be bakup - use "user folder" for it - Rho::RhoApplication::get_user_path. All you files created in old version in Rho::RhoApplication::get_base_app_path now should be open in Rho::RhoApplication::get_user_path.
@@ -1719,8 +1719,8 @@ Also there are few additional parameters in build.yml (use it only if you want t
f.write('my own file !')
f.close
-Also you can set special iOS attiribute "do not bakup" to any files or folders or files related to database :
-### setup "do not bakup" attribute for files related database conaint Model 'Product'
+Also you can set special iOS attribute "do not bakup" to any files or folders related to database :
+### setup "do not bakup" attribute for files related database Model 'Product'
:::ruby
require_model 'Product'
db = Rho::RHO::get_src_db('Product')
@@ -1734,7 +1734,7 @@ Device/simulator files folder root - Program Files/<app name>/rho
To use client with the HTTP proxy you should pass its URL as the first command line argument `-http_proxy_url=http://<login>:<passwod>@<host>:<port>` or add it to rhoconfig.txt.
## Shutdown hook
-Like any application written in Ruby, rhodes can register a shutdown hook. Shutdown hook is routine registered for execution when the program exits. It usefull for cleanup on exit, saving program states, etc. To create you own shutdown hook you should add at_exit block to the file application.rb.
+Like any application written in Ruby, rhodes can register a shutdown hook. Shutdown hook is routine registered for execution when the program exits. It useful for cleanup on exit, saving program states, etc. To create you own shutdown hook you should add at_exit block to the file application.rb.
For example:
:::ruby
at_exit do
@@ -1768,7 +1768,7 @@ To make phone calls enable the phone capability. This is done by adding the foll
<a href="mailto:test@host.com?subject=testing123">Mailto</a>
Note, even for an empty address, you must add the @ symbol: <a href="mailto:@?subject=testing123">Mailto</a>
-Blackberry: if you need cc, bcc feilds, use rhomailto scheme:
+Blackberry: if you need cc, bcc fields, use rhomailto scheme:
:::html
<a href="rhomailto:test@host.com?cc=geny@mail.ru&bcc=vasy@gmail.com&body=testMessage&subject=sub1">Send e-mail to test@host.com</a>
@@ -1798,7 +1798,7 @@ When using jQuery and/or jQuery Mobile in application code, you cannot use usual
#TestController method:
def send_mail
WebView.navigate( 'mailto:test@host.com' )
- #to open url inexternal application you can use System.open_url
+ #to open url in external application you can use System.open_url
end
### Blackberry
@@ -1901,7 +1901,7 @@ Blackberry 5.0 and above has new BrowserField class, which support javascript, a
WebView.execute_js is also supported in this mode.
-NOTE: on Blackberry 6.0 and above it is recommended to use full browser mode. Because overwise some UI elements like combobox is not selectable by trackball:
+NOTE: on Blackberry 6.0 and above it is recommended to use full browser mode, because otherwise some UI elements like combobox are not selectable by trackball:
# use full browser only on BB 6.0 and above
use_bb_full_browser=6
View
22 doc/linea.txt
@@ -19,7 +19,7 @@ Ruby interface located in [https://github.com/rhomobile/linea-rhodes/blob/master
#
# Ruby interface of LineaSDK.
# see LineaSDK.h and Linea documentation for details
- # This main class Linea have the very simiilar interface with main Linea class in objective-C LineaSDK
+ # This main class Linea have the very similar interface with main Linea class in objective-C LineaSDK
# All constants and methods have the same name and practically the same results/parameters (with little Ruby specific)
# All method can raise Ruby exception like methods of Linea objective-C class
#
@@ -195,7 +195,7 @@ Ruby interface located in [https://github.com/rhomobile/linea-rhodes/blob/master
# Prints EAN128 optimized barcode. Supported only on PP-60, DPP-350 and DPP-250 printers, it makes the barcode lot smaller especially when numbers only are used
BAR_PRN_EAN128AUTO = 11
- # Barcode Text Positopn
+ # Barcode Text Position
BAR_TEXT_NONE = 0
BAR_TEXT_ABOVE = 1
BAR_TEXT_BELOW = 2
@@ -257,7 +257,7 @@ Ruby interface located in [https://github.com/rhomobile/linea-rhodes/blob/master
# Encryption key, if set magnetic card data will be encrypted
KEY_ENCRYPTION = 1
- # Creates and initializes new Linea class instance or returns already initalized one. Use this function, if you want to \
+ # Creates and initializes new Linea class instance or returns already initialized one. Use this function, if you want to \
# access Linea from multiple classes
# return instance of Linea device class (Linea)
def self.sharedDevice
@@ -539,7 +539,7 @@ Ruby interface located in [https://github.com/rhomobile/linea-rhodes/blob/master
def barcodeEngineWriteString?(data)
end
- # max_length - int with maximum length of readed data in bytes
+ # max_length - int with maximum length of read data in bytes
# timeout - float
# return array of bytes or nil if nothing
def barcodeEngineRead(max_length, timeout)
@@ -579,55 +579,55 @@ This is simple example of ruby code where you can see how LineSDK is used in rub
begin
Linea.sharedDevice.connect
rescue
- puts 'Linea exception catched : '+$!.to_s
+ puts 'Linea exception caught : '+$!.to_s
end
end
def do_disconnect
begin
Linea.sharedDevice.disconnect
rescue
- puts 'Linea exception catched : '+$!.to_s
+ puts 'Linea exception caught : '+$!.to_s
end
end
def do_startScan
begin
Linea.sharedDevice.startScan
rescue
- puts 'Linea exception catched : '+$!.to_s
+ puts 'Linea exception caught : '+$!.to_s
end
end
def do_stopScan
begin
Linea.sharedDevice.stopScan
rescue
- puts 'Linea exception catched : '+$!.to_s
+ puts 'Linea exception caught : '+$!.to_s
end
end
def do_msStartScan
begin
Linea.sharedDevice.msStartScan
rescue
- puts 'Linea exception catched : '+$!.to_s
+ puts 'Linea exception caught : '+$!.to_s
end
end
def do_msStopScan
begin
Linea.sharedDevice.msStopScan
rescue
- puts 'Linea exception catched : '+$!.to_s
+ puts 'Linea exception caught : '+$!.to_s
end
end
def do_enableAllBarcodeTypes
begin
Linea.sharedDevice.enableBarcode(Linea::BAR_ALL, true)
rescue
- puts 'Linea exception catched : '+$!.to_s
+ puts 'Linea exception caught : '+$!.to_s
end
end
View
4 doc/nfc.txt
@@ -56,7 +56,7 @@ You can use the method NFCManager.is_supported to see if NFC is supported on you
If your method is going to read or write NFC tags, it also needs to set the callback methods that process the NFC tag. The NFCManager.set_nfc_tech_callback is for reading and writing NFC tags (when the Android ACTION_TECH_DISCOVERED event is processed). NFCManager.set_nfc_callback is for peer-to-peer communication (when the Android ACTION_NDEF_DISCOVERED or ACTION_TAG_DISCOVERED events are processed).
-For NFCManager.set_nfc_tech_callback (the Android ACTION_TECH_DISCOVERED event), set up your list of techs in a resource file : [Rhodes ROOT]/lib/extensions/nfc/ext/nfc/platform/android/additional_files/res/xml/filter_nfc.xml. Refet to the Android documentation - [Android ACTION_TECH_DISCOVERED description](http://developer.android.com/reference/android/nfc/NfcAdapter.html#ACTION_TECH_DISCOVERED). Here is an example.
+For NFCManager.set_nfc_tech_callback (the Android ACTION_TECH_DISCOVERED event), set up your list of techs in a resource file : [Rhodes ROOT]/lib/extensions/nfc/ext/nfc/platform/android/additional_files/res/xml/filter_nfc.xml. Refer to the Android documentation - [Android ACTION_TECH_DISCOVERED description](http://developer.android.com/reference/android/nfc/NfcAdapter.html#ACTION_TECH_DISCOVERED). Here is an example.
:::xml
<?xml version="1.0" encoding="utf-8"?>
@@ -1283,7 +1283,7 @@ None.
### NFCManager.enable
-The enable method enables NFC event processing on your mobile device. Your nfc and nfc_tech callback methods are executed only if Rhodes NFC is enabled. On Android, when Rhodes NFC is enabled and the application activity is in the foreground, the activity gets high priority for NFC events. Android will not show additional UI for the select Activity for Tag processing; the Rhodes applciation will processed the tag.
+The enable method enables NFC event processing on your mobile device. Your nfc and nfc_tech callback methods are executed only if Rhodes NFC is enabled. On Android, when Rhodes NFC is enabled and the application activity is in the foreground, the activity gets high priority for NFC events. Android will not show additional UI for the select Activity for Tag processing; the Rhodes application will process the tag.
#### Returns
View
8 doc/release.txt
@@ -66,7 +66,7 @@ Run on Platform Simulator from 'mytest' folder.
- Date and Time: you should see 2 fields Date, Time
- Date only: only date should be displayed
- Time only: only time should be displayed
- Setting date/time should be processed without reload page. When you reopen DateTime Picker you should see date time from field (previosly setted).
+ Setting date/time should be processed without reload page. When you reopen DateTime Picker you should see date time from field (previously set).
* Alerts: select each link. you should see corresponding actions
* Ringtones: all phone ring-tones should be listed. Select 2 of them - you should listen some sound. On second press [stop], sound should stopped immediately
* AsyncHttpTest: Apache license page should be displayed
@@ -83,7 +83,7 @@ Run on Platform Simulator from 'mytest' folder.
- press 'Test back with alert', enter some text to edit, when press Back button - you should see<br/> Alert with message 'Do you want to leave?'. Press No - text from edit should not disappear. <br/>Press back again, on alert press Yes - you should return to dynamic menu test
- press 'Test back with close', when press Back button - application should exit
* Rho tests: press on each link, you should see corresponding page with message
-* Barcode recognize test: open "My Barcode recognize ..." press [scan] under image - see Alert with correct recognized code. Press [Take Picture] for make shot of barcode by camea and see Alert with recognized code or "[]" if not recognized.
+* Barcode recognize test: open "My Barcode recognize ..." press [scan] under image - see Alert with correct recognized code. Press [Take Picture] for make shot of barcode by camera and see Alert with recognized code or "[]" if not recognized.
* Bluetooth Chat Demo:
1. Phone and external Bluetooth device (for example external GPS Bluetooth device) - for Android, Windows Mobile and Blackberry only.
- pair device with phone
@@ -222,7 +222,7 @@ Same procedure as for plug-in
4. Import into workspace DLTK plugins
- Select 'Pluigns and Fragments' item in Import Dialog and going to 'Selection' page.
+ Select 'Plugins and Fragments' item in Import Dialog and going to 'Selection' page.
In left list of plugins select items with names:
org.eclipse.dltk.debug
@@ -245,7 +245,7 @@ Same procedure as for plug-in
8. Export. Select File/Export/Plugin Development
8.1 For update site need select - Deployable features
-8.2 For installer (or for export only Rhostudio plugin) need select Deplyable plugin and fragments
+8.2 For installer (or for export only Rhostudio plugin) need select Deployable plugin and fragments
##Build Rhodes Eclipse
View
12 doc/rhom.txt
@@ -55,7 +55,7 @@ This will generate a file called `product.rb` which looks like:
# Uncomment the following line to enable sync with Product.
# enable :sync
- #add model specifc code here
+ #add model specific code here
end
There are several features you can enable or disable in the model, below is a complete list:
@@ -70,7 +70,7 @@ There are several features you can enable or disable in the model, below is a co
enable :sync
# Set the type of sync this model
- # will use (default :incrmental).
+ # will use (default :incremental).
# Set to :bulk_only to disable incremental
# sync and only use bulk sync.
set :sync_type, :bulk_only
@@ -171,7 +171,7 @@ Below is a full list of options available to fixed schema models:
enable :sync
# Set the type of sync this model
- # will use (default :incrmental).
+ # will use (default :incremental).
# Set to :bulk_only to disable incremental
# sync and only use bulk sync.
set :sync_type, :bulk_only
@@ -626,7 +626,7 @@ Name of the source.
#=> "Product"
### `last_updated`
-Last time the source was successfully synchronzied (in `Time.at` format).
+Last time the source was successfully synchronized (in `Time.at` format).
:::ruby
@source.last_updated.to_s
@@ -923,8 +923,8 @@ If your application requires that the local database is encrypted on the filesys
bb:
use_sqlite: 0
-## Perfomance Tips
-* Before test application for perfomance set warning log level in rhoconfig.txt(MUST set for Blackberry testing):
+## Performance Tips
+* Before test application for performance set warning log level in rhoconfig.txt(MUST set for Blackberry testing):
MinSeverity = 3
View
24 doc/rhostudio-test-plan.txt
@@ -6,7 +6,7 @@ RhoStudio is a multi-platform application and should act identically on all plat
The only process that differs from platform to platform is an installation. So the installation tests are
described separately for each platform. All other tests should be performed on all platforms and yield the identical results.
-Any deviation from the described behaviour is a possible bug and should be reported to the developers.
+Any deviation from the described behavior is a possible bug and should be reported to the developers.
## On Virtual Machines
@@ -42,17 +42,17 @@ It is recommended to run all tests on virtual machines (e.g. using freeware [Ora
NOTE: Pay attention to `System > Processor > Processors` property -- if you plan to connect USB devices directly to virtual machine, set the number of processors strictly to 1
(this is a workaround for the bug in VirtualBox). Also for USB pass-thru you need to install [VirtualBox Extension Pack](https://www.virtualbox.org/wiki/Downloads) and,
- if VirtualBox is installed on Linux host, then you need to add all users runnung virtual machines to `vboxusers` group.
+ if VirtualBox is installed on Linux host, then you need to add all users running virtual machines to `vboxusers` group.
2. Install desired operating system to virtual machine using original installation media (CD or DVD) and product license key
(see VirtualBox help and documentation for details on guest operating systems installation).
3. Install all updates, service packs and official patches for installed OS.
-4. Install all latest avaiable SDKs for supported mobile platforms:
+4. Install all latest available SDKs for supported mobile platforms:
1. Install latest Android SDK and NDK. Do not forget to run Android SDK Manager to download and install all latest tools, platforms and APIs.
- Don't use path with spaces, install SDK and NDK to something like `C:\Anrdoid\android-sdk` and `C:\Anrdoid\android-ndk` on Windows
+ Don't use path with spaces, install SDK and NDK to something like `C:\Android\android-sdk` and `C:\Android\android-ndk` on Windows
and to something like `/Developer/SDKs/android-sdk` and `/Developer/SDKs/android-ndk` on Mac.
2. On Windows: install Visual Studio 2008 and Windows Mobile 6 Professional SDK Refresh
(don't forget to run Microsoft Update after Visual Studio installation to apply all latest updates, service packs and fixes).
@@ -78,7 +78,7 @@ It is recommended to run all tests on virtual machines (e.g. using freeware [Ora
Thus you will always have an up-to-date clean fresh installation of each operating system with all required SDKs for testing purposes.
NOTE: Never create a snapshot of crashed or abnormally exited virtual machine! Always restore previous good state
-from latest snapshot, install neccesary updates/service-packs/patches, create new snapshot, and delete previous snapshot.
+from latest snapshot, install necessary updates/service-packs/patches, create new snapshot, and delete previous snapshot.
NOTE: Deletion of previous snapshots lets you save a lot of free disk space on a physical (host) machine especially for Windows virtual machines (guests).
@@ -121,14 +121,14 @@ Take a fresh clean installation of Mac OS X with all available Software Updates
### Installation failure test on Mac OS X without Xcode
-1. Open 'Install gems' shorcut. The Terminal window will appear.
+1. Open 'Install gems' shortcut. The Terminal window will appear.
2. If asked for a password, enter the password.
3. The message will appear: "Please install building tools"
### Installation failure test on Mac OS X without Java
1. Install latest available Xcode with iOS SDK.
-2. Open 'Install gems' shorcut again.
+2. Open 'Install gems' shortcut again.
3. If asked for a password, enter the password.
4. The message will appear: "Please install java development kit"
@@ -141,7 +141,7 @@ Take a fresh clean installation of Mac OS X with all available Software Updates
The window will appear asking you about installation of Java -- agree and proceed JDK installation.
-2. Open 'Install gems' shorcut again.
+2. Open 'Install gems' shortcut again.
3. If asked for password, enter your password.
@@ -203,7 +203,7 @@ When you open the RhoStudio it asks a path to create (or open existing) `workspa
4. Expand 'Rhomobile' node.
5. 'RhoStudio' should be grayed out -- that means the latest version is already installed.
6. To double-check this write down the version number of RhoStudio available from the update site (that is displayed in this list).
-7. Click 'What is <u>alreay installed</u>?' link.
+7. Click 'What is <u>already installed</u>?' link.
8. Switch to 'Plug-ins' tab.
9. Find plug-in named 'com.rhomobile.rhostudio' and write down its version number.
10. The version numbers written down on step 6 and step 9 should be the same -- if not, the RhoStudio installer contains
@@ -277,7 +277,7 @@ RET: 0
2.6. Check that project with given name appeared at `Project Explorer` view.
2.7. Check project files in `Project Explorer` view item.
-3. RhoMoile Application project creation from existing sources test
+3. RhoMobile Application project creation from existing sources test
3.1. Create application outside of workspace by hand.
3.2. Go to `File > New > Project` in the top menu.
@@ -288,7 +288,7 @@ RET: 0
3.6. Check that project with given name appeared at `Project Explorer` view.
3.7. Check project files in `Project Explorer` view item.
-4. RhoMoile Application project creation from existing sources in workspace test
+4. RhoMobile Application project creation from existing sources in workspace test
4.1. Create application in workspace by hand.
4.2. Go to `File > New > Project` in the top menu.
@@ -306,7 +306,7 @@ RET: 0
3. Enter the correct path to `bin` folder of the installed JDK (typically `/Library/Java/Home/bin` on Mac,
and the `bin` folder of JDK installed during installation tests on Windows, e.g. `C:\Program Files\Java\jdk1.7.0\bin`).
4. Expand `Rhomobile` node and enter correct paths to 'Android SDK' and 'Android NDK' on `Android` tab,
- e.g. `C:\Anrdoid\android-sdk` and `C:\Anrdoid\android-ndk` on Windows
+ e.g. `C:\Android\android-sdk` and `C:\Android\android-ndk` on Windows
and `/Developer/SDKs/android-sdk` and `/Developer/SDKs/android-ndk` on Mac.
5. On Windows go to `Windows Mobile` tab and set a correct path to 'Cab wizard'.
6. Click `OK` to finish editing and apply changes.
View
4 doc/simulator.txt
@@ -77,15 +77,15 @@ Follow these instructions to build your own customized version of RhoSimulator.
* Download the Qt source:
* Go to [http://qt.nokia.com/downloads](http://qt.nokia.com/downloads)
* Jump to `Qt libraries`
- * Download the [source code as a gzipped tar](http://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-4.8.2.tar.gz) (228 MB)
+ * Download the [source code as a zipped tar](http://releases.qt-project.org/qt4/source/qt-everywhere-opensource-src-4.8.2.tar.gz) (228 MB)
* Extract the downloaded archive, e.g. into `~/qt-4.8.2`
* Make sure that your `PATH` environment variable does not contain the path to any previously installed Qt binaries
* Add to your `~/.bash_profile` the new environment variable `QTDIR` by adding the line (or by changing the existing `QTDIR` variable):
export QTDIR=/Developer/SDKs/Qt
* Restart terminal windows to enable new environment setting.
- * Patch Qt sources by replacing all occurences of '/Developer/SDKs/MacOSX10' to '.*MacOSX10' in two project files:
+ * Patch Qt sources by replacing all occurrences of '/Developer/SDKs/MacOSX10' to '.*MacOSX10' in two project files:
* `~/qt-4.8.2/src/3rdparty/webkit/Source/WebKit/qt/QtWebKit.pro`
* `~/qt-4.8.2/src/plugins/bearer/corewlan/corewlan.pro`
* Open `Terminal.app` and issue commands:
View
2 doc/syncengine-ajax-api.txt
@@ -99,7 +99,7 @@ NOTE: It is just for SyncEngine control and at the moment it doesn't provide any
All API methods are defined in the *Rho.syncengine* namespace. Each method is accessible in javascript as *window.Rho.syncengine.method_name*.
Each API method receives callback functions as two last parameters, those are:
-* success - Success handler function. Paremeters are:
+* success - Success handler function. Parameters are:
* result - String value with AJAX response. Contains just "ok" value if different behavior is not described for exact API method as *RETURNED* value.
* status - Number value with HTTP response status
* xhr - XmlHttpRequest object associated with response
View
4 doc/ui.txt
@@ -100,7 +100,7 @@ Rhodes 2.0+ includes an improved [CSS Framework](css-framework) which takes adva
To implement advanced UI for your Rhodes View you may consider using such JavaScript UI frameworks as [Sencha](http://www.sencha.com/). Place one of these libraries in public/js folder of your application, load it in your [layout.erb](#layout), and you are ready to go.
[Jquery Mobile](http://jquerymobile.com/) is supported out of the box.
-Rhodes support for [jQTouch library](http://jqtouch.com/) has been dropped, here you can find instructions on [how to transit your legacy Rhodes application fom jQTouch to jQuery Mobile](jqt-jqm-transition).
+Rhodes support for [jQTouch library](http://jqtouch.com/) has been dropped, here you can find instructions on [how to transit your legacy Rhodes application from jQTouch to jQuery Mobile](jqt-jqm-transition).
### jQuery Mobile modifications
@@ -759,7 +759,7 @@ Set the iPhone badge to Tab (only on iOS devices).
# set badge '12' to tab 1
Rho::NativeTabbar.set_tab_badge( 1, '12')
-Rho::NativeTabbar.create() createa a native tab bar UI element and activates its first tab. If you want to see another tab, call Rho::NativeTabbar.switch_tab explicitly just after NativeBar.create, as in the following example.
+Rho::NativeTabbar.create() creates a native tab bar UI element and activates its first tab. If you want to see another tab, call Rho::NativeTabbar.switch_tab explicitly just after NativeBar.create, as in the following example.
:::ruby
require 'rho/rhotabbar'

0 comments on commit 084d52c

Please sign in to comment.