~ubuntu-branches/ubuntu/utopic/accessodf/utopic

« back to all changes in this revision

Viewing changes to debian/user-guide

  • Committer: Package Import Robot
  • Author(s): Sebastian Humenda
  • Date: 2012-04-09 11:21:13 UTC
  • Revision ID: package-import@ubuntu.com-20120409112113-huzjydidped86kce
Tags: 0.1-1
Initial release, packaged as a dependency for odt2braille. (Closes: #668144)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
UserGuide   
 
2
 
 
3
This user guide was taken from
 
4
  http://sourceforge.net/p/accessodf/wiki/UserGuide/
 
5
please have a look there for an up-to-date version.
 
6
 
 
7
User Guide
 
8
 
 
9
1. Introduction
 
10
 
 
11
AccessODF helps authors evaluate and improve the accessibility of their documents in
 
12
OpenOffice.org or LibreOffice Writer. A document may contain many problems that the author
 
13
is unaware of but that can keep someone with a disability from accessing the content. This
 
14
is true whether documents are accessed in Writer itself, or exported to a more common format
 
15
like HTML or PDF. Thanks to the extensions odt2daisy and odt2braille, Writer documents can
 
16
be a suitable source for formats specifically aimed at persons with disabilities. But in
 
17
order to create valid and usable Braille or DAISY books, the source document needs to be
 
18
accessible.
 
19
 
 
20
You can do several things to increase the accessibility of ODT documents. The following
 
21
documents give you a number of guidelines:
 
22
 
 
23
  • ODF Accessibility Guidelines by the Accessibility subcommittee of the OASIS Open
 
24
    Document Format for Office Applications (OpenDocument) TC
 
25
  • Authoring Techniques For Accessible Office Documents by the Accessible Digital Office
 
26
    Document (ADOD) Project
 
27
  • OpenOffice.org and Accessibility by Web Accessibility in Mind (WebAIM)
 
28
 
 
29
AccessODF helps you to keep these rules in mind and makes it very easy to write accessible
 
30
documents. Checking the accessibility is now as straightforward as checking the spelling:
 
31
similar to the spelling checker alerting you to potential spelling errors, the accessibility
 
32
checker helps you identify and resolve potential accessibility issues.
 
33
 
 
34
2. Installation
 
35
 
 
36
AccessODF is available as an extension. The installation requires OpenOffice.org/LibreOffice
 
37
3.3. AccessODF runs on all platforms (Windows, Mac OS, Linux).
 
38
 
 
39
 1. Download the installation file (OXT)
 
40
 2. In Writer, go to Tools > Extension Manager...
 
41
 3. Click Add...
 
42
 4. Select the OXT file and click Open
 
43
 5. Wait until the installation has finished, then click Close
 
44
 6. Finally, restart Writer
 
45
 
 
46
Warning: If you get an error dialog with the words
 
47
com.sun.star.registry.CannotRegisterImplementationException in it when installing the
 
48
extension on Ubuntu, open a command line and enter the command sudo apt-get install
 
49
libreoffice-java-common. This solution may also work for other Linux distributions.
 
50
 
 
51
3. Evaluate accessibility
 
52
 
 
53
The accessibility checker is shown in the Accessibility section of the Task Pane in Writer.
 
54
The Accessibility section of the Task Pane
 
55
You might have seen this Task Pane before in Impress, where it is used for Master Pages,
 
56
Layouts, Custom Animations and Transitions. It is usually located at the right side of the
 
57
workspace, but it can also be placed at the left or even undocked. To check the document for
 
58
possible issues, do the following:
 
59
 
 
60
 1. Open the document in Writer
 
61
 2. Go to Tools > Accessibility Evaluation... The Accessibility Evaluation item in the Tools
 
62
    menu
 
63
 3. Click Check The check button
 
64
 4. Wait for the tool to scan the whole document
 
65
 
 
66
The task pane displays all issues in a 'tree' view. While navigating the issues, focus will
 
67
move to the relevant location in the document. Each issue is classified as an error or a
 
68
warning. Selecting an issue shows information about why something might be inaccessible, and
 
69
instructions on how to fix it.
 
70
The accessibility checker gives an overview of all issues in a tree view
 
71
You can include or exclude certain checks specific to the export to DAISY and Braille. To
 
72
show these options, go to Tools > Options... > OpenOffice.org/LibreOffice Writer >
 
73
Accessibility Checker. In order to do Braille-specific checks, odt2braille version 1.1.0 or
 
74
later must be installed.
 
75
The Options page
 
76
 
 
77
4. Resolve accessibility issues
 
78
 
 
79
Each error or warning includes instructions on how to fix it manually. For some issues, you
 
80
can also use the handy Repair button. This button either fixes the issue automatically, or
 
81
it sends you in the right direction so that you can skip a few steps. It is also possible
 
82
that the checker reports an issue where no problem exists. In this case, just ignore the
 
83
issue with the Ignore button.
 
84
 
 
85
 1. Select an issue
 
86
 2. If this is not a real issue, click Ignore
 
87
 3. Else, if the Repair button is enabled, use it to fix the issue (semi-)automatically
 
88
 4. Else, fix the issue manually
 
89
 5. Repeat this until no issues are left
 
90