Quick Start
Understand file page and word
RWD is a single document application. RWD users create edit and save the document and only one document can be managed at the same time.
The document is the wordbook where language learners collect their new words. The wordbook can also be thought of as a 'file' because it is a file on computer.
RWD file has two formats. One is compressed binary, the another is XML. The binary one can save disk space while the XML one is more usable and exchangeable.
A file can be empty or consisted of one or several pages. A page can be empty or consisted of one or several words.
Frequently used command
- open
To open an existed RWD file.> open -f /somepath/somefile.xml
- list
To use '-p' to list the browsed page, so that a user can know what words are in the page. When there is a page, there must be a browsed page. The browsed page is the page a user is working on.> list -p
To use '-f' to list the opened file, so that a user can know how many pages are in the file.> list -f
- state
Before to list a page, a user might want to set what fields of words he/she want to list. If a user want to show all fields of words, the command line would look like this:> state -m 7
> list -p - next
In every page, there must be a word which a user is working on. There is an index to indicate the focused word in every page. When a user finished learning a word, he/she would move the index forward by using 'next' command. In fact, full command typing is unnecessary. A user can always omit one or more characters at the tail of a command if only there is no ambiguity happened.> nex
- show
If considering RWD as a flashcard program, 'show' is equal to 'flash'. A user will use this command if he/she wants to see fields of the index word. There are many fields of a word. A user can decide which field to show when using the command, and the user can use '-l' to achieve so.> show -l 3
The higher value of '-l', the more fields of a word would be shown.
- >
When using GUI version, '>' is very useful, because a user can type it to start typing command line without touching mouse.
About GNU readline
Because RWD is on the basis of command line, I think it suitable and valuable to let it have GNU readline feature.
In CUI version of RWD, users can have full feature of GNU readline 5.2. However, in GUI version, the readline is not GNU readline but a migrated version, named RWD readline which has only a partial feature of GNU readline so far.
To learn reference of GNU readline, chick here to search 'GNU readline' on Google.