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/components/discussion-components.rst b/docs/en_us/olx/source/components/discussion-components.rst index a5fa05fbfd..183d1b2256 100644 --- a/docs/en_us/olx/source/components/discussion-components.rst +++ b/docs/en_us/olx/source/components/discussion-components.rst @@ -2,7 +2,7 @@ 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 +22,26 @@ 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 split this up, you can also create: + + + You create the file ``discussion/Introduce_Yourself.xml`` to define the inline diff --git a/docs/en_us/olx/source/components/html-components.rst b/docs/en_us/olx/source/components/html-components.rst index e562da30ed..5680cdd3bd 100644 --- a/docs/en_us/olx/source/components/html-components.rst +++ b/docs/en_us/olx/source/components/html-components.rst @@ -4,7 +4,12 @@ HTML Components ################################# -To add an HTML component to your course, you create both XML and HTML files. +To add an HTML component to your course, you can either in-line it in +the parent XML file, or split it up into either 1 or 2 additional +files. HTML configuration can be broken out into a .xml file in the +html directory. In addition, HTML content can be broken out into an +additional .html file in the same directory. Breaking out HTML content +is especially useful if you are embedding HTML which is not valid XML. See: @@ -15,11 +20,20 @@ See: * `Create the HTML File for an HTML Component`_ * `Example HTML Component Content`_ +************************************* +In-line HTML Example +************************************* + +.. 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 +Fully split HTML file example and explanation ********************************************* You create an XML file in the ``html`` directory for each HTML component in your course. @@ -43,7 +57,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 @@ -113,5 +127,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/components/index.rst b/docs/en_us/olx/source/components/index.rst index 3b6b2b966a..af139f2e10 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,14 @@ Use the chapters in this section to create course components. html-components discussion-components video-components + annotation + lti_component + open_response_assessment + word_cloud + conditional_module + full_screen_image + google_hangout + periodic_table + poll + vitalsource + zooming_image diff --git a/docs/en_us/olx/source/components/video-components.rst b/docs/en_us/olx/source/components/video-components.rst index 0d8c890095..d6e4c969f5 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,18 @@ 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. +If you wish to place a video in your course, add it to the course XML tree as: + +