Bug#509371: installation-guide: Installation guide accessibility sections
Package: installation-guide
Severity: normal
Tags: patch
Here is a patch that adds to installation-guide two accessibility
sections: in the supported hardware section, provide urls to lists
of supported braille displays and speech syntheses, and in the boot
section, document the boot parameters needed to enable accessibility
features.
Samuel
-- System Information:
Debian Release: 5.0
APT prefers testing
APT policy: (990, 'testing'), (500, 'unstable'), (500, 'stable'), (1, 'experimental')
Architecture: amd64 (x86_64)
Kernel: Linux 2.6.27 (SMP w/2 CPU cores)
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash
Index: build/entities/urls.ent
===================================================================
--- build/entities/urls.ent (révision 56918)
+++ build/entities/urls.ent (copie de travail)
@@ -202,7 +202,14 @@
<!ENTITY url-simtel "ftp://ftp.simtel.net/pub/simtelnet/msdos/";>
+<!ENTITY url-brltty "http://www.mielke.cc/brltty/";>
+<!ENTITY url-brltty-driver-codes "http://www.mielke.cc/brltty/doc/Manual-BRLTTY/English/BRLTTY-11.html";>
+<!ENTITY url-brltty-table-codes "http://www.mielke.cc/brltty/doc/Manual-BRLTTY/English/BRLTTY-6.html";>
+<!ENTITY url-speakup "http://www.linux-speakup.org/";>
+<!ENTITY url-speakup-driver-codes "http://www.linux-speakup.org/spkguide.txt";>
+
+
<!-- ****************************************** m68k links -->
<!--
urls that I need to absorb or point to:
Index: build/entities/common.ent
===================================================================
--- build/entities/common.ent (révision 56918)
+++ build/entities/common.ent (copie de travail)
@@ -126,6 +126,12 @@
<!-- version of X11 shipping with the current release -->
<!ENTITY x11ver "7.3">
+<!-- version of BRLTTY shipping with the current release -->
+<!ENTITY brlttyver "3.10">
+
+<!-- version of Speakup shipping with the current release -->
+<!ENTITY speakupver "3.0.3">
+
<!-- an example of adding another image to lilo.conf, cf
en/post-install.sgml etc. -->
<!ENTITY additional-lilo-image
Index: build/templates/docstruct.ent
===================================================================
--- build/templates/docstruct.ent (révision 56918)
+++ build/templates/docstruct.ent (copie de travail)
@@ -29,6 +29,7 @@
<!ENTITY supported-sparc.xml SYSTEM "##SRCPATH##/hardware/supported/sparc.xml">
<!ENTITY network-cards.xml SYSTEM "##SRCPATH##/hardware/network-cards.xml">
<!ENTITY supported-peripherals.xml SYSTEM "##SRCPATH##/hardware/supported-peripherals.xml">
+ <!ENTITY accessibility-hardware.xml SYSTEM "##SRCPATH##/hardware/accessibility.xml">
<!ENTITY buying-hardware.xml SYSTEM "##SRCPATH##/hardware/buying-hardware.xml">
<!ENTITY installation-media.xml SYSTEM "##SRCPATH##/hardware/installation-media.xml">
<!ENTITY memory-disk-requirements.xml SYSTEM "##SRCPATH##/hardware/memory-disk-requirements.xml">
@@ -94,6 +95,7 @@
<!ENTITY boot-installer-s390.xml SYSTEM "##SRCPATH##/boot-installer/s390.xml">
<!ENTITY boot-installer-sparc.xml SYSTEM "##SRCPATH##/boot-installer/sparc.xml">
<!ENTITY boot-installer-parameters.xml SYSTEM "##SRCPATH##/boot-installer/parameters.xml">
+ <!ENTITY boot-installer-accessibility.xml SYSTEM "##SRCPATH##/boot-installer/accessibility.xml">
<!ENTITY boot-installer-trouble.xml SYSTEM "##SRCPATH##/boot-installer/trouble.xml">
<!ENTITY using-d-i.xml SYSTEM "##SRCPATH##/using-d-i/using-d-i.xml">
Index: en/hardware/hardware-supported.xml
===================================================================
--- en/hardware/hardware-supported.xml (révision 56918)
+++ en/hardware/hardware-supported.xml (copie de travail)
@@ -399,6 +399,7 @@
</sect2>
&network-cards.xml;
+&accessibility-hardware.xml;
&supported-peripherals.xml;
</sect1>
Index: en/hardware/accessibility.xml
===================================================================
--- en/hardware/accessibility.xml (révision 0)
+++ en/hardware/accessibility.xml (révision 0)
@@ -0,0 +1,29 @@
+<!-- retain these comments for translator revision tracking -->
+<!-- $Id: accessibility-hardware.xml $ -->
+
+ <sect2 id="braille-displays">
+ <title>Braille Displays</title>
+<para>
+
+Debian's support for braille displays is determined by the underlying
+support found in BRLTTY. Most displays work under BRLTTY, via serial, USB
+or bluetooth. Details on supported braille devices can be found at <ulink
+url="&url-brltty;"></ulink>. Debian &release; ships with BRLTTY version
+&brlttyver;.
+
+</para>
+ </sect2>
+
+ <sect2 id="hardware-speech-syntheses" arch="x86">
+ <title>Hardware Speech Syntheses</title>
+<para>
+
+Debian's support for hardware speech syntheses is determined by the underlying
+support found in Speakup. Speakup only supports integrated boards and external
+devices connected through Serial (no USB or serial-to-USB adapters are
+supported). Details on supported hardware speech syntheses can be found at
+<ulink url="&url-speakup;"></ulink>. Debian &release; ships with Speakup version
+&speakupver;.
+
+</para>
+ </sect2>
Index: en/boot-installer/accessibility.xml
===================================================================
--- en/boot-installer/accessibility.xml (révision 0)
+++ en/boot-installer/accessibility.xml (révision 0)
@@ -0,0 +1,92 @@
+<!-- retain these comments for translator revision tracking -->
+<!-- $Id: boot-installer-accessibility.xml $ -->
+
+ <sect1 id="boot-installer-accessibility"><title>Accessibility</title>
+<para>
+
+Some people may need particular support due to e.g. visual impairment. USB
+braille displays are automatically detected, but most other accessibility
+features have to be enabled by hand. On machines that support it, the boot
+menu emits a beep when it is ready to receive keystrokes. Some boot parameters
+can then be appended to enable accessibility features. Note that on most
+architectures the boot loader interprets your keyboard as a QWERTY keyboard.
+
+</para>
+
+<sect2><title>USB Braille Displays</title>
+
+<para>
+
+USB braille displays should be automatically detected. A textual version of
+the installer will then be automatically selected, and support for the braille
+display will be automatically installed on the target system. You can thus just
+press &enterkey; at the boot menu. Once BRLTTY is started,
+you can choose a braille table by entering the preference menu.
+
+</para>
+
+ </sect2>
+ <sect2><title>Serial Braille Displays</title>
+
+<para>
+
+Serial braille displays can not safely be automatically detected
+(since that may brick some of them). You thus need to append the
+<userinput>brltty=driver,port,table</userinput> boot parameter to tell
+BRLTTY which driver it should use. <userinput>driver</userinput>
+should be replaced by the two-letter driver core for your terminal,
+see <ulink url="&url-brltty-driver-codes;"></ulink> for a list.
+<userinput>device</userinput> should be replaced by the name of the serial
+port the display is connected to, <userinput>ttyS0</userinput> is the default.
+<userinput>table</userinput> is the name of the braille table to be used, see
+<ulink url="&url-brltty-table-codes;"></ulink> for a list, the english table
+is the default. Note that the table can be changed later by entering the
+preference menu.
+
+</para>
+
+ </sect2>
+
+ <sect2 arch="x86"><title>Hardware Speech Syntheses</title>
+
+<para>
+
+Support for hardware speech syntheses is enabled only along support for
+graphical installer. You thus need to select the <computeroutput>Graphical
+install</computeroutput> entry in the boot menu.
+
+Hardware speech syntheses can not be automatically detected. You thus need
+to append the <userinput>speakup.synth=driver</userinput> boot parameter
+to tell Speakup which driver it should use. <userinput>driver</userinput>
+should be replaced by the driver code for your device, see <ulink
+url="&url-speakup-driver-codes;"></ulink> for a list. The textual version of
+the installer will then be automatically selected, and support for the speech
+synthesis will be automatically installed on the target system.
+
+</para>
+
+ </sect2>
+ <sect2><title>Board-based Devices</title>
+
+<para>
+
+Some accessibility devices are actual boards that are plugged inside
+the machine and that directly read text from the video memory. To get
+them working the framebuffer support must be disabled by using the
+<userinput>fb=false</userinput> boot parameter.
+
+</para>
+
+ </sect2>
+ <sect2><title>High-Contrast Theme</title>
+
+<para>
+
+For people with low vision, the installer can use a high-contrast
+theme that makes it more readable. To enable it, append the
+<userinput>theme=dark</userinput> boot parameter.
+
+</para>
+
+ </sect2>
+ </sect1>
Index: en/boot-installer/boot-installer.xml
===================================================================
--- en/boot-installer/boot-installer.xml (révision 56918)
+++ en/boot-installer/boot-installer.xml (copie de travail)
@@ -44,6 +44,7 @@
</sect1>
+&boot-installer-accessibility.xml;
&boot-installer-parameters.xml;
&boot-installer-trouble.xml;
Reply to: