Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-platform
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-platform
Commits
e7e528e8
Commit
e7e528e8
authored
Feb 04, 2014
by
Calen Pennington
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add docs about testing xblocks in the LMS
[LMS-2059] [LMS-2060] [LMS-1216]
parent
0f8919a6
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
63 additions
and
3 deletions
+63
-3
docs/en_us/developers/source/xblocks.rst
+63
-3
No files found.
docs/en_us/developers/source/xblocks.rst
View file @
e7e528e8
...
@@ -4,6 +4,11 @@ Integrating XBlocks with edx-platform
...
@@ -4,6 +4,11 @@ Integrating XBlocks with edx-platform
The edX LMS and Studio have several features that are extensions of the core XBlock
The edX LMS and Studio have several features that are extensions of the core XBlock
libraries (https://xblock.readthedocs.org). These features are listed below.
libraries (https://xblock.readthedocs.org). These features are listed below.
* `LMS`_
* `Studio`_
* `Testing`_
* `Deploying your XBlock`_
LMS
LMS
---
---
...
@@ -67,11 +72,67 @@ Class Features
...
@@ -67,11 +72,67 @@ Class Features
* studio_view (XBlock.view): The view used to render an editor in Studio.
* studio_view (XBlock.view): The view used to render an editor in Studio.
* non_editable_metadata_fields (property): A list of
xblock.fields.Field
objects that
* non_editable_metadata_fields (property): A list of
:class:`~xblock.fields.Field`
objects that
shouldn't be displayed in the default editing view for Studio.
shouldn't be displayed in the default editing view for Studio.
Restrictions
Restrictions
~~~~~~~~~~~~
~~~~~~~~~~~~
* A block can't modify the value of any field with a scope where the ``user`` property
* A block can't modify the value of any field with a scope where the ``user`` property
is not ``UserScope.NONE``.
is not ``UserScope.NONE``.
\ No newline at end of file
Testing
-------
These instructions are temporary. Once XBlocks are fully supported by edx-platform
(both the LMS and Studio), installation and testing will be much more straightforward.
To enable an XBlock for testing in your devstack (https://github.com/edx/configuration/wiki/edX-Developer-Stack):
#. Install your block::
$ vagrant ssh
vagrant@precise64:~$ sudo -u edxapp /edx/bin/pip.edxapp install /path/to/your/block
#. Enable the block
#. In ``edx-platform/lms/envs/common.py``, uncomment::
# from xmodule.x_module import prefer_xmodules
# XBLOCK_SELECT_FUNCTION = prefer_xmodules
#. In ``edx-platform/cms/envs/common.py``, uncomment::
# from xmodule.x_module import prefer_xmodules
# XBLOCK_SELECT_FUNCTION = prefer_xmodules
#. In ``edx-platform/cms/envs/common.py``, change::
'ALLOW_ALL_ADVANCED_COMPONENTS': False,
to::
'ALLOW_ALL_ADVANCED_COMPONENTS': True,
#. Add the block to your courses' advanced settings in Studio
#. Log in to Studio, and open your course
#. Settings -> Advanced Settings
#. Change the value for the key ``"advanced_modules"`` to ``["your-block"]``
#. Add your block into your course
#. Edit a unit
#. Advanced -> your-block
Note the name ``your-block`` used in Studio must exactly match the key you used to add your
block to your ``setup.py`` ``entry_points`` list.
Deploying your XBlock
---------------------
To deploy your block to your own hosted version of edx-platform, you need to install it
into the virtualenv that the platform is running out of, and add to the list of ``ADVANCED_COMPONENT_TYPES``
in ``edx-platform/cms/djangoapps/contentstore/views/component.py``.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment