[liblouis-liblouisxml] [liblouis] r709 committed - Enhance the documentation on the display opcode
- From: liblouis@xxxxxxxxxxxxxx
- To: liblouis-liblouisxml@xxxxxxxxxxxxx
- Date: Thu, 28 Jun 2012 09:06:38 +0000
Revision: 709
Author: christian.egli@xxxxxxxxxxxxxx
Date: Thu Jun 28 02:06:18 2012
Log: Enhance the documentation on the display opcode
http://code.google.com/p/liblouis/source/detail?r=709
Modified:
/trunk/ChangeLog
/trunk/NEWS
/trunk/doc/liblouis.texi
=======================================
--- /trunk/ChangeLog Thu Jun 14 07:39:52 2012
+++ /trunk/ChangeLog Thu Jun 28 02:06:18 2012
@@ -1,3 +1,8 @@
+2012-06-28 Christian Egli <christian.egli@xxxxxx>
+
+ * doc/liblouis.texi (Miscellaneous Opcodes): Enhance the
+ documentation on the display opcode
+
2012-06-14 Christian Egli <christian.egli@xxxxxx>
* liblouis/lou_translateString.c (hyphenate): Fix a buffer overrun.
=======================================
--- /trunk/NEWS Tue Jun 12 00:18:43 2012
+++ /trunk/NEWS Thu Jun 28 02:06:18 2012
@@ -30,6 +30,7 @@
** Improved the documentation
- Document the test harness
- Document the use of Valgrind to find memory leaks
+ - Improve the documentation on the display opcode
** Bug fixes
- lou_allround and lou_translate now properly handle Unicode
=======================================
--- /trunk/doc/liblouis.texi Thu Jun 21 01:38:50 2012
+++ /trunk/doc/liblouis.texi Thu Jun 28 02:06:18 2012
@@ -1671,13 +1671,15 @@
examples:
@example
-display a 1 When the character a is sent to the embosser or display,
-it # will produce a dot 1.
+# When the character a is sent to the embosser or display,
+# it will produce a dot 1.
+display a 1
@end example
@example
-display L 123 When the character L is sent to the display or embosser
-# produces dots 1-2-3.
+# When the character L is sent to the display or embosser
+# it will produce dots 1-2-3.
+display L 123
@end example
The @code{display} opcode is optional. It is used when the embosser or
@@ -1685,6 +1687,11 @@
that given in @ref{Character-Definition Opcodes}. If used, display
entries must proceed character-definition entries.
+A possible use case would be to define display opcodes so that the
+result is Unicode braille for use on a display and a second set of
+display opcodes (in a different file) to produce plain ASCII braille
+for use with an embosser.
+
@opcode{multind, dots opcode opcode ...}
The @code{multind} opcode tells the back-translator that a sequence of
braille cells represents more than one braille indicator. For example,
For a description of the software, to download it and links to
project pages go to http://www.abilitiessoft.com
Other related posts:
- » [liblouis-liblouisxml] [liblouis] r709 committed - Enhance the documentation on the display opcode - liblouis
