DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: ReadSpeaker - Online Text to Speech¶
| Author: | Christopher |
|---|---|
| Created: | 2010-12-18T19:57:23 |
| Changed: | 2012-07-11T23:10:17 |
| Classification: | readspeaker |
| Keywords: | text to speech, web accessibility |
| Author: | Oliver Hader |
| Email: | oliver.hader@typo3.org |
| language (en): | en |
EXT: ReadSpeaker - Online Text to Speech¶
Extension Key: readspeaker
Language:
Version: 0.2.0
Keywords: text to speech, web accessibility
Copyright 2012, Oliver Hader, oliver.hader@typo3.org
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
`EXT: ReadSpeaker - Online Text to Speech 1 <#__RefHeading__5708_1738894311>`_
`Introduction 3 <#__RefHeading__5710_1738894311>`_
`Administration 4 <#__RefHeading__31511_818911409>`_
Content column with CSS id content-column 4
`Configuration 6 <#__RefHeading__31515_818911409>`_
`ChangeLog 8 <#__RefHeading__31623_818911409>`_
Introduction¶
What does it do?¶
This extension allows to integrate the ReadSpeaker widget in the TYPO3 front-end. ReadSpeaker ( http://www.readspeaker.com/ ) is a service that fetches the contents of a web page and transfers those to spoken words. Thus, this is a good way to deliver kind of a screen reader for your website out of the box.
Screenshots¶
ReadSpeaker button that is rendered above the main content column
Administration¶
Configuration¶
TypoScript Templates¶
This extension is shipped with a static template that needs to be included.
Inclusion of static TypoScript in the TYPO3 back-end
Configuration¶
Most of the settings can be defined by using the constant editor in the TYPO3 back-end. Most important properties are customerIdand readId(see TypoScript reference for further details).
Let's assume that the main content column has the CSS id content- columnand thus shall be used as readId, the part of the site to be read by ReadSpeaker.
Content column with CSS id content-column
Various properties that can be modified in the TYPO3 constant editor
Disable ReadSpeaker for content elements or pages¶
The ReadSpeaker feature can be disabled for a whole page or for particular content elements on a page. For content elements the accordant part is wrapped the CSS class rs-skip.
Disabling ReadSpeaker for a particular page
Disabling ReadSpeaker for a particular content element
Configuration¶
Reference¶
plugin.tx_readspeaker¶
settings¶
Property
settings
Data type
array
Description
Defines several settings that can be defined in the constant editor.
Example:
settings {
stylesheet = fileadmin/readspeaker.css
customerId = 12345
baseUrl = ...
language = en_en
readId = content-column
renderTo = readspeaker-section
scriptUrl = ...
applicationUrl = ...
buttonStyle = tx-readspeaker-icon-basic
}
Default
renderObject¶
Property
renderObject
Data type
cObject
Description
Applies to restricted URLs
Example:
renderObject = COA
renderObject {
10 = TEXT
10 {
...
}
}
Default
plugin.tx_readspeaker.settings¶
stylesheet¶
Property
stylesheet
Data type
string
Description
File name of an alternative CSS stylesheet to be used.
Default
customerId¶
Property
customerId
Data type
integer
Description
The customerId provided by ReadSpeaker, you need a valid contract from http://www.readspeaker.com/
Default
baseUrl¶
Property
baseUrl
Data type
string
Description
Defines an alternative base URL to be used, in case your website is running on different domains and the currently used domain not activated in your ReadSpeaker account.
Example:
Assume that baseUrlis set to the following value
http://test.local/home.html?query=value
will be modified to
http://mydomain.com/home.html?query=value
Default
language¶
Property
language
Data type
string
Description
The dictionary to be used (e.g. en_en, de_de, fr_fr, ...)
Default
en_en
voice¶
Property
voice
Data type
String
Description
Optional voice to be used (e.g de_hans, ...)
Default
readId¶
Property
readId
Data type
string
Description
CSS id to be used to determine the contents to be read.
Default
renderTo¶
Property
renderTo
Data type
string
Description
CSS id to be used to render the ReadSpeaker widget to.
Example:
<div id="readspeaker-section">
will be extended to containt the ReadSpeaker widget
<div id="readspeaker-section">
<div id="tx-readspeaker-widget-1"
class="tx-readspeaker-widget rs_skip">
...
</div>
Default
scriptUrl¶
Property
scriptUrl
Data type
string
Description
(internal)
URL of the ReadSpeaker JavaScript
Default
applicationUrl¶
Property
applicationUrl
Data type
string
Description
(internal)
URL of the ReadSpeaker application reading texts
Default
buttonStyle¶
Property
buttonStyle
Data type
string
Description
CSS class name of the “read text” button to be used.
Default