Next: emacsvox-browse-kill-ring, Previous: emacsvox-bookmark, Up: Emacsvox Commands And Options [Index]
BOOKSHARE == http://www.bookshare.org provides book access to print-disabled users. It provides a simple Web API http://developer.bookshare.org This module implements an Emacsvox Bookshare client.
The main entry point is command
emacsvox-bookshare bound to C-e C-b.
This creates a special Bookshare Interaction buffer that is
placed in emacsvox-bookshare-mode.
Se the help for that mode on detailed usage instructions and key-bindings.
Assuming you have correctly setup your API key:
emacsvox-bookshare by pressing C-h G.
auth-source — usually ~/.authinfo.gpg.
You can also use password-store[.]
Call action specified by invoking key.
Perform a Bookshare author search. Interactive prefix arg filters search by category. (fn QUERY &optional CATEGORY)
Return latest books.
Browse popular books. Optional interactive prefix arg prompts for a category to use as a filter. (fn &optional CATEGORY)
Ignore ARGUMENTS, do nothing, and return nil. This function accepts any number of arguments in ARGUMENTS. Also see ‘always’. (fn &rest ARGUMENTS)
Download audio format of specified book to target location. (fn ID TARGET)
Download audio version of book under point. Target location is generated from author and title.
Download Daisy format of specified book to target location. (fn ID TARGET)
Download Braille version of book under point. Target location is generated from author and title.
Download Daisy format of specified book to target location. (fn ID TARGET)
Download Daisy version of book under point. Target location is generated from author and title.
Download epub-3 format of specified book to target location. (fn ID TARGET)
Download epub-3 version of book under point. Target location is generated from author and title.
Download content to target location. (fn URL TARGET)
Expand entry at point by retrieving metadata. Once retrieved, memoize to avoid multiple retrievals.
Extract content referred to by link under point, and render via the browser. (fn URL)
Extract content referred to by link under point, and return an XML buffer. (fn URL)
Flush lines matching regexp in Bookshare buffer. (fn REGEXP)
Display fulltext contents of book in specified directory. Useful for fulltext search in a book. (fn DIRECTORY)
Perform a Bookshare fulltext search. (fn QUERY)
Get next page of results for last query.
Perform a Bookshare id search. (fn QUERY)
Perform a Bookshare isbn search. (fn QUERY)
Return preference list.
A Bookshare front-end for the Emacsvox desktop. The Emacsvox Bookshare front-end is launched by command emacsvox-bookshare bound to C-e C-b This command switches to a special buffer that has Bookshare commands bounds to single keystrokes– see the key-binding list at the end of this description. Use Emacs online help facility to look up help on these commands. emacsvox-bookshare-mode provides the necessary functionality to Search and download Bookshare material, Manage a local library of downloaded Bookshare content, And commands to easily read newer Daisy books from Bookshare. Here is a list of all emacsvox Bookshare commands with their key-bindings: a Author Search A Author/Title Search t Title Search s Full Text Search d Date Search b Browse Key Binding ——————————————————————————- RET emacsvox-bookshare-toc-at-point SPC emacsvox-bookshare-expand-at-point + emacsvox-bookshare-action / emacsvox-bookshare-action 3 emacsvox-bookshare-download-epub-3-at-point A emacsvox-bookshare-download-audio-at-point B emacsvox-bookshare-download-brf-at-point C emacsvox-bookshare-fulltext D emacsvox-bookshare-download-daisy-at-point E emacsvox-bookshare-eww I emacsvox-bookshare-action P emacsvox-bookshare-action S emacsvox-bookshare-action U emacsvox-bookshare-unpack-at-point V emacsvox-bookshare-view-at-point [ backward-page ] forward-page a emacsvox-bookshare-action b emacsvox-bookshare-browse c emacsvox-bookshare-toc-at-point d emacsvox-bookshare-action e emacsvox-bookshare-eww f emacsvox-bookshare-flush-lines i emacsvox-bookshare-action j next-line k previous-line l .. m emacsvox-bookshare-action n emacsvox-bookshare-next-result p emacsvox-bookshare-previous-result q bury-buffer s .. t emacsvox-bookshare-action v emacsvox-bookshare-view M-n emacsvox-bookshare-next-result M-p emacsvox-bookshare-previous-result In addition to any hooks its parent mode ‘special-mode’ might have run, this mode runs the hook ‘emacsvox-bookshare-mode-hook’, as the final or penultimate step during initialization.
Move to next result.
Return list of periodicals.
Move to previous result.
Set preference preference-id to value. (fn PREFERENCE-ID VALUE)
Perform a Bookshare date search. Optional interactive prefix arg filters by category. (fn QUERY &optional CATEGORY)
Perform a Bookshare title search. Interactive prefix arg filters search by category. (fn QUERY &optional CATEGORY)
View TOC for book in specified directory. (fn DIRECTORY)
View TOC for book at point. Make sure it’s downloaded and unpacked first.
Unpack downloaded content if necessary.
Custom URL executor for use in Bookshare TOC. (fn URL)
Ignore ARGUMENTS, do nothing, and return nil. This function accepts any number of arguments in ARGUMENTS. Also see ‘always’. (fn &rest ARGUMENTS)
View book in specified directory. (fn DIRECTORY)
Web API key for this application. See http://developer.bookshare.org/docs for details on how to get an API key.
Default Value:
nil
Customize this to the root of where books are organized.
Default Value:
"~/books/book-share"
Next: emacsvox-browse-kill-ring, Previous: emacsvox-bookmark, Up: Emacsvox Commands And Options [Index]