ABOUT SKIMREAD feature
------------------------------------
1. Skim Reading: The skim read feature provides a quick overview of a document. When a user issues "Skim Read" command (Ctrl + KP_Add in desktop, Orca + Ctrl + semicolon in laptop), orca skims through the entire document. SkimRead reads first line/sentence (depending on the "Say All By" setting) of  the current paragraph and then reads the first line/sentence of each subsequent paragraphs and highlights it. When skimRead starts, it informs user about current position of cursor in document and accordingly gives information to user. It also provides option to start skimread from top of document by pressing 't' key instead of start reading from the first line of current paragraph identified. If user presses any key, when skimread is enabled, then skim reading stops at the line/sentencejust read. This feature works with Libre/Open Office word processor and gedit text editor. More information can be found at 'https://bugzilla.gnome.org/show_bug.cgi?id=577481'.
2. The highlight feature is provided to increase the usability of skimread feature. When skimRead is enabled, it underlines the current line. It is useful for a partially blind user. This works fine, when "Say All By" settings set to Line.


DEPENDENCY
-------------------------------------
- Required debian 7,ubuntu 12 based operating systems or fedora 17 based operating systems which contains Gnome 3 or higher version.
- Based on Orca-3.4.2
1. To install Orca-SkimRead patch:
    For Debian based operating system:
      - Install 'python-pip' using 'apt-get install python-pip'.
      - Install 'PyUserInput' using 'pip install PyUserInput', or download it from 
        'https://github.com/SavinaRoja/PyUserInput/archive/master.zip'.
      - Install 'python-xlib' using Synaptic Package Manager or 'apt-get install python-xlib'.
    For Fedora based operating system:
      - Install 'python-pip' using 'yum install python-pip'.
      - Install 'PyUserInput' using 'pip install PyUserInput', or download it from 
        'https://github.com/SavinaRoja/PyUserInput/archive/master.zip'.
      - Install 'yum install python-xlib' or 'pip install python-xlib'.    
2. To install Pyatspi patch:
   In 'pyatspi/text.py/getCharacterAtOffset()' method uses wrong name to call method from the C library.
   The method 'get_character_offset' doesn't exists at libatspi. It was a typo.
   For refrence 'https://mail.gnome.org/archives/commits-list/2012-November/msg03566.html'. 
   
Restart orca. All additional feature listed above should be working now.


HOW TO APPLY THE PATCH
-------------------------------------
1. Copy skimRead patch file in orca directory.
2. Run 'git apply patchFileName' command in orca's installed directory.
3. Copy pyatspi patch file in pyatspi directory.
4. Run 'git apply patchFileName' command in pyatspi's installed directory.


HOW TO USE
-------------------------------------
1. Install patch i.e. OrcaSkimRead.patch in orca's directory and install Pyatspi.patch in pyatspi's directory using 'git apply patchname'
   command.
2. Run orca and set "Say All By" settings to Line.
3. Open gedit or any word processor application and press "Ctrl + KP_Add" in desktop or "Orca + Ctrl + semicolon" in laptop. When skimRead
   starts it will identify current cursor position in document and provides option to user that user can start skimRead from top of document
   by pressing 't' key otherwise skimread will starts from current paragraph's first line and highlight it.
4. While skimReading the document, if user presses any key, then skimread will stop.


KNOWN ISSUES
-------------------------------------
1. As of now, this patch works well with 'gedit' and 'Libre/Open Office word processor' application, although it is intended to work for all types of text documents.
2. In highlight line feature, it works fine when "Say All By" settings set to Line, but if "Say All By" setting is set to sentence, then highlight may not display properly because it is possible that the sentence covers multiple lines. If sentence is ending in the same line, then it will be ok.
3. In LibreOffice or OpenOffice, when focus is shifted to next page, then it is possible that highlight is not synchronized properly.


CONTRIBUTERS
--------------------------------------
Sagun Baijal (sagun@cdac.in)
Leena Chourey (leenac@cdac.in)
Dhairyashil Bhosale (dhairyashilb@cdac.in)


REPORTING BUGS
--------------------------------------
If you experience any bugs or issues, while using skimRead or wants to give any feedback, we encourage you to report/send the them so that they can be addressed and we can provide more better software.
mailto: ossd@cdac.in


COPYRIGHT
--------------------------------------
Copyright 2014 CDAC, Mumbai, India.
