diff --git a/docs/en_us/course_authors/source/Images/HTML_Insert-Edit_Image.png b/docs/en_us/course_authors/source/Images/HTML_Insert-Edit_Image.png new file mode 100644 index 0000000000..654055cfe8 Binary files /dev/null and b/docs/en_us/course_authors/source/Images/HTML_Insert-Edit_Image.png differ diff --git a/docs/en_us/course_authors/source/Images/HTML_Link_File.png b/docs/en_us/course_authors/source/Images/HTML_Link_File.png index cebc1e51e5..bbe5da370b 100644 Binary files a/docs/en_us/course_authors/source/Images/HTML_Link_File.png and b/docs/en_us/course_authors/source/Images/HTML_Link_File.png differ diff --git a/docs/en_us/course_authors/source/Images/file_pagination.png b/docs/en_us/course_authors/source/Images/file_pagination.png index 26fecd5d9b..b8447be1a7 100644 Binary files a/docs/en_us/course_authors/source/Images/file_pagination.png and b/docs/en_us/course_authors/source/Images/file_pagination.png differ diff --git a/docs/en_us/course_authors/source/Images/file_sort.png b/docs/en_us/course_authors/source/Images/file_sort.png index d2f6f4aced..280804883d 100644 Binary files a/docs/en_us/course_authors/source/Images/file_sort.png and b/docs/en_us/course_authors/source/Images/file_sort.png differ diff --git a/docs/en_us/course_authors/source/Images/files_uploads_urls.png b/docs/en_us/course_authors/source/Images/files_uploads_urls.png new file mode 100644 index 0000000000..0fb1d0bc12 Binary files /dev/null and b/docs/en_us/course_authors/source/Images/files_uploads_urls.png differ diff --git a/docs/en_us/course_authors/source/Images/image_link.png b/docs/en_us/course_authors/source/Images/image_link.png new file mode 100644 index 0000000000..c0cccee52a Binary files /dev/null and b/docs/en_us/course_authors/source/Images/image_link.png differ diff --git a/docs/en_us/course_authors/source/change_log.rst b/docs/en_us/course_authors/source/change_log.rst index 0381aa31c3..c66f235ba5 100644 --- a/docs/en_us/course_authors/source/change_log.rst +++ b/docs/en_us/course_authors/source/change_log.rst @@ -10,6 +10,10 @@ Change Log * - Date - Change + * - 02/25/14 + - Updated :ref:`Add Files to a Course` section to include new External URL feature. + * - + - Updated :ref:`Add a Link to a File` and :ref:`Add an Image to an HTML Component` to specify you must use the file's Embed URL. * - 02/24/14 - Created new chapter, :ref:`Getting Started with edX`. * - diff --git a/docs/en_us/course_authors/source/create_html_component.rst b/docs/en_us/course_authors/source/create_html_component.rst index 0ea53d24fe..2b2d112315 100644 --- a/docs/en_us/course_authors/source/create_html_component.rst +++ b/docs/en_us/course_authors/source/create_html_component.rst @@ -194,12 +194,15 @@ Add a Link to a File You can add a link in an HTML component to any file you've uploaded for the course. For more information about uploading files, see :ref:`Add Files to a Course`. -#. On the **Files & Uploads** page, copy the URL of the file. +#. On the **Files & Uploads** page, copy the **Embed URL** of the file. - .. image:: Images/HTML_Link_File.gif - :alt: Image of Files and Uploads page with the URL field circled + .. image:: Images/HTML_Link_File.png + :alt: Image of Files and Uploads page with the URL field circled + + + .. note:: You must use the **Embed URL** to link to the file, not the **External URL**. -#. Select the text that you want to make into the link. +2. Select the text that you want to make into the link. #. Click the link icon in the toolbar. @@ -210,7 +213,7 @@ You can add a link in an HTML component to any file you've uploaded for the cour Make sure to include both forward slashes (/). .. image:: /Images/HTML_Insert-EditLink_File.gif - :alt: Image of the Inser/Edit Link dialog box with a link to a file + :alt: Image of the Insert/Edit Link dialog box with a link to a file #. If you want the link to open in a new window, click the drop-down arrow next to the **Target** field, and then select **Open Link in a New Window**. If not, you can leave the default value. @@ -219,6 +222,8 @@ You can add a link in an HTML component to any file you've uploaded for the cour #. Save the HTML component and test the link. +.. note:: When you add the file link in the format ``/static/FileName.type``, then later reopen the **Insert/Edit Link** dialog box, you see that the link changes to ``/c4x/edX/Course-name/asset/FileName.type``. This URL is OK and you do not need to change it. In the HTML view, the link appears as ``/static/FileName.type``. + .. _Add an Image to an HTML Component: @@ -232,19 +237,35 @@ You can add any image that you have uploaded for the course to an HTML component To add an image, you'll need the URL of the image that you uploaded to the course. You'll then create a link to the image in the HTML component. -#. On the **Files & Uploads** page, copy the URL of the image that you want. +#. On the **Files & Uploads** page, copy the **Embed URL** of the image that you want. -#. In the HTML component, switch to HTML view. + .. image:: Images/image_link.png + :alt: Image of the Files & Upload page with the Embed URL for the image circled -#. In the location where you want to add the image, enter an image tag that uses the following syntax. + .. note:: You must use the **Embed URL** to add the image, not the **External URL**. - ``

[description]

`` +2. Click the image icon in the toolbar. - For example, your image tag may resemble the following. +#. In the **Insert/Edit Image** dialog box, enter the following in the **Image URL** field. + + ``/static/FileName.type`` + + Make sure to include both forward slashes (/). + + .. image:: /Images/HTML_Insert-Edit_Image.png + :alt: Image of the Insert/Edit Image dialog box with a link to a file + +4. Enter alternative text in the Image Description field. See :ref:`Best Practices for Describing Images` for more information. + +#. As needed, in the **Insert/Edit Image** dialog box, customize the image alignment, dimensions, border, and vertical and horizontal space. + +#. Click **Insert**. + +#. Save the HTML component and test the image. + +.. note:: When you add the image URL in the format ``/static/FileName.type``, then later reopen the **Insert/Edit Image** dialog box, you see that the URL changes to ``/c4x/edX/Course-name/asset/FileName.type``. This URL is OK and you do not need to change it. In the HTML view, the URL appears as ``/static/FileName.type``. - ``

Map of the Great Lakes

`` -#. Switch back to Visual view to make sure your image appears. .. _Import LaTeX Code: 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 2fcd2c1d8e..5bd162d1b1 100644 --- a/docs/en_us/course_authors/source/create_new_course.rst +++ b/docs/en_us/course_authors/source/create_new_course.rst @@ -267,7 +267,7 @@ Set Course Requirements The estimated Effort per Week appears on the Course Summary page that students see. #. From the **Settings** menu, select **Schedule & Details**. -#. Scroll down to the **Requirments** section. +#. Scroll down to the **Requirements** section. #. In the **Hours of Effort per Week** field, enter the number of hours you expect students to work on this course each week. #. View your course summary page to test how the video will appear to students. @@ -278,24 +278,42 @@ Add Files to a Course ********************** You can add files that you want students to access in the course. After you add a file, -you must link to it from a course component, update, or in the course handouts. A file +you must link to it from a component, a course update, or in the course handouts. A file is only visible to students if you create a link to it. .. note:: Because the file name becomes part of the URL, students can see the name of the file when they open it. Avoid using file names such as AnswerKey.pdf. .. warning:: If you upload a file with the same name as an existing course file, the original file is overwritten without warning. -To add a file: +To add files: #. From the **Content** menu, select **Files & Uploads**. #. Click **Upload New File**. #. In the **Upload New File** dialog box, click **Choose File**. -#. In the **Open** dialog box, locate the file that you want, and then click **Open**. -#. To add another file, click **Load Another File**. +#. In the **Open** dialog box, select one more files that you want to upload, then click **Open**. +#. To add more file, click **Load Another File** and repeat the previous step. #. To close the dialog box, click the **x** in the top right corner. When you close the dialog box, the new files appear on the **Files & Uploads** page. +================== +File URLs +================== + +In the Files & Uploads page, each file has has an **Embed URL** and an **External URL**: + + +.. image:: Images/files_uploads_urls.png + :alt: Image of the Files and Uploads page, with Embed URL and External URL columns circled + +* You use the **Embed URL** to link to the file or image from a component, a course update, or a course handout. + +* You use the **External URL** to reference the file or image from outside of your course. The external URL does not work if you lock the file unless the person accessing the URL is enrolled in the course. + + .. warning:: You cannot use the External URL as the reference to a file or image from within your course. + +You can double click a value in the **Embed URL** or **External URL** column to select the value, then copy it. + ================== Sort Files @@ -332,14 +350,6 @@ You can navigate through the pages listing files in two ways: :alt: Pagination in the Files & Uploads page -================== -Get the File URL -================== -To link to the file from a course component, update, or the course handout list, you must get the file URL. - -In the **Files & Uploads** page, locate the file. The **URL** column shows the value to use in links. - -You can double click a value in the **URL** column to select the value, then copy it. ================== Lock a file @@ -347,6 +357,8 @@ Lock a file By default, anyone can access a file you upload if they know the URL, even people not enrolled in your class. To ensure that those not in your class cannot view the file, click the lock icon. + +.. note:: The external URL does not work if you lock the file. ================== Delete a file