You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by jm...@apache.org on 2014/08/29 02:48:25 UTC
[8/8] git commit: [flex-utilities] [refs/heads/develop] - update read
me with instruction on use and where to get dictionaries from
update read me with instruction on use and where to get dictionaries from
Project: http://git-wip-us.apache.org/repos/asf/flex-utilities/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-utilities/commit/57e22380
Tree: http://git-wip-us.apache.org/repos/asf/flex-utilities/tree/57e22380
Diff: http://git-wip-us.apache.org/repos/asf/flex-utilities/diff/57e22380
Branch: refs/heads/develop
Commit: 57e2238040eedc03a5a50b61040b4f7d5478001c
Parents: 4b0dd48
Author: Justin Mclean <jm...@apache.org>
Authored: Fri Aug 29 10:47:55 2014 +1000
Committer: Justin Mclean <jm...@apache.org>
Committed: Fri Aug 29 10:47:55 2014 +1000
----------------------------------------------------------------------
Squiggly/README | 47 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 47 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flex-utilities/blob/57e22380/Squiggly/README
----------------------------------------------------------------------
diff --git a/Squiggly/README b/Squiggly/README
index deabcf9..d06e67f 100644
--- a/Squiggly/README
+++ b/Squiggly/README
@@ -39,6 +39,7 @@ There are several other useful ant targets.
compile-swc compile squiggly swcs
package package up all source files
+ generate-docs generate asdocs
package-binary-tar tar up all source files and swcs
package-binary-zip zip up all source files and swcs
package-source-tar tar up all source files
@@ -55,3 +56,49 @@ How to check the code out of Git
2. Change directory to:
cd Squiggly
+
+==========================================================================================
+How to use the Squiggly SDK
+==========================================================================================
+
+Please read the ASDoc first to understand the classes in Squiggly.
+
+If you are using the SpellChecker class directly, you need.
+- SpellingEngine.swc in [YourProject]/libs folder, you can find it from ./libs
+- Dictionary files in [YourProject]/src folder
+
+You can obtain dictionary files from:
+http://extensions.openoffice.org
+http://hunspell.sourceforge.net
+
+If you are using the simple UI integration feature (SpellUI class), in addition to what
+mentioned above, you also need:
+- SpellingConfig.xml in [YourProject]/src
+- SpellingUI.swc in [YourProject]/src
+- SpellingUIEx.swc if you need spark support in Flex 4) in [YourProject]/libs
+
+You can download HunSpell dictionaries and use those by editing SpellingConfig.xml.
+
+The default name of the config file has changed from AdobeSpellingConfig.xml to
+SpellingConfig.xml.
+
+Here's the content of SpellingConfig.xml, each entry maps the languageCode with the
+relative path for resource files.
+
+<SpellingConfig>
+ <LanguageResource language="English" languageCode="en_US"
+ ruleFile="dict/en_US/en_US.aff" dictionaryFile="dict/en_US/en_US.dic"/>
+</SpellingConfig>
+
+So if you are adding Spanish, you just need to get the hunspell dictionary
+ es_ES.aff/dic and add one line to your config file.
+ <LanguageResource language="Spanish" languageCode="es_ES"
+ ruleFile="dict/es_ES/es_ES.aff" dictionaryFile="dict/es_ES/es_ES.dic"/>
+
+Note that you can put the dictionaries in any location as long as you update
+the config file, but the config file itself MUST be in [YourProject]/src folder.
+
+
+
+
+