igor@9: 
igor@9: '''new-words''' is a script which helps you to control your vocabulary
igor@9: and find unknown words in texts before you start to read them.
igor@9: 
igor@9: The script is intended to be run in a console; interactive part of the work
igor@9: done with a help of a text editor (vim by default).
igor@9: 
igor@9: Features:
igor@9: * Multilanguage support;
igor@9: * Dictionary software integration;
igor@9: * Notes to unknown words.
igor@9: 
igor@9: == Installation ==
igor@9: 
igor@9:     wget http://xgu.ru/downloads/new-words.tar.gz
igor@9:     tar xvfz new-words.tar.gz
igor@9:     ./INSTALL
igor@9: 
igor@9: == First steps ==
igor@9: 
igor@9: First of all you have to give a program some information
igor@9: about your vocabularies for foreign languages (one or more).
igor@9: Let us learn Russian and French.
igor@9: 
igor@9: Find unknown words in a page from the Internet:
igor@9: 
igor@9:     $ new-words http://ru.wikipedia.org/wiki/Москва
igor@9: 
igor@9: Delete (dd) words, that you know. Save the result and quit the editor (:wq).
igor@9: 
igor@9: Repeat the same using several other pages:
igor@9: 
igor@9:     $ new-words http://ru.wikipedia.org/wiki/Киев
igor@9:     $ new-words http://ru.wikipedia.org/wiki/Linux
igor@9: 
igor@9: Now new-words knows something about your Russian vocabulary.
igor@9: 
igor@9: You can do the same for other languages, e.g. for French:
igor@9: 
igor@9:     $ new-words http://fr.wikipedia.org/wiki/Paris
igor@9:     $ new-words http://fr.wikipedia.org/wiki/Linux
igor@9: 
igor@9: You can change your vocabularies data in the directory ~/.new-words:
igor@9: 
igor@9:     $ ls -1 /home/igor/.new-words
igor@9:     fr.txt
igor@9:     ru.txt
igor@9: 
igor@9: The language of pages are automatically derived from URL for pages from Wikipedia.
igor@9: If you want, you can specify language manually (using -l key):
igor@9: 
igor@9:     $ new-words -l fr http://fr.wikipedia.org/wiki/Paris
igor@9: 
igor@9: == External dictionaries usage ==
igor@9: 
igor@9: There is a script ~/bin/en was created during installation.
igor@9: 
igor@9: This is an example of the script, which translates its command line parameters from one language to another.
igor@9: This example translates its arguments from English to Russian,
igor@9: but you can specify another dictionary in its code.
igor@9: 
igor@9: Also you can create links to the file to make it possible
igor@9: to use external dictionaries not only for English texts (en)
igor@9: but for texts in any other languages.
igor@9: 
igor@9:     $ cd ~/bin/
igor@9:     $ ln en fr
igor@9:     $ ln en ru
igor@9: 
igor@9: After that you should edit the file ~/bin/en and specify correct names of the dictionaries that have to be used
igor@9: to translate from the French and Russian language to the language you want.
igor@9: 
igor@9: You can use the dictionary wrapper from new-words:
igor@9: when you are in the editor working with your words, 
igor@9: you can set a cursor at any word and press K (shift k).
igor@9: The dictionary wrapper will be run. 
igor@9: 
igor@9: The wrappers' buffer will show you not only a translation of the word
igor@9: but sentences from the text which contain the word where the cursor were.
igor@9: 
igor@9: 
igor@9: == Adding notes to the words ==
igor@9: 
igor@9: You can add additional notes to words which you can't remember.
igor@9: These notes will be automatically saved and restored when needed.
igor@9: 
igor@9: Notes are saved in the file ~/.new-words/notes-??.txt .
igor@9: Here the language code should be specified instead of ?? .
igor@9: 
igor@9: You can browse last notes with UNIX tail command:
igor@9: 
igor@9:     $ tail ~/.new-words/notes-ru.txt
igor@9: