extensions/access-builtin/README

   1 # ***** BEGIN LICENSE BLOCK *****
   2 # Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3 #
   4 # The contents of this file are subject to the Mozilla Public License Version
   5 # 1.1 (the "License"); you may not use this file except in compliance with
   6 # the License. You may obtain a copy of the License at
   7 # http://www.mozilla.org/MPL/
   8 #
   9 # Software distributed under the License is distributed on an "AS IS" basis,
  10 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11 # for the specific language governing rights and limitations under the
  12 # License.
  13 #
  14 # The Original Code is mozilla.org Code.
  15 #
  16 # The Initial Developer of the Original Code is
  17 # Aaron Leventhal.
  18 # Portions created by the Initial Developer are Copyright (C) 2001
  19 # the Initial Developer. All Rights Reserved.
  20 #
  21 # Contributor(s):
  22 #
  23 # Alternatively, the contents of this file may be used under the terms of
  24 # either the GNU General Public License Version 2 or later (the "GPL"), or
  25 # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26 # in which case the provisions of the GPL or the LGPL are applicable instead
  27 # of those above. If you wish to allow use of your version of this file only
  28 # under the terms of either the GPL or the LGPL, and not to allow others to
  29 # use your version of this file under the terms of the MPL, indicate your
  30 # decision by deleting the provisions above and replace them with the notice
  31 # and other provisions required by the GPL or the LGPL. If you do not delete
  32 # the provisions above, a recipient may use your version of this file under
  33 # the terms of any one of the MPL, the GPL or the LGPL.
  34 #
  35 # ***** END LICENSE BLOCK *****
  36
  37 This is the access-builtin module
  38
  39 This module creates a preference in Mozilla for browsing with text-to-speech, and eventually
  40 with a brailled display.
  41
  42 See http://access-mozilla.sourceforge.net
  43
  44 On UNIX or Linux, enable this as part of the build with
  45 ./configure --with-extensions=default,accessibility
  46
  47 On Windows you will need to manually perform the make in this directory.
  48
  49 Mac builds are not enabled yet.
  50
  51 To use, you must add these lines to prefs.js in your profile directory.
  52 user_pref("accessibility.browsewithcaret", true);
  53 user_pref("accessibility.usetexttospeech", "ViaVoice");
  54
  55 The actual text-to-speech conversion is temporarily broken.
  56 However, the debug console window will tell you what would be spoken.
  57
  58 Normally, you would need to get the free download of IBM ViaVoice.