new-words
view README.en @ 49:00286f6bfa85
experimental: when -c specified, use dictionary for compression
| author | Igor Chubin <igor@chub.in> | 
|---|---|
| date | Wed Feb 09 21:08:23 2011 +0200 (2011-02-09) | 
| parents | |
| children | 
 line source
     2 '''new-words''' is a script which helps you to control your vocabulary
     3 and find unknown words in texts before you start to read them.
     5 The script is intended to be run in a console; interactive part of the work
     6 done with a help of a text editor (vim by default).
     8 Features:
     9 * Multilanguage support;
    10 * Dictionary software integration;
    11 * Notes to unknown words.
    13 == Installation ==
    15     wget http://xgu.ru/downloads/new-words.tar.gz
    16     tar xvfz new-words.tar.gz
    17     ./INSTALL
    19 == First steps ==
    21 First of all you have to give a program some information
    22 about your vocabularies for foreign languages (one or more).
    23 Let us learn Russian and French.
    25 Find unknown words in a page from the Internet:
    27     $ new-words http://ru.wikipedia.org/wiki/Москва
    29 Delete (dd) words, that you know. Save the result and quit the editor (:wq).
    31 Repeat the same using several other pages:
    33     $ new-words http://ru.wikipedia.org/wiki/Киев
    34     $ new-words http://ru.wikipedia.org/wiki/Linux
    36 Now new-words knows something about your Russian vocabulary.
    38 You can do the same for other languages, e.g. for French:
    40     $ new-words http://fr.wikipedia.org/wiki/Paris
    41     $ new-words http://fr.wikipedia.org/wiki/Linux
    43 You can change your vocabularies data in the directory ~/.new-words:
    45     $ ls -1 /home/igor/.new-words
    46     fr.txt
    47     ru.txt
    49 The language of pages are automatically derived from URL for pages from Wikipedia.
    50 If you want, you can specify language manually (using -l key):
    52     $ new-words -l fr http://fr.wikipedia.org/wiki/Paris
    54 == External dictionaries usage ==
    56 There is a script ~/bin/en was created during installation.
    58 This is an example of the script, which translates its command line parameters from one language to another.
    59 This example translates its arguments from English to Russian,
    60 but you can specify another dictionary in its code.
    62 Also you can create links to the file to make it possible
    63 to use external dictionaries not only for English texts (en)
    64 but for texts in any other languages.
    66     $ cd ~/bin/
    67     $ ln en fr
    68     $ ln en ru
    70 After that you should edit the file ~/bin/en and specify correct names of the dictionaries that have to be used
    71 to translate from the French and Russian language to the language you want.
    73 You can use the dictionary wrapper from new-words:
    74 when you are in the editor working with your words, 
    75 you can set a cursor at any word and press K (shift k).
    76 The dictionary wrapper will be run. 
    78 The wrappers' buffer will show you not only a translation of the word
    79 but sentences from the text which contain the word where the cursor were.
    82 == Adding notes to the words ==
    84 You can add additional notes to words which you can't remember.
    85 These notes will be automatically saved and restored when needed.
    87 Notes are saved in the file ~/.new-words/notes-??.txt .
    88 Here the language code should be specified instead of ?? .
    90 You can browse last notes with UNIX tail command:
    92     $ tail ~/.new-words/notes-ru.txt
