Next: , Previous: , Up: Emacspeak Commands And Options   [Contents][Index]


12.70 emacspeak-eww

EWW == Emacs Web Browser

EWW is a light-weight Web browser built into Emacs starting with Emacs-24.4 . This module speech-enables EWW.

It implements additional interactive commands for navigating the DOM. It also provides a set of filters for interactively filtering the DOM by various attributes such as id, class and role. Finally, this module updates EWW’s built-in key-bindings with Emacspeak conveniences.

12.70.1 Structured Navigation

These commands move through section headers as defined in HTML.

1

emacspeak-eww-next-h1 Move to next H1 heading.

2

emacspeak-eww-next-h2 Move to next H2 heading.

3

emacspeak-eww-next-h3 Move to next H3 heading.

4

emacspeak-eww-next-h4 Move to next H4 heading.

.

emacspeak-eww-next-h Move to next heading. (H1...H4).

M-1

emacspeak-eww-previous-h1 Move to previous H1 heading.

M-2

emacspeak-eww-previous-h2 Move to previous H2 heading.

M-3

emacspeak-eww-previous-h3 Move to previous H3 heading.

M-4

emacspeak-eww-previous-h4 Move to previous H4 heading.

,

emacspeak-eww-previous-h Move to previous heading (H1...H4).

This next set of DOM commands enable navigating by HTML elements.

M-SPC

emacspeak-eww-speak-this-element Speak contents of current element.

J

emacspeak-eww-next-element-like-this Jump to next element that is the same as the one under point. If there are multiple HTML elements under point, prompts for element-name using completion.

K

emacspeak-eww-previous-element-like-this Jump to previous element that is the same as the one under point. If there are multiple HTML elements under point, prompts for element-name using completion.

N

emacspeak-eww-next-element-from-history Jump to next element based on previous J/K command history.

P

emacspeak-eww-previous-element-from-history Jump to previous element based on previous J/K history.

O

emacspeak-eww-previous-li Jump to previous list item.

o

emacspeak-eww-next-li Jump to next list item.

T

emacspeak-eww-previous-table Jump to previous table in page.

t

emacspeak-eww-next-table Jump to next table.

[

emacspeak-eww-previous-p Jump to previous paragraph.

]

emacspeak-eww-next-p Jump to next paragraph.

b

shr-previous-link Jump to previous link.

f

shr-next-link Jump to next link.

n

emacspeak-eww-next-element Jump to next element.

p

emacspeak-eww-previous-element Jump to previous element.

s

eww-readable Use EWW’s built-in readable tool.

:

emacspeak-eww-tags-at-point Display currently active HTML tags at point.

12.70.2 Filtering Content Using The DOM

These commands use EWW’s HTML DOM to display different filtered views of the Web page. With an interactive prefix argument, these commands prompt for a list of filters. Command emacspeak-eww-restore bound to DEL can be used to restore the previous view.

A

eww-view-dom-having-attribute Display DOM nodes having specified attribute. Valid attributes are available via completion.

C

eww-view-dom-having-class Display DOM nodes having specified class. Valid classes are available via completion.

E

eww-view-dom-having-elements Display specified elements from the Dom. Valid element names are available via completion.

I

eww-view-dom-having-id Display DOM nodes having specified ID. Valid id values are available via completion.

R

eww-view-dom-having-role Display DOM nodes having specified role. Valid roles are available via completion.

M-a

eww-view-dom-not-having-attribute Filter out DOM nodes having specified attribute. Valid attribute values are available via completion.

M-c

eww-view-dom-not-having-class Filter out DOM nodes having specified class. Valid class values are available via completion.

M-e

eww-view-dom-not-having-elements Filter out specified element DOM nodes. Valid element names are available via completion.

M-i

eww-view-dom-not-having-id Dfilter out Display DOM nodes having specified ID. Valid id values are available via completion.

M-r

eww-view-dom-not-having-role Filter out DOM nodes having specified role. Valid role values are available via completion.

12.70.3 Updated Commands For Following Links

These key-bindings are available when point is on a link. They enable context-specific actions for following links, e.g., to play media streams, or to open various feed-types such as ATOM, RSS, or OPML.

k

shr-copy-url Copy URL under point to the kill-ring.

;

emacspeak-webutils-play-media-at-point Play media URL under point using emacs-m-player.

U

emacspeak-webutils-curl-play-media-at-point Play media url under point by first downloading the URL using CURL. This is useful for sites that do multiple redirects before returning the actual media stream URL.

C-o

emacspeak-feeds-opml-display Display link under point as an OPML feed .

C-r

emacspeak-feeds-rss-display Display link under point as an RSS feed.

C-a

emacspeak-feeds-atom-display Display link under point as an ATOM feed.

y

emacspeak-m-player-youtube-player Play link under point as a Youtube stream.

12.70.4 Miscellaneous Commands

'

emacspeak-speak-rest-of-buffer Speak rest of current Web page starting from point.

*

eww-add-bookmark Bookmark current Web page.

= dtk-toggle-punctuation-mode

Toggle punctuation mode.

?

emacspeak-webutils-google-similar-to-this-page Google similarity search.

C-t

emacspeak-eww-transcode Transcode current page to something more readable.

G emacspeak-google-command

Prefix key to invoke Google-specific commands.

L

emacspeak-eww-links-rel Display any related links discovered via the document’s meta tag.

Q

emacspeak-kill-buffer-quietly Delete this buffer.

V

eww-view-source Display Web page source.

e

emacspeak-we-xsl-map Prefix key for invoking XSLT-based filters.

k

eww-copy-page-url Copy page URL to kill-ring.

In addition, see commands in See emacspeak-google, for Google-Search specific commands, many of which are available via prefix-key G.

12.70.5 Filtering Content Using XSLT And XPath

C-c

emacspeak-we-junk-by-class-list Prompts for list of class-names with completion, and filters out matching elements.

C-f

emacspeak-we-count-matches Prompts for XPath expression, and returns count of matching elements.

C-p

emacspeak-we-xpath-junk-and-follow Follows link under point, and displays that page after filtering by a specified XPath expression.

C-t

emacspeak-we-count-tables Display a count of tables in the page.

C-x

emacspeak-we-count-nested-tables Counts nested tables.

C

emacspeak-we-extract-by-class-list Prompts for a list of class-names, and displays matching elements.

D

emacspeak-we-junk-by-class-list Filters out elements having specified class attributes.

I

emacspeak-we-extract-by-id-list Extracts elements by specified list of ID values.

M

emacspeak-we-extract-tables-by-match-list Extracts tables that match specified selection pattern.

P

emacspeak-we-follow-and-extract-main Follows link under point, and extracts readable content, by default, this is all paragraphs and headings.

S

emacspeak-we-style-filter Filters content by style attribute.

T

emacspeak-we-extract-tables-by-position-list Extracts tables by their position on the page.

X

emacspeak-we-extract-nested-table-list Extracts nested tables.

a

emacspeak-we-xslt-apply Prompt for and apply specified XSLT transform to current page.

b

emacspeak-we-follow-and-filter-by-id Follow link under point, and filter by specified id value.

c

emacspeak-we-extract-by-class Extracts elements by class.

d

emacspeak-we-junk-by-class Filters out elements having specified class value.

e

emacspeak-we-url-expand-and-execute Follow link under point, but pass the result to a custom executor.

f

emacspeak-we-xslt-filter Apply a specified XSLT filter (XPath) to current page.

i

emacspeak-we-extract-by-id Extract elements by id value.

j

emacspeak-we-xslt-junk Filter out elements matching specified pattern.

k

emacspeak-we-toggle-xsl-keep-result Debugging tool — retains the HTML source after XSLT.

m

emacspeak-we-extract-table-by-match Extract matching table.

p

emacspeak-we-xpath-filter-and-follow Follow link under point, and filter results by a specified XPath filter.

r

emacspeak-we-extract-by-role Extract elements by specified role value.

s

emacspeak-we-xslt-select Select default XSLT transform that is applied before rendering the page.

t

emacspeak-we-extract-table-by-position Extracts tables by their position on the page.

u

emacspeak-we-extract-matching-urls Display matching links on the page.

v

emacspeak-we-class-filter-and-follow-link Follow link under point, and filter by specified class value.

w

emacspeak-we-extract-by-property Extract element using a combination of DOM attributes.

x

emacspeak-we-extract-nested-table Extract a nested table using a match-list.

y

emacspeak-we-class-filter-and-follow Follow link under point and filter by class values.

12.70.6 EWW And EBooks On The Emacspeak Audio Desktop

Modules emacspeak-epub and emacspeak-bookshare provide EBook front-ends to EPub-2 and Daisy EBooks. Both modules now use EWW to render these EBooks. Module emacspeak-eww provides a simple bookmarking facility — called eww-marks (to avoid confusion with EWW’s Web Bookmarks). When reading an EBook, you can use m to create an EWW-mark at that position. These marks are automatically saved across Emacs sessions. To open a previously created eww-mark, use command emacspeak-eww-open-mark bound to C-x r e. This command reads a eww-mark name with completion. Use this command with an interactive prefix arg to delete a previously created eww-mark.

12.70.7 emacspeak-eww Commands

12.70.7.1 emacspeak-eww-add-mark

Command: emacspeak-eww-add-mark (name)
        Interactively add a mark with name title+‘name’ at current position.

(fn NAME)

12.70.7.2 emacspeak-eww-delete-mark

Command: emacspeak-eww-delete-mark (name)
        Interactively delete a mark with name ‘name’ at current position.

(fn NAME)

12.70.7.3 emacspeak-eww-google-knowledge-card

Command: emacspeak-eww-google-knowledge-card
Show just the knowledge card.
Warning, this is fragile, and depends on a stable id for the
  knowledge card.

12.70.7.4 emacspeak-eww-links-rel

Command: emacspeak-eww-links-rel
        Display Link tags of type rel.  Web pages for which alternate links
are available are cued by an auditory icon on the header line.

12.70.7.5 emacspeak-eww-marks-load

Command: emacspeak-eww-marks-load
Load saved marks.

12.70.7.6 emacspeak-eww-marks-save

Command: emacspeak-eww-marks-save
Save Emacspeak EWW marks.

12.70.7.7 emacspeak-eww-masquerade

Command: emacspeak-eww-masquerade
Toggle masquerade state.

12.70.7.8 emacspeak-eww-next-dd

Command: emacspeak-eww-next-dd (&optional speak)
Move forward to the next dd.
Optional interactive prefix arg speaks the dd.
The dd is automatically spoken if there is no user activity.

12.70.7.9 emacspeak-eww-next-dl

Command: emacspeak-eww-next-dl (&optional speak)
Move forward to the next dl.
Optional interactive prefix arg speaks the dl.
The dl is automatically spoken if there is no user activity.

12.70.7.10 emacspeak-eww-next-dt

Command: emacspeak-eww-next-dt (&optional speak)
Move forward to the next dt.
Optional interactive prefix arg speaks the dt.
The dt is automatically spoken if there is no user activity.

12.70.7.11 emacspeak-eww-next-element

Command: emacspeak-eww-next-element (el)
        Move forward to the next specified element.

(fn EL)

12.70.7.12 emacspeak-eww-next-element-from-history

Command: emacspeak-eww-next-element-from-history
        Uses element navigation history to decide where we jump.

12.70.7.13 emacspeak-eww-next-element-like-this

Command: emacspeak-eww-next-element-like-this (element)
Moves to next element like current.
Prompts if content at point is enclosed by multiple elements.

(fn ELEMENT)

12.70.7.14 emacspeak-eww-next-h

Command: emacspeak-eww-next-h (&optional speak)
Move forward to the next h.
Optional interactive prefix arg speaks the h.
The h is automatically spoken if there is no user activity.

12.70.7.15 emacspeak-eww-next-h1

Command: emacspeak-eww-next-h1 (&optional speak)
Move forward to the next h1.
Optional interactive prefix arg speaks the h1.
The h1 is automatically spoken if there is no user activity.

12.70.7.16 emacspeak-eww-next-h2

Command: emacspeak-eww-next-h2 (&optional speak)
Move forward to the next h2.
Optional interactive prefix arg speaks the h2.
The h2 is automatically spoken if there is no user activity.

12.70.7.17 emacspeak-eww-next-h3

Command: emacspeak-eww-next-h3 (&optional speak)
Move forward to the next h3.
Optional interactive prefix arg speaks the h3.
The h3 is automatically spoken if there is no user activity.

12.70.7.18 emacspeak-eww-next-h4

Command: emacspeak-eww-next-h4 (&optional speak)
Move forward to the next h4.
Optional interactive prefix arg speaks the h4.
The h4 is automatically spoken if there is no user activity.

12.70.7.19 emacspeak-eww-next-h5

Command: emacspeak-eww-next-h5 (&optional speak)
Move forward to the next h5.
Optional interactive prefix arg speaks the h5.
The h5 is automatically spoken if there is no user activity.

12.70.7.20 emacspeak-eww-next-h6

Command: emacspeak-eww-next-h6 (&optional speak)
Move forward to the next h6.
Optional interactive prefix arg speaks the h6.
The h6 is automatically spoken if there is no user activity.

12.70.7.21 emacspeak-eww-next-li

Command: emacspeak-eww-next-li (&optional speak)
Move forward to the next li.
Optional interactive prefix arg speaks the li.
The li is automatically spoken if there is no user activity.

12.70.7.22 emacspeak-eww-next-ol

Command: emacspeak-eww-next-ol (&optional speak)
Move forward to the next ol.
Optional interactive prefix arg speaks the ol.
The ol is automatically spoken if there is no user activity.

12.70.7.23 emacspeak-eww-next-p

Command: emacspeak-eww-next-p (&optional speak)
Move forward to the next p.
Optional interactive prefix arg speaks the p.
The p is automatically spoken if there is no user activity.

12.70.7.24 emacspeak-eww-next-table

Command: emacspeak-eww-next-table (&optional speak)
Move forward to the next table.
Optional interactive prefix arg speaks the table.
The table is automatically spoken if there is no user activity.

12.70.7.25 emacspeak-eww-next-ul

Command: emacspeak-eww-next-ul (&optional speak)
Move forward to the next ul.
Optional interactive prefix arg speaks the ul.
The ul is automatically spoken if there is no user activity.

12.70.7.26 emacspeak-eww-open-mark

Command: emacspeak-eww-open-mark (name &optional delete)
C-x r e
        Open specified EWW marked location. If the content is already being
displayed in this Emacs session, jump to it directly. With optional
interactive prefix arg ‘delete’, delete that mark instead.

(fn NAME &optional DELETE)

12.70.7.27 emacspeak-eww-phantom

Command: emacspeak-eww-phantom (url)
        Retrieve ‘url’  using PhantomJS and render with EWW.

(fn URL)

12.70.7.28 emacspeak-eww-previous-dd

Command: emacspeak-eww-previous-dd (&optional speak)
Move backward to the next dd.
Optional interactive prefix arg speaks the dd.
The dd is automatically spoken if there is no user activity.

12.70.7.29 emacspeak-eww-previous-dl

Command: emacspeak-eww-previous-dl (&optional speak)
Move backward to the next dl.
Optional interactive prefix arg speaks the dl.
The dl is automatically spoken if there is no user activity.

12.70.7.30 emacspeak-eww-previous-dt

Command: emacspeak-eww-previous-dt (&optional speak)
Move backward to the next dt.
Optional interactive prefix arg speaks the dt.
The dt is automatically spoken if there is no user activity.

12.70.7.31 emacspeak-eww-previous-element

Command: emacspeak-eww-previous-element (el)
        Move backward  to the previous  specified element.

(fn EL)

12.70.7.32 emacspeak-eww-previous-element-from-history

Command: emacspeak-eww-previous-element-from-history
        Uses element navigation history to decide where we jump.

12.70.7.33 emacspeak-eww-previous-element-like-this

Command: emacspeak-eww-previous-element-like-this (element)
Moves to next element like current.
Prompts if content at point is enclosed by multiple elements.

(fn ELEMENT)

12.70.7.34 emacspeak-eww-previous-h

Command: emacspeak-eww-previous-h (&optional speak)
Move backward to the next h.
Optional interactive prefix arg speaks the h.
The h is automatically spoken if there is no user activity.

12.70.7.35 emacspeak-eww-previous-h1

Command: emacspeak-eww-previous-h1 (&optional speak)
Move backward to the next h1.
Optional interactive prefix arg speaks the h1.
The h1 is automatically spoken if there is no user activity.

12.70.7.36 emacspeak-eww-previous-h2

Command: emacspeak-eww-previous-h2 (&optional speak)
Move backward to the next h2.
Optional interactive prefix arg speaks the h2.
The h2 is automatically spoken if there is no user activity.

12.70.7.37 emacspeak-eww-previous-h3

Command: emacspeak-eww-previous-h3 (&optional speak)
Move backward to the next h3.
Optional interactive prefix arg speaks the h3.
The h3 is automatically spoken if there is no user activity.

12.70.7.38 emacspeak-eww-previous-h4

Command: emacspeak-eww-previous-h4 (&optional speak)
Move backward to the next h4.
Optional interactive prefix arg speaks the h4.
The h4 is automatically spoken if there is no user activity.

12.70.7.39 emacspeak-eww-previous-h5

Command: emacspeak-eww-previous-h5 (&optional speak)
Move backward to the next h5.
Optional interactive prefix arg speaks the h5.
The h5 is automatically spoken if there is no user activity.

12.70.7.40 emacspeak-eww-previous-h6

Command: emacspeak-eww-previous-h6 (&optional speak)
Move backward to the next h6.
Optional interactive prefix arg speaks the h6.
The h6 is automatically spoken if there is no user activity.

12.70.7.41 emacspeak-eww-previous-li

Command: emacspeak-eww-previous-li (&optional speak)
Move backward to the next li.
Optional interactive prefix arg speaks the li.
The li is automatically spoken if there is no user activity.

12.70.7.42 emacspeak-eww-previous-ol

Command: emacspeak-eww-previous-ol (&optional speak)
Move backward to the next ol.
Optional interactive prefix arg speaks the ol.
The ol is automatically spoken if there is no user activity.

12.70.7.43 emacspeak-eww-previous-p

Command: emacspeak-eww-previous-p (&optional speak)
Move backward to the next p.
Optional interactive prefix arg speaks the p.
The p is automatically spoken if there is no user activity.

12.70.7.44 emacspeak-eww-previous-table

Command: emacspeak-eww-previous-table (&optional speak)
Move backward to the next table.
Optional interactive prefix arg speaks the table.
The table is automatically spoken if there is no user activity.

12.70.7.45 emacspeak-eww-previous-ul

Command: emacspeak-eww-previous-ul (&optional speak)
Move backward to the next ul.
Optional interactive prefix arg speaks the ul.
The ul is automatically spoken if there is no user activity.

12.70.7.46 emacspeak-eww-reading-settings

Command: emacspeak-eww-reading-settings
        Setup speech-rate, punctuation and split-caps for reading prose.

12.70.7.47 emacspeak-eww-restore

Command: emacspeak-eww-restore
        Restore buffer to pre-filtered canonical state.

12.70.7.48 emacspeak-eww-shell-command-on-url-at-point

Command: emacspeak-eww-shell-command-on-url-at-point (&optional prefix)
        Run specified shell command on URL at point.
Warning: Running shell script cbox through this fails mysteriously.

(fn &optional PREFIX)

12.70.7.49 emacspeak-eww-smart-tabs

Command: emacspeak-eww-smart-tabs (char &optional define)
C-, SPC
C-x @ a SPC
Open URL in EWW keyed by  ‘char’.
To associate a URL with a char, use this command
with an interactive prefix arg. 

(fn CHAR &optional DEFINE)

12.70.7.50 emacspeak-eww-smart-tabs-add

Command: emacspeak-eww-smart-tabs-add (char url)
        Add a URL to the specified location in smart tabs.

(fn CHAR URL)

12.70.7.51 emacspeak-eww-smart-tabs-load

Command: emacspeak-eww-smart-tabs-load
Load our smart tabsfrom a file.

12.70.7.52 emacspeak-eww-smart-tabs-save

Command: emacspeak-eww-smart-tabs-save
        Save our smart tabs to a file for reloading.

12.70.7.53 emacspeak-eww-speak-this-element

Command: emacspeak-eww-speak-this-element (element)
Speaks  to next element like current.
Uses most recently navigated structural unit.
Otherwise, prompts if content at point is enclosed by multiple elements.

(fn ELEMENT)

12.70.7.54 emacspeak-eww-table-next-cell

Command: emacspeak-eww-table-next-cell (&optional prefix)
        Speak next cell after making it current.
Interactive prefix arg moves to the last cell in the table.

(fn &optional PREFIX)

12.70.7.55 emacspeak-eww-table-previous-cell

Command: emacspeak-eww-table-previous-cell (&optional prefix)
        Speak previous cell after making it current.
With interactive prefix arg, move to the start of the table.

(fn &optional PREFIX)

12.70.7.56 emacspeak-eww-table-speak-cell

Command: emacspeak-eww-table-speak-cell
Speak current cell.

12.70.7.57 emacspeak-eww-tags-at-point

Command: emacspeak-eww-tags-at-point
Display tags at point.

12.70.7.58 emacspeak-eww-transcode

Command: emacspeak-eww-transcode
        Apply appropriate transcoding rules to current DOM.

12.70.7.59 emacspeak-eww-update-title

Command: emacspeak-eww-update-title (title)
        Interactively set title — renames buffer, and sets header-line.

(fn TITLE)

12.70.8 emacspeak-eww Options

Variable: User Option emacspeak-eww-masquerade-as

User Agent string that is sent when masquerading is on.

Variable: User Option emacspeak-eww-silence-images

Set to nil if you want EWW to load images.


Next: , Previous: , Up: Emacspeak Commands And Options   [Contents][Index]