diff --git a/docs/en_us/olx/source/advanced-components/index.rst b/docs/en_us/olx/source/advanced-components/index.rst deleted file mode 100644 index 5bc47d9717..0000000000 --- a/docs/en_us/olx/source/advanced-components/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _Advanced Components: - -################################# -Advanced Components -################################# - -Use the chapters in this section to create advanced course components. - -.. toctree:: - :maxdepth: 2 - - annotation - lti_component - open_response_assessment - word_cloud \ No newline at end of file diff --git a/docs/en_us/olx/source/change_log.rst b/docs/en_us/olx/source/change_log.rst index 26eb6885e5..2ba16e6677 100644 --- a/docs/en_us/olx/source/change_log.rst +++ b/docs/en_us/olx/source/change_log.rst @@ -13,6 +13,19 @@ October, 2014 * - Date - Change + * - 10/17/14 + - Provided more explanation to the introduction to :ref:`Problems and + Tools`. + * - + - Reorganized the :ref:`Problems and Tools` and :ref:`Course Components` + sections to properly categorize these types of objects. + * - + - Updated the :ref:`ODL Directory Structure` chapter to accurately reflect + how an OLX course is organized. + * - + - Updated the :ref:`HTML Components`, :ref:`Discussion Components`, and + :ref:`Video Components` chapters to explain the option to embed content + in container objects. * - 10/07/14 - Added pages for the :ref:`Graphical Slider Tool` and :ref:`Symbolic Response` to the :ref:`Problems and Tools` section. diff --git a/docs/en_us/olx/source/advanced-components/annotation.rst b/docs/en_us/olx/source/components/annotation.rst similarity index 100% rename from docs/en_us/olx/source/advanced-components/annotation.rst rename to docs/en_us/olx/source/components/annotation.rst diff --git a/docs/en_us/olx/source/problem-xml/conditional_module.rst b/docs/en_us/olx/source/components/conditional_module.rst similarity index 100% rename from docs/en_us/olx/source/problem-xml/conditional_module.rst rename to docs/en_us/olx/source/components/conditional_module.rst diff --git a/docs/en_us/olx/source/components/discussion-components.rst b/docs/en_us/olx/source/components/discussion-components.rst index a5fa05fbfd..9c4bcc7d3b 100644 --- a/docs/en_us/olx/source/components/discussion-components.rst +++ b/docs/en_us/olx/source/components/discussion-components.rst @@ -1,8 +1,10 @@ +.. _Discussion Components: + ################################# Discussion Components ################################# -You can add inline discussion components to a vertical, or unit, in your +You can add inline discussion components to any container in your course. See: @@ -22,13 +24,28 @@ discussion component in your course. The name of the XML file must match the value of the @url_name attribute of the ``discussion`` element in the vertical XML file. -For example, if the vertical XML file contains: +In-line, you can create, if the vertical XML file contains: .. code-block:: xml - - . . . + + + +If you prefer to create the discussion in its own file, you can create: + +.. code-block:: xml + + + You create the file ``discussion/Introduce_Yourself.xml`` to define the inline diff --git a/docs/en_us/olx/source/problem-xml/full_screen_image.rst b/docs/en_us/olx/source/components/full_screen_image.rst similarity index 100% rename from docs/en_us/olx/source/problem-xml/full_screen_image.rst rename to docs/en_us/olx/source/components/full_screen_image.rst diff --git a/docs/en_us/olx/source/problem-xml/google_hangout.rst b/docs/en_us/olx/source/components/google_hangout.rst similarity index 100% rename from docs/en_us/olx/source/problem-xml/google_hangout.rst rename to docs/en_us/olx/source/components/google_hangout.rst diff --git a/docs/en_us/olx/source/problem-xml/graphical_slider_tool.rst b/docs/en_us/olx/source/components/graphical_slider_tool.rst similarity index 100% rename from docs/en_us/olx/source/problem-xml/graphical_slider_tool.rst rename to docs/en_us/olx/source/components/graphical_slider_tool.rst diff --git a/docs/en_us/olx/source/problem-xml/gst_example_bars.xml b/docs/en_us/olx/source/components/gst_example_bars.xml similarity index 100% rename from docs/en_us/olx/source/problem-xml/gst_example_bars.xml rename to docs/en_us/olx/source/components/gst_example_bars.xml diff --git a/docs/en_us/olx/source/problem-xml/gst_example_dynamic_labels.xml b/docs/en_us/olx/source/components/gst_example_dynamic_labels.xml similarity index 100% rename from docs/en_us/olx/source/problem-xml/gst_example_dynamic_labels.xml rename to docs/en_us/olx/source/components/gst_example_dynamic_labels.xml diff --git a/docs/en_us/olx/source/problem-xml/gst_example_dynamic_range.xml b/docs/en_us/olx/source/components/gst_example_dynamic_range.xml similarity index 100% rename from docs/en_us/olx/source/problem-xml/gst_example_dynamic_range.xml rename to docs/en_us/olx/source/components/gst_example_dynamic_range.xml diff --git a/docs/en_us/olx/source/problem-xml/gst_example_html_element_output.xml b/docs/en_us/olx/source/components/gst_example_html_element_output.xml similarity index 100% rename from docs/en_us/olx/source/problem-xml/gst_example_html_element_output.xml rename to docs/en_us/olx/source/components/gst_example_html_element_output.xml diff --git a/docs/en_us/olx/source/problem-xml/gst_example_with_documentation.xml b/docs/en_us/olx/source/components/gst_example_with_documentation.xml similarity index 100% rename from docs/en_us/olx/source/problem-xml/gst_example_with_documentation.xml rename to docs/en_us/olx/source/components/gst_example_with_documentation.xml diff --git a/docs/en_us/olx/source/components/html-components.rst b/docs/en_us/olx/source/components/html-components.rst index e562da30ed..3a11ca3424 100644 --- a/docs/en_us/olx/source/components/html-components.rst +++ b/docs/en_us/olx/source/components/html-components.rst @@ -4,27 +4,50 @@ HTML Components ################################# -To add an HTML component to your course, you create both XML and HTML files. - See: -* `Create the XML File for an HTML Component`_ +* `Create the HTML Component`_ +* `Example of an HTML Component Embedded in a Vertical`_ +* `Example of Separate HTML Files`_ * `HTML Component XML File Elements`_ * `html Element Attributes`_ * `Example HTML Component XML File`_ -* `Create the HTML File for an HTML Component`_ * `Example HTML Component Content`_ + +********************************************* +Create the HTML Component +********************************************* + +To add an HTML component to your course, you can embed the XML for it in the +parent XML file, or split it up into either 1 or 2 additional files. You can +break up the HTML configuration into an .xml file in the html directory and an +additional .html file in the same directory. + +.. caution:: If you are including HTML that is not valid HTML, you must break out HTML content in a separate file. + + +***************************************************** +Example of an HTML Component Embedded in a Vertical +***************************************************** + +.. code-block:: xml -Both files, for each component, must be in the ``html`` directory. + + ... + The above has an error. x should be y in the second equation. + + ********************************************* -Create the XML File for an HTML Component +Example of Separate HTML Files ********************************************* -You create an XML file in the ``html`` directory for each HTML component in your course. +You create an XML file in the ``html`` directory for each HTML component in +your course. -The name of the XML file must match the value of the @url_name attribute of the ``html`` element in the vertical XML file. +The name of the XML file must match the value of the @url_name attribute of the +``html`` element in the vertical XML file. For example, if the vertical XML file contains: @@ -43,7 +66,7 @@ HTML Component XML File Elements The root element of the XML file for the HTML component is file is ``html``. -The ``html`` element contains not children. +In this case, the ``html`` element contains no children. ************************************* ``html`` Element Attributes @@ -73,22 +96,6 @@ The following example shows an XML file for an HTML component: -********************************************* -Create the HTML File for an HTML Component -********************************************* - -You create an HTML file in the ``html`` directory for each HTML component in your course. - -The name of the HTML file must match the value of the @file_name attribute of the ``html`` element in the component's XML file. - -For example, if the component's XML file contains: - -.. code-block:: xml - - - -You create the file ``html/Introduction.html`` to define the HTML component content. - ************************************* Example HTML Component Content ************************************* @@ -113,5 +120,3 @@ file for the edX Demo course:  They’re fun to play with.  Many courses will have tools and labs that you need to use to complete homework assignments.

- - diff --git a/docs/en_us/olx/source/problem-xml/iframe.rst b/docs/en_us/olx/source/components/iframe.rst similarity index 100% rename from docs/en_us/olx/source/problem-xml/iframe.rst rename to docs/en_us/olx/source/components/iframe.rst diff --git a/docs/en_us/olx/source/components/index.rst b/docs/en_us/olx/source/components/index.rst index 3b6b2b966a..f85c3b3e43 100644 --- a/docs/en_us/olx/source/components/index.rst +++ b/docs/en_us/olx/source/components/index.rst @@ -1,10 +1,10 @@ .. _Course Components: ################################# -Course Components +Course Components (XBlocks) ################################# -Use the chapters in this section to create course components. +Use the chapters in this section to create course components. .. toctree:: :maxdepth: 2 @@ -12,3 +12,15 @@ Use the chapters in this section to create course components. html-components discussion-components video-components + annotation + conditional_module + full_screen_image + google_hangout + graphical_slider_tool + iframe + lti_component + open_response_assessment + periodic_table + poll + word_cloud + zooming_image diff --git a/docs/en_us/olx/source/advanced-components/lti_component.rst b/docs/en_us/olx/source/components/lti_component.rst similarity index 100% rename from docs/en_us/olx/source/advanced-components/lti_component.rst rename to docs/en_us/olx/source/components/lti_component.rst diff --git a/docs/en_us/olx/source/advanced-components/open_response_assessment.rst b/docs/en_us/olx/source/components/open_response_assessment.rst similarity index 100% rename from docs/en_us/olx/source/advanced-components/open_response_assessment.rst rename to docs/en_us/olx/source/components/open_response_assessment.rst diff --git a/docs/en_us/olx/source/problem-xml/periodic_table.rst b/docs/en_us/olx/source/components/periodic_table.rst similarity index 100% rename from docs/en_us/olx/source/problem-xml/periodic_table.rst rename to docs/en_us/olx/source/components/periodic_table.rst diff --git a/docs/en_us/olx/source/problem-xml/poll.rst b/docs/en_us/olx/source/components/poll.rst similarity index 100% rename from docs/en_us/olx/source/problem-xml/poll.rst rename to docs/en_us/olx/source/components/poll.rst diff --git a/docs/en_us/olx/source/components/video-components.rst b/docs/en_us/olx/source/components/video-components.rst index 0d8c890095..d21a501c54 100644 --- a/docs/en_us/olx/source/components/video-components.rst +++ b/docs/en_us/olx/source/components/video-components.rst @@ -4,7 +4,9 @@ Video Components ################################# -You can add video components to a vertical, or unit, in your course. +You can add video components to any container in your course (such as +a vertical or sequential). Studio places all video components inside +verticals (which it calls units). See: @@ -17,8 +19,20 @@ See: Create the XML File for a Video Component ********************************************** -You create an XML file in the ``video`` directory for each video component in -your course. +To add a video component to your course, add it to the course XML tree as: + +.. code-block:: xml + +