=== Distortions README ===

[About]
Distortions is a Firefox extension that allows the user to build filters
of similar words associated with a color and apply them to pages they are 
browsing.

When a theme is applied to the page currently in focus, statistics 
describing the percentage of words on the current page that match the 
words making up the theme that was applied will be displayed.

All of the words matching the words in the theme will be highlighted in the
theme's color and increased in size to make them stand out.

The degree to which the background is shaded the particular theme's color 
is proportional to the percentage of matching words as described above.


[Installation]
Drag "Distortions.xpi" into the address bar in Firefox.


[Help]

=to access the preferences window=

Tools => Add-Ons => Click the "Preferences" button under "Distortions"

-OR-

1) - Right-click anywhere in the browser window to access the context menu
   and select the "Distortions" sub-menu.
   - Alternatively, click on the global "Tools" menu and select the 
   "Distortions" sub-menu.
   - Alternatively, right-click on the text in the lower right hand corner
   of the browser window that reads "Distortions".

2) Choose "View Preferences"


=to apply a filter=

1) If you have not already created a theme, see =addtional help= below.

2) Follow step #1 above.

3) Click on the theme you would like to apply.


=additional help=

- Click on the *Add* button to add a new theme.
- Click on the *Edit* button to edit one of the themes already present.

In either of the above dialogs
  > Enter whatever you would like to use to refer to the new theme in the 
     *Name* text box.
  > Enter words separated by commas (',') that reflect the theme in the 
     *Synonyms* text box.  For example, if your theme was happy words you 
     might enter 'happy,joy,pleasant,fun,thrill,genial' without quotes.
  > Click on the button underneath the word *Color:* and select a color
     to use to identify the current theme.

- Click on the *Remove* button to remove a theme.

- Click on the *Import* button to import a premade theme from a .dtheme 
  file.

- Click on the *Export* button to save a theme from the list to a local 
  .dtheme file.

- Click on the *Mine* button to create a theme using the current web 
  page as a basis.
  
  Clicking on the grey box to the right of the *Mine* button will display 
  the title of the current page.
  
  This page will be used as the root page to mine for frequently used words.
  
  The *# Pages* box should be filled with the total number of pages to be 
  mined (including the current page).  Therefore, the minimum # Pages is 1.  
  The mining script will follow # Pages - 1 links from the current page and 
  mine those pages as well.
  
  Due to the time it takes to mine most pages, a limit of  10 pages total 
  has been imposed.  Any value higher than this will be reset to 10.