Skip to content

Commit a8ac806

Browse files
committed
Updates on OLX custom pages and textbooks
1 parent 90d10d8 commit a8ac806

File tree

3 files changed

+76
-10
lines changed

3 files changed

+76
-10
lines changed

source/educators/olx/assets/assets.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ see :ref:`Course Asset Policy`.
1515

1616
.. seealso::
1717

18-
:ref:`Add Course Assets` (reference)
19-
2018
:ref:`Course Asset Policy` (reference)
2119

2220
:ref:`What is Open Learning XML?` (concept)
@@ -27,11 +25,14 @@ see :ref:`Course Asset Policy`.
2725

2826
:ref:`OLX Directory Structure` (reference)
2927

28+
:ref:`Add Course Assets` (via Studio) (reference)
29+
30+
3031

3132
**Maintenance chart**
3233

3334
+--------------+-------------------------------+----------------+--------------------------------+
3435
| Review Date | Working Group Reviewer | Release |Test situation |
3536
+--------------+-------------------------------+----------------+--------------------------------+
36-
| | | | |
37+
| 2025-11-06 | sarina | Ulmo | Pass |
3738
+--------------+-------------------------------+----------------+--------------------------------+

source/educators/olx/pages/pages.rst

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,53 @@
11
.. _Course Tabs:
22

3-
#################################
3+
########################################
44
Create Course Tabs in OLX
5-
#################################
5+
#########################################
66

77
.. tags:: educator, how-to
88

9-
You can add tabs, or pages, to your course. Each page appears in your course's
9+
You can add custom tabs, or pages, to your course. Each page appears in your course's
1010
navigation bar.
1111

1212
*********************************************
1313
Create the Tab File
1414
*********************************************
1515

1616
For each page you want your course to offer, you create an HTML file in the
17-
``tabs`` directory.
17+
``tabs`` directory. It can be as simple as this:
18+
19+
*Contents of* ``html_custom_tab.html``:
20+
21+
.. code-block:: html
22+
23+
<h1>Welcome to the OLX Example Course!</h1>
24+
25+
<p>This is a custom HTML page added as a custom tab to the course.</p>
1826

1927
You can add any text and HTML markup to the page. Pages can also be links or
2028
other types of content. One design pattern is to link a tab to a chromeless
2129
XBlock in the courseware, which allows for top-level interactive course
2230
content.
2331

32+
Ensure you place the custom tab properly in the ``policy.json`` file as detailed
33+
in :ref:`Course Policies`.
34+
35+
.. code-block:: json
36+
37+
{
38+
"course/2025": {
39+
...
40+
41+
{
42+
"course_staff_only": false,
43+
"name": "HTML Custom Tab",
44+
"type": "static_tab",
45+
"url_slug": "html_custom_tab"
46+
}
47+
}
48+
49+
50+
2451
.. seealso::
2552
2653
:ref:`What is Open Learning XML?` (concept)

source/educators/olx/policies/assets-policy.rst

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _Course Asset Policy:
22

3-
#####################################
4-
Create the Course Asset Policy in OLX
5-
#####################################
3+
#####################################################
4+
Create Course Assets and Textbooks in OLX
5+
#####################################################
66

77
.. tags:: educator, how-to
88

@@ -119,6 +119,44 @@ The following example shows the JSON policy for an image file and a PDF textbook
119119
},
120120
}
121121
122+
.. _Course Textbooks OLX:
123+
124+
*********************************************
125+
Create Textbooks
126+
*********************************************
127+
128+
As described above, first upload a textbook asset to
129+
your course in the ``static`` directory.
130+
131+
.. admonition:: Accessibility concerns
132+
133+
See the notes in the :ref:`Add Course Textbooks` article around accessibility - namely, that
134+
PDF textbooks are accessible whereas PNG/image files are not.
135+
136+
Then, as described above, link it in your ``assets.json`` file.
137+
138+
Finally, update the ``policy.json`` file (described in :ref:`Course Policies`)
139+
with information in the ``pdf_textbooks`` key:
140+
141+
.. code-block:: json
142+
143+
{
144+
"course/2025": {
145+
...
146+
"pdf_textbooks": [
147+
{
148+
"chapters": [
149+
{
150+
"title": "Full Book",
151+
"url": "/asset-v1:OpenedX+OLXex+2025+type@asset+block@Education_for_a_Digital_World.pdf"
152+
}
153+
],
154+
"id": "6Education_for_a_Digital_World",
155+
"tab_title": "Education for a Digital World: Advice, Guidelines and Effective Practice from Around Globe"
156+
}
157+
],
158+
...
159+
}
122160
123161
.. seealso::
124162

0 commit comments

Comments
 (0)