Merge pull request #1920 from edx/markhoeber/documentation/stud-1007

Adding accessibility guidelines to "Building a Course with edX Studio" documentation 

docs/course_authors/source/change_log.rst

@@ -10,5 +10,7 @@ Change Log
 ==============  ================================================================
 12/05/2013	Complete revision of edX Studio documentation and integration 
                 of edX101 content.
+12/10/2013      Added MathJax appendix   
+12/11/2013      Added Accessibility chapter       
 ==============  ================================================================
 

docs/course_authors/source/checking_student_progress.rst

@@ -12,6 +12,7 @@ students during the run of the course and what you will need to do at the
 end of the course to give out grades.
  
 .. _A Student's View:
+
 ******************************
 A Student's View
 ******************************

docs/course_authors/source/common_problems.rst

@@ -376,9 +376,9 @@ To make the response case sensitive, change the value of the **type** attribute
       <textline size="20"/>
     </stringresponse>
     
-=========================================
+=============================================
 Response Field Length of Text Input Problems
-=========================================
+=============================================
 
 By default, the response field for text input problems is 20 characters long. 
 

docs/course_authors/source/create_html_component.rst

@@ -23,6 +23,8 @@ See the following topics:
 
 .. note:: Ensure you understand the chapter :ref:`Organizing Your Course Content` before working with HTML components.
 
+.. note:: Review :ref:`Best Practices for HTML Markup` before adding HTML components to your course.
+
 
 .. _Create an HTML Component:
 
@@ -228,6 +230,8 @@ Find any copy the URL of the image in the Files & Uploads page.
 
 See :ref:`Add Files to a Course` for more information.
 
+.. note::  Review :ref:`Best Practices for Describing Images` when adding images to HTML components.
+
 While editing the HTML component:
 
 #. Switch to the HTML view.

docs/course_authors/source/create_new_course.rst

@@ -26,7 +26,8 @@ This chapter describes how to create and set up your course:
 #. :ref:`Add Course Handouts`
 #. :ref:`Add Textbooks`
 
-Also see the chapters :ref:`Establish a Grading Policy` and :ref:`Organizing Your Course Content`.
+Also see the chapters :ref:`Establish a Grading Policy`, :ref:`Organizing Your Course Content`, and :ref:`Guidelines for Creating Accessible Content`.
+
 
 
 .. _Create a New Course:

docs/course_authors/source/create_video.rst

@@ -20,7 +20,7 @@ See the following topics:
 * :ref:`Video Hosting`
 * :ref:`Create a Video Component`
 
-
+.. note:: Review :ref:`Best Practices for Accessible Media` before adding videos to your course.
 
 .. _Video Formats:
 

docs/course_authors/source/index.rst

@@ -29,6 +29,7 @@ Contents
    set_content_releasedates
    view_course_content
    export_import_course
+   accessibility
    checking_student_progress
    ora_students
    change_log

docs/course_authors/source/organizing_course.rst

@@ -21,6 +21,9 @@ You organize your course in the following hierarchy:
 Studio provides you with flexibility when organizing your course.  
 A common course model is for Sections to correspond to weeks, and for Subsections to correspond to lessons.
 
+.. note::  We recommend that you review :ref:`Guidelines for Creating Accessible Content` before developing content for your course.
+
+
 ==================
 The Course Outline
 ==================

docs/data/source/conf.py

@@ -22,4 +22,10 @@ templates_path.append('source/_templates')
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path.append('source/_static')
 
+project = u'edX Data Documentation'
+copyright = u'2013, edX Documentation Team'
 
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
\ No newline at end of file

docs/data/source/index.rst

@@ -43,6 +43,7 @@ These document describe how we store course structure, student state/progress, a
 
    internal_data_formats/sql_schema.rst
    internal_data_formats/discussion_data.rst
+   internal_data_formats/wiki_data.rst
    internal_data_formats/tracking_logs.rst
 
 Indices and tables

docs/data/source/internal_data_formats/sql_schema.rst

@@ -374,6 +374,29 @@ A row in this table represents a student's enrollment for a particular course ru
   String indicating what kind of enrollment this was. The default is "honor" (honor certificate) and all enrollments prior to 2013-08-20 will be of that type. Other types being considered are "audit" and "verified_id".
 
 
+`user_id_map`
+==========================
+A row in this table maps a student's real user ID to an anonymous ID generated to obfuscate the student's identity.
+
+`id`
+----
+  Primary key.
+
+`user_id`
+---------
+  Student's ID in `auth_user.id`
+
+`anonymous_user_id`
+-----------
+ The user ID generated to obfuscate the student's identity.
+
+`course_id`
+-----------
+  The ID of the course run the student is enrolled in.
+
+
+
+
 *******************
 Courseware Progress
 *******************

docs/data/source/internal_data_formats/wiki_data.rst

+##############################
+Wiki Data
+##############################
+
+The following sections detail how edX stores Wiki data internally, and is useful for developers and researchers who are examining database exports. This information includes demographic information collected at signup, course enrollment, course progress, and certificate status.
+
+Conventions to keep in mind:
+
+* edX currently uses an external application called Django Wiki for Wiki functionality within courses. 
+
+
+
+****************
+Notification Type
+****************
+
+The `notifications` table stores . It has the following fields::
+
+  +------------------------------+--------------+------+-----+
+  | Field                        | Type         | Null | Key |
+  +------------------------------+--------------+------+-----+
+  | key                          | varchar(128) | NO   | PRI |
+  | label                        | varchar(128) | YES  |     |
+  | content_type                 | ForeignKey   | YES  |     | 
+  +------------------------------+--------------+------+-----+
+
+`key`
+----
+  Primary key . . .  
+
+`label`
+----------
+   The label for the notification . . .
+
+`content_type`
+------------
+    A foreign key . . .
+
+
+
+****************
+Settings
+****************
+
+The `Settings` table stores . It has the following fields::
+
+  +------------------------------+--------------+------+-----+
+  | Field                        | Type         | Null | Key |
+  +------------------------------+--------------+------+-----+
+  | user                         | ForeignKey   | NO   | PRI |
+  | interval                     | smallint(6)  | NO   |     |
+  +------------------------------+--------------+------+-----+
+
+`user`
+----
+  Primary key . . .  
+
+`interval`
+----------
+   The . . . 
+
+
+****************
+Subscriptions
+****************
+
+The `Subscriptions` table stores . It has the following fields::
+
+  +------------------------------+--------------+------+-----+
+  | Field                        | Type         | Null | Key |
+  +------------------------------+--------------+------+-----+
+  | settings                     | ForeignKey   | NO   | PRI |
+  | notification_type            | ForeignKey   | NO   |     |
+  | object_id                    | varchar(64)  | YES  |     |
+  | send_emails                  | boolean      | NO   |     |  
+  +------------------------------+--------------+------+-----+
+
+`settings`
+----
+  Primary key . . .  
+
+`notification type`
+----------
+   The . . . 
+   
+`object_id`
+----
+  Primary key . . .  
+
+`send_emails`
+----------
+   The . . . 
+   
+   
+****************
+Notification
+****************
+
+The `Notification` table stores . It has the following fields::
+
+  +------------------------------+--------------+------+-----+
+  | Field                        | Type         | Null | Key |
+  +------------------------------+--------------+------+-----+
+  | subscription                 | ForeignKey   | NO   | PRI |
+  | message                      | text         | NO   |     |
+  | url                          | URLField     | YES  |     |
+  | is_viewed                    | boolean      | NO   |     |  
+  | is_emailed                   | boolean      | NO   |     |  
+  | created                      | datetime     | NO   |     |  
+  +------------------------------+--------------+------+-----+
+
+`subscription`
+----
+  Primary key . . .  
+
+`message`
+----------
+   The . . . 
+   
+`url`
+----
+  Primary key . . .  
+
+`is_viewed`
+----------
+   The . . . 
+
+`is_emailed`
+----------
+   The . . . 
+
+`created`
+----------
+   The . . .