[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#509371: installation-guide: Installation guide accessibility sections



Frans Pop, le Mon 06 Apr 2009 03:49:54 +0200, a écrit :
> Oops, sorry. The separator is ";" instead of ",".

OK.

> (I don't do this that often either; grep in existing docs is your friend.)

Yes, it doesn't work very well in the installation guide, but it does in
the release notes indeed. Here is an updated patch. I had to explicitely
list architectures however as I couldn't find a way to express "all
archs but this list".

Samuel
Index: build/entities/urls.ent
===================================================================
--- build/entities/urls.ent	(révision 58149)
+++ 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 58149)
+++ build/entities/common.ent	(copie de travail)
@@ -147,6 +147,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 58149)
+++ 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 58149)
+++ 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,32 @@
+<!-- retain these comments for translator revision tracking -->
+<!-- $Id: accessibility-hardware.xml $ -->
+
+ <sect2 id="braille-displays" arch="alpha;ia64;powerpc;x86">
+ <title>Braille Displays</title>
+<para>
+
+Debian's support for braille displays is determined by the underlying
+support found in <classname>brltty</classname>. Most displays
+work under <classname>brltty</classname>, via serial, USB or
+bluetooth. Details on supported braille devices can be found on the <ulink
+url="&url-brltty;"><classname>brltty</classname> website</ulink>. Debian
+&release; ships with <classname>brltty</classname> version &brlttyver;.
+
+</para>
+ </sect2>
+
+ <sect2 id="hardware-speech-synthesis" arch="x86">
+ <title>Hardware Speech Syntheses</title>
+<para>
+
+Debian's support for hardware speech synthesis devices is determined
+by the underlying support found in <classname>speakup</classname>.
+<classname>speakup</classname> only supports integrated boards and external
+devices connected to a serial port (no USB or serial-to-USB adapters are
+supported).  Details on supported hardware speech synthesis devices can
+be found on the <ulink url="&url-speakup;"><classname>speakup</classname>
+website</ulink>. Debian &release; ships with <classname>speakup</classname>
+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,98 @@
+<!-- retain these comments for translator revision tracking -->
+<!-- $Id: boot-installer-accessibility.xml $ -->
+
+ <sect1 id="boot-installer-accessibility" arch="not-s390"><title>Accessibility</title>
+<para>
+
+Some users may need particular support because of e.g. some visual
+impairment. <phrase arch="alpha;ia64;powerpc;x86">USB braille
+displays are automatically detected, but most other</phrase> <phrase
+arch="arm;armel;hppa;mips;impsel;sparc;s390"> Most</phrase> accessibility
+features have to be enabled manually. <phrase arch="x86">On machines
+that support it, the boot menu emits a beep when it is ready to receive
+keystrokes.</phrase> Some boot parameters can <phrase arch="x86">then</phrase>
+be appended to enable accessibility features.  Note that on most architectures
+the boot loader interprets your keyboard as a QWERTY keyboard.
+
+</para>
+
+<sect2 arch="alpha;ia64;powerpc;x86"><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 <classname>brltty</classname> is started,
+you can choose a braille table by entering the preference menu.
+
+</para>
+
+  </sect2>
+  <sect2 arch="alpha;ia64;powerpc;x86"><title>Serial Braille Displays</title>
+
+<para>
+
+Serial braille displays cannot safely be automatically detected
+(since that may brick some of them).  You thus need to append the
+<userinput>brltty=<replaceable>driver</replaceable>,<replaceable>port</replaceable>,<replaceable>table</replaceable></userinput>
+boot parameter to tell <classname>brltty</classname> which driver it should use.
+<userinput>driver</userinput> should be replaced by the two-letter driver code
+for your terminal, see in the <ulink url="&url-brltty-driver-codes;">driver code
+list</ulink>. <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 the <ulink url="&url-brltty-table-codes;">table code list</ulink>,
+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 Synthesis</title>
+
+<para>
+
+Support for hardware speech synthesis devices 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 synthesis devices cannot be
+automatically detected.  You thus need to append the
+<userinput>speakup.synth=<replaceable>driver</replaceable></userinput> boot
+parameter to tell <classname>speakup</classname> which driver it should use.
+<userinput>driver</userinput> should be replaced by the driver code for
+your device, see the <ulink url="&url-speakup-driver-codes;">driver code
+list</ulink>.  The textual version of the installer will then be automatically
+selected, and support for the speech synthesis device will be automatically
+installed on the target system.
+
+</para>
+
+  </sect2>
+  <sect2><title>Board Devices</title>
+
+<para>
+
+Some accessibility devices are actual boards that are plugged inside
+the machine and that read text directly from the video memory.  To
+get them to work framebuffer support must be disabled by using the
+<userinput>fb=false</userinput> boot parameter.  This will however reduce the
+number of available languages.
+
+</para>
+
+  </sect2>
+  <sect2><title>High-Contrast Theme</title>
+
+<para>
+
+For users 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 58149)
+++ 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: