From 41a153ae4848a90c7cef3837f5be930d64fb183b Mon Sep 17 00:00:00 2001 From: Mark Hoeber Date: Tue, 21 Jan 2014 10:56:11 -0500 Subject: [PATCH] Textbooks accessibility changes Removed image-based textbook info from XML tutorial. Added not about accessibility and textbooks to Building a Course file. --- docs/en_us/course_authors/source/conf.py | 2 +- .../source/create_new_course.rst | 2 + .../source/course_data_formats/course_xml.rst | 72 +------------------ 3 files changed, 4 insertions(+), 72 deletions(-) diff --git a/docs/en_us/course_authors/source/conf.py b/docs/en_us/course_authors/source/conf.py index 7f4927ffc5..c2f66117bf 100644 --- a/docs/en_us/course_authors/source/conf.py +++ b/docs/en_us/course_authors/source/conf.py @@ -25,7 +25,7 @@ html_static_path.append('source/_static') # General information about the project. project = u'Building a Course with edX Studio' -copyright = u'2013, edX Documentation Team' +copyright = u'2014, edX' # The short X.Y version. version = '' diff --git a/docs/en_us/course_authors/source/create_new_course.rst b/docs/en_us/course_authors/source/create_new_course.rst index aa3cfae574..451075780c 100644 --- a/docs/en_us/course_authors/source/create_new_course.rst +++ b/docs/en_us/course_authors/source/create_new_course.rst @@ -391,6 +391,8 @@ Add Textbooks **************** You can add textbooks for your course as PDF files. +.. note:: Do not use image files (for example, .PNG files) as textbooks for your course, as they are not accessible to screen readers. Review the :ref:`Best Practices for Accessible PDFs` for more information. + Each textbook that you add is displayed to students as a tab in the course navigation bar. It's recommended that you upload a separate PDF file for each chapter of your textbook. diff --git a/docs/en_us/data/source/course_data_formats/course_xml.rst b/docs/en_us/data/source/course_data_formats/course_xml.rst index fed8e4e397..9523c10857 100644 --- a/docs/en_us/data/source/course_data_formats/course_xml.rst +++ b/docs/en_us/data/source/course_data_formats/course_xml.rst @@ -567,77 +567,7 @@ If you want to customize the courseware tabs displayed for your course, specify ********* Textbooks ********* -Support is currently provided for image-based, HTML-based and PDF-based textbooks. In addition to enabling the display of textbooks in tabs (see above), specific information about the location of textbook content must be configured. - -Image-based Textbooks -===================== - -Configuration -------------- - -Image-based textbooks are configured at the course level in the XML markup. Here is an example: - -.. code-block:: xml - - - - - - - - - -Each `textbook` element is displayed on a different tab. The `title` attribute is used as the tab's name, and the `book_url` attribute points to the remote directory that contains the images of the text. Note the trailing slash on the end of the `book_url` attribute. - -The images must be stored in the same directory as the `book_url`, with filenames matching `pXXX.png`, where `XXX` is a three-digit number representing the page number (with leading zeroes as necessary). Pages start at `p001.png`. - -Each textbook must also have its own table of contents. This is read from the `book_url` location, by appending `toc.xml`. This file contains a `table_of_contents` parent element, with `entry` elements nested below it. Each `entry` has attributes for `name`, `page_label`, and `page`, as well as an optional `chapter` attribute. An arbitrary number of levels of nesting of `entry` elements within other `entry` elements is supported, but you're likely to only want two levels. The `page` represents the actual page to link to, while the `page_label` matches the displayed page number on that page. Here's an example: - -.. code-block:: xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Linking from Content --------------------- - -It is possible to add links to specific pages in a textbook by using a URL that encodes the index of the textbook and the page number. The URL is of the form `/course/book/${bookindex}/$page}`. If the page is omitted from the URL, the first page is assumed. - -You can use a `customtag` to create a template for such links. For example, you can create a `book` template in the `customtag` directory, containing: - -.. code-block:: xml - - More information given in the text. - -The course content can then link to page 25 using the `customtag` element: - -.. code-block:: xml - - +Support is currently provided for HTML-based and PDF-based textbooks. In addition to enabling the display of textbooks in tabs (see above), specific information about the location of textbook content must be configured. HTML-based Textbooks