-

${_("Welcome, {0}!".format(user.username))}

+

${_("Welcome, {0}!").format(user.username)}

%if len(courses) > 0:
@@ -290,10 +290,10 @@

${_('Need help?')}

- % if course_creator_status=='disallowed_for_this_site' and settings.MITX_FEATURES.get('STUDIO_REQUEST_EMAIL',''): + % if course_creator_status=='disallowed_for_this_site' and settings.FEATURES.get('STUDIO_REQUEST_EMAIL',''):

${_('Can I create courses in Studio?')}

-

${_('In order to create courses in Studio, you must')} ${_("contact edX staff to help you create a course")}

+

${_('In order to create courses in Studio, you must')} ${_("contact edX staff to help you create a course")}

% endif diff --git a/cms/templates/js/transcripts/messages/transcripts-uploaded.underscore b/cms/templates/js/transcripts/messages/transcripts-uploaded.underscore index c17d83f71078..9895d7fea8bb 100644 --- a/cms/templates/js/transcripts/messages/transcripts-uploaded.underscore +++ b/cms/templates/js/transcripts/messages/transcripts-uploaded.underscore @@ -10,7 +10,7 @@ - "> + "> <%= gettext("Download to Edit") %>
diff --git a/cms/templates/settings_advanced.html b/cms/templates/settings_advanced.html index 0735992a9a1a..566e281291bc 100644 --- a/cms/templates/settings_advanced.html +++ b/cms/templates/settings_advanced.html @@ -64,7 +64,7 @@

${_("Manual Policy Definition")}

- ${_("Manually Edit Course Policy Values (JSON Key / Value pairs)")} + ${_("Manually Edit Course Policy Values (JSON Key / Value pairs, use " not ')")}

${_("Warning: Do not modify these policies unless you are familiar with their purpose.")}

diff --git a/cms/templates/signup.html b/cms/templates/signup.html index d9a733ae4712..422c152b503f 100644 --- a/cms/templates/signup.html +++ b/cms/templates/signup.html @@ -60,7 +60,9 @@

${_("Sign Up for edX Studio")}

  • - +
    • diff --git a/cms/templates/textbooks.html b/cms/templates/textbooks.html index 238834da2287..a8d73319ecf1 100644 --- a/cms/templates/textbooks.html +++ b/cms/templates/textbooks.html @@ -23,14 +23,7 @@ CMS.URL.LMS_BASE = "${settings.LMS_BASE}" require(["js/models/section", "js/collections/textbook", "js/views/list_textbooks"], function(Section, TextbookCollection, ListTextbooksView) { - window.section = new Section({ - name: "${course.display_name_with_default | h}", - url_name: "${course.location.name | h}", - org: "${course.location.org | h}", - num: "${course.location.course | h}", - revision: "${course.location.revision | h}" - }); - var textbooks = new TextbookCollection(${json.dumps(course.pdf_textbooks)}, {parse: true}); + var textbooks = new TextbookCollection(${json.dumps(textbooks)}, {parse: true}); var tbView = new ListTextbooksView({collection: textbooks}); $(function() { diff --git a/cms/templates/widgets/footer.html b/cms/templates/widgets/footer.html index db7d5fb3f857..bd7d0c6073f1 100644 --- a/cms/templates/widgets/footer.html +++ b/cms/templates/widgets/footer.html @@ -1,25 +1,25 @@ <%! from django.core.urlresolvers import reverse %> <%! from django.utils.translation import ugettext as _ %> -
    +
    diff --git a/cms/templates/widgets/header.html b/cms/templates/widgets/header.html index b5d6c80d9cc3..ac9067e6be9e 100644 --- a/cms/templates/widgets/header.html +++ b/cms/templates/widgets/header.html @@ -13,13 +13,14 @@

    edX Studio

    % if context_course: - <% + <% ctx_loc = context_course.location location = loc_mapper().translate_location(ctx_loc.course_id, ctx_loc, False, True) index_url = location.url_reverse('course') checklists_url = location.url_reverse('checklists') course_team_url = location.url_reverse('course_team') assets_url = location.url_reverse('assets') + textbooks_url = location.url_reverse('textbooks') import_url = location.url_reverse('import') course_info_url = location.url_reverse('course_info') export_url = location.url_reverse('export') @@ -58,7 +59,7 @@

    ${_("Course" ${_("Files & Uploads")}
  • - ${_("Textbooks")} + ${_("Textbooks")}

    • diff --git a/cms/templates/widgets/qualaroo.html b/cms/templates/widgets/qualaroo.html index 04d10e08d166..1081c22c08dd 100644 --- a/cms/templates/widgets/qualaroo.html +++ b/cms/templates/widgets/qualaroo.html @@ -1,4 +1,4 @@ -% if settings.MITX_FEATURES.get('STUDIO_NPS_SURVEY'): +% if settings.FEATURES.get('STUDIO_NPS_SURVEY'): + + + + + + +.. notes:: When you create a JavaScript Input problem, keep the following in mind. + + - The webGLDemo.js file defines the three JavaScript functions (**WebGLDemo.getGrade**, + **WebGLDemo.getState**, and **WebGLDemo.setState**). + + - The JavaScript input problem code uses **WebGLDemo.getGrade**, **WebGLDemo.getState**, + and **WebGLDemo.setState** to grade, save, or restore a problem. These functions must + be global in scope. + + - **WebGLDemo.getState** and **WebGLDemo.setState** are optional. You only have to define + these functions if you want to conserve the state of the problem. + + - **Width** and **height** represent the dimensions of the IFrame that holds the + application. + + - When the problem opens, the cone and the cube are both blue, or "unselected." When + you click either shape once, the shape becomes yellow, or "selected." To unselect + the shape, click it again. Continue clicking the shape to select and unselect it. + + - The response is graded as correct if the cone is selected (yellow) when the user + clicks **Check**. + + - Clicking **Check** or **Save** registers the problem's current state. + +.. _Math Expression Input: + +Math Expression Input +--------------------- + +In math expression input problems, students enter text that represents +a mathematical expression, and Studio changes that text to a symbolic +expression that appears below the field where the student is typing. +Unlike numerical input problems, which only allow integers and a few +select constants, math expression problems can include more complicated +symbolic expressions. + +When you create a math expression input problem for your students in +Studio, you'll use `MathJax `_ to change your +plain text into "beautiful math." For more information about how to use +MathJax in Studio, see :ref:`MathJax in Studio`. + +.. image:: Images/MathExpressionInputExample.gif + +Create a Math Expression Input Problem +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To create a math expression input problem: + +#. In the unit where you want to create the problem, click **Problem** + under **Add New Component**, and then click the **Advanced** tab. +#. Click **Math Expression Input**. +#. In the component that appears, click **Edit**. +#. In the component editor, replace the example code with your own code. +#. Click **Save**. + +For more information, see `Symbolic Response +`_. + +.. _Problem Written in LaTeX: + +Problem Written in LaTeX +------------------------ + +If you have an problem that is already written in LaTeX, you can use +this problem type to easily convert your code into XML. After you paste +your code into the LaTeX editor, you'll only need to make a few minor +adjustments. Note that **this problem type is still a prototype and may +not be supported in the future**, so you should use it with caution. + +.. note:: If you want to use LaTeX to typeset mathematical expressions + in problems that you haven't yet written, use any of the other problem + templates together with `MathJax `_. For more + information about how to create mathematical expressions in Studio using + MathJax, see *A Brief Introduction to MathJax in Studio*. + +.. image:: Images/ProblemWrittenInLaTeX.gif + +Create a Problem Written in LaTeX +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To create a problem written in LaTeX: + +#. In the unit where you want to create the problem, click **Problem** + under **Add New Component**, and then click the **Advanced** tab. +#. Click **Problem Written in LaTeX**. +#. In the component editor that appears, click **Edit**. +#. In the lower left corner of the component editor, click **Launch + LaTeX Source Compiler**. +#. Replace the example code with your own code. +#. In the lower left corner of the LaTeX source compiler, click **Save & + Compile to edX XML**. + +.. _Problem with Adaptive Hint: + +Problem with Adaptive Hint +-------------------------- + +A problem with an adaptive hint evaluates a student's response, then +gives the student feedback or a hint based on that response so that the +student is more likely to answer correctly on the next attempt. These +problems can be text input or multiple choice problems. + +.. image:: Images/ProblemWithAdaptiveHintExample.gif + +Create a Problem with an Adaptive Hint +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To create a problem with an adaptive hint: + +#. In the unit where you want to create the problem, click **Problem** + under **Add New Component**, and then click the **Advanced** tab. +#. Click **Problem with Adaptive Hint**. +#. In the component that appears, click **Edit**. +#. In the component editor, replace the example code with your own code. +#. Click **Save**. + + diff --git a/docs/course_authors/source/appendices/a.rst b/docs/course_authors/source/appendices/a.rst index 18b4fb4e7fca..0c59dcba95aa 100644 --- a/docs/course_authors/source/appendices/a.rst +++ b/docs/course_authors/source/appendices/a.rst @@ -1,6 +1,8 @@ .. raw:: latex \newpage % + +.. _Appendix A: ======================================== APPENDIX A-Template For Course Overview diff --git a/docs/course_authors/source/appendices/b.rst b/docs/course_authors/source/appendices/b.rst index 7e7d98506726..560700e3e40b 100644 --- a/docs/course_authors/source/appendices/b.rst +++ b/docs/course_authors/source/appendices/b.rst @@ -2,6 +2,7 @@ \newpage % +.. _Appendix B: =========================================== APPENDIX B: Code for Dynamic HTML Schedule diff --git a/docs/course_authors/source/appendices/e.rst b/docs/course_authors/source/appendices/e.rst index 44c747b38c42..40865ce64f65 100644 --- a/docs/course_authors/source/appendices/e.rst +++ b/docs/course_authors/source/appendices/e.rst @@ -2,6 +2,8 @@ \newpage % +.. _Appendix E: + ========================== APPENDIX E: Problem Types @@ -527,6 +529,7 @@ We urge usage of . See the opening paragraphs of the .. image:: ../Images/numericalresponse5.png +.. _Math Expression Syntax: Math Expression Syntax ---------------------- @@ -580,7 +583,7 @@ default. These include: - ``pi`` - ``k``: the Boltzmann constant (~1.38e-23 in Joules/Kelvin) - ``c``: the speed of light in m/s (2.998e8) -- ``T``: typical room temperature (298.15 Kelvin, same as 25C/77F) +- ``T``: the positive difference between 0K and 0°C (285.15) - ``q``: the fundamental charge (~1.602e-19 Coloumbs) Operators and Functions @@ -786,6 +789,7 @@ XML Attribute Information \newpage % +.. _Custom Response: Custom Response =============== @@ -914,6 +918,8 @@ Sample Problem: \newpage % +.. _Chemical Equation Response: + Chemical Equation Response ========================== diff --git a/docs/course_authors/source/appendices/f.rst b/docs/course_authors/source/appendices/f.rst new file mode 100644 index 000000000000..94a9258656b9 --- /dev/null +++ b/docs/course_authors/source/appendices/f.rst @@ -0,0 +1,936 @@ +.. _Appendix F: + +Appendix F - Files for the Example JavaScript Input Problem +=========================================================== + +For the example JavaScript Input problem, you need the following four files: + +- :ref:`webGLDemo.html` +- :ref:`webGLDemo.css` +- :ref:`webGLDemo.js` +- :ref:`three.min.js` + +To create these files, copy the code for each file into a text editor, and +then save each file. Make sure to use the correct file name extension when you save +each file. + +.. _webGLDemo.html: + +webGLDemo.html +-------------- + +:: + + + + + + + + + + + + + +
    + + + + + + + + + +.. _webGLDemo.css: + +webGLDemo.css +------------- + +:: + + #container { + background-color: black; + width: 400px; + height:400px; + } + + +.. _webGLDemo.js: + +webGLDemo.js +------------ + +:: + + var WebGLDemo = (function() { + + var width = 400, height = 400; + var container, renderer, scene, camera, projector, + ambientlight, directionalLight, + cylinder, cube, nonSelectedMaterial, selectedMaterial; + // Revolutions per second + var angularSpeed = 0.5, lastTime = 0; + var state = { + 'selectedObjects': { + 'cylinder': false, + 'cube': false + } + }; + + function init() { + container = document.getElementById('container'); + // Renderer + renderer = new THREE.WebGLRenderer({antialias:true}); + renderer.setSize(width, height); + renderer.setClearColor(0x000000, 1); + container.appendChild(renderer.domElement); + + // Scene + scene = new THREE.Scene(); + + // Camera + camera = new THREE.PerspectiveCamera(45, width/height, 1, 1000); + camera.position.z = 700; + + unselectedMaterial = new THREE.MeshPhongMaterial({ + specular: '#a9fcff', + color: '#00abb1', + emissive: '#006063', + shininess: 100 + }); + + selectedMaterial = new THREE.MeshPhongMaterial({ + specular: '#a9fcff', + color: '#abb100', + emissive: '#606300', + shininess: 100 + }); + + // Cylinder: bottomRadius, topRadius, height, segmentsRadius, segmentsHeight + cylinder = new THREE.Mesh(new THREE.CylinderGeometry(0, 100, 150, 50, 50, false), unselectedMaterial); + cylinder.position.x = -125; + cylinder.overdraw = true; + scene.add(cylinder); + + // Cube + cube = new THREE.Mesh(new THREE.CubeGeometry(120, 120, 120), unselectedMaterial); + cube.position.x = 125; + cube.overdraw = true; + scene.add(cube); + + // Ambient light + ambientLight = new THREE.AmbientLight(0x222222); + scene.add(ambientLight); + + // Directional light + directionalLight = new THREE.DirectionalLight(0xffffff); + directionalLight.position.set(1, 1, 1).normalize(); + scene.add(directionalLight); + + // Used to select element with mouse click + projector = new THREE.Projector(); + + renderer.domElement.addEventListener('click', onMouseClick, false); + + // Start animation + animate(); + } + + // This function is executed on each animation frame + function animate() { + // Request new frame + requestAnimationFrame(animate); + render(); + } + + function render() { + // Update + var time = (new Date()).getTime(); + var timeDiff = time - lastTime; + var angleChange = angularSpeed * timeDiff * 2 * Math.PI / 1000; + cylinder.rotation.x += angleChange; + cylinder.rotation.z += angleChange; + cube.rotation.x += angleChange; + cube.rotation.y += angleChange; + lastTime = time; + + // Render + renderer.render(scene, camera); + } + + function onMouseClick(event) { + var vector = new THREE.Vector3((event.clientX / width) * 2 - 1, + -(event.clientY / height) * 2 + 1, 1); + projector.unprojectVector(vector, camera); + + var raycaster = new THREE.Raycaster(camera.position, vector.sub(camera.position).normalize()), + intersects = raycaster.intersectObjects(scene.children); + + if (intersects.length > 0) { + if (intersects[0].object === cylinder) { + state.selectedObjects.cylinder = !state.selectedObjects.cylinder; + } + else if (intersects[0].object === cube) { + state.selectedObjects.cube = !state.selectedObjects.cube; + } + + updateMaterials(); + } + } + + function updateMaterials() { + if (state.selectedObjects.cylinder) { + cylinder.material = selectedMaterial; + } + else { + cylinder.material = unselectedMaterial; + } + + if (state.selectedObjects.cube) { + cube.material = selectedMaterial; + } + else { + cube.material = unselectedMaterial; + } + } + + init(); + + function getState() { + return JSON.stringify(state); + } + + function setState(stateStr) { + state = JSON.parse(stateStr); + updateMaterials(); + } + + function getGrade() { + // The following return value may or may not be used to grade server-side. + // If getState and setState are used, then the Python grader also gets + // access to the return value of getState and can choose it instead to grade. + return JSON.stringify(state['selectedObjects']); + } + + return { + getState: getState, + setState: setState, + getGrade: getGrade + }; + }()); + + +.. _three.min.js: + +three.min.js +------------ + +:: + + // three.js - http://github.com/mrdoob/three.js + 'use strict';var THREE={REVISION:"62"};self.console=self.console||{info:function(){},log:function(){},debug:function(){},warn:function(){},error:function(){}};String.prototype.trim=String.prototype.trim||function(){return this.replace(/^\s+|\s+$/g,"")};THREE.extend=function(a,b){if(Object.keys)for(var c=Object.keys(b),d=0,e=c.length;d>16&255)/255;this.g=(a>>8&255)/255;this.b=(a&255)/255;return this},setRGB:function(a,b,c){this.r=a;this.g=b;this.b=c;return this},setHSL:function(a,b,c){if(0===b)this.r=this.g=this.b=c;else{var d=function(a,b,c){0>c&&(c+=1);1c?b:c<2/3?a+6*(b-a)*(2/3-c):a},b=0.5>=c?c*(1+b):c+b-c*b,c=2*c-b;this.r=d(c,b,a+1/3);this.g=d(c,b,a);this.b=d(c,b,a-1/3)}return this},setStyle:function(a){if(/^rgb\((\d+), ?(\d+), ?(\d+)\)$/i.test(a))return a=/^rgb\((\d+), ?(\d+), ?(\d+)\)$/i.exec(a),this.r=Math.min(255,parseInt(a[1],10))/255,this.g=Math.min(255,parseInt(a[2],10))/255,this.b=Math.min(255,parseInt(a[3],10))/255,this;if(/^rgb\((\d+)\%, ?(\d+)\%, ?(\d+)\%\)$/i.test(a))return a=/^rgb\((\d+)\%, ?(\d+)\%, ?(\d+)\%\)$/i.exec(a),this.r= + Math.min(100,parseInt(a[1],10))/100,this.g=Math.min(100,parseInt(a[2],10))/100,this.b=Math.min(100,parseInt(a[3],10))/100,this;if(/^\#([0-9a-f]{6})$/i.test(a))return a=/^\#([0-9a-f]{6})$/i.exec(a),this.setHex(parseInt(a[1],16)),this;if(/^\#([0-9a-f])([0-9a-f])([0-9a-f])$/i.test(a))return a=/^\#([0-9a-f])([0-9a-f])([0-9a-f])$/i.exec(a),this.setHex(parseInt(a[1]+a[1]+a[2]+a[2]+a[3]+a[3],16)),this;if(/^(\w+)$/i.test(a))return this.setHex(THREE.ColorKeywords[a]),this},copy:function(a){this.r=a.r;this.g= + a.g;this.b=a.b;return this},copyGammaToLinear:function(a){this.r=a.r*a.r;this.g=a.g*a.g;this.b=a.b*a.b;return this},copyLinearToGamma:function(a){this.r=Math.sqrt(a.r);this.g=Math.sqrt(a.g);this.b=Math.sqrt(a.b);return this},convertGammaToLinear:function(){var a=this.r,b=this.g,c=this.b;this.r=a*a;this.g=b*b;this.b=c*c;return this},convertLinearToGamma:function(){this.r=Math.sqrt(this.r);this.g=Math.sqrt(this.g);this.b=Math.sqrt(this.b);return this},getHex:function(){return 255*this.r<<16^255*this.g<< + 8^255*this.b<<0},getHexString:function(){return("000000"+this.getHex().toString(16)).slice(-6)},getHSL:function(){var a={h:0,s:0,l:0};return function(){var b=this.r,c=this.g,d=this.b,e=Math.max(b,c,d),f=Math.min(b,c,d),h,g=(f+e)/2;if(f===e)f=h=0;else{var i=e-f,f=0.5>=g?i/(e+f):i/(2-e-f);switch(e){case b:h=(c-d)/i+(cf&&c>b?(c=2*Math.sqrt(1+c-f-b),this._w=(i-h)/c,this._x=0.25*c, + this._y=(a+e)/c,this._z=(d+g)/c):f>b?(c=2*Math.sqrt(1+f-c-b),this._w=(d-g)/c,this._x=(a+e)/c,this._y=0.25*c,this._z=(h+i)/c):(c=2*Math.sqrt(1+b-c-f),this._w=(e-a)/c,this._x=(d+g)/c,this._y=(h+i)/c,this._z=0.25*c);this._updateEuler();return this},inverse:function(){this.conjugate().normalize();return this},conjugate:function(){this._x*=-1;this._y*=-1;this._z*=-1;this._updateEuler();return this},lengthSq:function(){return this._x*this._x+this._y*this._y+this._z*this._z+this._w*this._w},length:function(){return Math.sqrt(this._x* + this._x+this._y*this._y+this._z*this._z+this._w*this._w)},normalize:function(){var a=this.length();0===a?(this._z=this._y=this._x=0,this._w=1):(a=1/a,this._x*=a,this._y*=a,this._z*=a,this._w*=a);return this},multiply:function(a,b){return void 0!==b?(console.warn("DEPRECATED: Quaternion's .multiply() now only accepts one argument. Use .multiplyQuaternions( a, b ) instead."),this.multiplyQuaternions(a,b)):this.multiplyQuaternions(this,a)},multiplyQuaternions:function(a,b){var c=a._x,d=a._y,e=a._z,f= + a._w,h=b._x,g=b._y,i=b._z,k=b._w;this._x=c*k+f*h+d*i-e*g;this._y=d*k+f*g+e*h-c*i;this._z=e*k+f*i+c*g-d*h;this._w=f*k-c*h-d*g-e*i;this._updateEuler();return this},multiplyVector3:function(a){console.warn("DEPRECATED: Quaternion's .multiplyVector3() has been removed. Use is now vector.applyQuaternion( quaternion ) instead.");return a.applyQuaternion(this)},slerp:function(a,b){var c=this._x,d=this._y,e=this._z,f=this._w,h=f*a._w+c*a._x+d*a._y+e*a._z;0>h?(this._w=-a._w,this._x=-a._x,this._y=-a._y,this._z= + -a._z,h=-h):this.copy(a);if(1<=h)return this._w=f,this._x=c,this._y=d,this._z=e,this;var g=Math.acos(h),i=Math.sqrt(1-h*h);if(0.001>Math.abs(i))return this._w=0.5*(f+this._w),this._x=0.5*(c+this._x),this._y=0.5*(d+this._y),this._z=0.5*(e+this._z),this;h=Math.sin((1-b)*g)/i;g=Math.sin(b*g)/i;this._w=f*h+this._w*g;this._x=c*h+this._x*g;this._y=d*h+this._y*g;this._z=e*h+this._z*g;this._updateEuler();return this},equals:function(a){return a._x===this._x&&a._y===this._y&&a._z===this._z&&a._w===this._w}, + fromArray:function(a){this._x=a[0];this._y=a[1];this._z=a[2];this._w=a[3];this._updateEuler();return this},toArray:function(){return[this._x,this._y,this._z,this._w]},clone:function(){return new THREE.Quaternion(this._x,this._y,this._z,this._w)}};THREE.Quaternion.slerp=function(a,b,c,d){return c.copy(a).slerp(b,d)};THREE.Vector2=function(a,b){this.x=a||0;this.y=b||0}; + THREE.Vector2.prototype={constructor:THREE.Vector2,set:function(a,b){this.x=a;this.y=b;return this},setX:function(a){this.x=a;return this},setY:function(a){this.y=a;return this},setComponent:function(a,b){switch(a){case 0:this.x=b;break;case 1:this.y=b;break;default:throw Error("index is out of range: "+a);}},getComponent:function(a){switch(a){case 0:return this.x;case 1:return this.y;default:throw Error("index is out of range: "+a);}},copy:function(a){this.x=a.x;this.y=a.y;return this},add:function(a, + b){if(void 0!==b)return console.warn("DEPRECATED: Vector2's .add() now only accepts one argument. Use .addVectors( a, b ) instead."),this.addVectors(a,b);this.x+=a.x;this.y+=a.y;return this},addVectors:function(a,b){this.x=a.x+b.x;this.y=a.y+b.y;return this},addScalar:function(a){this.x+=a;this.y+=a;return this},sub:function(a,b){if(void 0!==b)return console.warn("DEPRECATED: Vector2's .sub() now only accepts one argument. Use .subVectors( a, b ) instead."),this.subVectors(a,b);this.x-=a.x;this.y-= + a.y;return this},subVectors:function(a,b){this.x=a.x-b.x;this.y=a.y-b.y;return this},multiplyScalar:function(a){this.x*=a;this.y*=a;return this},divideScalar:function(a){0!==a?(a=1/a,this.x*=a,this.y*=a):this.y=this.x=0;return this},min:function(a){this.x>a.x&&(this.x=a.x);this.y>a.y&&(this.y=a.y);return this},max:function(a){this.xb.x&&(this.x=b.x);this.yb.y&&(this.y=b.y); + return this},negate:function(){return this.multiplyScalar(-1)},dot:function(a){return this.x*a.x+this.y*a.y},lengthSq:function(){return this.x*this.x+this.y*this.y},length:function(){return Math.sqrt(this.x*this.x+this.y*this.y)},normalize:function(){return this.divideScalar(this.length())},distanceTo:function(a){return Math.sqrt(this.distanceToSquared(a))},distanceToSquared:function(a){var b=this.x-a.x,a=this.y-a.y;return b*b+a*a},setLength:function(a){var b=this.length();0!==b&&a!==b&&this.multiplyScalar(a/ + b);return this},lerp:function(a,b){this.x+=(a.x-this.x)*b;this.y+=(a.y-this.y)*b;return this},equals:function(a){return a.x===this.x&&a.y===this.y},fromArray:function(a){this.x=a[0];this.y=a[1];return this},toArray:function(){return[this.x,this.y]},clone:function(){return new THREE.Vector2(this.x,this.y)}};THREE.Vector3=function(a,b,c){this.x=a||0;this.y=b||0;this.z=c||0}; + THREE.Vector3.prototype={constructor:THREE.Vector3,set:function(a,b,c){this.x=a;this.y=b;this.z=c;return this},setX:function(a){this.x=a;return this},setY:function(a){this.y=a;return this},setZ:function(a){this.z=a;return this},setComponent:function(a,b){switch(a){case 0:this.x=b;break;case 1:this.y=b;break;case 2:this.z=b;break;default:throw Error("index is out of range: "+a);}},getComponent:function(a){switch(a){case 0:return this.x;case 1:return this.y;case 2:return this.z;default:throw Error("index is out of range: "+ + a);}},copy:function(a){this.x=a.x;this.y=a.y;this.z=a.z;return this},add:function(a,b){if(void 0!==b)return console.warn("DEPRECATED: Vector3's .add() now only accepts one argument. Use .addVectors( a, b ) instead."),this.addVectors(a,b);this.x+=a.x;this.y+=a.y;this.z+=a.z;return this},addScalar:function(a){this.x+=a;this.y+=a;this.z+=a;return this},addVectors:function(a,b){this.x=a.x+b.x;this.y=a.y+b.y;this.z=a.z+b.z;return this},sub:function(a,b){if(void 0!==b)return console.warn("DEPRECATED: Vector3's .sub() now only accepts one argument. Use .subVectors( a, b ) instead."), + this.subVectors(a,b);this.x-=a.x;this.y-=a.y;this.z-=a.z;return this},subVectors:function(a,b){this.x=a.x-b.x;this.y=a.y-b.y;this.z=a.z-b.z;return this},multiply:function(a,b){if(void 0!==b)return console.warn("DEPRECATED: Vector3's .multiply() now only accepts one argument. Use .multiplyVectors( a, b ) instead."),this.multiplyVectors(a,b);this.x*=a.x;this.y*=a.y;this.z*=a.z;return this},multiplyScalar:function(a){this.x*=a;this.y*=a;this.z*=a;return this},multiplyVectors:function(a,b){this.x=a.x* + b.x;this.y=a.y*b.y;this.z=a.z*b.z;return this},applyMatrix3:function(a){var b=this.x,c=this.y,d=this.z,a=a.elements;this.x=a[0]*b+a[3]*c+a[6]*d;this.y=a[1]*b+a[4]*c+a[7]*d;this.z=a[2]*b+a[5]*c+a[8]*d;return this},applyMatrix4:function(a){var b=this.x,c=this.y,d=this.z,a=a.elements;this.x=a[0]*b+a[4]*c+a[8]*d+a[12];this.y=a[1]*b+a[5]*c+a[9]*d+a[13];this.z=a[2]*b+a[6]*c+a[10]*d+a[14];return this},applyProjection:function(a){var b=this.x,c=this.y,d=this.z,a=a.elements,e=1/(a[3]*b+a[7]*c+a[11]*d+a[15]); + this.x=(a[0]*b+a[4]*c+a[8]*d+a[12])*e;this.y=(a[1]*b+a[5]*c+a[9]*d+a[13])*e;this.z=(a[2]*b+a[6]*c+a[10]*d+a[14])*e;return this},applyQuaternion:function(a){var b=this.x,c=this.y,d=this.z,e=a.x,f=a.y,h=a.z,a=a.w,g=a*b+f*d-h*c,i=a*c+h*b-e*d,k=a*d+e*c-f*b,b=-e*b-f*c-h*d;this.x=g*a+b*-e+i*-h-k*-f;this.y=i*a+b*-f+k*-e-g*-h;this.z=k*a+b*-h+g*-f-i*-e;return this},transformDirection:function(a){var b=this.x,c=this.y,d=this.z,a=a.elements;this.x=a[0]*b+a[4]*c+a[8]*d;this.y=a[1]*b+a[5]*c+a[9]*d;this.z=a[2]* + b+a[6]*c+a[10]*d;this.normalize();return this},divide:function(a){this.x/=a.x;this.y/=a.y;this.z/=a.z;return this},divideScalar:function(a){0!==a?(a=1/a,this.x*=a,this.y*=a,this.z*=a):this.z=this.y=this.x=0;return this},min:function(a){this.x>a.x&&(this.x=a.x);this.y>a.y&&(this.y=a.y);this.z>a.z&&(this.z=a.z);return this},max:function(a){this.xb.x&&(this.x=b.x);this.y< + a.y?this.y=a.y:this.y>b.y&&(this.y=b.y);this.zb.z&&(this.z=b.z);return this},negate:function(){return this.multiplyScalar(-1)},dot:function(a){return this.x*a.x+this.y*a.y+this.z*a.z},lengthSq:function(){return this.x*this.x+this.y*this.y+this.z*this.z},length:function(){return Math.sqrt(this.x*this.x+this.y*this.y+this.z*this.z)},lengthManhattan:function(){return Math.abs(this.x)+Math.abs(this.y)+Math.abs(this.z)},normalize:function(){return this.divideScalar(this.length())}, + setLength:function(a){var b=this.length();0!==b&&a!==b&&this.multiplyScalar(a/b);return this},lerp:function(a,b){this.x+=(a.x-this.x)*b;this.y+=(a.y-this.y)*b;this.z+=(a.z-this.z)*b;return this},cross:function(a,b){if(void 0!==b)return console.warn("DEPRECATED: Vector3's .cross() now only accepts one argument. Use .crossVectors( a, b ) instead."),this.crossVectors(a,b);var c=this.x,d=this.y,e=this.z;this.x=d*a.z-e*a.y;this.y=e*a.x-c*a.z;this.z=c*a.y-d*a.x;return this},crossVectors:function(a,b){var c= + a.x,d=a.y,e=a.z,f=b.x,h=b.y,g=b.z;this.x=d*g-e*h;this.y=e*f-c*g;this.z=c*h-d*f;return this},angleTo:function(a){a=this.dot(a)/(this.length()*a.length());return Math.acos(THREE.Math.clamp(a,-1,1))},distanceTo:function(a){return Math.sqrt(this.distanceToSquared(a))},distanceToSquared:function(a){var b=this.x-a.x,c=this.y-a.y,a=this.z-a.z;return b*b+c*c+a*a},setEulerFromRotationMatrix:function(){console.error("REMOVED: Vector3's setEulerFromRotationMatrix has been removed in favor of Euler.setFromRotationMatrix(), please update your code.")}, + setEulerFromQuaternion:function(){console.error("REMOVED: Vector3's setEulerFromQuaternion: has been removed in favor of Euler.setFromQuaternion(), please update your code.")},getPositionFromMatrix:function(a){this.x=a.elements[12];this.y=a.elements[13];this.z=a.elements[14];return this},getScaleFromMatrix:function(a){var b=this.set(a.elements[0],a.elements[1],a.elements[2]).length(),c=this.set(a.elements[4],a.elements[5],a.elements[6]).length(),a=this.set(a.elements[8],a.elements[9],a.elements[10]).length(); + this.x=b;this.y=c;this.z=a;return this},getColumnFromMatrix:function(a,b){var c=4*a,d=b.elements;this.x=d[c];this.y=d[c+1];this.z=d[c+2];return this},equals:function(a){return a.x===this.x&&a.y===this.y&&a.z===this.z},fromArray:function(a){this.x=a[0];this.y=a[1];this.z=a[2];return this},toArray:function(){return[this.x,this.y,this.z]},clone:function(){return new THREE.Vector3(this.x,this.y,this.z)}}; + THREE.extend(THREE.Vector3.prototype,{applyEuler:function(){var a=new THREE.Quaternion;return function(b){!1===b instanceof THREE.Euler&&console.error("ERROR: Vector3's .applyEuler() now expects a Euler rotation rather than a Vector3 and order. Please update your code.");this.applyQuaternion(a.setFromEuler(b));return this}}(),applyAxisAngle:function(){var a=new THREE.Quaternion;return function(b,c){this.applyQuaternion(a.setFromAxisAngle(b,c));return this}}(),projectOnVector:function(){var a=new THREE.Vector3; + return function(b){a.copy(b).normalize();b=this.dot(a);return this.copy(a).multiplyScalar(b)}}(),projectOnPlane:function(){var a=new THREE.Vector3;return function(b){a.copy(this).projectOnVector(b);return this.sub(a)}}(),reflect:function(){var a=new THREE.Vector3;return function(b){a.copy(this).projectOnVector(b).multiplyScalar(2);return this.subVectors(a,this)}}()});THREE.Vector4=function(a,b,c,d){this.x=a||0;this.y=b||0;this.z=c||0;this.w=void 0!==d?d:1}; + THREE.Vector4.prototype={constructor:THREE.Vector4,set:function(a,b,c,d){this.x=a;this.y=b;this.z=c;this.w=d;return this},setX:function(a){this.x=a;return this},setY:function(a){this.y=a;return this},setZ:function(a){this.z=a;return this},setW:function(a){this.w=a;return this},setComponent:function(a,b){switch(a){case 0:this.x=b;break;case 1:this.y=b;break;case 2:this.z=b;break;case 3:this.w=b;break;default:throw Error("index is out of range: "+a);}},getComponent:function(a){switch(a){case 0:return this.x; + case 1:return this.y;case 2:return this.z;case 3:return this.w;default:throw Error("index is out of range: "+a);}},copy:function(a){this.x=a.x;this.y=a.y;this.z=a.z;this.w=void 0!==a.w?a.w:1;return this},add:function(a,b){if(void 0!==b)return console.warn("DEPRECATED: Vector4's .add() now only accepts one argument. Use .addVectors( a, b ) instead."),this.addVectors(a,b);this.x+=a.x;this.y+=a.y;this.z+=a.z;this.w+=a.w;return this},addScalar:function(a){this.x+=a;this.y+=a;this.z+=a;this.w+=a;return this}, + addVectors:function(a,b){this.x=a.x+b.x;this.y=a.y+b.y;this.z=a.z+b.z;this.w=a.w+b.w;return this},sub:function(a,b){if(void 0!==b)return console.warn("DEPRECATED: Vector4's .sub() now only accepts one argument. Use .subVectors( a, b ) instead."),this.subVectors(a,b);this.x-=a.x;this.y-=a.y;this.z-=a.z;this.w-=a.w;return this},subVectors:function(a,b){this.x=a.x-b.x;this.y=a.y-b.y;this.z=a.z-b.z;this.w=a.w-b.w;return this},multiplyScalar:function(a){this.x*=a;this.y*=a;this.z*=a;this.w*=a;return this}, + applyMatrix4:function(a){var b=this.x,c=this.y,d=this.z,e=this.w,a=a.elements;this.x=a[0]*b+a[4]*c+a[8]*d+a[12]*e;this.y=a[1]*b+a[5]*c+a[9]*d+a[13]*e;this.z=a[2]*b+a[6]*c+a[10]*d+a[14]*e;this.w=a[3]*b+a[7]*c+a[11]*d+a[15]*e;return this},divideScalar:function(a){0!==a?(a=1/a,this.x*=a,this.y*=a,this.z*=a,this.w*=a):(this.z=this.y=this.x=0,this.w=1);return this},setAxisAngleFromQuaternion:function(a){this.w=2*Math.acos(a.w);var b=Math.sqrt(1-a.w*a.w);1E-4>b?(this.x=1,this.z=this.y=0):(this.x=a.x/b, + this.y=a.y/b,this.z=a.z/b);return this},setAxisAngleFromRotationMatrix:function(a){var b,c,d,a=a.elements,e=a[0];d=a[4];var f=a[8],h=a[1],g=a[5],i=a[9];c=a[2];b=a[6];var k=a[10];if(0.01>Math.abs(d-h)&&0.01>Math.abs(f-c)&&0.01>Math.abs(i-b)){if(0.1>Math.abs(d+h)&&0.1>Math.abs(f+c)&&0.1>Math.abs(i+b)&&0.1>Math.abs(e+g+k-3))return this.set(1,0,0,0),this;a=Math.PI;e=(e+1)/2;g=(g+1)/2;k=(k+1)/2;d=(d+h)/4;f=(f+c)/4;i=(i+b)/4;e>g&&e>k?0.01>e?(b=0,d=c=0.707106781):(b=Math.sqrt(e),c=d/b,d=f/b):g>k?0.01>g? + (b=0.707106781,c=0,d=0.707106781):(c=Math.sqrt(g),b=d/c,d=i/c):0.01>k?(c=b=0.707106781,d=0):(d=Math.sqrt(k),b=f/d,c=i/d);this.set(b,c,d,a);return this}a=Math.sqrt((b-i)*(b-i)+(f-c)*(f-c)+(h-d)*(h-d));0.001>Math.abs(a)&&(a=1);this.x=(b-i)/a;this.y=(f-c)/a;this.z=(h-d)/a;this.w=Math.acos((e+g+k-1)/2);return this},min:function(a){this.x>a.x&&(this.x=a.x);this.y>a.y&&(this.y=a.y);this.z>a.z&&(this.z=a.z);this.w>a.w&&(this.w=a.w);return this},max:function(a){this.xb.x&&(this.x=b.x);this.yb.y&&(this.y=b.y);this.zb.z&&(this.z=b.z);this.wb.w&&(this.w=b.w);return this},negate:function(){return this.multiplyScalar(-1)},dot:function(a){return this.x*a.x+this.y*a.y+this.z*a.z+this.w*a.w},lengthSq:function(){return this.x*this.x+this.y*this.y+this.z*this.z+this.w*this.w},length:function(){return Math.sqrt(this.x* + this.x+this.y*this.y+this.z*this.z+this.w*this.w)},lengthManhattan:function(){return Math.abs(this.x)+Math.abs(this.y)+Math.abs(this.z)+Math.abs(this.w)},normalize:function(){return this.divideScalar(this.length())},setLength:function(a){var b=this.length();0!==b&&a!==b&&this.multiplyScalar(a/b);return this},lerp:function(a,b){this.x+=(a.x-this.x)*b;this.y+=(a.y-this.y)*b;this.z+=(a.z-this.z)*b;this.w+=(a.w-this.w)*b;return this},equals:function(a){return a.x===this.x&&a.y===this.y&&a.z===this.z&& + a.w===this.w},fromArray:function(a){this.x=a[0];this.y=a[1];this.z=a[2];this.w=a[3];return this},toArray:function(){return[this.x,this.y,this.z,this.w]},clone:function(){return new THREE.Vector4(this.x,this.y,this.z,this.w)}};THREE.Euler=function(a,b,c,d){this._x=a||0;this._y=b||0;this._z=c||0;this._order=d||THREE.Euler.DefaultOrder};THREE.Euler.RotationOrders="XYZ YZX ZXY XZY YXZ ZYX".split(" ");THREE.Euler.DefaultOrder="XYZ"; + THREE.Euler.prototype={constructor:THREE.Euler,_x:0,_y:0,_z:0,_order:THREE.Euler.DefaultOrder,_quaternion:void 0,_updateQuaternion:function(){void 0!==this._quaternion&&this._quaternion.setFromEuler(this,!1)},get x(){return this._x},set x(a){this._x=a;this._updateQuaternion()},get y(){return this._y},set y(a){this._y=a;this._updateQuaternion()},get z(){return this._z},set z(a){this._z=a;this._updateQuaternion()},get order(){return this._order},set order(a){this._order=a;this._updateQuaternion()}, + set:function(a,b,c,d){this._x=a;this._y=b;this._z=c;this._order=d||this._order;this._updateQuaternion();return this},copy:function(a){this._x=a._x;this._y=a._y;this._z=a._z;this._order=a._order;this._updateQuaternion();return this},setFromRotationMatrix:function(a,b){function c(a){return Math.min(Math.max(a,-1),1)}var d=a.elements,e=d[0],f=d[4],h=d[8],g=d[1],i=d[5],k=d[9],m=d[2],l=d[6],d=d[10],b=b||this._order;"XYZ"===b?(this._y=Math.asin(c(h)),0.99999>Math.abs(h)?(this._x=Math.atan2(-k,d),this._z= + Math.atan2(-f,e)):(this._x=Math.atan2(l,i),this._z=0)):"YXZ"===b?(this._x=Math.asin(-c(k)),0.99999>Math.abs(k)?(this._y=Math.atan2(h,d),this._z=Math.atan2(g,i)):(this._y=Math.atan2(-m,e),this._z=0)):"ZXY"===b?(this._x=Math.asin(c(l)),0.99999>Math.abs(l)?(this._y=Math.atan2(-m,d),this._z=Math.atan2(-f,i)):(this._y=0,this._z=Math.atan2(g,e))):"ZYX"===b?(this._y=Math.asin(-c(m)),0.99999>Math.abs(m)?(this._x=Math.atan2(l,d),this._z=Math.atan2(g,e)):(this._x=0,this._z=Math.atan2(-f,i))):"YZX"===b?(this._z= + Math.asin(c(g)),0.99999>Math.abs(g)?(this._x=Math.atan2(-k,i),this._y=Math.atan2(-m,e)):(this._x=0,this._y=Math.atan2(h,d))):"XZY"===b?(this._z=Math.asin(-c(f)),0.99999>Math.abs(f)?(this._x=Math.atan2(l,i),this._y=Math.atan2(h,e)):(this._x=Math.atan2(-k,d),this._y=0)):console.warn("WARNING: Euler.setFromRotationMatrix() given unsupported order: "+b);this._order=b;this._updateQuaternion();return this},setFromQuaternion:function(a,b,c){function d(a){return Math.min(Math.max(a,-1),1)}var e=a.x*a.x,f= + a.y*a.y,h=a.z*a.z,g=a.w*a.w,b=b||this._order;"XYZ"===b?(this._x=Math.atan2(2*(a.x*a.w-a.y*a.z),g-e-f+h),this._y=Math.asin(d(2*(a.x*a.z+a.y*a.w))),this._z=Math.atan2(2*(a.z*a.w-a.x*a.y),g+e-f-h)):"YXZ"===b?(this._x=Math.asin(d(2*(a.x*a.w-a.y*a.z))),this._y=Math.atan2(2*(a.x*a.z+a.y*a.w),g-e-f+h),this._z=Math.atan2(2*(a.x*a.y+a.z*a.w),g-e+f-h)):"ZXY"===b?(this._x=Math.asin(d(2*(a.x*a.w+a.y*a.z))),this._y=Math.atan2(2*(a.y*a.w-a.z*a.x),g-e-f+h),this._z=Math.atan2(2*(a.z*a.w-a.x*a.y),g-e+f-h)):"ZYX"=== + b?(this._x=Math.atan2(2*(a.x*a.w+a.z*a.y),g-e-f+h),this._y=Math.asin(d(2*(a.y*a.w-a.x*a.z))),this._z=Math.atan2(2*(a.x*a.y+a.z*a.w),g+e-f-h)):"YZX"===b?(this._x=Math.atan2(2*(a.x*a.w-a.z*a.y),g-e+f-h),this._y=Math.atan2(2*(a.y*a.w-a.x*a.z),g+e-f-h),this._z=Math.asin(d(2*(a.x*a.y+a.z*a.w)))):"XZY"===b?(this._x=Math.atan2(2*(a.x*a.w+a.y*a.z),g-e+f-h),this._y=Math.atan2(2*(a.x*a.z+a.y*a.w),g+e-f-h),this._z=Math.asin(d(2*(a.z*a.w-a.x*a.y)))):console.warn("WARNING: Euler.setFromQuaternion() given unsupported order: "+ + b);this._order=b;!1!==c&&this._updateQuaternion();return this},reorder:function(){var a=new THREE.Quaternion;return function(b){a.setFromEuler(this);this.setFromQuaternion(a,b)}}(),fromArray:function(a){this._x=a[0];this._y=a[1];this._z=a[2];void 0!==a[3]&&(this._order=a[3]);this._updateQuaternion();return this},toArray:function(){return[this._x,this._y,this._z,this._order]},equals:function(a){return a._x===this._x&&a._y===this._y&&a._z===this._z&&a._order===this._order},clone:function(){return new THREE.Euler(this._x, + this._y,this._z,this._order)}};THREE.Line3=function(a,b){this.start=void 0!==a?a:new THREE.Vector3;this.end=void 0!==b?b:new THREE.Vector3}; + THREE.Line3.prototype={constructor:THREE.Line3,set:function(a,b){this.start.copy(a);this.end.copy(b);return this},copy:function(a){this.start.copy(a.start);this.end.copy(a.end);return this},center:function(a){return(a||new THREE.Vector3).addVectors(this.start,this.end).multiplyScalar(0.5)},delta:function(a){return(a||new THREE.Vector3).subVectors(this.end,this.start)},distanceSq:function(){return this.start.distanceToSquared(this.end)},distance:function(){return this.start.distanceTo(this.end)},at:function(a, + b){var c=b||new THREE.Vector3;return this.delta(c).multiplyScalar(a).add(this.start)},closestPointToPointParameter:function(){var a=new THREE.Vector3,b=new THREE.Vector3;return function(c,d){a.subVectors(c,this.start);b.subVectors(this.end,this.start);var e=b.dot(b),e=b.dot(a)/e;d&&(e=THREE.Math.clamp(e,0,1));return e}}(),closestPointToPoint:function(a,b,c){a=this.closestPointToPointParameter(a,b);c=c||new THREE.Vector3;return this.delta(c).multiplyScalar(a).add(this.start)},applyMatrix4:function(a){this.start.applyMatrix4(a); + this.end.applyMatrix4(a);return this},equals:function(a){return a.start.equals(this.start)&&a.end.equals(this.end)},clone:function(){return(new THREE.Line3).copy(this)}};THREE.Box2=function(a,b){this.min=void 0!==a?a:new THREE.Vector2(Infinity,Infinity);this.max=void 0!==b?b:new THREE.Vector2(-Infinity,-Infinity)}; + THREE.Box2.prototype={constructor:THREE.Box2,set:function(a,b){this.min.copy(a);this.max.copy(b);return this},setFromPoints:function(a){if(0this.max.x&&(this.max.x=b.x),b.ythis.max.y&&(this.max.y=b.y)}else this.makeEmpty();return this},setFromCenterAndSize:function(){var a=new THREE.Vector2;return function(b,c){var d=a.copy(c).multiplyScalar(0.5); + this.min.copy(b).sub(d);this.max.copy(b).add(d);return this}}(),copy:function(a){this.min.copy(a.min);this.max.copy(a.max);return this},makeEmpty:function(){this.min.x=this.min.y=Infinity;this.max.x=this.max.y=-Infinity;return this},empty:function(){return this.max.xthis.max.x||a.ythis.max.y?!1:!0},containsBox:function(a){return this.min.x<=a.min.x&&a.max.x<=this.max.x&&this.min.y<=a.min.y&&a.max.y<=this.max.y?!0:!1},getParameter:function(a){return new THREE.Vector2((a.x-this.min.x)/(this.max.x-this.min.x), + (a.y-this.min.y)/(this.max.y-this.min.y))},isIntersectionBox:function(a){return a.max.xthis.max.x||a.max.ythis.max.y?!1:!0},clampPoint:function(a,b){return(b||new THREE.Vector2).copy(a).clamp(this.min,this.max)},distanceToPoint:function(){var a=new THREE.Vector2;return function(b){return a.copy(b).clamp(this.min,this.max).sub(b).length()}}(),intersect:function(a){this.min.max(a.min);this.max.min(a.max);return this},union:function(a){this.min.min(a.min);this.max.max(a.max); + return this},translate:function(a){this.min.add(a);this.max.add(a);return this},equals:function(a){return a.min.equals(this.min)&&a.max.equals(this.max)},clone:function(){return(new THREE.Box2).copy(this)}};THREE.Box3=function(a,b){this.min=void 0!==a?a:new THREE.Vector3(Infinity,Infinity,Infinity);this.max=void 0!==b?b:new THREE.Vector3(-Infinity,-Infinity,-Infinity)}; + THREE.Box3.prototype={constructor:THREE.Box3,set:function(a,b){this.min.copy(a);this.max.copy(b);return this},addPoint:function(a){a.xthis.max.x&&(this.max.x=a.x);a.ythis.max.y&&(this.max.y=a.y);a.zthis.max.z&&(this.max.z=a.z)},setFromPoints:function(a){if(0this.max.x||a.ythis.max.y||a.zthis.max.z?!1:!0},containsBox:function(a){return this.min.x<=a.min.x&&a.max.x<=this.max.x&&this.min.y<=a.min.y&&a.max.y<=this.max.y&&this.min.z<=a.min.z&&a.max.z<=this.max.z?!0:!1},getParameter:function(a){return new THREE.Vector3((a.x-this.min.x)/(this.max.x-this.min.x), + (a.y-this.min.y)/(this.max.y-this.min.y),(a.z-this.min.z)/(this.max.z-this.min.z))},isIntersectionBox:function(a){return a.max.xthis.max.x||a.max.ythis.max.y||a.max.zthis.max.z?!1:!0},clampPoint:function(a,b){return(b||new THREE.Vector3).copy(a).clamp(this.min,this.max)},distanceToPoint:function(){var a=new THREE.Vector3;return function(b){return a.copy(b).clamp(this.min,this.max).sub(b).length()}}(),getBoundingSphere:function(){var a= + new THREE.Vector3;return function(b){b=b||new THREE.Sphere;b.center=this.center();b.radius=0.5*this.size(a).length();return b}}(),intersect:function(a){this.min.max(a.min);this.max.min(a.max);return this},union:function(a){this.min.min(a.min);this.max.max(a.max);return this},applyMatrix4:function(){var a=[new THREE.Vector3,new THREE.Vector3,new THREE.Vector3,new THREE.Vector3,new THREE.Vector3,new THREE.Vector3,new THREE.Vector3,new THREE.Vector3];return function(b){a[0].set(this.min.x,this.min.y, + this.min.z).applyMatrix4(b);a[1].set(this.min.x,this.min.y,this.max.z).applyMatrix4(b);a[2].set(this.min.x,this.max.y,this.min.z).applyMatrix4(b);a[3].set(this.min.x,this.max.y,this.max.z).applyMatrix4(b);a[4].set(this.max.x,this.min.y,this.min.z).applyMatrix4(b);a[5].set(this.max.x,this.min.y,this.max.z).applyMatrix4(b);a[6].set(this.max.x,this.max.y,this.min.z).applyMatrix4(b);a[7].set(this.max.x,this.max.y,this.max.z).applyMatrix4(b);this.makeEmpty();this.setFromPoints(a);return this}}(),translate:function(a){this.min.add(a); + this.max.add(a);return this},equals:function(a){return a.min.equals(this.min)&&a.max.equals(this.max)},clone:function(){return(new THREE.Box3).copy(this)}};THREE.Matrix3=function(a,b,c,d,e,f,h,g,i){this.elements=new Float32Array(9);this.set(void 0!==a?a:1,b||0,c||0,d||0,void 0!==e?e:1,f||0,h||0,g||0,void 0!==i?i:1)}; + THREE.Matrix3.prototype={constructor:THREE.Matrix3,set:function(a,b,c,d,e,f,h,g,i){var k=this.elements;k[0]=a;k[3]=b;k[6]=c;k[1]=d;k[4]=e;k[7]=f;k[2]=h;k[5]=g;k[8]=i;return this},identity:function(){this.set(1,0,0,0,1,0,0,0,1);return this},copy:function(a){a=a.elements;this.set(a[0],a[3],a[6],a[1],a[4],a[7],a[2],a[5],a[8]);return this},multiplyVector3:function(a){console.warn("DEPRECATED: Matrix3's .multiplyVector3() has been removed. Use vector.applyMatrix3( matrix ) instead.");return a.applyMatrix3(this)}, + multiplyVector3Array:function(){var a=new THREE.Vector3;return function(b){for(var c=0,d=b.length;cd?c.copy(this.origin):c.copy(this.direction).multiplyScalar(d).add(this.origin)},distanceToPoint:function(){var a=new THREE.Vector3;return function(b){var c=a.subVectors(b,this.origin).dot(this.direction);if(0>c)return this.origin.distanceTo(b);a.copy(this.direction).multiplyScalar(c).add(this.origin);return a.distanceTo(b)}}(),distanceSqToSegment:function(a,b,c,d){var e=a.clone().add(b).multiplyScalar(0.5),f=b.clone().sub(a).normalize(),h=0.5*a.distanceTo(b), + g=this.origin.clone().sub(e),a=-this.direction.dot(f),b=g.dot(this.direction),i=-g.dot(f),k=g.lengthSq(),m=Math.abs(1-a*a),l,p;0<=m?(g=a*i-b,l=a*b-i,p=h*m,0<=g?l>=-p?l<=p?(h=1/m,g*=h,l*=h,a=g*(g+a*l+2*b)+l*(a*g+l+2*i)+k):(l=h,g=Math.max(0,-(a*l+b)),a=-g*g+l*(l+2*i)+k):(l=-h,g=Math.max(0,-(a*l+b)),a=-g*g+l*(l+2*i)+k):l<=-p?(g=Math.max(0,-(-a*h+b)),l=0a.normal.dot(this.direction)*b?!0:!1},distanceToPlane:function(a){var b=a.normal.dot(this.direction);if(0==b)return 0==a.distanceToPoint(this.origin)? + 0:null;a=-(this.origin.dot(a.normal)+a.constant)/b;return 0<=a?a:null},intersectPlane:function(a,b){var c=this.distanceToPlane(a);return null===c?null:this.at(c,b)},isIntersectionBox:function(){var a=new THREE.Vector3;return function(b){return null!==this.intersectBox(b,a)}}(),intersectBox:function(a,b){var c,d,e,f,h;d=1/this.direction.x;f=1/this.direction.y;h=1/this.direction.z;var g=this.origin;0<=d?(c=(a.min.x-g.x)*d,d*=a.max.x-g.x):(c=(a.max.x-g.x)*d,d*=a.min.x-g.x);0<=f?(e=(a.min.y-g.y)*f,f*= + a.max.y-g.y):(e=(a.max.y-g.y)*f,f*=a.min.y-g.y);if(c>f||e>d)return null;if(e>c||c!==c)c=e;if(fh||e>d)return null;if(e>c||c!==c)c=e;if(hd?null:this.at(0<=c?c:d,b)},intersectTriangle:function(){var a=new THREE.Vector3,b=new THREE.Vector3,c=new THREE.Vector3,d=new THREE.Vector3;return function(e,f,h,g,i){b.subVectors(f,e);c.subVectors(h,e);d.crossVectors(b,c);f=this.direction.dot(d);if(0< + f){if(g)return null;g=1}else if(0>f)g=-1,f=-f;else return null;a.subVectors(this.origin,e);e=g*this.direction.dot(c.crossVectors(a,c));if(0>e)return null;h=g*this.direction.dot(b.cross(a));if(0>h||e+h>f)return null;e=-g*a.dot(d);return 0>e?null:this.at(e/f,i)}}(),applyMatrix4:function(a){this.direction.add(this.origin).applyMatrix4(a);this.origin.applyMatrix4(a);this.direction.sub(this.origin);this.direction.normalize();return this},equals:function(a){return a.origin.equals(this.origin)&&a.direction.equals(this.direction)}, + clone:function(){return(new THREE.Ray).copy(this)}};THREE.Sphere=function(a,b){this.center=void 0!==a?a:new THREE.Vector3;this.radius=void 0!==b?b:0}; + THREE.Sphere.prototype={constructor:THREE.Sphere,set:function(a,b){this.center.copy(a);this.radius=b;return this},setFromPoints:function(){var a=new THREE.Box3;return function(b,c){var d=this.center;void 0!==c?d.copy(c):a.setFromPoints(b).center(d);for(var e=0,f=0,h=b.length;f=this.radius},containsPoint:function(a){return a.distanceToSquared(this.center)<= + this.radius*this.radius},distanceToPoint:function(a){return a.distanceTo(this.center)-this.radius},intersectsSphere:function(a){var b=this.radius+a.radius;return a.center.distanceToSquared(this.center)<=b*b},clampPoint:function(a,b){var c=this.center.distanceToSquared(a),d=b||new THREE.Vector3;d.copy(a);c>this.radius*this.radius&&(d.sub(this.center).normalize(),d.multiplyScalar(this.radius).add(this.center));return d},getBoundingBox:function(a){a=a||new THREE.Box3;a.set(this.center,this.center);a.expandByScalar(this.radius); + return a},applyMatrix4:function(a){this.center.applyMatrix4(a);this.radius*=a.getMaxScaleOnAxis();return this},translate:function(a){this.center.add(a);return this},equals:function(a){return a.center.equals(this.center)&&a.radius===this.radius},clone:function(){return(new THREE.Sphere).copy(this)}};THREE.Frustum=function(a,b,c,d,e,f){this.planes=[void 0!==a?a:new THREE.Plane,void 0!==b?b:new THREE.Plane,void 0!==c?c:new THREE.Plane,void 0!==d?d:new THREE.Plane,void 0!==e?e:new THREE.Plane,void 0!==f?f:new THREE.Plane]}; + THREE.Frustum.prototype={constructor:THREE.Frustum,set:function(a,b,c,d,e,f){var h=this.planes;h[0].copy(a);h[1].copy(b);h[2].copy(c);h[3].copy(d);h[4].copy(e);h[5].copy(f);return this},copy:function(a){for(var b=this.planes,c=0;6>c;c++)b[c].copy(a.planes[c]);return this},setFromMatrix:function(a){var b=this.planes,c=a.elements,a=c[0],d=c[1],e=c[2],f=c[3],h=c[4],g=c[5],i=c[6],k=c[7],m=c[8],l=c[9],p=c[10],s=c[11],t=c[12],n=c[13],r=c[14],c=c[15];b[0].setComponents(f-a,k-h,s-m,c-t).normalize();b[1].setComponents(f+ + a,k+h,s+m,c+t).normalize();b[2].setComponents(f+d,k+g,s+l,c+n).normalize();b[3].setComponents(f-d,k-g,s-l,c-n).normalize();b[4].setComponents(f-e,k-i,s-p,c-r).normalize();b[5].setComponents(f+e,k+i,s+p,c+r).normalize();return this},intersectsObject:function(){var a=new THREE.Sphere;return function(b){var c=b.geometry;null===c.boundingSphere&&c.computeBoundingSphere();a.copy(c.boundingSphere);a.applyMatrix4(b.matrixWorld);return this.intersectsSphere(a)}}(),intersectsSphere:function(a){for(var b=this.planes, + c=a.center,a=-a.radius,d=0;6>d;d++)if(b[d].distanceToPoint(c)e;e++){var f=d[e];a.x=0h&&0>f)return!1}return!0}}(),containsPoint:function(a){for(var b= + this.planes,c=0;6>c;c++)if(0>b[c].distanceToPoint(a))return!1;return!0},clone:function(){return(new THREE.Frustum).copy(this)}};THREE.Plane=function(a,b){this.normal=void 0!==a?a:new THREE.Vector3(1,0,0);this.constant=void 0!==b?b:0}; + THREE.Plane.prototype={constructor:THREE.Plane,set:function(a,b){this.normal.copy(a);this.constant=b;return this},setComponents:function(a,b,c,d){this.normal.set(a,b,c);this.constant=d;return this},setFromNormalAndCoplanarPoint:function(a,b){this.normal.copy(a);this.constant=-b.dot(this.normal);return this},setFromCoplanarPoints:function(){var a=new THREE.Vector3,b=new THREE.Vector3;return function(c,d,e){d=a.subVectors(e,d).cross(b.subVectors(c,d)).normalize();this.setFromNormalAndCoplanarPoint(d, + c);return this}}(),copy:function(a){this.normal.copy(a.normal);this.constant=a.constant;return this},normalize:function(){var a=1/this.normal.length();this.normal.multiplyScalar(a);this.constant*=a;return this},negate:function(){this.constant*=-1;this.normal.negate();return this},distanceToPoint:function(a){return this.normal.dot(a)+this.constant},distanceToSphere:function(a){return this.distanceToPoint(a.center)-a.radius},projectPoint:function(a,b){return this.orthoPoint(a,b).sub(a).negate()},orthoPoint:function(a, + b){var c=this.distanceToPoint(a);return(b||new THREE.Vector3).copy(this.normal).multiplyScalar(c)},isIntersectionLine:function(a){var b=this.distanceToPoint(a.start),a=this.distanceToPoint(a.end);return 0>b&&0a&&0f||1e;e++)8==e||13==e||18==e||23==e?b[e]="-":14==e?b[e]="4":(2>=c&&(c=33554432+16777216*Math.random()|0),d=c&15,c>>=4,b[e]=a[19==e?d&3|8:d]);return b.join("")}}(),clamp:function(a,b,c){return ac?c:a},clampBottom:function(a,b){return a=c)return 1;a=(a-b)/(c-b);return a*a*(3-2*a)},smootherstep:function(a,b,c){if(a<=b)return 0;if(a>=c)return 1;a=(a-b)/(c-b);return a*a*a*(a*(6*a-15)+10)},random16:function(){return(65280*Math.random()+255*Math.random())/65535},randInt:function(a,b){return a+Math.floor(Math.random()*(b-a+1))},randFloat:function(a,b){return a+Math.random()*(b-a)},randFloatSpread:function(a){return a*(0.5-Math.random())},sign:function(a){return 0>a?-1:0this.points.length-2?this.points.length-1:f+1;c[3]=f>this.points.length-3?this.points.length-1: + f+2;k=this.points[c[0]];m=this.points[c[1]];l=this.points[c[2]];p=this.points[c[3]];g=h*h;i=h*g;d.x=b(k.x,m.x,l.x,p.x,h,g,i);d.y=b(k.y,m.y,l.y,p.y,h,g,i);d.z=b(k.z,m.z,l.z,p.z,h,g,i);return d};this.getControlPointsArray=function(){var a,b,c=this.points.length,d=[];for(a=0;a=b.x+b.y}}(); + THREE.Triangle.prototype={constructor:THREE.Triangle,set:function(a,b,c){this.a.copy(a);this.b.copy(b);this.c.copy(c);return this},setFromPointsAndIndices:function(a,b,c,d){this.a.copy(a[b]);this.b.copy(a[c]);this.c.copy(a[d]);return this},copy:function(a){this.a.copy(a.a);this.b.copy(a.b);this.c.copy(a.c);return this},area:function(){var a=new THREE.Vector3,b=new THREE.Vector3;return function(){a.subVectors(this.c,this.b);b.subVectors(this.a,this.b);return 0.5*a.cross(b).length()}}(),midpoint:function(a){return(a|| + new THREE.Vector3).addVectors(this.a,this.b).add(this.c).multiplyScalar(1/3)},normal:function(a){return THREE.Triangle.normal(this.a,this.b,this.c,a)},plane:function(a){return(a||new THREE.Plane).setFromCoplanarPoints(this.a,this.b,this.c)},barycoordFromPoint:function(a,b){return THREE.Triangle.barycoordFromPoint(a,this.a,this.b,this.c,b)},containsPoint:function(a){return THREE.Triangle.containsPoint(a,this.a,this.b,this.c)},equals:function(a){return a.a.equals(this.a)&&a.b.equals(this.b)&&a.c.equals(this.c)}, + clone:function(){return(new THREE.Triangle).copy(this)}};THREE.Vertex=function(a){console.warn("THREE.Vertex has been DEPRECATED. Use THREE.Vector3 instead.");return a};THREE.UV=function(a,b){console.warn("THREE.UV has been DEPRECATED. Use THREE.Vector2 instead.");return new THREE.Vector2(a,b)};THREE.Clock=function(a){this.autoStart=void 0!==a?a:!0;this.elapsedTime=this.oldTime=this.startTime=0;this.running=!1}; + THREE.Clock.prototype={constructor:THREE.Clock,start:function(){this.oldTime=this.startTime=void 0!==self.performance&&void 0!==self.performance.now?self.performance.now():Date.now();this.running=!0},stop:function(){this.getElapsedTime();this.running=!1},getElapsedTime:function(){this.getDelta();return this.elapsedTime},getDelta:function(){var a=0;this.autoStart&&!this.running&&this.start();if(this.running){var b=void 0!==self.performance&&void 0!==self.performance.now?self.performance.now():Date.now(), + a=0.001*(b-this.oldTime);this.oldTime=b;this.elapsedTime+=a}return a}};THREE.EventDispatcher=function(){}; + THREE.EventDispatcher.prototype={constructor:THREE.EventDispatcher,apply:function(a){a.addEventListener=THREE.EventDispatcher.prototype.addEventListener;a.hasEventListener=THREE.EventDispatcher.prototype.hasEventListener;a.removeEventListener=THREE.EventDispatcher.prototype.removeEventListener;a.dispatchEvent=THREE.EventDispatcher.prototype.dispatchEvent},addEventListener:function(a,b){void 0===this._listeners&&(this._listeners={});var c=this._listeners;void 0===c[a]&&(c[a]=[]);-1===c[a].indexOf(b)&& + c[a].push(b)},hasEventListener:function(a,b){if(void 0===this._listeners)return!1;var c=this._listeners;return void 0!==c[a]&&-1!==c[a].indexOf(b)?!0:!1},removeEventListener:function(a,b){if(void 0!==this._listeners){var c=this._listeners,d=c[a].indexOf(b);-1!==d&&c[a].splice(d,1)}},dispatchEvent:function(){var a=[];return function(b){if(void 0!==this._listeners){var c=this._listeners[b.type];if(void 0!==c){b.target=this;for(var d=c.length,e=0;ef.scale.x)return s;s.push({distance:t,point:f.position,face:null,object:f})}else if(f instanceof + a.LOD)d.getPositionFromMatrix(f.matrixWorld),t=m.ray.origin.distanceTo(d),k(f.getObjectForDistance(t),m,s);else if(f instanceof a.Mesh){var n=f.geometry;null===n.boundingSphere&&n.computeBoundingSphere();b.copy(n.boundingSphere);b.applyMatrix4(f.matrixWorld);if(!1===m.ray.isIntersectionSphere(b))return s;e.getInverse(f.matrixWorld);c.copy(m.ray).applyMatrix4(e);if(null!==n.boundingBox&&!1===c.isIntersectionBox(n.boundingBox))return s;if(n instanceof a.BufferGeometry){var r=f.material;if(void 0=== + r||!1===n.dynamic)return s;var q,u,w=m.precision;if(void 0!==n.attributes.index)for(var z=n.offsets,B=n.attributes.index.array,D=n.attributes.position.array,x=n.offsets.length,F=n.attributes.index.array.length/3,F=0;Fm.far)||s.push({distance:t,point:q,face:null,faceIndex:null,object:f}));else{D=n.attributes.position.array;F=n.attributes.position.array.length;for(n=0;nm.far)||s.push({distance:t,point:q,face:null,faceIndex:null,object:f}))}}else if(n instanceof a.Geometry){B=f.material instanceof a.MeshFaceMaterial;D=!0===B?f.material.materials:null;w=m.precision;z=n.vertices;x=0;for(F=n.faces.length;xm.far)||s.push({distance:t,point:q,face:A,faceIndex:x,object:f})))}}else if(f instanceof a.Line){w=m.linePrecision;r=w*w;n=f.geometry;null===n.boundingSphere&&n.computeBoundingSphere();b.copy(n.boundingSphere);b.applyMatrix4(f.matrixWorld);if(!1===m.ray.isIntersectionSphere(b))return s;e.getInverse(f.matrixWorld);c.copy(m.ray).applyMatrix4(e);if(n instanceof a.Geometry){z=n.vertices;w=z.length;q=new a.Vector3;u=new a.Vector3;F=f.type===a.LineStrip?1: + 2;for(n=0;nr||(t=c.origin.distanceTo(u),tm.far||s.push({distance:t,point:q.clone().applyMatrix4(f.matrixWorld),face:null,faceIndex:null,object:f}))}}},m=function(a,b,c){for(var a=a.getDescendants(),d=0,e=a.length;de&&0>f||0>h&&0>g)return!1;0>e?c=Math.max(c,e/(e-f)):0>f&&(d=Math.min(d,e/(e-f)));0>h?c=Math.max(c,h/(h-g)):0>g&&(d=Math.min(d,h/(h-g)));if(dg.positionScreen.x||1g.positionScreen.y||1g.positionScreen.z||1< + g.positionScreen.z)}ea=0;for(F=ta.length;ea(ia.positionScreen.x-V.positionScreen.x)*(P.positionScreen.y-V.positionScreen.y)-(ia.positionScreen.y-V.positionScreen.y)*(P.positionScreen.x-V.positionScreen.x),Z===THREE.DoubleSide|| + da===(Z===THREE.FrontSide)){if(p===t){var Da=new THREE.RenderableFace3;s.push(Da);t++;p++;l=Da}else l=s[p++];l.id=U.id;l.v1.copy(V);l.v2.copy(P);l.v3.copy(ia);l.normalModel.copy(M.normal);!1===da&&(Z===THREE.BackSide||Z===THREE.DoubleSide)&&l.normalModel.negate();l.normalModel.applyMatrix3(R).normalize();l.normalModelView.copy(l.normalModel).applyMatrix3(J);l.centroidModel.copy(M.centroid).applyMatrix4(v);ia=M.vertexNormals;V=0;for(P=Math.min(ia.length,3);VA.z&&(z===D?(ta=new THREE.RenderableSprite,B.push(ta),D++,z++,w=ta):w=B[z++],w.id=U.id,w.x=A.x*fa,w.y=A.y*fa,w.z=A.z,w.object=U,w.rotation=U.rotation,w.scale.x=U.scale.x*Math.abs(w.x-(A.x+f.projectionMatrix.elements[0])/(A.w+f.projectionMatrix.elements[12])), + w.scale.y=U.scale.y*Math.abs(w.y-(A.y+f.projectionMatrix.elements[5])/(A.w+f.projectionMatrix.elements[13])),w.material=U.material,x.elements.push(w)));!0===m&&x.elements.sort(b);return x}};THREE.Face3=function(a,b,c,d,e,f){this.a=a;this.b=b;this.c=c;this.normal=d instanceof THREE.Vector3?d:new THREE.Vector3;this.vertexNormals=d instanceof Array?d:[];this.color=e instanceof THREE.Color?e:new THREE.Color;this.vertexColors=e instanceof Array?e:[];this.vertexTangents=[];this.materialIndex=void 0!==f?f:0;this.centroid=new THREE.Vector3}; + THREE.Face3.prototype={constructor:THREE.Face3,clone:function(){var a=new THREE.Face3(this.a,this.b,this.c);a.normal.copy(this.normal);a.color.copy(this.color);a.centroid.copy(this.centroid);a.materialIndex=this.materialIndex;var b,c;b=0;for(c=this.vertexNormals.length;bd?-1:1,e.vertexTangents[c]=new THREE.Vector4(z.x,z.y,z.z,d)}this.hasTangents=!0},computeLineDistances:function(){for(var a=0,b=this.vertices,c=0,d=b.length;cd;d++)if(e[d]==e[(d+1)%3]){a.push(f);break}}for(f=a.length-1;0<=f;f--){e=a[f];this.faces.splice(e,1);c=0;for(h=this.faceVertexUvs.length;cb.max.x&&(b.max.x=c),db.max.y&&(b.max.y=d),eb.max.z&&(b.max.z=e)}if(void 0===a||0===a.length)this.boundingBox.min.set(0,0,0),this.boundingBox.max.set(0,0,0)},computeBoundingSphere:function(){var a= + new THREE.Box3,b=new THREE.Vector3;return function(){null===this.boundingSphere&&(this.boundingSphere=new THREE.Sphere);var c=this.attributes.position.array;if(c){for(var d=this.boundingSphere.center,e=0,f=c.length;eQ?-1:1;h[4*a]=J.x;h[4*a+1]=J.y;h[4*a+2]=J.z;h[4*a+3]=N}if(void 0===this.attributes.index||void 0===this.attributes.position||void 0===this.attributes.normal||void 0===this.attributes.uv)console.warn("Missing required attributes (index, position, normal or uv) in BufferGeometry.computeTangents()");else{var b=this.attributes.index.array,c=this.attributes.position.array,d=this.attributes.normal.array,e=this.attributes.uv.array,f=c.length/3;void 0===this.attributes.tangent&& + (this.attributes.tangent={itemSize:4,array:new Float32Array(4*f)});for(var h=this.attributes.tangent.array,g=[],i=[],k=0;ka.length?".":a.join("/"))+"/"},initMaterials:function(a,b){for(var c=[],d=0;da.opacity)i.transparent=a.transparent;void 0!==a.depthTest&&(i.depthTest=a.depthTest);void 0!==a.depthWrite&&(i.depthWrite=a.depthWrite);void 0!==a.visible&&(i.visible=a.visible);void 0!==a.flipSided&&(i.side=THREE.BackSide); + void 0!==a.doubleSided&&(i.side=THREE.DoubleSide);void 0!==a.wireframe&&(i.wireframe=a.wireframe);void 0!==a.vertexColors&&("face"===a.vertexColors?i.vertexColors=THREE.FaceColors:a.vertexColors&&(i.vertexColors=THREE.VertexColors));a.colorDiffuse?i.color=f(a.colorDiffuse):a.DbgColor&&(i.color=a.DbgColor);a.colorSpecular&&(i.specular=f(a.colorSpecular));a.colorAmbient&&(i.ambient=f(a.colorAmbient));a.transparency&&(i.opacity=a.transparency);a.specularCoef&&(i.shininess=a.specularCoef);a.mapDiffuse&& + b&&e(i,"map",a.mapDiffuse,a.mapDiffuseRepeat,a.mapDiffuseOffset,a.mapDiffuseWrap,a.mapDiffuseAnisotropy);a.mapLight&&b&&e(i,"lightMap",a.mapLight,a.mapLightRepeat,a.mapLightOffset,a.mapLightWrap,a.mapLightAnisotropy);a.mapBump&&b&&e(i,"bumpMap",a.mapBump,a.mapBumpRepeat,a.mapBumpOffset,a.mapBumpWrap,a.mapBumpAnisotropy);a.mapNormal&&b&&e(i,"normalMap",a.mapNormal,a.mapNormalRepeat,a.mapNormalOffset,a.mapNormalWrap,a.mapNormalAnisotropy);a.mapSpecular&&b&&e(i,"specularMap",a.mapSpecular,a.mapSpecularRepeat, + a.mapSpecularOffset,a.mapSpecularWrap,a.mapSpecularAnisotropy);a.mapBumpScale&&(i.bumpScale=a.mapBumpScale);a.mapNormal?(g=THREE.ShaderLib.normalmap,k=THREE.UniformsUtils.clone(g.uniforms),k.tNormal.value=i.normalMap,a.mapNormalFactor&&k.uNormalScale.value.set(a.mapNormalFactor,a.mapNormalFactor),i.map&&(k.tDiffuse.value=i.map,k.enableDiffuse.value=!0),i.specularMap&&(k.tSpecular.value=i.specularMap,k.enableSpecular.value=!0),i.lightMap&&(k.tAO.value=i.lightMap,k.enableAO.value=!0),k.uDiffuseColor.value.setHex(i.color), + k.uSpecularColor.value.setHex(i.specular),k.uAmbientColor.value.setHex(i.ambient),k.uShininess.value=i.shininess,void 0!==i.opacity&&(k.uOpacity.value=i.opacity),g=new THREE.ShaderMaterial({fragmentShader:g.fragmentShader,vertexShader:g.vertexShader,uniforms:k,lights:!0,fog:!0}),i.transparent&&(g.transparent=!0)):g=new THREE[g](i);void 0!==a.DbgName&&(g.name=a.DbgName);return g}};THREE.XHRLoader=function(a){this.manager=void 0!==a?a:THREE.DefaultLoadingManager}; + THREE.XHRLoader.prototype={constructor:THREE.XHRLoader,load:function(a,b,c,d){var e=this,f=new XMLHttpRequest;void 0!==b&&f.addEventListener("load",function(c){b(c.target.responseText);e.manager.itemEnd(a)},!1);void 0!==c&&f.addEventListener("progress",function(a){c(a)},!1);void 0!==d&&f.addEventListener("error",function(a){d(a)},!1);void 0!==this.crossOrigin&&(f.crossOrigin=this.crossOrigin);f.open("GET",a,!0);f.send(null);e.manager.itemStart(a)},setCrossOrigin:function(a){this.crossOrigin=a}};THREE.ImageLoader=function(a){this.manager=void 0!==a?a:THREE.DefaultLoadingManager}; + THREE.ImageLoader.prototype={constructor:THREE.ImageLoader,load:function(a,b,c,d){var e=this,f=document.createElement("img");void 0!==b&&f.addEventListener("load",function(){e.manager.itemEnd(a);b(this)},!1);void 0!==c&&f.addEventListener("progress",function(a){c(a)},!1);void 0!==d&&f.addEventListener("error",function(a){d(a)},!1);void 0!==this.crossOrigin&&(f.crossOrigin=this.crossOrigin);f.src=a;e.manager.itemStart(a);return f},setCrossOrigin:function(a){this.crossOrigin=a}};THREE.JSONLoader=function(a){THREE.Loader.call(this,a);this.withCredentials=!1};THREE.JSONLoader.prototype=Object.create(THREE.Loader.prototype);THREE.JSONLoader.prototype.load=function(a,b,c){c=c&&"string"===typeof c?c:this.extractUrlBase(a);this.onLoadStart();this.loadAjaxJSON(this,a,b,c)}; + THREE.JSONLoader.prototype.loadAjaxJSON=function(a,b,c,d,e){var f=new XMLHttpRequest,h=0;f.onreadystatechange=function(){if(f.readyState===f.DONE)if(200===f.status||0===f.status){if(f.responseText){var g=JSON.parse(f.responseText),g=a.parse(g,d);c(g.geometry,g.materials)}else console.warn("THREE.JSONLoader: ["+b+"] seems to be unreachable or file there is empty");a.onLoadComplete()}else console.error("THREE.JSONLoader: Couldn't load ["+b+"] ["+f.status+"]");else f.readyState===f.LOADING?e&&(0===h&& + (h=f.getResponseHeader("Content-Length")),e({total:h,loaded:f.responseText.length})):f.readyState===f.HEADERS_RECEIVED&&void 0!==e&&(h=f.getResponseHeader("Content-Length"))};f.open("GET",b,!0);f.withCredentials=this.withCredentials;f.send(null)}; + THREE.JSONLoader.prototype.parse=function(a,b){var c=new THREE.Geometry,d=void 0!==a.scale?1/a.scale:1,e,f,h,g,i,k,m,l,p,s,t,n,r,q,u=a.faces;p=a.vertices;var w=a.normals,z=a.colors,B=0;if(void 0!==a.uvs){for(e=0;ef;f++)l=u[g++],q=r[2*l],l=r[2*l+1],q=new THREE.Vector2(q,l),2!==f&&c.faceVertexUvs[e][h].push(q),0!==f&&c.faceVertexUvs[e][h+1].push(q)}m&&(m=3*u[g++],s.normal.set(w[m++],w[m++],w[m]),n.normal.copy(s.normal));if(t)for(e=0;4>e;e++)m=3*u[g++],t=new THREE.Vector3(w[m++], + w[m++],w[m]),2!==e&&s.vertexNormals.push(t),0!==e&&n.vertexNormals.push(t);k&&(k=u[g++],k=z[k],s.color.setHex(k),n.color.setHex(k));if(p)for(e=0;4>e;e++)k=u[g++],k=z[k],2!==e&&s.vertexColors.push(new THREE.Color(k)),0!==e&&n.vertexColors.push(new THREE.Color(k));c.faces.push(s);c.faces.push(n)}else{s=new THREE.Face3;s.a=u[g++];s.b=u[g++];s.c=u[g++];h&&(h=u[g++],s.materialIndex=h);h=c.faces.length;if(e)for(e=0;ef;f++)l=u[g++],q=r[2*l],l=r[2*l+1], + q=new THREE.Vector2(q,l),c.faceVertexUvs[e][h].push(q)}m&&(m=3*u[g++],s.normal.set(w[m++],w[m++],w[m]));if(t)for(e=0;3>e;e++)m=3*u[g++],t=new THREE.Vector3(w[m++],w[m++],w[m]),s.vertexNormals.push(t);k&&(k=u[g++],s.color.setHex(z[k]));if(p)for(e=0;3>e;e++)k=u[g++],s.vertexColors.push(new THREE.Color(z[k]));c.faces.push(s)}if(a.skinWeights){g=0;for(i=a.skinWeights.length;gG.parameters.opacity&&(G.parameters.transparent=!0);G.parameters.normalMap?(E=THREE.ShaderLib.normalmap,y=THREE.UniformsUtils.clone(E.uniforms), + q=G.parameters.color,v=G.parameters.specular,r=G.parameters.ambient,I=G.parameters.shininess,y.tNormal.value=A.textures[G.parameters.normalMap],G.parameters.normalScale&&y.uNormalScale.value.set(G.parameters.normalScale[0],G.parameters.normalScale[1]),G.parameters.map&&(y.tDiffuse.value=G.parameters.map,y.enableDiffuse.value=!0),G.parameters.envMap&&(y.tCube.value=G.parameters.envMap,y.enableReflection.value=!0,y.uReflectivity.value=G.parameters.reflectivity),G.parameters.lightMap&&(y.tAO.value=G.parameters.lightMap, + y.enableAO.value=!0),G.parameters.specularMap&&(y.tSpecular.value=A.textures[G.parameters.specularMap],y.enableSpecular.value=!0),G.parameters.displacementMap&&(y.tDisplacement.value=A.textures[G.parameters.displacementMap],y.enableDisplacement.value=!0,y.uDisplacementBias.value=G.parameters.displacementBias,y.uDisplacementScale.value=G.parameters.displacementScale),y.uDiffuseColor.value.setHex(q),y.uSpecularColor.value.setHex(v),y.uAmbientColor.value.setHex(r),y.uShininess.value=I,G.parameters.opacity&& + (y.uOpacity.value=G.parameters.opacity),t=new THREE.ShaderMaterial({fragmentShader:E.fragmentShader,vertexShader:E.vertexShader,uniforms:y,lights:!0,fog:!0})):t=new THREE[G.type](G.parameters);t.name=R;A.materials[R]=t}for(R in C.materials)if(G=C.materials[R],G.parameters.materials){J=[];for(q=0;qg.end&&(g.end=e);b||(b=h)}}a.firstAnimation=b}; + THREE.MorphAnimMesh.prototype.setAnimationLabel=function(a,b,c){this.geometry.animations||(this.geometry.animations={});this.geometry.animations[a]={start:b,end:c}};THREE.MorphAnimMesh.prototype.playAnimation=function(a,b){var c=this.geometry.animations[a];c?(this.setFrameRange(c.start,c.end),this.duration=1E3*((c.end-c.start)/b),this.time=0):console.warn("animation["+a+"] undefined")}; + THREE.MorphAnimMesh.prototype.updateAnimation=function(a){var b=this.duration/this.length;this.time+=this.direction*a;if(this.mirroredLoop){if(this.time>this.duration||0>this.time)this.direction*=-1,this.time>this.duration&&(this.time=this.duration,this.directionBackwards=!0),0>this.time&&(this.time=0,this.directionBackwards=!1)}else this.time%=this.duration,0>this.time&&(this.time+=this.duration);a=this.startKeyframe+THREE.Math.clamp(Math.floor(this.time/b),0,this.length-1);a!==this.currentKeyframe&& + (this.morphTargetInfluences[this.lastKeyframe]=0,this.morphTargetInfluences[this.currentKeyframe]=1,this.morphTargetInfluences[a]=0,this.lastKeyframe=this.currentKeyframe,this.currentKeyframe=a);b=this.time%b/b;this.directionBackwards&&(b=1-b);this.morphTargetInfluences[this.currentKeyframe]=b;this.morphTargetInfluences[this.lastKeyframe]=1-b}; + THREE.MorphAnimMesh.prototype.clone=function(a){void 0===a&&(a=new THREE.MorphAnimMesh(this.geometry,this.material));a.duration=this.duration;a.mirroredLoop=this.mirroredLoop;a.time=this.time;a.lastKeyframe=this.lastKeyframe;a.currentKeyframe=this.currentKeyframe;a.direction=this.direction;a.directionBackwards=this.directionBackwards;THREE.Mesh.prototype.clone.call(this,a);return a};THREE.LOD=function(){THREE.Object3D.call(this);this.objects=[]};THREE.LOD.prototype=Object.create(THREE.Object3D.prototype);THREE.LOD.prototype.addLevel=function(a,b){void 0===b&&(b=0);for(var b=Math.abs(b),c=0;c=this.objects[d].distance)this.objects[d-1].object.visible=!1,this.objects[d].object.visible=!0;else break;for(;d=g||(g*=f.intensity,c.add(La.multiplyScalar(g)))}else f instanceof THREE.PointLight&&(h=ua.getPositionFromMatrix(f.matrixWorld),g=b.dot(ua.subVectors(h,a).normalize()),0>=g||(g*=0==f.distance?1:1-Math.min(a.distanceTo(h)/f.distance,1),0!=g&&(g*=f.intensity,c.add(La.multiplyScalar(g)))))}} + function c(a,b,c,d){m(b);l(c);p(d);s(a.getStyle());C.stroke();ra.expandByScalar(2*b)}function d(a){t(a.getStyle());C.fill()}function e(a,b,c,e,f,h,g,j,i,k,m,l,p){if(!(p instanceof THREE.DataTexture||void 0===p.image||0==p.image.width)){if(!0===p.needsUpdate){var n=p.wrapS==THREE.RepeatWrapping,r=p.wrapT==THREE.RepeatWrapping;Ga[p.id]=C.createPattern(p.image,!0===n&&!0===r?"repeat":!0===n&&!1===r?"repeat-x":!1===n&&!0===r?"repeat-y":"no-repeat");p.needsUpdate=!1}void 0===Ga[p.id]?t("rgba(0,0,0,1)"): + t(Ga[p.id]);var n=p.offset.x/p.repeat.x,r=p.offset.y/p.repeat.y,s=p.image.width*p.repeat.x,q=p.image.height*p.repeat.y,g=(g+n)*s,j=(1-j+r)*q,c=c-a,e=e-b,f=f-a,h=h-b,i=(i+n)*s-g,k=(1-k+r)*q-j,m=(m+n)*s-g,l=(1-l+r)*q-j,n=i*l-m*k;0===n?(void 0===fa[p.id]&&(b=document.createElement("canvas"),b.width=p.image.width,b.height=p.image.height,b=b.getContext("2d"),b.drawImage(p.image,0,0),fa[p.id]=b.getImageData(0,0,p.image.width,p.image.height).data),b=fa[p.id],g=4*(Math.floor(g)+Math.floor(j)*p.image.width), + V.setRGB(b[g]/255,b[g+1]/255,b[g+2]/255),d(V)):(n=1/n,p=(l*c-k*f)*n,k=(l*e-k*h)*n,c=(i*f-m*c)*n,e=(i*h-m*e)*n,a=a-p*g-c*j,g=b-k*g-e*j,C.save(),C.transform(p,k,c,e,a,g),C.fill(),C.restore())}}function f(a,b,c,d,e,f,h,g,j,i,k,m,l){var p,n;p=l.width-1;n=l.height-1;h*=p;g*=n;c-=a;d-=b;e-=a;f-=b;j=j*p-h;i=i*n-g;k=k*p-h;m=m*n-g;n=1/(j*m-k*i);p=(m*c-i*e)*n;i=(m*d-i*f)*n;c=(j*e-k*c)*n;d=(j*f-k*d)*n;a=a-p*h-c*g;b=b-i*h-d*g;C.save();C.transform(p,i,c,d,a,b);C.clip();C.drawImage(l,0,0);C.restore()}function h(a, + b,c,d){va[0]=255*a.r|0;va[1]=255*a.g|0;va[2]=255*a.b|0;va[4]=255*b.r|0;va[5]=255*b.g|0;va[6]=255*b.b|0;va[8]=255*c.r|0;va[9]=255*c.g|0;va[10]=255*c.b|0;va[12]=255*d.r|0;va[13]=255*d.g|0;va[14]=255*d.b|0;j.putImageData(Oa,0,0);Ea.drawImage(Pa,0,0);return wa}function g(a,b,c){var d=b.x-a.x,e=b.y-a.y,f=d*d+e*e;0!==f&&(c/=Math.sqrt(f),d*=c,e*=c,b.x+=d,b.y+=e,a.x-=d,a.y-=e)}function i(a){y!==a&&(y=C.globalAlpha=a)}function k(a){v!==a&&(a===THREE.NormalBlending?C.globalCompositeOperation="source-over": + a===THREE.AdditiveBlending?C.globalCompositeOperation="lighter":a===THREE.SubtractiveBlending&&(C.globalCompositeOperation="darker"),v=a)}function m(a){J!==a&&(J=C.lineWidth=a)}function l(a){ba!==a&&(ba=C.lineCap=a)}function p(a){oa!==a&&(oa=C.lineJoin=a)}function s(a){G!==a&&(G=C.strokeStyle=a)}function t(a){R!==a&&(R=C.fillStyle=a)}function n(a,b){if(pa!==a||N!==b)C.setLineDash([a,b]),pa=a,N=b}console.log("THREE.CanvasRenderer",THREE.REVISION);var r=THREE.Math.smoothstep,a=a||{},q=this,u,w,z,B= + new THREE.Projector,D=void 0!==a.canvas?a.canvas:document.createElement("canvas"),x=D.width,F=D.height,A=Math.floor(x/2),O=Math.floor(F/2),C=D.getContext("2d"),E=new THREE.Color(0),I=0,y=1,v=0,G=null,R=null,J=null,ba=null,oa=null,pa=null,N=0,M,Q,K,ca;new THREE.RenderableVertex;new THREE.RenderableVertex;var Fa,Ba,da,Aa,$,ea,V=new THREE.Color,P=new THREE.Color,Z=new THREE.Color,U=new THREE.Color,ka=new THREE.Color,ta=new THREE.Color,ia=new THREE.Color,La=new THREE.Color,Ga={},fa={},Da,Ua,Qa,xa,bb, + cb,Ma,fb,sb,pb,Ha=new THREE.Box2,la=new THREE.Box2,ra=new THREE.Box2,gb=new THREE.Color,sa=new THREE.Color,ga=new THREE.Color,ua=new THREE.Vector3,Pa,j,Oa,va,wa,Ea,Ra=16;Pa=document.createElement("canvas");Pa.width=Pa.height=2;j=Pa.getContext("2d");j.fillStyle="rgba(0,0,0,1)";j.fillRect(0,0,2,2);Oa=j.getImageData(0,0,2,2);va=Oa.data;wa=document.createElement("canvas");wa.width=wa.height=Ra;Ea=wa.getContext("2d");Ea.translate(-Ra/2,-Ra/2);Ea.scale(Ra,Ra);Ra--;void 0===C.setLineDash&&(C.setLineDash= + void 0!==C.mozDash?function(a){C.mozDash=null!==a[0]?a:null}:function(){});this.domElement=D;this.devicePixelRatio=void 0!==a.devicePixelRatio?a.devicePixelRatio:void 0!==self.devicePixelRatio?self.devicePixelRatio:1;this.sortElements=this.sortObjects=this.autoClear=!0;this.info={render:{vertices:0,faces:0}};this.supportsVertexTextures=function(){};this.setFaceCulling=function(){};this.setSize=function(a,b,c){x=a*this.devicePixelRatio;F=b*this.devicePixelRatio;A=Math.floor(x/2);O=Math.floor(F/2); + D.width=x;D.height=F;1!==this.devicePixelRatio&&!1!==c&&(D.style.width=a+"px",D.style.height=b+"px");Ha.set(new THREE.Vector2(-A,-O),new THREE.Vector2(A,O));la.set(new THREE.Vector2(-A,-O),new THREE.Vector2(A,O));y=1;v=0;oa=ba=J=R=G=null};this.setClearColor=function(a,b){E.set(a);I=void 0!==b?b:1;la.set(new THREE.Vector2(-A,-O),new THREE.Vector2(A,O))};this.setClearColorHex=function(a,b){console.warn("DEPRECATED: .setClearColorHex() is being removed. Use .setClearColor() instead.");this.setClearColor(a, + b)};this.getMaxAnisotropy=function(){return 0};this.clear=function(){C.setTransform(1,0,0,-1,A,O);!1===la.empty()&&(la.intersect(Ha),la.expandByScalar(2),1>I&&C.clearRect(la.min.x|0,la.min.y|0,la.max.x-la.min.x|0,la.max.y-la.min.y|0),0>1,ba=I.height>>1,N=F.scale.x*A,E=F.scale.y*O,x=N*R,v=E*ba,ra.min.set(y.x-x,y.y-v),ra.max.set(y.x+x,y.y+v),!1===Ha.isIntersectionBox(ra)?ra.makeEmpty():(C.save(),C.translate(y.x,y.y),C.rotate(-F.rotation), + C.scale(N,-E),C.translate(-R,-ba),C.drawImage(I,0,0),C.restore())):(N=F.object.scale.x,E=F.object.scale.y,N*=F.scale.x*A,E*=F.scale.y*O,ra.min.set(y.x-N,y.y-E),ra.max.set(y.x+N,y.y+E),!1===Ha.isIntersectionBox(ra)?ra.makeEmpty():(t(J.color.getStyle()),C.save(),C.translate(y.x,y.y),C.rotate(-F.rotation),C.scale(N,E),C.fillRect(-1,-1,2,2),C.restore())):J instanceof THREE.SpriteCanvasMaterial&&(x=F.scale.x*A,v=F.scale.y*O,ra.min.set(y.x-x,y.y-v),ra.max.set(y.x+x,y.y+v),!1===Ha.isIntersectionBox(ra)? + ra.makeEmpty():(s(J.color.getStyle()),t(J.color.getStyle()),C.save(),C.translate(y.x,y.y),C.rotate(-F.rotation),C.scale(x,v),J.program(C),C.restore()))}else if(x instanceof THREE.RenderableLine){if(Q=x.v1,K=x.v2,Q.positionScreen.x*=A,Q.positionScreen.y*=O,K.positionScreen.x*=A,K.positionScreen.y*=O,ra.setFromPoints([Q.positionScreen,K.positionScreen]),!0===Ha.isIntersectionBox(ra))if(y=Q,F=K,J=x,x=v,i(x.opacity),k(x.blending),C.beginPath(),C.moveTo(y.positionScreen.x,y.positionScreen.y),C.lineTo(F.positionScreen.x, + F.positionScreen.y),x instanceof THREE.LineBasicMaterial){m(x.linewidth);l(x.linecap);p(x.linejoin);if(x.vertexColors!==THREE.VertexColors)s(x.color.getStyle());else if(v=J.vertexColors[0].getStyle(),J=J.vertexColors[1].getStyle(),v===J)s(v);else{try{var fa=C.createLinearGradient(y.positionScreen.x,y.positionScreen.y,F.positionScreen.x,F.positionScreen.y);fa.addColorStop(0,v);fa.addColorStop(1,J)}catch(oa){fa=v}s(fa)}C.stroke();ra.expandByScalar(2*x.linewidth)}else x instanceof THREE.LineDashedMaterial&& + (m(x.linewidth),l(x.linecap),p(x.linejoin),s(x.color.getStyle()),n(x.dashSize,x.gapSize),C.stroke(),ra.expandByScalar(2*x.linewidth),n(null,null))}else if(x instanceof THREE.RenderableFace3){Q=x.v1;K=x.v2;ca=x.v3;if(-1>Q.positionScreen.z||1K.positionScreen.z||1ca.positionScreen.z||1 0\nuniform vec3 directionalLightColor[ MAX_DIR_LIGHTS ];\nuniform vec3 directionalLightDirection[ MAX_DIR_LIGHTS ];\n#endif\n#if MAX_HEMI_LIGHTS > 0\nuniform vec3 hemisphereLightSkyColor[ MAX_HEMI_LIGHTS ];\nuniform vec3 hemisphereLightGroundColor[ MAX_HEMI_LIGHTS ];\nuniform vec3 hemisphereLightDirection[ MAX_HEMI_LIGHTS ];\n#endif\n#if MAX_POINT_LIGHTS > 0\nuniform vec3 pointLightColor[ MAX_POINT_LIGHTS ];\nuniform vec3 pointLightPosition[ MAX_POINT_LIGHTS ];\nuniform float pointLightDistance[ MAX_POINT_LIGHTS ];\n#endif\n#if MAX_SPOT_LIGHTS > 0\nuniform vec3 spotLightColor[ MAX_SPOT_LIGHTS ];\nuniform vec3 spotLightPosition[ MAX_SPOT_LIGHTS ];\nuniform vec3 spotLightDirection[ MAX_SPOT_LIGHTS ];\nuniform float spotLightDistance[ MAX_SPOT_LIGHTS ];\nuniform float spotLightAngleCos[ MAX_SPOT_LIGHTS ];\nuniform float spotLightExponent[ MAX_SPOT_LIGHTS ];\n#endif\n#ifdef WRAP_AROUND\nuniform vec3 wrapRGB;\n#endif", + lights_lambert_vertex:"vLightFront = vec3( 0.0 );\n#ifdef DOUBLE_SIDED\nvLightBack = vec3( 0.0 );\n#endif\ntransformedNormal = normalize( transformedNormal );\n#if MAX_DIR_LIGHTS > 0\nfor( int i = 0; i < MAX_DIR_LIGHTS; i ++ ) {\nvec4 lDirection = viewMatrix * vec4( directionalLightDirection[ i ], 0.0 );\nvec3 dirVector = normalize( lDirection.xyz );\nfloat dotProduct = dot( transformedNormal, dirVector );\nvec3 directionalLightWeighting = vec3( max( dotProduct, 0.0 ) );\n#ifdef DOUBLE_SIDED\nvec3 directionalLightWeightingBack = vec3( max( -dotProduct, 0.0 ) );\n#ifdef WRAP_AROUND\nvec3 directionalLightWeightingHalfBack = vec3( max( -0.5 * dotProduct + 0.5, 0.0 ) );\n#endif\n#endif\n#ifdef WRAP_AROUND\nvec3 directionalLightWeightingHalf = vec3( max( 0.5 * dotProduct + 0.5, 0.0 ) );\ndirectionalLightWeighting = mix( directionalLightWeighting, directionalLightWeightingHalf, wrapRGB );\n#ifdef DOUBLE_SIDED\ndirectionalLightWeightingBack = mix( directionalLightWeightingBack, directionalLightWeightingHalfBack, wrapRGB );\n#endif\n#endif\nvLightFront += directionalLightColor[ i ] * directionalLightWeighting;\n#ifdef DOUBLE_SIDED\nvLightBack += directionalLightColor[ i ] * directionalLightWeightingBack;\n#endif\n}\n#endif\n#if MAX_POINT_LIGHTS > 0\nfor( int i = 0; i < MAX_POINT_LIGHTS; i ++ ) {\nvec4 lPosition = viewMatrix * vec4( pointLightPosition[ i ], 1.0 );\nvec3 lVector = lPosition.xyz - mvPosition.xyz;\nfloat lDistance = 1.0;\nif ( pointLightDistance[ i ] > 0.0 )\nlDistance = 1.0 - min( ( length( lVector ) / pointLightDistance[ i ] ), 1.0 );\nlVector = normalize( lVector );\nfloat dotProduct = dot( transformedNormal, lVector );\nvec3 pointLightWeighting = vec3( max( dotProduct, 0.0 ) );\n#ifdef DOUBLE_SIDED\nvec3 pointLightWeightingBack = vec3( max( -dotProduct, 0.0 ) );\n#ifdef WRAP_AROUND\nvec3 pointLightWeightingHalfBack = vec3( max( -0.5 * dotProduct + 0.5, 0.0 ) );\n#endif\n#endif\n#ifdef WRAP_AROUND\nvec3 pointLightWeightingHalf = vec3( max( 0.5 * dotProduct + 0.5, 0.0 ) );\npointLightWeighting = mix( pointLightWeighting, pointLightWeightingHalf, wrapRGB );\n#ifdef DOUBLE_SIDED\npointLightWeightingBack = mix( pointLightWeightingBack, pointLightWeightingHalfBack, wrapRGB );\n#endif\n#endif\nvLightFront += pointLightColor[ i ] * pointLightWeighting * lDistance;\n#ifdef DOUBLE_SIDED\nvLightBack += pointLightColor[ i ] * pointLightWeightingBack * lDistance;\n#endif\n}\n#endif\n#if MAX_SPOT_LIGHTS > 0\nfor( int i = 0; i < MAX_SPOT_LIGHTS; i ++ ) {\nvec4 lPosition = viewMatrix * vec4( spotLightPosition[ i ], 1.0 );\nvec3 lVector = lPosition.xyz - mvPosition.xyz;\nfloat spotEffect = dot( spotLightDirection[ i ], normalize( spotLightPosition[ i ] - worldPosition.xyz ) );\nif ( spotEffect > spotLightAngleCos[ i ] ) {\nspotEffect = max( pow( spotEffect, spotLightExponent[ i ] ), 0.0 );\nfloat lDistance = 1.0;\nif ( spotLightDistance[ i ] > 0.0 )\nlDistance = 1.0 - min( ( length( lVector ) / spotLightDistance[ i ] ), 1.0 );\nlVector = normalize( lVector );\nfloat dotProduct = dot( transformedNormal, lVector );\nvec3 spotLightWeighting = vec3( max( dotProduct, 0.0 ) );\n#ifdef DOUBLE_SIDED\nvec3 spotLightWeightingBack = vec3( max( -dotProduct, 0.0 ) );\n#ifdef WRAP_AROUND\nvec3 spotLightWeightingHalfBack = vec3( max( -0.5 * dotProduct + 0.5, 0.0 ) );\n#endif\n#endif\n#ifdef WRAP_AROUND\nvec3 spotLightWeightingHalf = vec3( max( 0.5 * dotProduct + 0.5, 0.0 ) );\nspotLightWeighting = mix( spotLightWeighting, spotLightWeightingHalf, wrapRGB );\n#ifdef DOUBLE_SIDED\nspotLightWeightingBack = mix( spotLightWeightingBack, spotLightWeightingHalfBack, wrapRGB );\n#endif\n#endif\nvLightFront += spotLightColor[ i ] * spotLightWeighting * lDistance * spotEffect;\n#ifdef DOUBLE_SIDED\nvLightBack += spotLightColor[ i ] * spotLightWeightingBack * lDistance * spotEffect;\n#endif\n}\n}\n#endif\n#if MAX_HEMI_LIGHTS > 0\nfor( int i = 0; i < MAX_HEMI_LIGHTS; i ++ ) {\nvec4 lDirection = viewMatrix * vec4( hemisphereLightDirection[ i ], 0.0 );\nvec3 lVector = normalize( lDirection.xyz );\nfloat dotProduct = dot( transformedNormal, lVector );\nfloat hemiDiffuseWeight = 0.5 * dotProduct + 0.5;\nfloat hemiDiffuseWeightBack = -0.5 * dotProduct + 0.5;\nvLightFront += mix( hemisphereLightGroundColor[ i ], hemisphereLightSkyColor[ i ], hemiDiffuseWeight );\n#ifdef DOUBLE_SIDED\nvLightBack += mix( hemisphereLightGroundColor[ i ], hemisphereLightSkyColor[ i ], hemiDiffuseWeightBack );\n#endif\n}\n#endif\nvLightFront = vLightFront * diffuse + ambient * ambientLightColor + emissive;\n#ifdef DOUBLE_SIDED\nvLightBack = vLightBack * diffuse + ambient * ambientLightColor + emissive;\n#endif", + lights_phong_pars_vertex:"#ifndef PHONG_PER_PIXEL\n#if MAX_POINT_LIGHTS > 0\nuniform vec3 pointLightPosition[ MAX_POINT_LIGHTS ];\nuniform float pointLightDistance[ MAX_POINT_LIGHTS ];\nvarying vec4 vPointLight[ MAX_POINT_LIGHTS ];\n#endif\n#if MAX_SPOT_LIGHTS > 0\nuniform vec3 spotLightPosition[ MAX_SPOT_LIGHTS ];\nuniform float spotLightDistance[ MAX_SPOT_LIGHTS ];\nvarying vec4 vSpotLight[ MAX_SPOT_LIGHTS ];\n#endif\n#endif\n#if MAX_SPOT_LIGHTS > 0 || defined( USE_BUMPMAP )\nvarying vec3 vWorldPosition;\n#endif", + lights_phong_vertex:"#ifndef PHONG_PER_PIXEL\n#if MAX_POINT_LIGHTS > 0\nfor( int i = 0; i < MAX_POINT_LIGHTS; i ++ ) {\nvec4 lPosition = viewMatrix * vec4( pointLightPosition[ i ], 1.0 );\nvec3 lVector = lPosition.xyz - mvPosition.xyz;\nfloat lDistance = 1.0;\nif ( pointLightDistance[ i ] > 0.0 )\nlDistance = 1.0 - min( ( length( lVector ) / pointLightDistance[ i ] ), 1.0 );\nvPointLight[ i ] = vec4( lVector, lDistance );\n}\n#endif\n#if MAX_SPOT_LIGHTS > 0\nfor( int i = 0; i < MAX_SPOT_LIGHTS; i ++ ) {\nvec4 lPosition = viewMatrix * vec4( spotLightPosition[ i ], 1.0 );\nvec3 lVector = lPosition.xyz - mvPosition.xyz;\nfloat lDistance = 1.0;\nif ( spotLightDistance[ i ] > 0.0 )\nlDistance = 1.0 - min( ( length( lVector ) / spotLightDistance[ i ] ), 1.0 );\nvSpotLight[ i ] = vec4( lVector, lDistance );\n}\n#endif\n#endif\n#if MAX_SPOT_LIGHTS > 0 || defined( USE_BUMPMAP )\nvWorldPosition = worldPosition.xyz;\n#endif", + lights_phong_pars_fragment:"uniform vec3 ambientLightColor;\n#if MAX_DIR_LIGHTS > 0\nuniform vec3 directionalLightColor[ MAX_DIR_LIGHTS ];\nuniform vec3 directionalLightDirection[ MAX_DIR_LIGHTS ];\n#endif\n#if MAX_HEMI_LIGHTS > 0\nuniform vec3 hemisphereLightSkyColor[ MAX_HEMI_LIGHTS ];\nuniform vec3 hemisphereLightGroundColor[ MAX_HEMI_LIGHTS ];\nuniform vec3 hemisphereLightDirection[ MAX_HEMI_LIGHTS ];\n#endif\n#if MAX_POINT_LIGHTS > 0\nuniform vec3 pointLightColor[ MAX_POINT_LIGHTS ];\n#ifdef PHONG_PER_PIXEL\nuniform vec3 pointLightPosition[ MAX_POINT_LIGHTS ];\nuniform float pointLightDistance[ MAX_POINT_LIGHTS ];\n#else\nvarying vec4 vPointLight[ MAX_POINT_LIGHTS ];\n#endif\n#endif\n#if MAX_SPOT_LIGHTS > 0\nuniform vec3 spotLightColor[ MAX_SPOT_LIGHTS ];\nuniform vec3 spotLightPosition[ MAX_SPOT_LIGHTS ];\nuniform vec3 spotLightDirection[ MAX_SPOT_LIGHTS ];\nuniform float spotLightAngleCos[ MAX_SPOT_LIGHTS ];\nuniform float spotLightExponent[ MAX_SPOT_LIGHTS ];\n#ifdef PHONG_PER_PIXEL\nuniform float spotLightDistance[ MAX_SPOT_LIGHTS ];\n#else\nvarying vec4 vSpotLight[ MAX_SPOT_LIGHTS ];\n#endif\n#endif\n#if MAX_SPOT_LIGHTS > 0 || defined( USE_BUMPMAP )\nvarying vec3 vWorldPosition;\n#endif\n#ifdef WRAP_AROUND\nuniform vec3 wrapRGB;\n#endif\nvarying vec3 vViewPosition;\nvarying vec3 vNormal;", + lights_phong_fragment:"vec3 normal = normalize( vNormal );\nvec3 viewPosition = normalize( vViewPosition );\n#ifdef DOUBLE_SIDED\nnormal = normal * ( -1.0 + 2.0 * float( gl_FrontFacing ) );\n#endif\n#ifdef USE_NORMALMAP\nnormal = perturbNormal2Arb( -vViewPosition, normal );\n#elif defined( USE_BUMPMAP )\nnormal = perturbNormalArb( -vViewPosition, normal, dHdxy_fwd() );\n#endif\n#if MAX_POINT_LIGHTS > 0\nvec3 pointDiffuse = vec3( 0.0 );\nvec3 pointSpecular = vec3( 0.0 );\nfor ( int i = 0; i < MAX_POINT_LIGHTS; i ++ ) {\n#ifdef PHONG_PER_PIXEL\nvec4 lPosition = viewMatrix * vec4( pointLightPosition[ i ], 1.0 );\nvec3 lVector = lPosition.xyz + vViewPosition.xyz;\nfloat lDistance = 1.0;\nif ( pointLightDistance[ i ] > 0.0 )\nlDistance = 1.0 - min( ( length( lVector ) / pointLightDistance[ i ] ), 1.0 );\nlVector = normalize( lVector );\n#else\nvec3 lVector = normalize( vPointLight[ i ].xyz );\nfloat lDistance = vPointLight[ i ].w;\n#endif\nfloat dotProduct = dot( normal, lVector );\n#ifdef WRAP_AROUND\nfloat pointDiffuseWeightFull = max( dotProduct, 0.0 );\nfloat pointDiffuseWeightHalf = max( 0.5 * dotProduct + 0.5, 0.0 );\nvec3 pointDiffuseWeight = mix( vec3 ( pointDiffuseWeightFull ), vec3( pointDiffuseWeightHalf ), wrapRGB );\n#else\nfloat pointDiffuseWeight = max( dotProduct, 0.0 );\n#endif\npointDiffuse += diffuse * pointLightColor[ i ] * pointDiffuseWeight * lDistance;\nvec3 pointHalfVector = normalize( lVector + viewPosition );\nfloat pointDotNormalHalf = max( dot( normal, pointHalfVector ), 0.0 );\nfloat pointSpecularWeight = specularStrength * max( pow( pointDotNormalHalf, shininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat specularNormalization = ( shininess + 2.0001 ) / 8.0;\nvec3 schlick = specular + vec3( 1.0 - specular ) * pow( 1.0 - dot( lVector, pointHalfVector ), 5.0 );\npointSpecular += schlick * pointLightColor[ i ] * pointSpecularWeight * pointDiffuseWeight * lDistance * specularNormalization;\n#else\npointSpecular += specular * pointLightColor[ i ] * pointSpecularWeight * pointDiffuseWeight * lDistance;\n#endif\n}\n#endif\n#if MAX_SPOT_LIGHTS > 0\nvec3 spotDiffuse = vec3( 0.0 );\nvec3 spotSpecular = vec3( 0.0 );\nfor ( int i = 0; i < MAX_SPOT_LIGHTS; i ++ ) {\n#ifdef PHONG_PER_PIXEL\nvec4 lPosition = viewMatrix * vec4( spotLightPosition[ i ], 1.0 );\nvec3 lVector = lPosition.xyz + vViewPosition.xyz;\nfloat lDistance = 1.0;\nif ( spotLightDistance[ i ] > 0.0 )\nlDistance = 1.0 - min( ( length( lVector ) / spotLightDistance[ i ] ), 1.0 );\nlVector = normalize( lVector );\n#else\nvec3 lVector = normalize( vSpotLight[ i ].xyz );\nfloat lDistance = vSpotLight[ i ].w;\n#endif\nfloat spotEffect = dot( spotLightDirection[ i ], normalize( spotLightPosition[ i ] - vWorldPosition ) );\nif ( spotEffect > spotLightAngleCos[ i ] ) {\nspotEffect = max( pow( spotEffect, spotLightExponent[ i ] ), 0.0 );\nfloat dotProduct = dot( normal, lVector );\n#ifdef WRAP_AROUND\nfloat spotDiffuseWeightFull = max( dotProduct, 0.0 );\nfloat spotDiffuseWeightHalf = max( 0.5 * dotProduct + 0.5, 0.0 );\nvec3 spotDiffuseWeight = mix( vec3 ( spotDiffuseWeightFull ), vec3( spotDiffuseWeightHalf ), wrapRGB );\n#else\nfloat spotDiffuseWeight = max( dotProduct, 0.0 );\n#endif\nspotDiffuse += diffuse * spotLightColor[ i ] * spotDiffuseWeight * lDistance * spotEffect;\nvec3 spotHalfVector = normalize( lVector + viewPosition );\nfloat spotDotNormalHalf = max( dot( normal, spotHalfVector ), 0.0 );\nfloat spotSpecularWeight = specularStrength * max( pow( spotDotNormalHalf, shininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat specularNormalization = ( shininess + 2.0001 ) / 8.0;\nvec3 schlick = specular + vec3( 1.0 - specular ) * pow( 1.0 - dot( lVector, spotHalfVector ), 5.0 );\nspotSpecular += schlick * spotLightColor[ i ] * spotSpecularWeight * spotDiffuseWeight * lDistance * specularNormalization * spotEffect;\n#else\nspotSpecular += specular * spotLightColor[ i ] * spotSpecularWeight * spotDiffuseWeight * lDistance * spotEffect;\n#endif\n}\n}\n#endif\n#if MAX_DIR_LIGHTS > 0\nvec3 dirDiffuse = vec3( 0.0 );\nvec3 dirSpecular = vec3( 0.0 );\nfor( int i = 0; i < MAX_DIR_LIGHTS; i ++ ) {\nvec4 lDirection = viewMatrix * vec4( directionalLightDirection[ i ], 0.0 );\nvec3 dirVector = normalize( lDirection.xyz );\nfloat dotProduct = dot( normal, dirVector );\n#ifdef WRAP_AROUND\nfloat dirDiffuseWeightFull = max( dotProduct, 0.0 );\nfloat dirDiffuseWeightHalf = max( 0.5 * dotProduct + 0.5, 0.0 );\nvec3 dirDiffuseWeight = mix( vec3( dirDiffuseWeightFull ), vec3( dirDiffuseWeightHalf ), wrapRGB );\n#else\nfloat dirDiffuseWeight = max( dotProduct, 0.0 );\n#endif\ndirDiffuse += diffuse * directionalLightColor[ i ] * dirDiffuseWeight;\nvec3 dirHalfVector = normalize( dirVector + viewPosition );\nfloat dirDotNormalHalf = max( dot( normal, dirHalfVector ), 0.0 );\nfloat dirSpecularWeight = specularStrength * max( pow( dirDotNormalHalf, shininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat specularNormalization = ( shininess + 2.0001 ) / 8.0;\nvec3 schlick = specular + vec3( 1.0 - specular ) * pow( 1.0 - dot( dirVector, dirHalfVector ), 5.0 );\ndirSpecular += schlick * directionalLightColor[ i ] * dirSpecularWeight * dirDiffuseWeight * specularNormalization;\n#else\ndirSpecular += specular * directionalLightColor[ i ] * dirSpecularWeight * dirDiffuseWeight;\n#endif\n}\n#endif\n#if MAX_HEMI_LIGHTS > 0\nvec3 hemiDiffuse = vec3( 0.0 );\nvec3 hemiSpecular = vec3( 0.0 );\nfor( int i = 0; i < MAX_HEMI_LIGHTS; i ++ ) {\nvec4 lDirection = viewMatrix * vec4( hemisphereLightDirection[ i ], 0.0 );\nvec3 lVector = normalize( lDirection.xyz );\nfloat dotProduct = dot( normal, lVector );\nfloat hemiDiffuseWeight = 0.5 * dotProduct + 0.5;\nvec3 hemiColor = mix( hemisphereLightGroundColor[ i ], hemisphereLightSkyColor[ i ], hemiDiffuseWeight );\nhemiDiffuse += diffuse * hemiColor;\nvec3 hemiHalfVectorSky = normalize( lVector + viewPosition );\nfloat hemiDotNormalHalfSky = 0.5 * dot( normal, hemiHalfVectorSky ) + 0.5;\nfloat hemiSpecularWeightSky = specularStrength * max( pow( hemiDotNormalHalfSky, shininess ), 0.0 );\nvec3 lVectorGround = -lVector;\nvec3 hemiHalfVectorGround = normalize( lVectorGround + viewPosition );\nfloat hemiDotNormalHalfGround = 0.5 * dot( normal, hemiHalfVectorGround ) + 0.5;\nfloat hemiSpecularWeightGround = specularStrength * max( pow( hemiDotNormalHalfGround, shininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat dotProductGround = dot( normal, lVectorGround );\nfloat specularNormalization = ( shininess + 2.0001 ) / 8.0;\nvec3 schlickSky = specular + vec3( 1.0 - specular ) * pow( 1.0 - dot( lVector, hemiHalfVectorSky ), 5.0 );\nvec3 schlickGround = specular + vec3( 1.0 - specular ) * pow( 1.0 - dot( lVectorGround, hemiHalfVectorGround ), 5.0 );\nhemiSpecular += hemiColor * specularNormalization * ( schlickSky * hemiSpecularWeightSky * max( dotProduct, 0.0 ) + schlickGround * hemiSpecularWeightGround * max( dotProductGround, 0.0 ) );\n#else\nhemiSpecular += specular * hemiColor * ( hemiSpecularWeightSky + hemiSpecularWeightGround ) * hemiDiffuseWeight;\n#endif\n}\n#endif\nvec3 totalDiffuse = vec3( 0.0 );\nvec3 totalSpecular = vec3( 0.0 );\n#if MAX_DIR_LIGHTS > 0\ntotalDiffuse += dirDiffuse;\ntotalSpecular += dirSpecular;\n#endif\n#if MAX_HEMI_LIGHTS > 0\ntotalDiffuse += hemiDiffuse;\ntotalSpecular += hemiSpecular;\n#endif\n#if MAX_POINT_LIGHTS > 0\ntotalDiffuse += pointDiffuse;\ntotalSpecular += pointSpecular;\n#endif\n#if MAX_SPOT_LIGHTS > 0\ntotalDiffuse += spotDiffuse;\ntotalSpecular += spotSpecular;\n#endif\n#ifdef METAL\ngl_FragColor.xyz = gl_FragColor.xyz * ( emissive + totalDiffuse + ambientLightColor * ambient + totalSpecular );\n#else\ngl_FragColor.xyz = gl_FragColor.xyz * ( emissive + totalDiffuse + ambientLightColor * ambient ) + totalSpecular;\n#endif", + color_pars_fragment:"#ifdef USE_COLOR\nvarying vec3 vColor;\n#endif",color_fragment:"#ifdef USE_COLOR\ngl_FragColor = gl_FragColor * vec4( vColor, 1.0 );\n#endif",color_pars_vertex:"#ifdef USE_COLOR\nvarying vec3 vColor;\n#endif",color_vertex:"#ifdef USE_COLOR\n#ifdef GAMMA_INPUT\nvColor = color * color;\n#else\nvColor = color;\n#endif\n#endif",skinning_pars_vertex:"#ifdef USE_SKINNING\n#ifdef BONE_TEXTURE\nuniform sampler2D boneTexture;\nuniform int boneTextureWidth;\nuniform int boneTextureHeight;\nmat4 getBoneMatrix( const in float i ) {\nfloat j = i * 4.0;\nfloat x = mod( j, float( boneTextureWidth ) );\nfloat y = floor( j / float( boneTextureWidth ) );\nfloat dx = 1.0 / float( boneTextureWidth );\nfloat dy = 1.0 / float( boneTextureHeight );\ny = dy * ( y + 0.5 );\nvec4 v1 = texture2D( boneTexture, vec2( dx * ( x + 0.5 ), y ) );\nvec4 v2 = texture2D( boneTexture, vec2( dx * ( x + 1.5 ), y ) );\nvec4 v3 = texture2D( boneTexture, vec2( dx * ( x + 2.5 ), y ) );\nvec4 v4 = texture2D( boneTexture, vec2( dx * ( x + 3.5 ), y ) );\nmat4 bone = mat4( v1, v2, v3, v4 );\nreturn bone;\n}\n#else\nuniform mat4 boneGlobalMatrices[ MAX_BONES ];\nmat4 getBoneMatrix( const in float i ) {\nmat4 bone = boneGlobalMatrices[ int(i) ];\nreturn bone;\n}\n#endif\n#endif", + skinbase_vertex:"#ifdef USE_SKINNING\nmat4 boneMatX = getBoneMatrix( skinIndex.x );\nmat4 boneMatY = getBoneMatrix( skinIndex.y );\n#endif",skinning_vertex:"#ifdef USE_SKINNING\n#ifdef USE_MORPHTARGETS\nvec4 skinVertex = vec4( morphed, 1.0 );\n#else\nvec4 skinVertex = vec4( position, 1.0 );\n#endif\nvec4 skinned = boneMatX * skinVertex * skinWeight.x;\nskinned \t += boneMatY * skinVertex * skinWeight.y;\n#endif",morphtarget_pars_vertex:"#ifdef USE_MORPHTARGETS\n#ifndef USE_MORPHNORMALS\nuniform float morphTargetInfluences[ 8 ];\n#else\nuniform float morphTargetInfluences[ 4 ];\n#endif\n#endif", + morphtarget_vertex:"#ifdef USE_MORPHTARGETS\nvec3 morphed = vec3( 0.0 );\nmorphed += ( morphTarget0 - position ) * morphTargetInfluences[ 0 ];\nmorphed += ( morphTarget1 - position ) * morphTargetInfluences[ 1 ];\nmorphed += ( morphTarget2 - position ) * morphTargetInfluences[ 2 ];\nmorphed += ( morphTarget3 - position ) * morphTargetInfluences[ 3 ];\n#ifndef USE_MORPHNORMALS\nmorphed += ( morphTarget4 - position ) * morphTargetInfluences[ 4 ];\nmorphed += ( morphTarget5 - position ) * morphTargetInfluences[ 5 ];\nmorphed += ( morphTarget6 - position ) * morphTargetInfluences[ 6 ];\nmorphed += ( morphTarget7 - position ) * morphTargetInfluences[ 7 ];\n#endif\nmorphed += position;\n#endif", + default_vertex:"vec4 mvPosition;\n#ifdef USE_SKINNING\nmvPosition = modelViewMatrix * skinned;\n#endif\n#if !defined( USE_SKINNING ) && defined( USE_MORPHTARGETS )\nmvPosition = modelViewMatrix * vec4( morphed, 1.0 );\n#endif\n#if !defined( USE_SKINNING ) && ! defined( USE_MORPHTARGETS )\nmvPosition = modelViewMatrix * vec4( position, 1.0 );\n#endif\ngl_Position = projectionMatrix * mvPosition;",morphnormal_vertex:"#ifdef USE_MORPHNORMALS\nvec3 morphedNormal = vec3( 0.0 );\nmorphedNormal += ( morphNormal0 - normal ) * morphTargetInfluences[ 0 ];\nmorphedNormal += ( morphNormal1 - normal ) * morphTargetInfluences[ 1 ];\nmorphedNormal += ( morphNormal2 - normal ) * morphTargetInfluences[ 2 ];\nmorphedNormal += ( morphNormal3 - normal ) * morphTargetInfluences[ 3 ];\nmorphedNormal += normal;\n#endif", + skinnormal_vertex:"#ifdef USE_SKINNING\nmat4 skinMatrix = skinWeight.x * boneMatX;\nskinMatrix \t+= skinWeight.y * boneMatY;\n#ifdef USE_MORPHNORMALS\nvec4 skinnedNormal = skinMatrix * vec4( morphedNormal, 0.0 );\n#else\nvec4 skinnedNormal = skinMatrix * vec4( normal, 0.0 );\n#endif\n#endif",defaultnormal_vertex:"vec3 objectNormal;\n#ifdef USE_SKINNING\nobjectNormal = skinnedNormal.xyz;\n#endif\n#if !defined( USE_SKINNING ) && defined( USE_MORPHNORMALS )\nobjectNormal = morphedNormal;\n#endif\n#if !defined( USE_SKINNING ) && ! defined( USE_MORPHNORMALS )\nobjectNormal = normal;\n#endif\n#ifdef FLIP_SIDED\nobjectNormal = -objectNormal;\n#endif\nvec3 transformedNormal = normalMatrix * objectNormal;", + shadowmap_pars_fragment:"#ifdef USE_SHADOWMAP\nuniform sampler2D shadowMap[ MAX_SHADOWS ];\nuniform vec2 shadowMapSize[ MAX_SHADOWS ];\nuniform float shadowDarkness[ MAX_SHADOWS ];\nuniform float shadowBias[ MAX_SHADOWS ];\nvarying vec4 vShadowCoord[ MAX_SHADOWS ];\nfloat unpackDepth( const in vec4 rgba_depth ) {\nconst vec4 bit_shift = vec4( 1.0 / ( 256.0 * 256.0 * 256.0 ), 1.0 / ( 256.0 * 256.0 ), 1.0 / 256.0, 1.0 );\nfloat depth = dot( rgba_depth, bit_shift );\nreturn depth;\n}\n#endif",shadowmap_fragment:"#ifdef USE_SHADOWMAP\n#ifdef SHADOWMAP_DEBUG\nvec3 frustumColors[3];\nfrustumColors[0] = vec3( 1.0, 0.5, 0.0 );\nfrustumColors[1] = vec3( 0.0, 1.0, 0.8 );\nfrustumColors[2] = vec3( 0.0, 0.5, 1.0 );\n#endif\n#ifdef SHADOWMAP_CASCADE\nint inFrustumCount = 0;\n#endif\nfloat fDepth;\nvec3 shadowColor = vec3( 1.0 );\nfor( int i = 0; i < MAX_SHADOWS; i ++ ) {\nvec3 shadowCoord = vShadowCoord[ i ].xyz / vShadowCoord[ i ].w;\nbvec4 inFrustumVec = bvec4 ( shadowCoord.x >= 0.0, shadowCoord.x <= 1.0, shadowCoord.y >= 0.0, shadowCoord.y <= 1.0 );\nbool inFrustum = all( inFrustumVec );\n#ifdef SHADOWMAP_CASCADE\ninFrustumCount += int( inFrustum );\nbvec3 frustumTestVec = bvec3( inFrustum, inFrustumCount == 1, shadowCoord.z <= 1.0 );\n#else\nbvec2 frustumTestVec = bvec2( inFrustum, shadowCoord.z <= 1.0 );\n#endif\nbool frustumTest = all( frustumTestVec );\nif ( frustumTest ) {\nshadowCoord.z += shadowBias[ i ];\n#if defined( SHADOWMAP_TYPE_PCF )\nfloat shadow = 0.0;\nconst float shadowDelta = 1.0 / 9.0;\nfloat xPixelOffset = 1.0 / shadowMapSize[ i ].x;\nfloat yPixelOffset = 1.0 / shadowMapSize[ i ].y;\nfloat dx0 = -1.25 * xPixelOffset;\nfloat dy0 = -1.25 * yPixelOffset;\nfloat dx1 = 1.25 * xPixelOffset;\nfloat dy1 = 1.25 * yPixelOffset;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx0, dy0 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( 0.0, dy0 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx1, dy0 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx0, 0.0 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx1, 0.0 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx0, dy1 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( 0.0, dy1 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nfDepth = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx1, dy1 ) ) );\nif ( fDepth < shadowCoord.z ) shadow += shadowDelta;\nshadowColor = shadowColor * vec3( ( 1.0 - shadowDarkness[ i ] * shadow ) );\n#elif defined( SHADOWMAP_TYPE_PCF_SOFT )\nfloat shadow = 0.0;\nfloat xPixelOffset = 1.0 / shadowMapSize[ i ].x;\nfloat yPixelOffset = 1.0 / shadowMapSize[ i ].y;\nfloat dx0 = -1.0 * xPixelOffset;\nfloat dy0 = -1.0 * yPixelOffset;\nfloat dx1 = 1.0 * xPixelOffset;\nfloat dy1 = 1.0 * yPixelOffset;\nmat3 shadowKernel;\nmat3 depthKernel;\ndepthKernel[0][0] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx0, dy0 ) ) );\ndepthKernel[0][1] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx0, 0.0 ) ) );\ndepthKernel[0][2] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx0, dy1 ) ) );\ndepthKernel[1][0] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( 0.0, dy0 ) ) );\ndepthKernel[1][1] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy ) );\ndepthKernel[1][2] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( 0.0, dy1 ) ) );\ndepthKernel[2][0] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx1, dy0 ) ) );\ndepthKernel[2][1] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx1, 0.0 ) ) );\ndepthKernel[2][2] = unpackDepth( texture2D( shadowMap[ i ], shadowCoord.xy + vec2( dx1, dy1 ) ) );\nvec3 shadowZ = vec3( shadowCoord.z );\nshadowKernel[0] = vec3(lessThan(depthKernel[0], shadowZ ));\nshadowKernel[0] *= vec3(0.25);\nshadowKernel[1] = vec3(lessThan(depthKernel[1], shadowZ ));\nshadowKernel[1] *= vec3(0.25);\nshadowKernel[2] = vec3(lessThan(depthKernel[2], shadowZ ));\nshadowKernel[2] *= vec3(0.25);\nvec2 fractionalCoord = 1.0 - fract( shadowCoord.xy * shadowMapSize[i].xy );\nshadowKernel[0] = mix( shadowKernel[1], shadowKernel[0], fractionalCoord.x );\nshadowKernel[1] = mix( shadowKernel[2], shadowKernel[1], fractionalCoord.x );\nvec4 shadowValues;\nshadowValues.x = mix( shadowKernel[0][1], shadowKernel[0][0], fractionalCoord.y );\nshadowValues.y = mix( shadowKernel[0][2], shadowKernel[0][1], fractionalCoord.y );\nshadowValues.z = mix( shadowKernel[1][1], shadowKernel[1][0], fractionalCoord.y );\nshadowValues.w = mix( shadowKernel[1][2], shadowKernel[1][1], fractionalCoord.y );\nshadow = dot( shadowValues, vec4( 1.0 ) );\nshadowColor = shadowColor * vec3( ( 1.0 - shadowDarkness[ i ] * shadow ) );\n#else\nvec4 rgbaDepth = texture2D( shadowMap[ i ], shadowCoord.xy );\nfloat fDepth = unpackDepth( rgbaDepth );\nif ( fDepth < shadowCoord.z )\nshadowColor = shadowColor * vec3( 1.0 - shadowDarkness[ i ] );\n#endif\n}\n#ifdef SHADOWMAP_DEBUG\n#ifdef SHADOWMAP_CASCADE\nif ( inFrustum && inFrustumCount == 1 ) gl_FragColor.xyz *= frustumColors[ i ];\n#else\nif ( inFrustum ) gl_FragColor.xyz *= frustumColors[ i ];\n#endif\n#endif\n}\n#ifdef GAMMA_OUTPUT\nshadowColor *= shadowColor;\n#endif\ngl_FragColor.xyz = gl_FragColor.xyz * shadowColor;\n#endif", + shadowmap_pars_vertex:"#ifdef USE_SHADOWMAP\nvarying vec4 vShadowCoord[ MAX_SHADOWS ];\nuniform mat4 shadowMatrix[ MAX_SHADOWS ];\n#endif",shadowmap_vertex:"#ifdef USE_SHADOWMAP\nfor( int i = 0; i < MAX_SHADOWS; i ++ ) {\nvShadowCoord[ i ] = shadowMatrix[ i ] * worldPosition;\n}\n#endif",alphatest_fragment:"#ifdef ALPHATEST\nif ( gl_FragColor.a < ALPHATEST ) discard;\n#endif",linear_to_gamma_fragment:"#ifdef GAMMA_OUTPUT\ngl_FragColor.xyz = sqrt( gl_FragColor.xyz );\n#endif"}; + THREE.UniformsUtils={merge:function(a){var b,c,d,e={};for(b=0;b dashSize ) {\ndiscard;\n}\ngl_FragColor = vec4( diffuse, opacity );",THREE.ShaderChunk.color_fragment,THREE.ShaderChunk.fog_fragment,"}"].join("\n")},depth:{uniforms:{mNear:{type:"f",value:1},mFar:{type:"f",value:2E3},opacity:{type:"f", + value:1}},vertexShader:"void main() {\ngl_Position = projectionMatrix * modelViewMatrix * vec4( position, 1.0 );\n}",fragmentShader:"uniform float mNear;\nuniform float mFar;\nuniform float opacity;\nvoid main() {\nfloat depth = gl_FragCoord.z / gl_FragCoord.w;\nfloat color = 1.0 - smoothstep( mNear, mFar, depth );\ngl_FragColor = vec4( vec3( color ), opacity );\n}"},normal:{uniforms:{opacity:{type:"f",value:1}},vertexShader:["varying vec3 vNormal;",THREE.ShaderChunk.morphtarget_pars_vertex,"void main() {\nvNormal = normalize( normalMatrix * normal );", + THREE.ShaderChunk.morphtarget_vertex,THREE.ShaderChunk.default_vertex,"}"].join("\n"),fragmentShader:"uniform float opacity;\nvarying vec3 vNormal;\nvoid main() {\ngl_FragColor = vec4( 0.5 * normalize( vNormal ) + 0.5, opacity );\n}"},normalmap:{uniforms:THREE.UniformsUtils.merge([THREE.UniformsLib.fog,THREE.UniformsLib.lights,THREE.UniformsLib.shadowmap,{enableAO:{type:"i",value:0},enableDiffuse:{type:"i",value:0},enableSpecular:{type:"i",value:0},enableReflection:{type:"i",value:0},enableDisplacement:{type:"i", + value:0},tDisplacement:{type:"t",value:null},tDiffuse:{type:"t",value:null},tCube:{type:"t",value:null},tNormal:{type:"t",value:null},tSpecular:{type:"t",value:null},tAO:{type:"t",value:null},uNormalScale:{type:"v2",value:new THREE.Vector2(1,1)},uDisplacementBias:{type:"f",value:0},uDisplacementScale:{type:"f",value:1},uDiffuseColor:{type:"c",value:new THREE.Color(16777215)},uSpecularColor:{type:"c",value:new THREE.Color(1118481)},uAmbientColor:{type:"c",value:new THREE.Color(16777215)},uShininess:{type:"f", + value:30},uOpacity:{type:"f",value:1},useRefract:{type:"i",value:0},uRefractionRatio:{type:"f",value:0.98},uReflectivity:{type:"f",value:0.5},uOffset:{type:"v2",value:new THREE.Vector2(0,0)},uRepeat:{type:"v2",value:new THREE.Vector2(1,1)},wrapRGB:{type:"v3",value:new THREE.Vector3(1,1,1)}}]),fragmentShader:["uniform vec3 uAmbientColor;\nuniform vec3 uDiffuseColor;\nuniform vec3 uSpecularColor;\nuniform float uShininess;\nuniform float uOpacity;\nuniform bool enableDiffuse;\nuniform bool enableSpecular;\nuniform bool enableAO;\nuniform bool enableReflection;\nuniform sampler2D tDiffuse;\nuniform sampler2D tNormal;\nuniform sampler2D tSpecular;\nuniform sampler2D tAO;\nuniform samplerCube tCube;\nuniform vec2 uNormalScale;\nuniform bool useRefract;\nuniform float uRefractionRatio;\nuniform float uReflectivity;\nvarying vec3 vTangent;\nvarying vec3 vBinormal;\nvarying vec3 vNormal;\nvarying vec2 vUv;\nuniform vec3 ambientLightColor;\n#if MAX_DIR_LIGHTS > 0\nuniform vec3 directionalLightColor[ MAX_DIR_LIGHTS ];\nuniform vec3 directionalLightDirection[ MAX_DIR_LIGHTS ];\n#endif\n#if MAX_HEMI_LIGHTS > 0\nuniform vec3 hemisphereLightSkyColor[ MAX_HEMI_LIGHTS ];\nuniform vec3 hemisphereLightGroundColor[ MAX_HEMI_LIGHTS ];\nuniform vec3 hemisphereLightDirection[ MAX_HEMI_LIGHTS ];\n#endif\n#if MAX_POINT_LIGHTS > 0\nuniform vec3 pointLightColor[ MAX_POINT_LIGHTS ];\nuniform vec3 pointLightPosition[ MAX_POINT_LIGHTS ];\nuniform float pointLightDistance[ MAX_POINT_LIGHTS ];\n#endif\n#if MAX_SPOT_LIGHTS > 0\nuniform vec3 spotLightColor[ MAX_SPOT_LIGHTS ];\nuniform vec3 spotLightPosition[ MAX_SPOT_LIGHTS ];\nuniform vec3 spotLightDirection[ MAX_SPOT_LIGHTS ];\nuniform float spotLightAngleCos[ MAX_SPOT_LIGHTS ];\nuniform float spotLightExponent[ MAX_SPOT_LIGHTS ];\nuniform float spotLightDistance[ MAX_SPOT_LIGHTS ];\n#endif\n#ifdef WRAP_AROUND\nuniform vec3 wrapRGB;\n#endif\nvarying vec3 vWorldPosition;\nvarying vec3 vViewPosition;", + THREE.ShaderChunk.shadowmap_pars_fragment,THREE.ShaderChunk.fog_pars_fragment,"void main() {\ngl_FragColor = vec4( vec3( 1.0 ), uOpacity );\nvec3 specularTex = vec3( 1.0 );\nvec3 normalTex = texture2D( tNormal, vUv ).xyz * 2.0 - 1.0;\nnormalTex.xy *= uNormalScale;\nnormalTex = normalize( normalTex );\nif( enableDiffuse ) {\n#ifdef GAMMA_INPUT\nvec4 texelColor = texture2D( tDiffuse, vUv );\ntexelColor.xyz *= texelColor.xyz;\ngl_FragColor = gl_FragColor * texelColor;\n#else\ngl_FragColor = gl_FragColor * texture2D( tDiffuse, vUv );\n#endif\n}\nif( enableAO ) {\n#ifdef GAMMA_INPUT\nvec4 aoColor = texture2D( tAO, vUv );\naoColor.xyz *= aoColor.xyz;\ngl_FragColor.xyz = gl_FragColor.xyz * aoColor.xyz;\n#else\ngl_FragColor.xyz = gl_FragColor.xyz * texture2D( tAO, vUv ).xyz;\n#endif\n}\nif( enableSpecular )\nspecularTex = texture2D( tSpecular, vUv ).xyz;\nmat3 tsb = mat3( normalize( vTangent ), normalize( vBinormal ), normalize( vNormal ) );\nvec3 finalNormal = tsb * normalTex;\n#ifdef FLIP_SIDED\nfinalNormal = -finalNormal;\n#endif\nvec3 normal = normalize( finalNormal );\nvec3 viewPosition = normalize( vViewPosition );\n#if MAX_POINT_LIGHTS > 0\nvec3 pointDiffuse = vec3( 0.0 );\nvec3 pointSpecular = vec3( 0.0 );\nfor ( int i = 0; i < MAX_POINT_LIGHTS; i ++ ) {\nvec4 lPosition = viewMatrix * vec4( pointLightPosition[ i ], 1.0 );\nvec3 pointVector = lPosition.xyz + vViewPosition.xyz;\nfloat pointDistance = 1.0;\nif ( pointLightDistance[ i ] > 0.0 )\npointDistance = 1.0 - min( ( length( pointVector ) / pointLightDistance[ i ] ), 1.0 );\npointVector = normalize( pointVector );\n#ifdef WRAP_AROUND\nfloat pointDiffuseWeightFull = max( dot( normal, pointVector ), 0.0 );\nfloat pointDiffuseWeightHalf = max( 0.5 * dot( normal, pointVector ) + 0.5, 0.0 );\nvec3 pointDiffuseWeight = mix( vec3 ( pointDiffuseWeightFull ), vec3( pointDiffuseWeightHalf ), wrapRGB );\n#else\nfloat pointDiffuseWeight = max( dot( normal, pointVector ), 0.0 );\n#endif\npointDiffuse += pointDistance * pointLightColor[ i ] * uDiffuseColor * pointDiffuseWeight;\nvec3 pointHalfVector = normalize( pointVector + viewPosition );\nfloat pointDotNormalHalf = max( dot( normal, pointHalfVector ), 0.0 );\nfloat pointSpecularWeight = specularTex.r * max( pow( pointDotNormalHalf, uShininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat specularNormalization = ( uShininess + 2.0001 ) / 8.0;\nvec3 schlick = uSpecularColor + vec3( 1.0 - uSpecularColor ) * pow( 1.0 - dot( pointVector, pointHalfVector ), 5.0 );\npointSpecular += schlick * pointLightColor[ i ] * pointSpecularWeight * pointDiffuseWeight * pointDistance * specularNormalization;\n#else\npointSpecular += pointDistance * pointLightColor[ i ] * uSpecularColor * pointSpecularWeight * pointDiffuseWeight;\n#endif\n}\n#endif\n#if MAX_SPOT_LIGHTS > 0\nvec3 spotDiffuse = vec3( 0.0 );\nvec3 spotSpecular = vec3( 0.0 );\nfor ( int i = 0; i < MAX_SPOT_LIGHTS; i ++ ) {\nvec4 lPosition = viewMatrix * vec4( spotLightPosition[ i ], 1.0 );\nvec3 spotVector = lPosition.xyz + vViewPosition.xyz;\nfloat spotDistance = 1.0;\nif ( spotLightDistance[ i ] > 0.0 )\nspotDistance = 1.0 - min( ( length( spotVector ) / spotLightDistance[ i ] ), 1.0 );\nspotVector = normalize( spotVector );\nfloat spotEffect = dot( spotLightDirection[ i ], normalize( spotLightPosition[ i ] - vWorldPosition ) );\nif ( spotEffect > spotLightAngleCos[ i ] ) {\nspotEffect = max( pow( spotEffect, spotLightExponent[ i ] ), 0.0 );\n#ifdef WRAP_AROUND\nfloat spotDiffuseWeightFull = max( dot( normal, spotVector ), 0.0 );\nfloat spotDiffuseWeightHalf = max( 0.5 * dot( normal, spotVector ) + 0.5, 0.0 );\nvec3 spotDiffuseWeight = mix( vec3 ( spotDiffuseWeightFull ), vec3( spotDiffuseWeightHalf ), wrapRGB );\n#else\nfloat spotDiffuseWeight = max( dot( normal, spotVector ), 0.0 );\n#endif\nspotDiffuse += spotDistance * spotLightColor[ i ] * uDiffuseColor * spotDiffuseWeight * spotEffect;\nvec3 spotHalfVector = normalize( spotVector + viewPosition );\nfloat spotDotNormalHalf = max( dot( normal, spotHalfVector ), 0.0 );\nfloat spotSpecularWeight = specularTex.r * max( pow( spotDotNormalHalf, uShininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat specularNormalization = ( uShininess + 2.0001 ) / 8.0;\nvec3 schlick = uSpecularColor + vec3( 1.0 - uSpecularColor ) * pow( 1.0 - dot( spotVector, spotHalfVector ), 5.0 );\nspotSpecular += schlick * spotLightColor[ i ] * spotSpecularWeight * spotDiffuseWeight * spotDistance * specularNormalization * spotEffect;\n#else\nspotSpecular += spotDistance * spotLightColor[ i ] * uSpecularColor * spotSpecularWeight * spotDiffuseWeight * spotEffect;\n#endif\n}\n}\n#endif\n#if MAX_DIR_LIGHTS > 0\nvec3 dirDiffuse = vec3( 0.0 );\nvec3 dirSpecular = vec3( 0.0 );\nfor( int i = 0; i < MAX_DIR_LIGHTS; i++ ) {\nvec4 lDirection = viewMatrix * vec4( directionalLightDirection[ i ], 0.0 );\nvec3 dirVector = normalize( lDirection.xyz );\n#ifdef WRAP_AROUND\nfloat directionalLightWeightingFull = max( dot( normal, dirVector ), 0.0 );\nfloat directionalLightWeightingHalf = max( 0.5 * dot( normal, dirVector ) + 0.5, 0.0 );\nvec3 dirDiffuseWeight = mix( vec3( directionalLightWeightingFull ), vec3( directionalLightWeightingHalf ), wrapRGB );\n#else\nfloat dirDiffuseWeight = max( dot( normal, dirVector ), 0.0 );\n#endif\ndirDiffuse += directionalLightColor[ i ] * uDiffuseColor * dirDiffuseWeight;\nvec3 dirHalfVector = normalize( dirVector + viewPosition );\nfloat dirDotNormalHalf = max( dot( normal, dirHalfVector ), 0.0 );\nfloat dirSpecularWeight = specularTex.r * max( pow( dirDotNormalHalf, uShininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat specularNormalization = ( uShininess + 2.0001 ) / 8.0;\nvec3 schlick = uSpecularColor + vec3( 1.0 - uSpecularColor ) * pow( 1.0 - dot( dirVector, dirHalfVector ), 5.0 );\ndirSpecular += schlick * directionalLightColor[ i ] * dirSpecularWeight * dirDiffuseWeight * specularNormalization;\n#else\ndirSpecular += directionalLightColor[ i ] * uSpecularColor * dirSpecularWeight * dirDiffuseWeight;\n#endif\n}\n#endif\n#if MAX_HEMI_LIGHTS > 0\nvec3 hemiDiffuse = vec3( 0.0 );\nvec3 hemiSpecular = vec3( 0.0 );\nfor( int i = 0; i < MAX_HEMI_LIGHTS; i ++ ) {\nvec4 lDirection = viewMatrix * vec4( hemisphereLightDirection[ i ], 0.0 );\nvec3 lVector = normalize( lDirection.xyz );\nfloat dotProduct = dot( normal, lVector );\nfloat hemiDiffuseWeight = 0.5 * dotProduct + 0.5;\nvec3 hemiColor = mix( hemisphereLightGroundColor[ i ], hemisphereLightSkyColor[ i ], hemiDiffuseWeight );\nhemiDiffuse += uDiffuseColor * hemiColor;\nvec3 hemiHalfVectorSky = normalize( lVector + viewPosition );\nfloat hemiDotNormalHalfSky = 0.5 * dot( normal, hemiHalfVectorSky ) + 0.5;\nfloat hemiSpecularWeightSky = specularTex.r * max( pow( hemiDotNormalHalfSky, uShininess ), 0.0 );\nvec3 lVectorGround = -lVector;\nvec3 hemiHalfVectorGround = normalize( lVectorGround + viewPosition );\nfloat hemiDotNormalHalfGround = 0.5 * dot( normal, hemiHalfVectorGround ) + 0.5;\nfloat hemiSpecularWeightGround = specularTex.r * max( pow( hemiDotNormalHalfGround, uShininess ), 0.0 );\n#ifdef PHYSICALLY_BASED_SHADING\nfloat dotProductGround = dot( normal, lVectorGround );\nfloat specularNormalization = ( uShininess + 2.0001 ) / 8.0;\nvec3 schlickSky = uSpecularColor + vec3( 1.0 - uSpecularColor ) * pow( 1.0 - dot( lVector, hemiHalfVectorSky ), 5.0 );\nvec3 schlickGround = uSpecularColor + vec3( 1.0 - uSpecularColor ) * pow( 1.0 - dot( lVectorGround, hemiHalfVectorGround ), 5.0 );\nhemiSpecular += hemiColor * specularNormalization * ( schlickSky * hemiSpecularWeightSky * max( dotProduct, 0.0 ) + schlickGround * hemiSpecularWeightGround * max( dotProductGround, 0.0 ) );\n#else\nhemiSpecular += uSpecularColor * hemiColor * ( hemiSpecularWeightSky + hemiSpecularWeightGround ) * hemiDiffuseWeight;\n#endif\n}\n#endif\nvec3 totalDiffuse = vec3( 0.0 );\nvec3 totalSpecular = vec3( 0.0 );\n#if MAX_DIR_LIGHTS > 0\ntotalDiffuse += dirDiffuse;\ntotalSpecular += dirSpecular;\n#endif\n#if MAX_HEMI_LIGHTS > 0\ntotalDiffuse += hemiDiffuse;\ntotalSpecular += hemiSpecular;\n#endif\n#if MAX_POINT_LIGHTS > 0\ntotalDiffuse += pointDiffuse;\ntotalSpecular += pointSpecular;\n#endif\n#if MAX_SPOT_LIGHTS > 0\ntotalDiffuse += spotDiffuse;\ntotalSpecular += spotSpecular;\n#endif\n#ifdef METAL\ngl_FragColor.xyz = gl_FragColor.xyz * ( totalDiffuse + ambientLightColor * uAmbientColor + totalSpecular );\n#else\ngl_FragColor.xyz = gl_FragColor.xyz * ( totalDiffuse + ambientLightColor * uAmbientColor ) + totalSpecular;\n#endif\nif ( enableReflection ) {\nvec3 vReflect;\nvec3 cameraToVertex = normalize( vWorldPosition - cameraPosition );\nif ( useRefract ) {\nvReflect = refract( cameraToVertex, normal, uRefractionRatio );\n} else {\nvReflect = reflect( cameraToVertex, normal );\n}\nvec4 cubeColor = textureCube( tCube, vec3( -vReflect.x, vReflect.yz ) );\n#ifdef GAMMA_INPUT\ncubeColor.xyz *= cubeColor.xyz;\n#endif\ngl_FragColor.xyz = mix( gl_FragColor.xyz, cubeColor.xyz, specularTex.r * uReflectivity );\n}", + THREE.ShaderChunk.shadowmap_fragment,THREE.ShaderChunk.linear_to_gamma_fragment,THREE.ShaderChunk.fog_fragment,"}"].join("\n"),vertexShader:["attribute vec4 tangent;\nuniform vec2 uOffset;\nuniform vec2 uRepeat;\nuniform bool enableDisplacement;\n#ifdef VERTEX_TEXTURES\nuniform sampler2D tDisplacement;\nuniform float uDisplacementScale;\nuniform float uDisplacementBias;\n#endif\nvarying vec3 vTangent;\nvarying vec3 vBinormal;\nvarying vec3 vNormal;\nvarying vec2 vUv;\nvarying vec3 vWorldPosition;\nvarying vec3 vViewPosition;", + THREE.ShaderChunk.skinning_pars_vertex,THREE.ShaderChunk.shadowmap_pars_vertex,"void main() {",THREE.ShaderChunk.skinbase_vertex,THREE.ShaderChunk.skinnormal_vertex,"#ifdef USE_SKINNING\nvNormal = normalize( normalMatrix * skinnedNormal.xyz );\nvec4 skinnedTangent = skinMatrix * vec4( tangent.xyz, 0.0 );\nvTangent = normalize( normalMatrix * skinnedTangent.xyz );\n#else\nvNormal = normalize( normalMatrix * normal );\nvTangent = normalize( normalMatrix * tangent.xyz );\n#endif\nvBinormal = normalize( cross( vNormal, vTangent ) * tangent.w );\nvUv = uv * uRepeat + uOffset;\nvec3 displacedPosition;\n#ifdef VERTEX_TEXTURES\nif ( enableDisplacement ) {\nvec3 dv = texture2D( tDisplacement, uv ).xyz;\nfloat df = uDisplacementScale * dv.x + uDisplacementBias;\ndisplacedPosition = position + normalize( normal ) * df;\n} else {\n#ifdef USE_SKINNING\nvec4 skinVertex = vec4( position, 1.0 );\nvec4 skinned = boneMatX * skinVertex * skinWeight.x;\nskinned \t += boneMatY * skinVertex * skinWeight.y;\ndisplacedPosition = skinned.xyz;\n#else\ndisplacedPosition = position;\n#endif\n}\n#else\n#ifdef USE_SKINNING\nvec4 skinVertex = vec4( position, 1.0 );\nvec4 skinned = boneMatX * skinVertex * skinWeight.x;\nskinned \t += boneMatY * skinVertex * skinWeight.y;\ndisplacedPosition = skinned.xyz;\n#else\ndisplacedPosition = position;\n#endif\n#endif\nvec4 mvPosition = modelViewMatrix * vec4( displacedPosition, 1.0 );\nvec4 worldPosition = modelMatrix * vec4( displacedPosition, 1.0 );\ngl_Position = projectionMatrix * mvPosition;\nvWorldPosition = worldPosition.xyz;\nvViewPosition = -mvPosition.xyz;\n#ifdef USE_SHADOWMAP\nfor( int i = 0; i < MAX_SHADOWS; i ++ ) {\nvShadowCoord[ i ] = shadowMatrix[ i ] * worldPosition;\n}\n#endif\n}"].join("\n")}, + cube:{uniforms:{tCube:{type:"t",value:null},tFlip:{type:"f",value:-1}},vertexShader:"varying vec3 vWorldPosition;\nvoid main() {\nvec4 worldPosition = modelMatrix * vec4( position, 1.0 );\nvWorldPosition = worldPosition.xyz;\ngl_Position = projectionMatrix * modelViewMatrix * vec4( position, 1.0 );\n}",fragmentShader:"uniform samplerCube tCube;\nuniform float tFlip;\nvarying vec3 vWorldPosition;\nvoid main() {\ngl_FragColor = textureCube( tCube, vec3( tFlip * vWorldPosition.x, vWorldPosition.yz ) );\n}"}, + depthRGBA:{uniforms:{},vertexShader:[THREE.ShaderChunk.morphtarget_pars_vertex,THREE.ShaderChunk.skinning_pars_vertex,"void main() {",THREE.ShaderChunk.skinbase_vertex,THREE.ShaderChunk.morphtarget_vertex,THREE.ShaderChunk.skinning_vertex,THREE.ShaderChunk.default_vertex,"}"].join("\n"),fragmentShader:"vec4 pack_depth( const in float depth ) {\nconst vec4 bit_shift = vec4( 256.0 * 256.0 * 256.0, 256.0 * 256.0, 256.0, 1.0 );\nconst vec4 bit_mask = vec4( 0.0, 1.0 / 256.0, 1.0 / 256.0, 1.0 / 256.0 );\nvec4 res = fract( depth * bit_shift );\nres -= res.xxyz * bit_mask;\nreturn res;\n}\nvoid main() {\ngl_FragData[ 0 ] = pack_depth( gl_FragCoord.z );\n}"}};THREE.WebGLRenderer=function(a){function b(a,b){var c=a.vertices.length,d=b.material;if(d.attributes){void 0===a.__webglCustomAttributesList&&(a.__webglCustomAttributesList=[]);for(var e in d.attributes){var f=d.attributes[e];if(!f.__webglInitialized||f.createUniqueBuffers){f.__webglInitialized=!0;var h=1;"v2"===f.type?h=2:"v3"===f.type?h=3:"v4"===f.type?h=4:"c"===f.type&&(h=3);f.size=h;f.array=new Float32Array(c*h);f.buffer=j.createBuffer();f.buffer.belongsToAttribute=e;f.needsUpdate=!0}a.__webglCustomAttributesList.push(f)}}} + function c(a,b){var c=b.geometry,h=a.faces3,g=3*h.length,i=1*h.length,k=3*h.length,h=d(b,a),m=f(h),l=e(h),p=h.vertexColors?h.vertexColors:!1;a.__vertexArray=new Float32Array(3*g);l&&(a.__normalArray=new Float32Array(3*g));c.hasTangents&&(a.__tangentArray=new Float32Array(4*g));p&&(a.__colorArray=new Float32Array(3*g));m&&(0l;l++)K.autoScaleCubemaps&&!f?(p=k,q=l,t=c.image[l],w=ac,t.width<=w&&t.height<=w||(z=Math.max(t.width,t.height),u=Math.floor(t.width*w/z),w=Math.floor(t.height*w/z),z=document.createElement("canvas"),z.width=u,z.height=w,z.getContext("2d").drawImage(t,0,0,t.width,t.height,0,0,u,w),t=z),p[q]=t):k[l]=c.image[l];l=k[0];p=0===(l.width&l.width-1)&&0===(l.height&l.height-1);q=v(c.format);t=v(c.type);E(j.TEXTURE_CUBE_MAP, + c,p);for(l=0;6>l;l++)if(f){w=k[l].mipmaps;z=0;for(y=w.length;z=Mb&&console.warn("WebGLRenderer: trying to use "+a+" texture units while this GPU supports only "+Mb);P+=1;return a}function D(a,b,c,d){a[b]=c.r*c.r*d;a[b+1]=c.g*c.g*d;a[b+2]=c.b*c.b*d}function x(a,b,c,d){a[b]=c.r*d;a[b+1]=c.g*d;a[b+2]=c.b*d}function F(a){a!==xa&&(j.lineWidth(a),xa=a)}function A(a,b,c){Da!==a&&(a?j.enable(j.POLYGON_OFFSET_FILL):j.disable(j.POLYGON_OFFSET_FILL),Da=a); + if(a&&(Ua!==b||Qa!==c))j.polygonOffset(b,c),Ua=b,Qa=c}function O(a){for(var a=a.split("\n"),b=0,c=a.length;bb;b++)j.deleteFramebuffer(a.__webglFramebuffer[b]),j.deleteRenderbuffer(a.__webglRenderbuffer[b]); + else j.deleteFramebuffer(a.__webglFramebuffer),j.deleteRenderbuffer(a.__webglRenderbuffer);K.info.memory.textures--},Fb=function(a){a=a.target;a.removeEventListener("dispose",Fb);Gb(a)},Hb=function(a){void 0!==a.__webglVertexBuffer&&j.deleteBuffer(a.__webglVertexBuffer);void 0!==a.__webglNormalBuffer&&j.deleteBuffer(a.__webglNormalBuffer);void 0!==a.__webglTangentBuffer&&j.deleteBuffer(a.__webglTangentBuffer);void 0!==a.__webglColorBuffer&&j.deleteBuffer(a.__webglColorBuffer);void 0!==a.__webglUVBuffer&& + j.deleteBuffer(a.__webglUVBuffer);void 0!==a.__webglUV2Buffer&&j.deleteBuffer(a.__webglUV2Buffer);void 0!==a.__webglSkinIndicesBuffer&&j.deleteBuffer(a.__webglSkinIndicesBuffer);void 0!==a.__webglSkinWeightsBuffer&&j.deleteBuffer(a.__webglSkinWeightsBuffer);void 0!==a.__webglFaceBuffer&&j.deleteBuffer(a.__webglFaceBuffer);void 0!==a.__webglLineBuffer&&j.deleteBuffer(a.__webglLineBuffer);void 0!==a.__webglLineDistanceBuffer&&j.deleteBuffer(a.__webglLineDistanceBuffer);if(void 0!==a.__webglCustomAttributesList)for(var b in a.__webglCustomAttributesList)j.deleteBuffer(a.__webglCustomAttributesList[b].buffer); + K.info.memory.geometries--},Gb=function(a){var b=a.program;if(void 0!==b){a.program=void 0;var c,d,e=!1,a=0;for(c=ca.length;ad.numSupportedMorphTargets?(l.sort(k),l.length=d.numSupportedMorphTargets):l.length>d.numSupportedMorphNormals?l.sort(k):0===l.length&&l.push([0,0]);for(m=0;mCa;Ca++)Ga=R[Ca],Ma[hb]=Ga.x,Ma[hb+1]=Ga.y,Ma[hb+2]=Ga.z,hb+=3;else for(Ca=0;3>Ca;Ca++)Ma[hb]=U.x,Ma[hb+1]=U.y,Ma[hb+2]=U.z,hb+=3;j.bindBuffer(j.ARRAY_BUFFER,v.__webglNormalBuffer);j.bufferData(j.ARRAY_BUFFER,Ma,D)}if(yb&&Cb&&N){E=0;for(I=aa.length;ECa;Ca++)Ea=$[Ca],bb[Oa]=Ea.x,bb[Oa+1]=Ea.y,Oa+=2;0Ca;Ca++)La=Fa[Ca],cb[Pa]=La.x,cb[Pa+1]=La.y,Pa+=2;0f;f++){a.__webglFramebuffer[f]=j.createFramebuffer();a.__webglRenderbuffer[f]=j.createRenderbuffer();j.texImage2D(j.TEXTURE_CUBE_MAP_POSITIVE_X+f,0,d,a.width,a.height,0,d,e,null);var h=a,g=j.TEXTURE_CUBE_MAP_POSITIVE_X+f;j.bindFramebuffer(j.FRAMEBUFFER,a.__webglFramebuffer[f]);j.framebufferTexture2D(j.FRAMEBUFFER,j.COLOR_ATTACHMENT0,g,h.__webglTexture,0);I(a.__webglRenderbuffer[f],a)}c&&j.generateMipmap(j.TEXTURE_CUBE_MAP)}else a.__webglFramebuffer=j.createFramebuffer(),a.__webglRenderbuffer= + a.shareDepthFrom?a.shareDepthFrom.__webglRenderbuffer:j.createRenderbuffer(),j.bindTexture(j.TEXTURE_2D,a.__webglTexture),E(j.TEXTURE_2D,a,c),j.texImage2D(j.TEXTURE_2D,0,d,a.width,a.height,0,d,e,null),d=j.TEXTURE_2D,j.bindFramebuffer(j.FRAMEBUFFER,a.__webglFramebuffer),j.framebufferTexture2D(j.FRAMEBUFFER,j.COLOR_ATTACHMENT0,d,a.__webglTexture,0),a.shareDepthFrom?a.depthBuffer&&!a.stencilBuffer?j.framebufferRenderbuffer(j.FRAMEBUFFER,j.DEPTH_ATTACHMENT,j.RENDERBUFFER,a.__webglRenderbuffer):a.depthBuffer&& + a.stencilBuffer&&j.framebufferRenderbuffer(j.FRAMEBUFFER,j.DEPTH_STENCIL_ATTACHMENT,j.RENDERBUFFER,a.__webglRenderbuffer):I(a.__webglRenderbuffer,a),c&&j.generateMipmap(j.TEXTURE_2D);b?j.bindTexture(j.TEXTURE_CUBE_MAP,null):j.bindTexture(j.TEXTURE_2D,null);j.bindRenderbuffer(j.RENDERBUFFER,null);j.bindFramebuffer(j.FRAMEBUFFER,null)}a?(b=b?a.__webglFramebuffer[a.activeCubeFace]:a.__webglFramebuffer,c=a.width,a=a.height,e=d=0):(b=null,c=Ma,a=fb,d=bb,e=cb);b!==da&&(j.bindFramebuffer(j.FRAMEBUFFER,b), + j.viewport(d,e,c,a),da=b);sb=c;pb=a};this.shadowMapPlugin=new THREE.ShadowMapPlugin;this.addPrePlugin(this.shadowMapPlugin);this.addPostPlugin(new THREE.SpritePlugin);this.addPostPlugin(new THREE.LensFlarePlugin)};THREE.WebGLRenderTarget=function(a,b,c){this.width=a;this.height=b;c=c||{};this.wrapS=void 0!==c.wrapS?c.wrapS:THREE.ClampToEdgeWrapping;this.wrapT=void 0!==c.wrapT?c.wrapT:THREE.ClampToEdgeWrapping;this.magFilter=void 0!==c.magFilter?c.magFilter:THREE.LinearFilter;this.minFilter=void 0!==c.minFilter?c.minFilter:THREE.LinearMipMapLinearFilter;this.anisotropy=void 0!==c.anisotropy?c.anisotropy:1;this.offset=new THREE.Vector2(0,0);this.repeat=new THREE.Vector2(1,1);this.format=void 0!==c.format?c.format: + THREE.RGBAFormat;this.type=void 0!==c.type?c.type:THREE.UnsignedByteType;this.depthBuffer=void 0!==c.depthBuffer?c.depthBuffer:!0;this.stencilBuffer=void 0!==c.stencilBuffer?c.stencilBuffer:!0;this.generateMipmaps=!0;this.shareDepthFrom=null}; + THREE.WebGLRenderTarget.prototype={constructor:THREE.WebGLRenderTarget,clone:function(){var a=new THREE.WebGLRenderTarget(this.width,this.height);a.wrapS=this.wrapS;a.wrapT=this.wrapT;a.magFilter=this.magFilter;a.minFilter=this.minFilter;a.anisotropy=this.anisotropy;a.offset.copy(this.offset);a.repeat.copy(this.repeat);a.format=this.format;a.type=this.type;a.depthBuffer=this.depthBuffer;a.stencilBuffer=this.stencilBuffer;a.generateMipmaps=this.generateMipmaps;a.shareDepthFrom=this.shareDepthFrom; + return a},dispose:function(){this.dispatchEvent({type:"dispose"})}};THREE.EventDispatcher.prototype.apply(THREE.WebGLRenderTarget.prototype);THREE.WebGLRenderTargetCube=function(a,b,c){THREE.WebGLRenderTarget.call(this,a,b,c);this.activeCubeFace=0};THREE.WebGLRenderTargetCube.prototype=Object.create(THREE.WebGLRenderTarget.prototype);THREE.RenderableVertex=function(){this.positionWorld=new THREE.Vector3;this.positionScreen=new THREE.Vector4;this.visible=!0};THREE.RenderableVertex.prototype.copy=function(a){this.positionWorld.copy(a.positionWorld);this.positionScreen.copy(a.positionScreen)};THREE.RenderableFace3=function(){this.id=0;this.v1=new THREE.RenderableVertex;this.v2=new THREE.RenderableVertex;this.v3=new THREE.RenderableVertex;this.centroidModel=new THREE.Vector3;this.normalModel=new THREE.Vector3;this.normalModelView=new THREE.Vector3;this.vertexNormalsLength=0;this.vertexNormalsModel=[new THREE.Vector3,new THREE.Vector3,new THREE.Vector3];this.vertexNormalsModelView=[new THREE.Vector3,new THREE.Vector3,new THREE.Vector3];this.material=this.color=null;this.uvs=[[]];this.z= + 0};THREE.RenderableObject=function(){this.id=0;this.object=null;this.z=0};THREE.RenderableSprite=function(){this.id=0;this.object=null;this.rotation=this.z=this.y=this.x=0;this.scale=new THREE.Vector2;this.material=null};THREE.RenderableLine=function(){this.id=0;this.v1=new THREE.RenderableVertex;this.v2=new THREE.RenderableVertex;this.vertexColors=[new THREE.Color,new THREE.Color];this.material=null;this.z=0};THREE.GeometryUtils={merge:function(a,b,c){var d,e,f=a.vertices.length,h=b instanceof THREE.Mesh?b.geometry:b,g=a.vertices,i=h.vertices,k=a.faces,m=h.faces,a=a.faceVertexUvs[0],h=h.faceVertexUvs[0];void 0===c&&(c=0);b instanceof THREE.Mesh&&(b.matrixAutoUpdate&&b.updateMatrix(),d=b.matrix,e=(new THREE.Matrix3).getNormalMatrix(d));for(var b=0,l=i.length;ba?b(c,e-1):k[e]>8&255,i>>16&255,i>>24&255)),d}d.mipmapCount=1;g[2]&131072&&!1!==b&&(d.mipmapCount=Math.max(1,g[7]));d.isCubemap=g[28]&512?!0:!1;d.width=g[4];d.height=g[3];for(var g=g[1]+4,f=d.width,h=d.height,i=d.isCubemap?6:1,m=0;ml-1?0:l-1,s=l+1>e-1?e-1:l+1,t=0>m-1?0:m-1,n=m+1>d-1?d-1:m+1,r=[],q=[0,0,g[4*(l*d+m)]/255*b];r.push([-1,0,g[4*(l*d+t)]/255*b]);r.push([-1,-1,g[4*(p*d+t)]/255*b]);r.push([0,-1,g[4*(p*d+m)]/255*b]);r.push([1,-1,g[4*(p*d+n)]/255*b]);r.push([1,0,g[4*(l*d+n)]/255*b]);r.push([1,1,g[4*(s*d+n)]/255*b]);r.push([0,1,g[4*(s*d+m)]/255*b]);r.push([-1,1,g[4*(s*d+t)]/255*b]);p=[];t=r.length;for(s=0;se)return null;var f=[],h=[],g=[],i,k,m;if(0=l--){console.log("Warning, unable to triangulate polygon!");break}i=k;e<=i&&(i=0);k=i+1;e<=k&&(k=0);m=k+1;e<=m&&(m=0);var p;a:{var s=p=void 0,t=void 0,n=void 0,r=void 0,q=void 0,u=void 0,w=void 0,z= + void 0,s=a[h[i]].x,t=a[h[i]].y,n=a[h[k]].x,r=a[h[k]].y,q=a[h[m]].x,u=a[h[m]].y;if(1E-10>(n-s)*(u-t)-(r-t)*(q-s))p=!1;else{var B=void 0,D=void 0,x=void 0,F=void 0,A=void 0,O=void 0,C=void 0,E=void 0,I=void 0,y=void 0,I=E=C=z=w=void 0,B=q-n,D=u-r,x=s-q,F=t-u,A=n-s,O=r-t;for(p=0;pi)h=d+1;else if(0b&&(b=0);1=b)return b=c[a]-b,a=this.curves[a],b=1-b/a.getLength(),a.getPointAt(b);a++}return null};THREE.CurvePath.prototype.getLength=function(){var a=this.getCurveLengths();return a[a.length-1]}; + THREE.CurvePath.prototype.getCurveLengths=function(){if(this.cacheLengths&&this.cacheLengths.length==this.curves.length)return this.cacheLengths;var a=[],b=0,c,d=this.curves.length;for(c=0;cb?b=g.x:g.xc?c=g.y:g.yd?d=g.z:g.zMath.abs(d.x-c[0].x)&&1E-10>Math.abs(d.y-c[0].y)&&c.splice(c.length-1,1);b&&c.push(c[0]);return c}; + THREE.Path.prototype.toShapes=function(a){var b,c,d,e,f=[],h=new THREE.Path;b=0;for(c=this.actions.length;b + g&&(g+=c.length);g%=c.length;0>h&&(h+=k.length);h%=k.length;e=0<=g-1?g-1:c.length-1;f=0<=h-1?h-1:k.length-1;n=[k[h],c[g],c[e]];n=THREE.FontUtils.Triangulate.area(n);r=[k[h],k[f],c[g]];r=THREE.FontUtils.Triangulate.area(r);l+p>n+r&&(g=s,h=m,0>g&&(g+=c.length),g%=c.length,0>h&&(h+=k.length),h%=k.length,e=0<=g-1?g-1:c.length-1,f=0<=h-1?h-1:k.length-1);l=c.slice(0,g);p=c.slice(g);s=k.slice(h);m=k.slice(0,h);f=[k[h],k[f],c[g]];t.push([k[h],c[g],c[e]]);t.push(f);c=l.concat(s).concat(m).concat(p)}return{shape:c, + isolatedPts:t,allpoints:d}},triangulateShape:function(a,b){var c=THREE.Shape.Utils.removeHoles(a,b),d=c.allpoints,e=c.isolatedPts,c=THREE.FontUtils.Triangulate(c.shape,!1),f,h,g,i,k={};f=0;for(h=d.length;fd;d++)i=g[d].x+":"+g[d].y,i=k[i],void 0!==i&&(g[d]=i)}f=0;for(h=e.length;fd;d++)i=g[d].x+":"+g[d].y,i=k[i],void 0!==i&&(g[d]=i)}return c.concat(e)}, + isClockWise:function(a){return 0>THREE.FontUtils.Triangulate.area(a)},b2p0:function(a,b){var c=1-a;return c*c*b},b2p1:function(a,b){return 2*(1-a)*a*b},b2p2:function(a,b){return a*a*b},b2:function(a,b,c,d){return this.b2p0(a,b)+this.b2p1(a,c)+this.b2p2(a,d)},b3p0:function(a,b){var c=1-a;return c*c*c*b},b3p1:function(a,b){var c=1-a;return 3*c*c*a*b},b3p2:function(a,b){return 3*(1-a)*a*a*b},b3p3:function(a,b){return a*a*a*b},b3:function(a,b,c,d,e){return this.b3p0(a,b)+this.b3p1(a,c)+this.b3p2(a,d)+ + this.b3p3(a,e)}};THREE.LineCurve=function(a,b){this.v1=a;this.v2=b};THREE.LineCurve.prototype=Object.create(THREE.Curve.prototype);THREE.LineCurve.prototype.getPoint=function(a){var b=this.v2.clone().sub(this.v1);b.multiplyScalar(a).add(this.v1);return b};THREE.LineCurve.prototype.getPointAt=function(a){return this.getPoint(a)};THREE.LineCurve.prototype.getTangent=function(){return this.v2.clone().sub(this.v1).normalize()};THREE.QuadraticBezierCurve=function(a,b,c){this.v0=a;this.v1=b;this.v2=c};THREE.QuadraticBezierCurve.prototype=Object.create(THREE.Curve.prototype);THREE.QuadraticBezierCurve.prototype.getPoint=function(a){var b;b=THREE.Shape.Utils.b2(a,this.v0.x,this.v1.x,this.v2.x);a=THREE.Shape.Utils.b2(a,this.v0.y,this.v1.y,this.v2.y);return new THREE.Vector2(b,a)}; + THREE.QuadraticBezierCurve.prototype.getTangent=function(a){var b;b=THREE.Curve.Utils.tangentQuadraticBezier(a,this.v0.x,this.v1.x,this.v2.x);a=THREE.Curve.Utils.tangentQuadraticBezier(a,this.v0.y,this.v1.y,this.v2.y);b=new THREE.Vector2(b,a);b.normalize();return b};THREE.CubicBezierCurve=function(a,b,c,d){this.v0=a;this.v1=b;this.v2=c;this.v3=d};THREE.CubicBezierCurve.prototype=Object.create(THREE.Curve.prototype);THREE.CubicBezierCurve.prototype.getPoint=function(a){var b;b=THREE.Shape.Utils.b3(a,this.v0.x,this.v1.x,this.v2.x,this.v3.x);a=THREE.Shape.Utils.b3(a,this.v0.y,this.v1.y,this.v2.y,this.v3.y);return new THREE.Vector2(b,a)}; + THREE.CubicBezierCurve.prototype.getTangent=function(a){var b;b=THREE.Curve.Utils.tangentCubicBezier(a,this.v0.x,this.v1.x,this.v2.x,this.v3.x);a=THREE.Curve.Utils.tangentCubicBezier(a,this.v0.y,this.v1.y,this.v2.y,this.v3.y);b=new THREE.Vector2(b,a);b.normalize();return b};THREE.SplineCurve=function(a){this.points=void 0==a?[]:a};THREE.SplineCurve.prototype=Object.create(THREE.Curve.prototype);THREE.SplineCurve.prototype.getPoint=function(a){var b=new THREE.Vector2,c=[],d=this.points,e;e=(d.length-1)*a;a=Math.floor(e);e-=a;c[0]=0==a?a:a-1;c[1]=a;c[2]=a>d.length-2?d.length-1:a+1;c[3]=a>d.length-3?d.length-1:a+2;b.x=THREE.Curve.Utils.interpolate(d[c[0]].x,d[c[1]].x,d[c[2]].x,d[c[3]].x,e);b.y=THREE.Curve.Utils.interpolate(d[c[0]].y,d[c[1]].y,d[c[2]].y,d[c[3]].y,e);return b};THREE.EllipseCurve=function(a,b,c,d,e,f,h){this.aX=a;this.aY=b;this.xRadius=c;this.yRadius=d;this.aStartAngle=e;this.aEndAngle=f;this.aClockwise=h};THREE.EllipseCurve.prototype=Object.create(THREE.Curve.prototype); + THREE.EllipseCurve.prototype.getPoint=function(a){var b;b=this.aEndAngle-this.aStartAngle;0>b&&(b+=2*Math.PI);b>2*Math.PI&&(b-=2*Math.PI);b=!0===this.aClockwise?this.aEndAngle+(1-a)*(2*Math.PI-b):this.aStartAngle+a*b;a=this.aX+this.xRadius*Math.cos(b);b=this.aY+this.yRadius*Math.sin(b);return new THREE.Vector2(a,b)};THREE.ArcCurve=function(a,b,c,d,e,f){THREE.EllipseCurve.call(this,a,b,c,c,d,e,f)};THREE.ArcCurve.prototype=Object.create(THREE.EllipseCurve.prototype);THREE.LineCurve3=THREE.Curve.create(function(a,b){this.v1=a;this.v2=b},function(a){var b=new THREE.Vector3;b.subVectors(this.v2,this.v1);b.multiplyScalar(a);b.add(this.v1);return b});THREE.QuadraticBezierCurve3=THREE.Curve.create(function(a,b,c){this.v0=a;this.v1=b;this.v2=c},function(a){var b,c;b=THREE.Shape.Utils.b2(a,this.v0.x,this.v1.x,this.v2.x);c=THREE.Shape.Utils.b2(a,this.v0.y,this.v1.y,this.v2.y);a=THREE.Shape.Utils.b2(a,this.v0.z,this.v1.z,this.v2.z);return new THREE.Vector3(b,c,a)});THREE.CubicBezierCurve3=THREE.Curve.create(function(a,b,c,d){this.v0=a;this.v1=b;this.v2=c;this.v3=d},function(a){var b,c;b=THREE.Shape.Utils.b3(a,this.v0.x,this.v1.x,this.v2.x,this.v3.x);c=THREE.Shape.Utils.b3(a,this.v0.y,this.v1.y,this.v2.y,this.v3.y);a=THREE.Shape.Utils.b3(a,this.v0.z,this.v1.z,this.v2.z,this.v3.z);return new THREE.Vector3(b,c,a)});THREE.SplineCurve3=THREE.Curve.create(function(a){this.points=void 0==a?[]:a},function(a){var b=new THREE.Vector3,c=[],d=this.points,e,a=(d.length-1)*a;e=Math.floor(a);a-=e;c[0]=0==e?e:e-1;c[1]=e;c[2]=e>d.length-2?d.length-1:e+1;c[3]=e>d.length-3?d.length-1:e+2;e=d[c[0]];var f=d[c[1]],h=d[c[2]],c=d[c[3]];b.x=THREE.Curve.Utils.interpolate(e.x,f.x,h.x,c.x,a);b.y=THREE.Curve.Utils.interpolate(e.y,f.y,h.y,c.y,a);b.z=THREE.Curve.Utils.interpolate(e.z,f.z,h.z,c.z,a);return b});THREE.ClosedSplineCurve3=THREE.Curve.create(function(a){this.points=void 0==a?[]:a},function(a){var b=new THREE.Vector3,c=[],d=this.points,e;e=(d.length-0)*a;a=Math.floor(e);e-=a;a+=0a.hierarchy[c].keys[d].time&& + (a.hierarchy[c].keys[d].time=0),void 0!==a.hierarchy[c].keys[d].rot&&!(a.hierarchy[c].keys[d].rot instanceof THREE.Quaternion)){var g=a.hierarchy[c].keys[d].rot;a.hierarchy[c].keys[d].rot=new THREE.Quaternion(g[0],g[1],g[2],g[3])}if(a.hierarchy[c].keys.length&&void 0!==a.hierarchy[c].keys[0].morphTargets){g={};for(d=0;ds;s++){c=b[s];h=i.prevKey[c];g=i.nextKey[c];if(g.time<=m){if(kd||1d?0:1;if("pos"===c)if(c=a.position,this.interpolationType===THREE.AnimationHandler.LINEAR)c.x=e[0]+(f[0]-e[0])*d,c.y=e[1]+(f[1]-e[1])*d,c.z=e[2]+ + (f[2]-e[2])*d;else{if(this.interpolationType===THREE.AnimationHandler.CATMULLROM||this.interpolationType===THREE.AnimationHandler.CATMULLROM_FORWARD)this.points[0]=this.getPrevKeyWith("pos",l,h.index-1).pos,this.points[1]=e,this.points[2]=f,this.points[3]=this.getNextKeyWith("pos",l,g.index+1).pos,d=0.33*d+0.33,e=this.interpolateCatmullRom(this.points,d),c.x=e[0],c.y=e[1],c.z=e[2],this.interpolationType===THREE.AnimationHandler.CATMULLROM_FORWARD&&(d=this.interpolateCatmullRom(this.points,1.01*d), + this.target.set(d[0],d[1],d[2]),this.target.sub(c),this.target.y=0,this.target.normalize(),d=Math.atan2(this.target.x,this.target.z),a.rotation.set(0,d,0))}else"rot"===c?THREE.Quaternion.slerp(e,f,a.quaternion,d):"scl"===c&&(c=a.scale,c.x=e[0]+(f[0]-e[0])*d,c.y=e[1]+(f[1]-e[1])*d,c.z=e[2]+(f[2]-e[2])*d)}}}}; + THREE.Animation.prototype.interpolateCatmullRom=function(a,b){var c=[],d=[],e,f,h,g,i,k;e=(a.length-1)*b;f=Math.floor(e);e-=f;c[0]=0===f?f:f-1;c[1]=f;c[2]=f>a.length-2?f:f+1;c[3]=f>a.length-3?f:f+2;f=a[c[0]];g=a[c[1]];i=a[c[2]];k=a[c[3]];c=e*e;h=e*c;d[0]=this.interpolate(f[0],g[0],i[0],k[0],e,c,h);d[1]=this.interpolate(f[1],g[1],i[1],k[1],e,c,h);d[2]=this.interpolate(f[2],g[2],i[2],k[2],e,c,h);return d}; + THREE.Animation.prototype.interpolate=function(a,b,c,d,e,f,h){a=0.5*(c-a);d=0.5*(d-b);return(2*(b-c)+a+d)*h+(-3*(b-c)-2*a-d)*f+a*e+b};THREE.Animation.prototype.getNextKeyWith=function(a,b,c){for(var d=this.data.hierarchy[b].keys,c=this.interpolationType===THREE.AnimationHandler.CATMULLROM||this.interpolationType===THREE.AnimationHandler.CATMULLROM_FORWARD?c=h?b.interpolate(c,h):b.interpolate(c,c.time)}this.data.hierarchy[a].node.updateMatrix();d.matrixWorldNeedsUpdate=!0}}if(this.JITCompile&&void 0===f[0][e]){this.hierarchy[0].updateMatrixWorld(!0);for(a=0;ag?(b=Math.atan2(b.y-a.y,b.x-a.x),a=Math.atan2(c.y-a.y,c.x-a.x),b>a&&(a+=2*Math.PI),c=(b+a)/2,a=-Math.cos(c),c=-Math.sin(c),new THREE.Vector2(a,c)):d.multiplyScalar(g).add(h).sub(a).clone()}function e(c,d){var e,f;for(N=c.length;0<=--N;){e=N;f=N-1;0>f&&(f=c.length-1);for(var g=0,h=s+2*m, + g=0;gMath.abs(c-i)?[new THREE.Vector2(b,1-e),new THREE.Vector2(d,1-f),new THREE.Vector2(k,1-h),new THREE.Vector2(l,1-a)]:[new THREE.Vector2(c,1-e),new THREE.Vector2(i,1-f),new THREE.Vector2(m,1-h),new THREE.Vector2(p,1-a)]}};THREE.ExtrudeGeometry.__v1=new THREE.Vector2;THREE.ExtrudeGeometry.__v2=new THREE.Vector2;THREE.ExtrudeGeometry.__v3=new THREE.Vector2;THREE.ExtrudeGeometry.__v4=new THREE.Vector2; + THREE.ExtrudeGeometry.__v5=new THREE.Vector2;THREE.ExtrudeGeometry.__v6=new THREE.Vector2;THREE.ShapeGeometry=function(a,b){THREE.Geometry.call(this);!1===a instanceof Array&&(a=[a]);this.shapebb=a[a.length-1].getBoundingBox();this.addShapeList(a,b);this.computeCentroids();this.computeFaceNormals()};THREE.ShapeGeometry.prototype=Object.create(THREE.Geometry.prototype);THREE.ShapeGeometry.prototype.addShapeList=function(a,b){for(var c=0,d=a.length;cc&&1===a.x&&(a=new THREE.Vector2(a.x-1,a.y));0===b.x&&0===b.z&&(a=new THREE.Vector2(c/2/Math.PI+0.5,a.y));return a.clone()}THREE.Geometry.call(this);for(var c=c||1,d=d||0,g=this,i=0,k=a.length;ip&&(0.2>a&&(d[0].x+=1),0.2>b&&(d[1].x+=1),0.2>m&&(d[2].x+=1));i=0;for(k=this.vertices.length;ic.y?this.quaternion.set(1,0,0,0):(a.set(c.z,0,-c.x).normalize(),b=Math.acos(c.y),this.quaternion.setFromAxisAngle(a,b))}}();THREE.ArrowHelper.prototype.setLength=function(a){this.scale.set(a,a,a)}; + THREE.ArrowHelper.prototype.setColor=function(a){this.line.material.color.setHex(a);this.cone.material.color.setHex(a)};THREE.BoxHelper=function(a){var b=[new THREE.Vector3(1,1,1),new THREE.Vector3(-1,1,1),new THREE.Vector3(-1,-1,1),new THREE.Vector3(1,-1,1),new THREE.Vector3(1,1,-1),new THREE.Vector3(-1,1,-1),new THREE.Vector3(-1,-1,-1),new THREE.Vector3(1,-1,-1)];this.vertices=b;var c=new THREE.Geometry;c.vertices.push(b[0],b[1],b[1],b[2],b[2],b[3],b[3],b[0],b[4],b[5],b[5],b[6],b[6],b[7],b[7],b[4],b[0],b[4],b[1],b[5],b[2],b[6],b[3],b[7]);THREE.Line.call(this,c,new THREE.LineBasicMaterial({color:16776960}),THREE.LinePieces); + void 0!==a&&this.update(a)};THREE.BoxHelper.prototype=Object.create(THREE.Line.prototype); + THREE.BoxHelper.prototype.update=function(a){var b=a.geometry;null===b.boundingBox&&b.computeBoundingBox();var c=b.boundingBox.min,b=b.boundingBox.max,d=this.vertices;d[0].set(b.x,b.y,b.z);d[1].set(c.x,b.y,b.z);d[2].set(c.x,c.y,b.z);d[3].set(b.x,c.y,b.z);d[4].set(b.x,b.y,c.z);d[5].set(c.x,b.y,c.z);d[6].set(c.x,c.y,c.z);d[7].set(b.x,c.y,c.z);this.geometry.computeBoundingSphere();this.geometry.verticesNeedUpdate=!0;this.matrixAutoUpdate=!1;this.matrixWorld=a.matrixWorld};THREE.BoundingBoxHelper=function(a,b){var c=b||8947848;this.object=a;this.box=new THREE.Box3;THREE.Mesh.call(this,new THREE.CubeGeometry(1,1,1),new THREE.MeshBasicMaterial({color:c,wireframe:!0}))};THREE.BoundingBoxHelper.prototype=Object.create(THREE.Mesh.prototype);THREE.BoundingBoxHelper.prototype.update=function(){this.box.setFromObject(this.object);this.box.size(this.scale);this.box.center(this.position)};THREE.CameraHelper=function(a){function b(a,b,d){c(a,d);c(b,d)}function c(a,b){d.vertices.push(new THREE.Vector3);d.colors.push(new THREE.Color(b));void 0===f[a]&&(f[a]=[]);f[a].push(d.vertices.length-1)}var d=new THREE.Geometry,e=new THREE.LineBasicMaterial({color:16777215,vertexColors:THREE.FaceColors}),f={};b("n1","n2",16755200);b("n2","n4",16755200);b("n4","n3",16755200);b("n3","n1",16755200);b("f1","f2",16755200);b("f2","f4",16755200);b("f4","f3",16755200);b("f3","f1",16755200);b("n1","f1",16755200); + b("n2","f2",16755200);b("n3","f3",16755200);b("n4","f4",16755200);b("p","n1",16711680);b("p","n2",16711680);b("p","n3",16711680);b("p","n4",16711680);b("u1","u2",43775);b("u2","u3",43775);b("u3","u1",43775);b("c","t",16777215);b("p","c",3355443);b("cn1","cn2",3355443);b("cn3","cn4",3355443);b("cf1","cf2",3355443);b("cf3","cf4",3355443);THREE.Line.call(this,d,e,THREE.LinePieces);this.camera=a;this.matrixWorld=a.matrixWorld;this.matrixAutoUpdate=!1;this.pointMap=f;this.update()}; + THREE.CameraHelper.prototype=Object.create(THREE.Line.prototype); + THREE.CameraHelper.prototype.update=function(){var a=new THREE.Vector3,b=new THREE.Camera,c=new THREE.Projector;return function(){function d(d,h,g,i){a.set(h,g,i);c.unprojectVector(a,b);d=e.pointMap[d];if(void 0!==d){h=0;for(g=d.length;hd;d++)c.faces[d].color=this.colors[4>d?0:1];d=new THREE.MeshBasicMaterial({vertexColors:THREE.FaceColors,wireframe:!0});this.lightSphere=new THREE.Mesh(c,d);this.add(this.lightSphere); + this.update()};THREE.HemisphereLightHelper.prototype=Object.create(THREE.Object3D.prototype);THREE.HemisphereLightHelper.prototype.dispose=function(){this.lightSphere.geometry.dispose();this.lightSphere.material.dispose()}; + THREE.HemisphereLightHelper.prototype.update=function(){var a=new THREE.Vector3;return function(){this.colors[0].copy(this.light.color).multiplyScalar(this.light.intensity);this.colors[1].copy(this.light.groundColor).multiplyScalar(this.light.intensity);this.lightSphere.lookAt(a.getPositionFromMatrix(this.light.matrixWorld).negate());this.lightSphere.geometry.colorsNeedUpdate=!0}}();THREE.PointLightHelper=function(a,b){this.light=a;this.light.updateMatrixWorld();var c=new THREE.SphereGeometry(b,4,2),d=new THREE.MeshBasicMaterial({wireframe:!0,fog:!1});d.color.copy(this.light.color).multiplyScalar(this.light.intensity);THREE.Mesh.call(this,c,d);this.matrixWorld=this.light.matrixWorld;this.matrixAutoUpdate=!1};THREE.PointLightHelper.prototype=Object.create(THREE.Mesh.prototype);THREE.PointLightHelper.prototype.dispose=function(){this.geometry.dispose();this.material.dispose()}; + THREE.PointLightHelper.prototype.update=function(){this.material.color.copy(this.light.color).multiplyScalar(this.light.intensity)};THREE.SpotLightHelper=function(a){THREE.Object3D.call(this);this.light=a;this.light.updateMatrixWorld();this.matrixWorld=a.matrixWorld;this.matrixAutoUpdate=!1;a=new THREE.CylinderGeometry(0,1,1,8,1,!0);a.applyMatrix((new THREE.Matrix4).makeTranslation(0,-0.5,0));a.applyMatrix((new THREE.Matrix4).makeRotationX(-Math.PI/2));var b=new THREE.MeshBasicMaterial({wireframe:!0,fog:!1});this.cone=new THREE.Mesh(a,b);this.add(this.cone);this.update()};THREE.SpotLightHelper.prototype=Object.create(THREE.Object3D.prototype); + THREE.SpotLightHelper.prototype.dispose=function(){this.cone.geometry.dispose();this.cone.material.dispose()};THREE.SpotLightHelper.prototype.update=function(){var a=new THREE.Vector3,b=new THREE.Vector3;return function(){var c=this.light.distance?this.light.distance:1E4,d=c*Math.tan(this.light.angle);this.cone.scale.set(d,d,c);a.getPositionFromMatrix(this.light.matrixWorld);b.getPositionFromMatrix(this.light.target.matrixWorld);this.cone.lookAt(b.sub(a));this.cone.material.color.copy(this.light.color).multiplyScalar(this.light.intensity)}}();THREE.VertexNormalsHelper=function(a,b,c,d){this.object=a;this.size=b||1;for(var b=c||16711680,d=d||1,c=new THREE.Geometry,a=a.geometry.faces,e=0,f=a.length;el;l++){b[0]=m[e[l]];b[1]=m[e[(l+1)%3]];b.sort(d);var p=b.toString();void 0===c[p]&&(f.vertices.push(h[b[0]]),f.vertices.push(h[b[1]]),c[p]=!0)}THREE.Line.call(this,f,new THREE.LineBasicMaterial({color:16777215}),THREE.LinePieces);this.matrixAutoUpdate=!1;this.matrixWorld=a.matrixWorld}; + THREE.WireframeHelper.prototype=Object.create(THREE.Line.prototype);THREE.ImmediateRenderObject=function(){THREE.Object3D.call(this);this.render=function(){}};THREE.ImmediateRenderObject.prototype=Object.create(THREE.Object3D.prototype);THREE.LensFlare=function(a,b,c,d,e){THREE.Object3D.call(this);this.lensFlares=[];this.positionScreen=new THREE.Vector3;this.customUpdateCallback=void 0;void 0!==a&&this.add(a,b,c,d,e)};THREE.LensFlare.prototype=Object.create(THREE.Object3D.prototype); + THREE.LensFlare.prototype.add=function(a,b,c,d,e,f){void 0===b&&(b=-1);void 0===c&&(c=0);void 0===f&&(f=1);void 0===e&&(e=new THREE.Color(16777215));void 0===d&&(d=THREE.NormalBlending);c=Math.min(c,Math.max(0,c));this.lensFlares.push({texture:a,size:b,distance:c,x:0,y:0,z:0,scale:1,rotation:1,opacity:f,color:e,blending:d})}; + THREE.LensFlare.prototype.updateLensFlares=function(){var a,b=this.lensFlares.length,c,d=2*-this.positionScreen.x,e=2*-this.positionScreen.y;for(a=0;ag.end&&(g.end=f);c||(c=i)}}for(i in d)g=d[i],this.createAnimation(i,g.start,g.end,a);this.firstAnimation=c}; + THREE.MorphBlendMesh.prototype.setAnimationDirectionForward=function(a){if(a=this.animationsMap[a])a.direction=1,a.directionBackwards=!1};THREE.MorphBlendMesh.prototype.setAnimationDirectionBackward=function(a){if(a=this.animationsMap[a])a.direction=-1,a.directionBackwards=!0};THREE.MorphBlendMesh.prototype.setAnimationFPS=function(a,b){var c=this.animationsMap[a];c&&(c.fps=b,c.duration=(c.end-c.start)/c.fps)}; + THREE.MorphBlendMesh.prototype.setAnimationDuration=function(a,b){var c=this.animationsMap[a];c&&(c.duration=b,c.fps=(c.end-c.start)/c.duration)};THREE.MorphBlendMesh.prototype.setAnimationWeight=function(a,b){var c=this.animationsMap[a];c&&(c.weight=b)};THREE.MorphBlendMesh.prototype.setAnimationTime=function(a,b){var c=this.animationsMap[a];c&&(c.time=b)};THREE.MorphBlendMesh.prototype.getAnimationTime=function(a){var b=0;if(a=this.animationsMap[a])b=a.time;return b}; + THREE.MorphBlendMesh.prototype.getAnimationDuration=function(a){var b=-1;if(a=this.animationsMap[a])b=a.duration;return b};THREE.MorphBlendMesh.prototype.playAnimation=function(a){var b=this.animationsMap[a];b?(b.time=0,b.active=!0):console.warn("animation["+a+"] undefined")};THREE.MorphBlendMesh.prototype.stopAnimation=function(a){if(a=this.animationsMap[a])a.active=!1}; + THREE.MorphBlendMesh.prototype.update=function(a){for(var b=0,c=this.animationsList.length;bd.duration||0>d.time)d.direction*=-1,d.time>d.duration&&(d.time=d.duration,d.directionBackwards=!0),0>d.time&&(d.time=0,d.directionBackwards=!1)}else d.time%=d.duration,0>d.time&&(d.time+=d.duration);var f=d.startFrame+THREE.Math.clamp(Math.floor(d.time/e),0,d.length-1),h=d.weight; + f!==d.currentFrame&&(this.morphTargetInfluences[d.lastFrame]=0,this.morphTargetInfluences[d.currentFrame]=1*h,this.morphTargetInfluences[f]=0,d.lastFrame=d.currentFrame,d.currentFrame=f);e=d.time%e/e;d.directionBackwards&&(e=1-e);this.morphTargetInfluences[d.currentFrame]=e*h;this.morphTargetInfluences[d.lastFrame]=(1-e)*h}}};THREE.LensFlarePlugin=function(){function a(a,c){var d=b.createProgram(),e=b.createShader(b.FRAGMENT_SHADER),f=b.createShader(b.VERTEX_SHADER),g="precision "+c+" float;\n";b.shaderSource(e,g+a.fragmentShader);b.shaderSource(f,g+a.vertexShader);b.compileShader(e);b.compileShader(f);b.attachShader(d,e);b.attachShader(d,f);b.linkProgram(d);return d}var b,c,d,e,f,h,g,i,k,m,l,p,s;this.init=function(t){b=t.context;c=t;d=t.getPrecision();e=new Float32Array(16);f=new Uint16Array(6);t=0;e[t++]=-1;e[t++]=-1; + e[t++]=0;e[t++]=0;e[t++]=1;e[t++]=-1;e[t++]=1;e[t++]=0;e[t++]=1;e[t++]=1;e[t++]=1;e[t++]=1;e[t++]=-1;e[t++]=1;e[t++]=0;e[t++]=1;t=0;f[t++]=0;f[t++]=1;f[t++]=2;f[t++]=0;f[t++]=2;f[t++]=3;h=b.createBuffer();g=b.createBuffer();b.bindBuffer(b.ARRAY_BUFFER,h);b.bufferData(b.ARRAY_BUFFER,e,b.STATIC_DRAW);b.bindBuffer(b.ELEMENT_ARRAY_BUFFER,g);b.bufferData(b.ELEMENT_ARRAY_BUFFER,f,b.STATIC_DRAW);i=b.createTexture();k=b.createTexture();b.bindTexture(b.TEXTURE_2D,i);b.texImage2D(b.TEXTURE_2D,0,b.RGB,16,16, + 0,b.RGB,b.UNSIGNED_BYTE,null);b.texParameteri(b.TEXTURE_2D,b.TEXTURE_WRAP_S,b.CLAMP_TO_EDGE);b.texParameteri(b.TEXTURE_2D,b.TEXTURE_WRAP_T,b.CLAMP_TO_EDGE);b.texParameteri(b.TEXTURE_2D,b.TEXTURE_MAG_FILTER,b.NEAREST);b.texParameteri(b.TEXTURE_2D,b.TEXTURE_MIN_FILTER,b.NEAREST);b.bindTexture(b.TEXTURE_2D,k);b.texImage2D(b.TEXTURE_2D,0,b.RGBA,16,16,0,b.RGBA,b.UNSIGNED_BYTE,null);b.texParameteri(b.TEXTURE_2D,b.TEXTURE_WRAP_S,b.CLAMP_TO_EDGE);b.texParameteri(b.TEXTURE_2D,b.TEXTURE_WRAP_T,b.CLAMP_TO_EDGE); + b.texParameteri(b.TEXTURE_2D,b.TEXTURE_MAG_FILTER,b.NEAREST);b.texParameteri(b.TEXTURE_2D,b.TEXTURE_MIN_FILTER,b.NEAREST);0>=b.getParameter(b.MAX_VERTEX_TEXTURE_IMAGE_UNITS)?(m=!1,l=a(THREE.ShaderFlares.lensFlare,d)):(m=!0,l=a(THREE.ShaderFlares.lensFlareVertexTexture,d));p={};s={};p.vertex=b.getAttribLocation(l,"position");p.uv=b.getAttribLocation(l,"uv");s.renderType=b.getUniformLocation(l,"renderType");s.map=b.getUniformLocation(l,"map");s.occlusionMap=b.getUniformLocation(l,"occlusionMap");s.opacity= + b.getUniformLocation(l,"opacity");s.color=b.getUniformLocation(l,"color");s.scale=b.getUniformLocation(l,"scale");s.rotation=b.getUniformLocation(l,"rotation");s.screenPosition=b.getUniformLocation(l,"screenPosition")};this.render=function(a,d,e,f){var a=a.__webglFlares,u=a.length;if(u){var w=new THREE.Vector3,z=f/e,B=0.5*e,D=0.5*f,x=16/f,F=new THREE.Vector2(x*z,x),A=new THREE.Vector3(1,1,0),O=new THREE.Vector2(1,1),C=s,x=p;b.useProgram(l);b.enableVertexAttribArray(p.vertex);b.enableVertexAttribArray(p.uv); + b.uniform1i(C.occlusionMap,0);b.uniform1i(C.map,1);b.bindBuffer(b.ARRAY_BUFFER,h);b.vertexAttribPointer(x.vertex,2,b.FLOAT,!1,16,0);b.vertexAttribPointer(x.uv,2,b.FLOAT,!1,16,8);b.bindBuffer(b.ELEMENT_ARRAY_BUFFER,g);b.disable(b.CULL_FACE);b.depthMask(!1);var E,I,y,v,G;for(E=0;EF;F++)z[F]=new THREE.Vector3,u[F]=new THREE.Vector3;z=B.shadowCascadeNearZ[w];B=B.shadowCascadeFarZ[w];u[0].set(-1,-1,z);u[1].set(1,-1,z);u[2].set(-1, + 1,z);u[3].set(1,1,z);u[4].set(-1,-1,B);u[5].set(1,-1,B);u[6].set(-1,1,B);u[7].set(1,1,B);x.originalCamera=p;u=new THREE.Gyroscope;u.position=n.shadowCascadeOffset;u.add(x);u.add(x.target);p.add(u);n.shadowCascadeArray[q]=x;console.log("Created virtualLight",x)}w=n;z=q;B=w.shadowCascadeArray[z];B.position.copy(w.position);B.target.position.copy(w.target.position);B.lookAt(B.target);B.shadowCameraVisible=w.shadowCameraVisible;B.shadowDarkness=w.shadowDarkness;B.shadowBias=w.shadowCascadeBias[z];u=w.shadowCascadeNearZ[z]; + w=w.shadowCascadeFarZ[z];B=B.pointsFrustum;B[0].z=u;B[1].z=u;B[2].z=u;B[3].z=u;B[4].z=w;B[5].z=w;B[6].z=w;B[7].z=w;D[r]=x;r++}else D[r]=n,r++;s=0;for(t=D.length;sw;w++)z=B[w],z.copy(u[w]),THREE.ShadowMapPlugin.__projector.unprojectVector(z,q),z.applyMatrix4(r.matrixWorldInverse),z.xk.x&&(k.x=z.x),z.yk.y&&(k.y=z.y),z.zk.z&& + (k.z=z.z);r.left=i.x;r.right=k.x;r.top=k.y;r.bottom=i.y;r.updateProjectionMatrix()}r=n.shadowMap;u=n.shadowMatrix;q=n.shadowCamera;q.position.getPositionFromMatrix(n.matrixWorld);m.getPositionFromMatrix(n.target.matrixWorld);q.lookAt(m);q.updateMatrixWorld();q.matrixWorldInverse.getInverse(q.matrixWorld);n.cameraHelper&&(n.cameraHelper.visible=n.shadowCameraVisible);n.shadowCameraVisible&&n.cameraHelper.update();u.set(0.5,0,0,0.5,0,0.5,0,0.5,0,0,0.5,0.5,0,0,0,1);u.multiply(q.projectionMatrix);u.multiply(q.matrixWorldInverse); + g.multiplyMatrices(q.projectionMatrix,q.matrixWorldInverse);h.setFromMatrix(g);b.setRenderTarget(r);b.clear();B=l.__webglObjects;n=0;for(r=B.length;n 0 ) {\nfloat depth = gl_FragCoord.z / gl_FragCoord.w;\nfloat fogFactor = 0.0;\nif ( fogType == 1 ) {\nfogFactor = smoothstep( fogNear, fogFar, depth );\n} else {\nconst float LOG2 = 1.442695;\nfloat fogFactor = exp2( - fogDensity * fogDensity * depth * depth * LOG2 );\nfogFactor = 1.0 - clamp( fogFactor, 0.0, 1.0 );\n}\ngl_FragColor = mix( gl_FragColor, vec4( fogColor, gl_FragColor.w ), fogFactor );\n}\n}"}}; diff --git a/docs/course_authors/source/appendices/g.rst b/docs/course_authors/source/appendices/g.rst new file mode 100644 index 000000000000..f89e07600d70 --- /dev/null +++ b/docs/course_authors/source/appendices/g.rst @@ -0,0 +1,58 @@ +.. _MathJax in Studio: + +A Brief Introduction to MathJax in Studio +========================================= + +To write clear and professional-looking symbols and equations, we use a LaTeX-like +language called +`MathJax `_. +Your MathJax equations can appear with other text in the paragraph (inline equations) or +on their own lines (display equations). + +- For inline equations, you can do either of the following. + + - Surround your Mathjax expression with backslashes and **parentheses**. + + ``\( equation \)`` + + - Surround your Mathjax expression with [mathjaxinline] tags. Note that these + tags use square brackets ([]). + + [mathjaxinline] equation [/mathjaxinline] + +- For display equations, you can do either of the following. + + - Surround your Mathjax expression with backslashes and **brackets**. + + ``\[ equation \]`` + + - Surround your Mathjax expression with [mathjax] tags. Note that these tags use + square brackets ([]). + + [mathjax] equation [/mathjax] + +You can use MathJax in HTML (text) components and in Problem components. + +.. note:: Complete MathJax documentation (together with a testing tool) can be + found at `http://www.onemathematicalcat.org/MathJaxDocumentation/TeXSyntax.htm `_. + + +HTML (Text) Components +---------------------- + +In the HTML component editor, you can use MathJax both in Visual view and in HTML view. + +.. image:: ../Images/MathJax_HTML.gif + +Problem Components +------------------ + +In the Problem component editor, you can use MathJax both in the Simple Editor +and in the Advanced Editor. + +In the example problem below, note that the Einstein equation in the +explanation is enclosed in backslashes and parentheses, so it appears inline with the text. The +Navier-Stokes equation is enclosed in backslashes and brackets, so it appears on its +own line. + +.. image:: ../Images/MathJax_Problem.gif \ No newline at end of file diff --git a/docs/course_authors/source/change_log.rst b/docs/course_authors/source/change_log.rst index 1a1e3e3d7156..11d116d1cf06 100644 --- a/docs/course_authors/source/change_log.rst +++ b/docs/course_authors/source/change_log.rst @@ -8,14 +8,10 @@ Change Log ============== ================================================================ DATE CHANGE ============== ================================================================ -7/1/2013 Online help and pdf files finalized in Sphinx 1.2b1 - -5/6/2013 Universal change to UTC for all GMT references. Changed “Add Course Catalog Information” to show URL and note that on this page, the course author sees local time from browser. Changed “Invite Students to Register” to reflect new link. - -4/18/13 “Create a Discussion” graphic change - -4/9/13 Changed order of sections (moved “Create a Lesson in Studio” after “Create a New Course”) Added content to “Export or Import a Course,”Create Lesson,” “Create Schedule,” and Upload a File to the "Files & Updates Page” sections. Revised “Add an Announcement" or Update" section. - -3/22/13 Revised “Add Manual Policy Data” section. Added “Appendix C: Time Zones” +12/05/2013 Complete revision of edX Studio documentation and integration + of edX101 content. +12/10/2013 Added MathJax appendix +12/11/2013 Added Accessibility chapter +12/12/2013 Added Glossary ============== ================================================================ diff --git a/docs/course_authors/source/checking_student_progress.rst b/docs/course_authors/source/checking_student_progress.rst index 01109bb853e5..7bfcc2ae0d26 100644 --- a/docs/course_authors/source/checking_student_progress.rst +++ b/docs/course_authors/source/checking_student_progress.rst @@ -1,23 +1,24 @@ -************************************************** +.. _Checking Student Progress and Issuing Certificates: + +################################################### Checking Student Progress and Issuing Certificates -************************************************** +################################################### -As will be discussed more in later sections, the grading policy and stored -problem scores are used to record progress through the course, determine +The grading policy and stored problem scores are used to record progress through the course, determine final grades, and issue certificates at the end. This unit will give you some advance information about how the grading policy will be visible to the students during the run of the course and what you will need to do at the end of the course to give out grades. - -Checking Progress as a Student +.. _A Student's View: + +****************************** +A Student's View ****************************** - -During the run of a course, students can check their progress by clicking on -the Progress tab of the course on Edge. (This is the same page they would go -to to view subsection problem scores, as described in Viewing Scores.) The +Students can check their progress by clicking on +the **Progress** tab in the course. The student's progress through the graded part of the course is displayed at the top of this page, above the subsection scores, as a chart with entries for all the assignments, total percentage earned in the course so far and @@ -26,17 +27,15 @@ progress through edX101. .. image:: Images/image245.png - + :width: 800 -The student will be able to see from this page that, at the time this -screenshot was taken, edX101 was graded as a Pass/Fail course with a cutoff +The student can see from this page that edX101 was graded as a Pass/Fail course with a cutoff of 34% and that the grading rubric contained one assignment type, called -Learning Sequence, consisting of 11 assignments total. Furthermore, this -picture says that this particular student has only submitted correct -responses to two assignments, and that their current total percent grade in -the course is 6%. By hovering over each progress bar, the student would be -able to get further statistics of how much each assignment was counted as. +Learning Sequence, consisting of 11 assignments total. Furthermore, this particular student has only +submitted correct responses to two assignments, and that her current total percent grade in +the course is 6%. By hovering over each progress bar, the student can +get further statistics of how much each assignment was counted as. As was mentioned in the unit on Viewing Scores, further down on the Progress @@ -46,29 +45,27 @@ down view of the example Progress page for the student in the example above: .. image:: Images/image247.png - + :width: 800 Again, note that point scores from graded sections are called "Problem Scores", while point scores from ungraded sections are called "Practice Scores". -.. raw:: latex - - \newpage % - -Checking Progress of Students as an Instructor +.. _Check Progress of Students as an Instructor: + +********************************************** +Check Progress of Students as an Instructor ********************************************** - -To check the progress of the student through the course, visit the -Instructor dashboard of your course in instructor view on Edge and click on -the Grades page. The Instructor dashboard for courses sometimes changes as +To check the progress of the student, go to the +Instructor Dashboard of your course click +the Grades page. The Instructor Dashboard for courses sometimes changes as more course-specific tools get added. Here is the current view of the top of the Grades page of the Instructor dashboard for edX101: .. image:: Images/image249.png - + :width: 800 Here you see several options for viewing or downloading student grades, viewing individual progress through a course or resetting problem attempts. @@ -84,7 +81,7 @@ viewing individual progress through a course or resetting problem attempts. .. note:: The stored scores visible to you on the Instructor tab and to - the students from the Progress tab in the course on Edge are a snapshot of the + the students from the Progress tab in the course are a snapshot of the current state of the problem score database. They may be slightly out of sync with actual problem scores. (Asynchronicities may happen if, for example, the weight of a live problem was changed during an assignment, and not @@ -92,17 +89,15 @@ viewing individual progress through a course or resetting problem attempts. are usually recomputed at the end of the semester before determining final grades and issuing Certificates. -.. raw:: latex - - \newpage % - - -Assigning Final Grades and Issuing Certificates +.. _Assign Final Grades and Issuing Certificates: + +*********************************************** +Assign Final Grades and Issue Certificates *********************************************** The final grades of a student in the course and the grading rubric you have set are used to determine whether the student has earned a Certificate of Mastery for the course. The process for issuing Certificates has to be started manually by you or by the edX support team at the end of the -course run. For more information about issuing Certificates, see TBD. +course. diff --git a/docs/course_authors/source/common_problems.rst b/docs/course_authors/source/common_problems.rst new file mode 100644 index 000000000000..c5d28afa9897 --- /dev/null +++ b/docs/course_authors/source/common_problems.rst @@ -0,0 +1,405 @@ +.. _Common Problems: + +############################ +Common Problems +############################ + +*Common problems* are typical problems such as multiple choice problems +and other problems whose answers are simple for students to select or +enter. You can create all of these problems using the Simple Editor in +Studio. You don't have to use XML or switch to the Advanced Editor. + +The following are the common problem types in Studio: + +- :ref:`Checkbox` In checkbox problems, students select one or more options + from a list of possible answers. +- :ref:`Dropdown` In dropdown problems, students select one answer from a + dropdown list. +- :ref:`Multiple Choice` Multiple choice problems require students to + select one answer from a list of choices that appear directly below + the question. +- :ref:`Numerical Input` Numerical input problems require answers that + include only integers, fractions, and a few common constants and + operators. +- :ref:`Text Input` In text input problems, students enter a short text + answer to a question. + +These problems are easy to access in Studio. To create them, click +**Problem** under **Add New Component**, click the **Common Problem +Types** tab, and then click the name of the problem. (Note that +**Checkbox** doesn't appear in the list of common problem types. To +create a checkbox problem, you'll click **Blank Common Problem**.) + +.. _Checkbox: + +******************* +Checkbox +******************* + +In checkbox problems, the student selects one or more options from a +list of possible answers. The student must select all the options that +apply to answer the problem correctly. Each checkbox problem must have +at least one correct answer. + +.. image:: Images/CheckboxExample.gif + +========================== +Create a Checkbox Problem +========================== + +#. Under **Add New Component**, click **Problem**. +#. In the **Select Problem Component Type** screen, click **Blank Common + Problem** on the **Common Problem Types** tab. +#. In the Problem component that appears, click **Edit**. +#. In the component editor, replace the default text with the text of your + problem. Enter each answer option on its own line. +#. Select all the answer options, and then click the checkbox button. + + When you do this, brackets appear next to each answer choice. + +#. Add an **x** between the brackets for the correct answer or answers. +#. In the component editor, select the text of the explanation, and then click the + explanation button to add explanation tags around the text. + + .. image:: Images/ProbCompButton_Explanation.gif + +#. On the **Settings** tab, specify the settings that you want. +#. Click **Save**. + +For the example problem above, the text in the Problem component is the +following. + +:: + + Learning about the benefits of preventative healthcare can be particularly + difficult. Check all of the reasons below why this may be the case. + + [x] A large amount of time passes between undertaking a preventative measure + and seeing the result. + [ ] Non-immunized people will always fall sick. + [x] If others are immunized, fewer people will fall sick regardless of a + particular individual's choice to get immunized or not. + [x] Trust in healthcare professionals and government officials is fragile. + + [explanation] + People who are not immunized against a disease may still not fall sick from + the disease. If someone is trying to learn whether or not preventative measures + against the disease have any impact, he or she may see these people and conclude, + since they have remained healthy despite not being immunized, that immunizations + have no effect. Consequently, he or she would tend to believe that immunization + (or other preventative measures) have fewer benefits than they actually do. + [explanation] + + +.. _Dropdown: + +******************* +Dropdown +******************* + +Dropdown problems allow the student to choose from a collection of +answer options, presented as a dropdown list. Unlike multiple choice +problems, whose answers are always visible directly below the question, +dropdown problems don't show answer choices until the student clicks +the dropdown arrow. + +.. image:: Images/DropdownExample.gif + +========================== +Create a Dropdown Problem +========================== + +To create a dropdown problem, follow these steps. + +#. Under **Add New Component**, click **Problem**. +#. In the **Select Problem Component Type** screen, click + **Dropdown** on the **Common Problem Types** tab. +#. In the new Problem component that appears, click **Edit**. +#. Replace the default text with the text for your problem. Enter each of the possible + answers on the same line, separated by commas. +#. Select all the answer options, and then click the dropdown button. + + .. image:: Images/ProbCompButton_Dropdown.gif + + When you do this, a double set of brackets ([[ ]]) appears and surrounds the + answer options. + +#. Inside the brackets, surround the correct answer with parentheses. +#. In the component editor, select the text of the explanation, and then click the + explanation button to add explanation tags around the text. + + .. image:: Images/ProbCompButton_Explanation.gif + +#. On the **Settings** tab, specify the settings that you want. +#. Click **Save**. + +For the example problem above, the text in the Problem component is the +following. + +:: + + What type of data are the following? + + Age: + [[Nominal, Discrete, (Continuous)]] + Age, rounded to the nearest year: + [[Nominal, (Discrete), Continuous]] + Life stage - infant, child, and adult: + [[(Nominal), Discrete, Continuous]] + + +.. _Multiple Choice: + +******************* +Multiple Choice +******************* + +In multiple choice problems, students select one option from a list of +answer options. Unlike with dropdown problems, whose answer choices +don't appear until the student clicks the drop-down arrow, answer +choices for multiple choice problems are always visible directly below +the question. + +.. image:: Images/MultipleChoiceExample.gif + +================================== +Create a Multiple Choice Problem +================================== + +#. Under **Add New Component**, click **Problem**. +#. In the **Select Problem Component Type** screen, click **Multiple + Choice** on the **Common Problem Types** tab. +#. When the new Problem component appears, click **Edit**. +#. In the component editor, replace the sample problem text with the text of your + problem. Enter each answer option on its own line. +#. Select all the answer options, and then click the multiple choice button. + + .. image:: Images/ProbCompButton_MultChoice.gif + + When you do this, the component editor adds a pair of parentheses next to each + possible answer. + +#. Add an "x" between the parentheses next to the correct answer. + +#. In the component editor, select the text of the explanation, and then click the + explanation button to add explanation tags around the text. + + .. image:: Images/ProbCompButton_Explanation.gif + +#. On the **Settings** tab, specify the settings that you want. +#. Click **Save**. + +For the example problem above, the text in the Problem component is the +following. + +:: + + Lateral inhibition, as was first discovered in the horsehoe crab: + + ( ) is a property of touch sensation, referring to the ability of crabs to + detect nearby predators. + ( ) is a property of hearing, referring to the ability of crabs to detect + low frequency noises. + (x) is a property of vision, referring to the ability of crabs eyes to + enhance contrasts. + ( ) has to do with the ability of crabs to use sonar to detect fellow horseshoe + crabs nearby. + ( ) has to do with a weighting system in the crabs skeleton that allows it to + balance in turbulent water. + + [Explanation] + Horseshoe crabs were essential to the discovery of lateral inhibition, a property of + vision present in horseshoe crabs as well as humans, that enables enhancement of + contrast at edges of objects as was demonstrated in class. In 1967, Haldan Hartline + received the Nobel prize for his research on vision and in particular his research + investigating lateral inhibition using horseshoe crabs. + [Explanation] + +.. _Numerical Input: + +******************* +Numerical Input +******************* + +In numerical input problems, students enter numbers or specific and +relatively simple mathematical expressions to answer a question. + +.. image:: Images/NumericalInputExample.gif + +Note that students' responses don't have to be exact for these problems. You can +specify a margin of error. For more information, see the instructions below. + +Responses for numerical input problems can include integers, fractions, +and constants such as *pi* and *g*. Responses can also include text +representing common functions, such as square root (sqrt) and log base 2 +(log2), as well as trigonometric functions and their inverses, such as +sine (sin) and arcsine (arcsin). For these functions, Studio changes the +text that the student enters into mathematical symbols. The following +example shows the way Studio renders students' text responses in +numerical input problems. To see more examples, scroll down to **Examples**. + +.. image:: Images/Math5.gif + +================================== +Create a Numerical Input Problem +================================== + +#. Under **Add New Component**, click **Problem**. +#. In the **Select Problem Component Type** screen, click **Numerical + Input** on the **Common Problem Types** tab. +#. When the new Problem component appears, click **Edit**. +#. In the component editor, replace the sample problem text with your own text. + +#. Select the text of the answer, and then click the numerical input button. + + .. image:: Images/ProbCompButton_NumInput.gif + + When you do this, an equal sign appears next to the answer. + +#. (Optional) If you want to include a margin of error, add **+-NUMBER** after the answer. For + example, if you want to include a 2% margin of error, add **+-2%**. + +#. In the component editor, select the text of the explanation, and then click the + explanation button to add explanation tags around the text. + + .. image:: Images/ProbCompButton_Explanation.gif + +#. On the **Settings** tab, specify the settings that you want. +#. Click **Save**. + +For the example problem above, the text in the Problem component is the +following. + +:: + + How many different countries do edX students live in as of May 2013? + + = 193 +- 5% + + [explanation] + As of edX's first birthday, in May 2013, edX students live in 193 different countries. + [explanation] + +**Examples** + +The following are a few more examples of the way that Studio renders numerical input +text that students enter. + +.. image:: Images/Math1.gif +.. image:: Images/Math2.gif +.. image:: Images/Math3.gif +.. image:: Images/Math4.gif + +For more information, see `Formula Equation Input +`_. + +.. _Text input: + +******************* +Text Input +******************* + +In text input problems, students enter text into a response field. The +response can include numbers, letters, and special characters such as +punctuation marks. Because the text that the student enters must match +the instructor's specified answer exactly, including spelling and +punctuation, we recommend that you specify more than one attempt for +text input problems to allow for typographical errors. + +.. image:: Images/TextInputExample.gif + +================================== +Create a Text Input Problem +================================== + +To create a text input problem, follow these steps. + +#. Under **Add New Component**, click **Problem**. +#. In the **Select Problem Component Type** screen, click **Text Input** + on the **Common Problem Types** tab. +#. In the new Problem component that appears, click **Edit**. +#. Replace the default text with the text for your problem. +#. Select the text of the answer, and then click the text input button. + + .. image:: Images/ProbCompButton_TextInput.gif + + When you do this, an equal sign appears next to the answer. + + +#. In the component editor, select the text of the explanation, and then click the + explanation button to add explanation tags around the text. + + .. image:: Images/ProbCompButton_Explanation.gif + +#. On the **Settings** tab, specify the settings that you want. +#. Click **Save**. + +For the example problem above, the text in the Problem component is the +following. + +:: + + What is the technical term that refers to the fact that, when enough people + sleep under a bednet, the disease may altogether disappear? + = herd immunity + + [explanation] + The correct answer is herd immunity. As more and more people use bednets, + the risk of malaria begins to fall for everyone – users and non-users alike. + This can fall to such a low probability that malaria is effectively eradicated + from the group (even when the group does not have 100% bednet coverage). + [explanation] + +========================================= +Case Sensitivity and Text Input Problems +========================================= + +By default, text input problems do not require a case sensitive response. You can change this +and require a case sensitive answer. + +To make a text input response case sensitive, you must use the :ref:`Advanced Editor`. + +In the advanced editor, you see that the **type** attribute of the **stringresponse** +element equals **ci**, for *case insensitive*. For example: + +:: + + + + + +To make the response case sensitive, change the value of the **type** attribute to **cs**. + +:: + + + + + +============================================= +Response Field Length of Text Input Problems +============================================= + +By default, the response field for text input problems is 20 characters long. + +You should preview the unit to ensure that the length of the response input field +accommodates the correct answer, and provides extra space for possible incorrect answers. + +If the default response field length is not sufficient, you can change it using the :ref:`Advanced Editor`. + +In the advanced editor, in the XML block for the answer, you see that the **size** attribute of the **textline** +element equals **20**: + +:: + + + + + +To change the response field length, change the value of the **size** attribute: + +:: + + + + diff --git a/docs/course_authors/source/conf.py b/docs/course_authors/source/conf.py index 90a78f48fd57..978a2c0f75e9 100644 --- a/docs/course_authors/source/conf.py +++ b/docs/course_authors/source/conf.py @@ -23,3 +23,11 @@ html_static_path.append('source/_static') +# General information about the project. +project = u'Building a Course with edX Studio' +copyright = u'2013, edX Documentation Team' + +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' \ No newline at end of file diff --git a/docs/course_authors/source/create_discussion.rst b/docs/course_authors/source/create_discussion.rst index 3fd7cd63cac4..62012e02203d 100644 --- a/docs/course_authors/source/create_discussion.rst +++ b/docs/course_authors/source/create_discussion.rst @@ -1,96 +1,88 @@ +.. _Working with Discussion Components: -******************* -Create a Discussion -******************* - -To create a discussion in your course, you create a question and Discussion -component in Studio. You can then encourage the students to respond by seeding -the discussion space on edX or Edge. +################################### +Working with Discussion Components +################################### +******************* +Overview +******************* -Create a Discussion Component -***************************** - -Keep in mind the following best practices when you create a Discussion -component. +You can add a Discussion component to a Unit, to pose a question related to the Unit and give students a chance to respond and interact. -• Be very sure that you want to add the Discussion component. Discussion -• categories are immediately visible in your forum (on the Discussion tab for -• your course) when you create them, even if the unit that contains the -• Discussion component is set to Private +See the following topics: -• When you create an ID for the Discussion component, be very careful—especially -• if you are adding the Discussion component to a running course. Follow the -• format in step 10 below to make sure that the ID is unique across all courses -• on edX. +* :ref:`Create a Discussion Component` +* :ref:`A Student's View of the Discussion` +* :ref:`Seed a Discussion Space in Your Course` -• Edit only the fields at the top of the Discussion component edit box. Do not -• change the XML in the large box. -To add a Discussion component: +Before you add a Discussion component, it is generally a good idea to add an HTML component that +introduces the topic to be discussed. The Discussion component itself does not contain any text and may be easy for students to overlook. -1. Open Studio. +.. _Create a Discussion Component: -2. Make a note of the **Display Name** of the Subsection you are in and the -**Display Name** of the Unit you are in. +***************************** +Create a Discussion Component +***************************** -3. At the location in the Unit where you want to start your discussion :doc:`create_html_component` -that contains the question you want students to discuss. +.. note:: Before you create a Discussion component, consider that Discussion categories are immediately visible in your forum (on the Discussion tab for your course) when you create them, even though the unit that contains the Discussion component is set to Private. -4. Directly under this new HTML component, click **Discussion** under **Add New -Component.** -.. image:: Images/image057.png +To create a new HTML component in an existing Unit, ensure the Unit is Private. +For more information on Public and Private Units, see LINK. -5. When the following box appears, click **Discussion Tag.** +#. Under **Add New Component**, click the **discussion** icon. -.. image:: Images/image059.png + .. image:: Images/NewComponent_Discussion.png + + The Discussion component is added: + + .. image:: Images/EditDiscussionComponent.png -6. When the following box appears, click **Edit.** -.. image:: Images/image061.png +#. In the Discussion component, click **Edit**. -The following editing box opens. You will change the values in the small boxes, -but you will not change the text in the large box. + The Discussion component editor opens. + + .. image:: Images/DiscussionComponentEditor.png -.. image:: Images/image063.png +#. Follow the guidelines in the editor to fill in the **Discussion Category**, **Display Name**, and **Subcategory**. + +#. Click **Save**. -.. note:: +.. _A Student's View of the Discussion: - In the future, these boxes may be filled in for you with a default value. +********************************** +A Student's View of the Discussion +********************************** -7. In the **discussion_category** box, type the name of the category that you -want to create for the discussion. You can include spaces. +For students, Discussion component names appear in the course ribbon at the top of the page: -8. In the **discussion_target** box, type the name of the subcategory that you -want to create for the discussion. You can include spaces. +.. image:: Images/DiscussionComponent_LMS_Ribbon.png -.. note:: - The category and subcategory names only appear in the discussion forum for - your course. They do not appear in the discussion space inside the Unit. +The Discussion space appears under other components in the unit. +It doesn't have a label in the body of the unit. +Instead, students see "Show discussion" or "Hide discussion" on the left, +and a blue **New Post** button on the right. -For example, if you set **discussion_category** to be “The Discussion Component” -and you set **discussion_target** to be “Online Instruction Methods,” the -category and subcategory appear as follow in the category list in the discussion -forum: +In the following example, the Discussion component follows Video and HTML components: -.. image:: Images/image065.png - :width: 300 +.. image:: Images/DiscussionComponent_LMS.png -9. In the **display_name** box, type a name for the discussion. The display name -appears when a student hovers the mouse over the ribbon. +In the **Discussion** tab at the top of the page, +students can find the category and subcategory of the discussion in the left pane. -10. Click **Save.** +.. image:: Images/DiscussionComponent_Forum.png -.. raw:: latex - - \newpage % +.. _Seed a Discussion Space in Your Course: +************************************** Seed a Discussion Space in Your Course ************************************** -When you create a discussion, many students may feel hesitant to be the first to +Many students may feel hesitant to be the first to post an answer to your question. You can get the discussion started by posting your own answer—preferably anonymously or as a student, so that students will be more comfortable replying if they disagree with your post. @@ -98,24 +90,21 @@ more comfortable replying if they disagree with your post. To post as a student, follow the steps below. If you later want to reply as yourself, log back into your usual account and omit steps 1 and 2. -1. Set up a test account on edX or Edge with an e-mail address that is not -associated with your Course Team. +#. Set up a test account on with an e-mail address that is not associated with your Course Team. -2. Go to your course URL and register for your course. +#. Go to your course URL and register for your course. -3. On edX or Edge, locate the Unit that contains the Discussion component. + a. Locate the Unit that contains the Discussion component. -4. In the Unit, locate the discussion space. + b. In the Unit, locate the discussion space. -5. Click **New post.** + c. Click **New post.** -6. Type a title for your post in the Title box, and then enter text for your -post. +3. Type a title for your post in the Title field, and then enter text for your post. -7. If you want to, select the **post anonymously** check box or the **follow -this post** check box. +#. If you want to, select the **post anonymously** check box or the **follow this post** check box. -8. When you are satisfied with your post, click **Add Post.** +#. When you are satisfied with your post, click **Add Post.** Your new post appears at the top of list in the unit. Posts are listed in reverse chronological order. diff --git a/docs/course_authors/source/create_html_component.rst b/docs/course_authors/source/create_html_component.rst index 818873a52874..13e5433e83cc 100644 --- a/docs/course_authors/source/create_html_component.rst +++ b/docs/course_authors/source/create_html_component.rst @@ -1,249 +1,270 @@ +.. _Working with HTML Components: -************************ -Create an HTML Component -************************ - .. image:: Images/image067.png +############################# +Working with HTML Components +############################# -The HTML component is the most basic component type. These components are the -building blocks of text-based courses. They are used to add information such as -text, lists, links, and images to units. For example, you can use these -components between Problem components to add explanatory text. You can also use -HTML components to import LaTeX code into your course. +******************* +Overview +******************* -The HTML component editor has two views: **Visual view** and **HTML view.** -Visual view offers you a “what you see is what you get” (WYSIWYG) editor for -editing a pre-formatted version of the text. HTML view gives you a text editor -in which you can edit HTML code directly. +You use an HTML component to add and format text for your course. +You can add text, lists, links and images in an HTML component. -.. note:: +See the following topics: - Studio processes the HTML code entered when saving it and before rendering - it. Make sure that the component you created looks the way you expect live if - you go back and forth between Visual and HTML view. +* :ref:`Create an HTML Component` +* :ref:`Work with the Visual and HTML Editors` +* :ref:`Use the Announcement Template` +* :ref:`Use the Anonymous User ID Template` +* :ref:`Import Content from LaTex` +* :ref:`Add a Link in an HTML Component` +* :ref:`Add an Image to an HTML Component` + +.. note:: Ensure you understand the chapter :ref:`Organizing Your Course Content` before working with HTML components. + +.. note:: Review :ref:`Best Practices for HTML Markup` before adding HTML components to your course. -.. raw:: latex - - \newpage % -Create a Basic HTML Component +.. _Create an HTML Component: + +***************************** +Create an HTML Component ***************************** -**To create a basic, blank HTML component:** +To create a new HTML component in an existing unit, ensure the unit is private. +For more information on public and private units, see :ref:`Public and Private Units`. -1. Under Add New Component, click **html**, and then click **Empty.** The -following blank component appears. +#. Under **Add New Component**, click the **html** icon. -.. image:: Images/image069.png + .. image:: Images/NewComponent_HTML.png -2. In the blank component, click **Edit.** The HTML editor opens. +2. In the list that appears, click **Text**. -.. image:: Images/image071.png + An empty component appears at the bottom of the Unit. + + .. image:: Images/HTMLComponent_Edit.png + +3. In the empty component, click **Edit**. + + The HTML Component Editor opens. + + .. image:: Images/HTMLEditor.png -3. Enter the information that you want, and then click **Save.** +4. Click **Settings** to enter the **Display Name** for the HTML component. -.. note:: + A student sees the Display when hovering your mouse over the icon for the Unit in the Subsection accordian. - If you want to enter links to other pages or to images or to edit the - HTML directly, switch to the HTML tab. + Click **Save** to return to the Component Editor. -.. raw:: latex - - \newpage % +5. Enter text as needed. -**To create a basic HTML component that includes a template you can use:** +6. Click **Save** to save the HTML component. -1. Under **Add New Component,** click **html** and then click **Announcement.** -The following screen opens. +For more information, see: -.. image:: Images/image073.png +* :ref:`Work with the Visual and HTML Editors` +* :ref:`Use the Announcement Template` +* :ref:`Import Content from LaTex` +* :ref:`Add a Link in an HTML Component` +* :ref:`Add an Image to an HTML Component` -2. Click **Edit.** - The text editor opens in Visual view. Replace the template text with your - announcement text. -.. note:: +.. _Work with the Visual and HTML Editors: - If you want to enter links to other pages or to images or to edit the - HTML directly, switch to the HTML tab. +***************************************** +Work with the Visual and HTML Editors +***************************************** -.. image:: Images/image075.png +The HTML Component editor has two views: the **Visual view** and the **HTML view.** -3. Click **Save.** +You select the view by clicking the tab in the upper-right of the component Editor. -.. raw:: latex - - \newpage % +.. image:: Images/HTMLEditorTabs.png + +============== +Visual Editor +============== + +The Visual view provides a “what you see is what you get” (WYSIWYG) editor for +editing a pre-formatted version of the text. -Create Links -************ +.. image:: Images/HTMLEditor_Visual.png -Link to a Handout or Image -========================== +Use the buttons at the top of the Visual editor to change the formatting as needed. +For example, you can enclose the title in heading tags, create bulleted or numbered lists, +or apply bold, italic, or underline formatting. -To link to a document, image, or other file that you uploaded to the Files & -Uploads page: +============== +HTML Editor +============== +The HTML allows you to edit HTML code directly. -1. Create a blank HTML component, and switch to HTML view. +.. image:: Images/HTMLEditor_HTML.png -2. In the HTML box, create links to your files. +.. note:: Studio processes the HTML code entered when saving it and before rendering + it. Make sure that the text you create looks the way you expect if + you go back and forth between the Visual and HTML views. -To create a link to a document, enter the following syntax, where URL OF FILE is -the URL that you noted in step 5 of Upload a File to the Files & Uploads Page -and LINK TEXT is the text that the user will click. :: +.. _Use the Announcement Template: -

    [LINK TEXT]

    +************************************ +Use the Announcement Template +************************************ -For example, to create a link to the HTML template for the “About” page document -whose URL is /c4x/edX/edX101/asset/AboutPage_Template.txt, use the following -code. :: +When you create a new HTML component, you can select to use a built-in Announcement template. -

    HTML Template for -

    +When creating the new HTML component, select **Announcement**. -To create a link to an image that you’ve uploaded, enter the following syntax, -where URL OF FILE is the URL that you noted in step 5 of Upload a File to the -Files & Uploads Page. :: +.. image:: Images/HTML_Component_Type.png + :width: 600 + +The following screen opens. -

    +.. image:: Images/image073.png -For example, to create a link to the CourseImage.jpg file whose URL is -/c4x/edX/edX101/asset/CourseImage.jpg, use the following code. :: +Edit the content of the announcement just as you would any HTML component. -

    -When you use this code, the following image appears. +.. _Use the Anonymous User ID Template: -.. image:: Images/image078.png - :width: 800 +************************************ +Use the Anonymous User ID Template +************************************ -3. Click **Save.** Your files or images appear in the component. +When you create a new HTML component, you can select to use a built-in Anonymous User ID template. +The Anonymous User ID template contains HTML set up for you to use a Qualtrics survey in your course. -.. raw:: latex - - \newpage % - +When creating the new HTML component, select **Anonymous User ID**. -Link to Course Units -==================== +.. image:: Images/HTML_Component_Type.png + :width: 600 -To direct the student to a specific place in your own course, you must add an -HTML link to that unit. To do this: +Edit the content just as you would any HTML component. -1. Determine the relative directory of your course. +To use your survey, you must edit the link in the template to include your university and survey ID. -a. On the Course Settings tab, click the blue your course URL link under Basic - Information. +You can also embed the survey in an iframe in the HTML component. -.. image:: Images/image079.png - :width: 800 +For more details, read the instructions in the HTML view of the component. -The registration page for your course opens. -b. In the address bar at the top of the page, locate the URL. -c. Copy the part of the URL after “.org” and before “about”, including the -forward slashes. The syntax is the following. :: - /courses/[organization]/[course_number]/[course_name]/ +.. _Import Content from LaTeX: -For example, for edX101: How to Create an edX Course from edX, the complete URL -is the following. :: +************************* +Import Content from LaTeX +************************* - https://edge.edx.org/courses/edX/edX101/How_to_create_an_edX_course/about +If LaTeX is enabled for your course, you can create an HTML component from imported LaTeX code. -The relative directory is the following. :: +Studio uses a third-party LaTeX processor to convert LaTeX code to XML. The LaTeX processor must be up and running. - /courses/edX/edX101/How_to_create_an_edX_course/ +1. When creating the new HTML component, select **E-text Written in LaTeX**. -2. Determine the location ID of the target unit. Studio generates the location -ID for each unit when you create the unit. The location ID uses the following -syntax. :: + The new HTML component opens, with an **upload** link: + + .. image:: Images/latex_upload.png + :width: 800 - i4x:////vertical/ +2. To upload a LaTeX file from your computer, click **upload**. -.. note:: + You are prompted to select a file. The file loads in the LaTeX editor. + +3. In the LaTeX editor, click **Save & Compile to edX XML**. - To find the location ID, open the page of the unit you are trying to link - to in Studio and look at the URL in the browser’s address bar. The location ID - is the text in the URL after edit, as in the following example. + The LaTeX content is added to the HTML component. For example: + + .. image:: Images/Latex_component.png + :width: 800 -.. image:: Images/image081.png +4. Verify that your newly created component looks the way you want it to. -3. Open the unit that you want to link from. +You can edit the HTML component with LaTeX as you can any other component. +In the editor, you can launch the LaTeX source compiler. -4. Under Add New Component, click html, and then click Empty. A new, blank -component appears. -.. image:: Images/image083.png - :width: 800 +.. _Add a Link in an HTML Component: -5. Click **edit**. +*********************************** +Add a Link in an HTML Component +*********************************** -6. In the HTML editor that opens, click the HTML tab. +You can add a link in an HTML component to any file you uploaded for the course. -7. Next to the number 1, type the following. Replace relative course directory, -location id of unit, and link text with your information. :: +Find any copy the URL of the file in the Files & Uploads page. -     [link text] +See :ref:`Add Files to a Course` for more information. -For example, a link to the “Creating an HTML Component” unit in edx101 -resembles the following :: +While editing the HTML component: - Creating an HTML - - +#. Switch to the HTML view. -.. raw:: latex - - \newpage % +#. To create a link to a document, enter the following syntax, where URL OF FILE is the URL that you copied from the Files & Uploads Page and LINK TEXT is the text that the user will click. + + ``

    [LINK TEXT]

    `` + + + + +.. _Add a Link to a Course Unit: + +============================ +Add a Link to a Course Unit +============================ + +You can add a link to a course unit in an HTML component. + +#. Determine the unit identifier of the unit you're linking to. To do this, open the + unit page in Studio, and locate the **Unit Identifier** field under **Unit Location** in the right pane. -Import from LaTeX -***************** +#. Copy the unit identifier. -You can create an HTML component from imported LaTeX code. +#. Open the HTML component where you want to add the link. -.. note:: +#. Select the text that you want to make into the link. - This feature is currently under development. +#. Click the link icon in the toolbar. -1. Under **Add New Component**, click **html**, and then click **E-text Written -in LaTeX.** +#. In the Insert/Edit Link dialog box, enter the following in the Link URL field. + + Make sure to replace (including the brackets) with the unit + identifier that you copied in step 2, and make sure to include both forward slashes (/). + + ``/jump_to_id/`` -.. image:: Images/image067.png - :width: 800 +#. 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. + +#. Click **Insert**. -2. In the component that appears, click Edit. +#. Save the HTML component and test the link. -.. image:: Images/image083.png - :width: 800 -3. The component editor opens. In the top left corner of the editor, click the -yellow **Edit High Level Source** text. +.. _Add an Image to an HTML Component: -.. image:: Images/image085.png - :width: 800 +*********************************** +Add an Image to an HTML Component +*********************************** -4. In the **High Level Source Editing** screen that opens, replace the sample -code with your LaTeX code. +You can add an any image that you have uploaded for the course to an HTML component. -.. image:: Images/image087.png - :width: 800 +Find any copy the URL of the image in the Files & Uploads page. -5. Click **Save and compile to edX XML** to convert the LaTeX code into edX XML -code. +See :ref:`Add Files to a Course` for more information. -.. note:: +.. note:: Review :ref:`Best Practices for Describing Images` when adding images to HTML components. - Studio uses a third-party LaTeX processor to convert LaTeX code to XML. - The LaTeX processor must be up and running. +While editing the HTML component: -6. Click **Save**. Verify that your newly created component looks the way you -want it to. +#. Switch to the HTML view. +#. To add the image to a document, enter the following syntax, where URL OF FILE is the URL that you copied from the Files & Uploads Page. + + ``

    `` diff --git a/docs/course_authors/source/create_lesson.rst b/docs/course_authors/source/create_lesson.rst deleted file mode 100644 index d0974ea8dcf3..000000000000 --- a/docs/course_authors/source/create_lesson.rst +++ /dev/null @@ -1,128 +0,0 @@ - -************************** -Create a Lesson in Studio -************************** - -Once you have created a course, you are ready to create content for that course. - -.. warning:: - - The alpha version of Studio does not have versioning or automatic - updating of your browser between refreshes. Versioning is planned for future - refresheseleases, but, in the meantime, only one author should edit a unit, in one - browser, on only one tab.  If a unit is open for editing in multiple browser - sessions, the session that saves last will overwrite any previously saved - content without displaying a warning. Also, older browser sessions can overwrite - more recent content, so refresh your browser before you start working every time - you work with a private unit or edit a draft of a public unit. - - -Introduction -************ - -Just as in an offline course, content in an online course is broken down into -smaller pieces. In Studio, these pieces are categories called **sections, -subsections, and units** Units, in turn, are made up of **components** that -contain the actual content of your course. - -Sections, for example, may correspond to weeks in your course, while subsections -often correspond to lessons, homework assignments, or exams. A lesson is an -interwoven selection of units of different types, such as videos, text, images, -discussions, and problems. It is an interactive representation of the material -that you would cover in a typical class period. - -On the **Course Outline** page, you can see all the sections, subsections, and -units in your course at a glance, as well as whether the subsections are public -or private. - - - .. image:: Images/image029.png - :width: 800 - - .. image:: Images/image031.png - :width: 800 - -.. raw:: latex - - \newpage % - -Section -******* - -A section is the topmost category that you use to organize your course. Many -instructors name sections according to the number of weeks in the course—for -example, section 1 is named Week 1, section 2 is named Week 2, and so on. -Sections contain subsections, which in turn contain units. - -You can set an individual release date for each section in your course. None of -the content in the section is visible until its release date has passed. - -For more information about how to create a section, see -:doc:`create_section_sub_section`. - -.. raw:: latex - - \newpage % - -Subsection -********** - -A subsection is a subcategory of a section. Many instructors name subsections -according to the topics in their courses. Subsection names appear along with -section names in the left pane when you view your course on Edge. - - .. image:: Images/image033.png - -You can set subsections to be one of the assignment types that you created when -you set up grading. You can then include assignments in the body of that -subsection. - -You can set an individual release date for each subsection in your course. None -of the content in the subsection is visible until its release date has passed. -If you do not set a release date, the subsection has the same release date as -its section. - -For more information about how to create a subsection, see -:doc:`create_section_sub_section`. - -.. raw:: latex - - \newpage % - -Unit -**** - -A unit is a further category that helps you organize your course materials. -Units contain components, which are the building blocks of lessons. Units do not -appear in the left pane with section and subsection headings. Instead, each unit -appears as a part of the course accordion at the top of the page when you view -your course on Edge. The following page shows a subsection that has two Units. - - .. image:: Images/image035.png - -Note that by default, all units are set to **Private.** To make a unit visible -to students, you have to explicitly change the unit’s visibility to **Public.** -For more information see :doc:`set_content_releasedates` . - -.. raw:: latex - - \newpage % - - -Component -********* - -A component is the part of a unit that contains your actual course content. The -names of all components in a unit appear when you hover over the unit in the -course accordion at the top of the page. - -.. image:: Images/image037.png - :width: 800 - -There are four types of components: Discussion components, HTML components, -Problem components, and Video components. For more information, -see :doc:`create_discussion`, :doc:`create_html_component`, :doc:`create_problem`, and :doc:`create_video` . - - - - diff --git a/docs/course_authors/source/create_lti.rst b/docs/course_authors/source/create_lti.rst index 00ccb71c6778..bf804693d238 100644 --- a/docs/course_authors/source/create_lti.rst +++ b/docs/course_authors/source/create_lti.rst @@ -1,97 +1,188 @@ -********************** -Create a LTI Component -********************** - -Description -=========== - -The LTI XModule is based on the `IMS Global Learning Tools Interoperability `_ Version 1.1.1 specifications. - -Enabling LTI -============ - -It is not available from the list of general components. To turn it on, add -"lti" to the "advanced_modules" key on the Advanced Settings page. - -The module supports 2 modes of operation. - -1. Simple display of external LTI content -2. Display of LTI content that will be graded by external provider - -In both cases, before an LTI component from an external provider can be -included in a unit, the following pieces of information must be known/decided -upon: - -**LTI id** [string] - Internal string representing the external LTI provider. Can contain multi- - case alphanumeric characters, and underscore. - -**Client key** [string] - Used for OAuth authentication. Issued by external LTI provider. - -**Client secret** [string] - Used for OAuth authentication. Issued by external LTI provider. - -LTI id is necessary to differentiate between multiple available external LTI -providers that are added to an edX course. - -The three fields above must be entered in "lti_passports" field in the format:: - - [ - "{lti_id}:{client_key}:{client_secret}" - ] - -Multiple external LTI providers are separated by commas:: - - [ - "{lti_id_1}:{client_key_1}:{client_secret_1}", - "{lti_id_2}:{client_key_2}:{client_secret_2}", - "{lti_id_3}:{client_key_3}:{client_secret_3}" - ] - -Adding LTI to a unit -==================== - -After LTI has been enabled, and an external provider has been registered, an -instance of it can be added to a unit. - -LTI will be available from the Advanced Component category. After adding an LTI -component to a unit, it can be configured by Editing it's settings (the Edit -dialog). The following settings are available: - -**Display Name** [string] - Title of the new LTI component instance - -**custom_parameters** [string] - With the "+ Add" button, multiple custom parameters can be - added. Basically, each individual external LTI provider can have a separate - format custom parameters. For example:: - - key=value - -**graded** [boolean] - Whether or not the grade for this particular LTI instance problem will be - counted towards student's total grade. - -**launch_url** [string] - If `rgaded` above is set to `true`, then this must be - the URL that will be passed to the external LTI provider for it to respond with - a grade. - -**lti_id** [string] - Internal string representing the external LTI provider that - will be used to display content. The same as was entered on the Advanced - Settings page. - -**open_in_a_new_page** [boolean] - If set to `true`, a link will be present for the student - to click. When the link is clicked, a new window will open with the external - LTI content. If set to `false`, the external LTI content will be loaded in the - page in an iframe. - -**weight** [float] - If the problem will be graded by an external LTI provider, - the raw grade will be in the range [0.0, 1.0]. In order to change this range, - set the `weight`. The grade that will be stored is calculated by the formula:: - - stored_grade = raw_grade * weight +.. _Working with LTI Components: + +Working with LTI Components +============================ + + +Introduction to LTI Components +------------------------------ + +You may have discovered or developed an external learning application +that you want to add to your online course. Or, you may have a digital +copy of your textbook that uses a format other than PDF. You can add +external learning applications or textbooks to Studio by using a +Learning Tools Interoperability (LTI) component. The LTI component is +based on the `IMS Global Learning Tools +Interoperability `_ +version 1.1.1 specifications. + +You can use an LTI component in two ways. + +- You can add external LTI content that is displayed only, such as + textbook content that doesn’t require a student response. +- You can add external LTI content that requires a student response. An + external provider will grade student responses. + +Before you create an LTI component from an external LTI provider in a +unit, you need the following information. + +- The **LTI ID**. This is a value that you create to refer to the external LTI + provider. You should create an LTI ID that you can remember easily. + + The LTI ID can contain uppercase and lowercase alphanumeric + characters, as well as underscore characters (_). It can contain any + number of characters. For example, you may create an LTI ID that is + as simple as **test_lti_id**, or your LTI ID may be a string of + numbers and letters such as **id_21441** or + **book_lti_provider_from_new_york**. +- The **client key**. This value is a sequence of characters that you + obtain from the LTI provider. The client key is used for + authentication and can contain any number of characters. For example, + your client key may be **b289378-f88d-2929-ctools.umich.edu**. +- The **client secret**. This value is a sequence of characters that + you obtain from the LTI provider. The client secret is used for + authentication and can contain any number of characters. For example, + your client secret may be something as simple as **secret**, or it + may be a string of numbers and letters such as **23746387264** or + **yt4984yr8**. +- The **launch URL** (if the LTI component requires a student response + that will be graded). You obtain the launch URL from the LTI + provider. The launch URL is the URL that Studio sends to the external + LTI provider so that the provider can send back students’ grades. + +Create an LTI Component +----------------------- + +Creating an LTI component in your course has three steps. + +#. Add LTI to the **advanced_modules** policy key. +#. Register the LTI provider. +#. Create the LTI component in an individual unit. + +Step 1. Add LTI to the Advanced Modules Policy Key +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. On the **Settings** menu, click **Advanced Settings**. +#. On the **Advanced Settings** page, locate the **Manual Policy + Definition** section, and then locate the **advanced_modules** + policy key (this key is at the top of the list). + + .. image:: Images/AdvancedModulesEmpty.gif + +#. Under **Policy Value**, place your cursor between the brackets, and + then enter **“lti”**. Make sure to include the quotation marks, but + not the period. + + .. image:: Images/LTI_Policy_Key.gif + + **Note** If the **Policy Value** field already contains text, place your + cursor directly after the closing quotation mark for the final item, and + then enter a comma followed by **“lti”** (make sure that you include the + quotation marks). + +#. At the bottom of the page, click **Save Changes**. + +The page refreshes automatically. At the top of the page, +you see a notification that your changes have been saved. + +Step 2. Register the External LTI Provider +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To regiser the external LTI provider, you’ll add the LIT ID, the client +key, and the client secret in the **lti_passports** policy key. + +#. On the **Advanced Settings** page, locate the **lti_passports** + policy key. + +#. Under **Policy Value**, place your cursor between the brackets, and + then enter the LTI ID, client key, and client secret in the following + format (make sure to include the quotation marks and the colons). + + :: + + “lti_id:client_key:client_secret” + + For example, the value in the **lti_passports** field may be the following. + + :: + + “test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret” + + If you have multiple LTI providers, separate the values with a comma. + Make sure to surround each entry with quotation marks. + + :: + + "test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret", + "id_21441:b289378-f88d-2929-ctools.school.edu:23746387264", + "book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8" + + +#. At the bottom of the page, click **Save Changes**. + +The page refreshes automatically. At the top of the page, +you see a notification that your changes have been saved, and you can +see your entries in the **lti_passports** policy key. + +Step 3. Add the LTI Component to a Unit +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. In the unit where you want to create the problem, click **Advanced** + under **Add New Component**, and then click **LTI**. +#. In the component that appears, click **Edit**. +#. In the component editor, set the options that you want. See the table + below for a description of each option. +#. Click **Save**. + + .. list-table:: + :widths: 10 80 + :header-rows: 1 + + * - `Setting` + - Description + * - `Display Name` + - Specifies the name of the problem. This name appears above the problem and in + the course ribbon at the top of the page in the courseware. + * - `custom_parameters` + - Enables you to add one or more custom parameters. For example, if you've added an + e-book, a custom parameter may include the page that your e-book should open to. + You could also use a custom parameter to set the background color of the LTI component. + + Every custom parameter has a key and a value. You must add the key and value in the following format. + + :: + + key=value + + For example, a custom parameter may resemble the following. + + :: + + bgcolor=red + + page=144 + + To add a custom parameter, click **Add**. + * - `graded` + - Indicates whether the grade for the problem counts towards student's total grade. By + default, this value is set to **False**. + * - `has_score` + - Specifies whether the problem has a numerical score. By default, this value + is set to **False**. + * - `launch_url` + - Lists the URL that Studio sends to the external LTI provider so that the provider + can send back students' grades. This setting is only used if **graded** is set to + **True**. + * - `lti_id` + - Specifies the LTI ID for the external LTI provider. This value must be the same + LTI ID that you entered on the **Advanced Settings** page. + * - `open_in_a_new_page` + - Indicates whether the problem opens in a new page. If you set this value to **True**, + the student clicks a link that opens the LTI content in a new window. If you set + this value to **False**, the LTI content opens in an IFrame in the current page. + * - `weight` + - Specifies the number of points possible for the problem. By default, if an + external LTI provider grades the problem, the problem is worth 1 point, and + a student’s score can be any value between 0 and 1. + + For more information about problem weights and computing point scores, see :ref:`Problem Weight`. \ No newline at end of file diff --git a/docs/course_authors/source/create_new_course.rst b/docs/course_authors/source/create_new_course.rst new file mode 100644 index 000000000000..5fcce6a75b3b --- /dev/null +++ b/docs/course_authors/source/create_new_course.rst @@ -0,0 +1,365 @@ +.. _Setting up a New Course: + +########################### +Setting up a New Course +########################### + + +******************* +Overview +******************* + +This chapter describes how to create and set up your course: + +#. :ref:`Create a New Course` +#. :ref:`Edit Your Course` +#. :ref:`Use the Course Checklist` +#. :ref:`Add Course Team Members` +#. :ref:`Set Important Dates for Your Course` +#. :ref:`Describe Your Course` +#. :ref:`Add a Course Image` +#. :ref:`Add a Course Video` +#. :ref:`Set Course Requirements` +#. :ref:`Add Files to a Course` +#. :ref:`Add Static Pages` +#. :ref:`Add a Course Update` +#. :ref:`Add Course Handouts` +#. :ref:`Add Textbooks` + +Also see the chapters :ref:`Establish a Grading Policy`, :ref:`Organizing Your Course Content`, and :ref:`Guidelines for Creating Accessible Content`. + + + +.. _Create a New Course: + +******************* +Create a New Course +******************* + +#. Log in to Studio. +#. Click **New Course**. +#. Enter course information as needed and click **Create**. + + .. image:: Images/new_course_info.png + :width: 800 + + .. note:: Enter new course information carefully. This information becomes part of the URL for your course. To change the URL after the course is created, you must contact edX through the Help site (http://help.edge.edx.org). Additionally, because this information becomes part of your course URL, the total number of characters in the following three fields must be 65 or fewer. + + * For **Course Name**, enter the title of your course. For example, the name may be “Sets, Maps and Symmetry Groups". Use title capitalization for the course title. + + * For **Organization**, enter the name of your university. Do not include whitespace or special characters. + + * For **Course Number**, enter both a subject abbreviation and a number. For example, for public health course number 207, enter **PH207**. For math course 101x, enter **Math101x**. Do not include whitespace or special characters in the course number. + + *Note: If your course will be open to the world, be sure to include the "x". If it is exclusively an on-campus offering, do not include the "x".* + +4. Click **Save.** + +You then see the empty Course Outline. + +.. _Edit Your Course: + +************************ +Edit Your Course +************************ +When you create a new course, the course opens in Studio automatically and you can begin editing. + +If you come back to Studio later, your courses are listed on the Studio login page. + + .. image:: Images/open_course.png + :width: 800 + +To open the course, click the course name. + +When you open a course, you go to the Course Outline. The next topic discusses working with your course outline. + +The rest of this page discusses other tasks you must do to set up your course. + +.. _Use the Course Checklist: + +************************ +Use the Course Checklist +************************ + +You can use a Course Checklist within Studio to help you work through the tasks of building a course. + +Categories of tasks in the Course Checklist include: + +* Getting Started with Studio +* Draft a Rough Course Outline +* Explore edX's Support Tools +* Draft Your Course About Page + +From the **Tools** menu, select **Checklists**. + + .. image:: Images/checklist.png + :width: 800 + + +As shown above for the **Add Course Team Members** task, if you hover over a task, a button is displayed that takes you to the page to complete that task. + +You can expand and collapse sections of this page as needed. + +You can check tasks as you complete them. Studio saves your changes automatically. Other course staff can see your changes. + +.. _Add Course Team Members: + +************************ +Add Course Team Members +************************ + +Course team members are users who help you build your course. + +Only a team member with Admin access can add or remove course team members, or grant Admin access to other team members. + +Other course team members can edit the course and perform all tasks except adding and removing other new team members and granting Admin access. + +.. note:: Any course team member can delete content created by other team members. + +All course team members must be registered with Studio and have an active account. + +To add a course team member: + +#. Ensure you have Admin access. +#. Ensure that the new team member has registered with Studio. +#. From the **Settings** menu, select **Course Team**. +#. Click **Add a New Team Member**. +#. Enter the new team member's email address, then click **ADD USER**. + +.. _Set Important Dates for Your Course: + +*********************************** +Set Important Dates for Your Course +*********************************** +You must set dates and times for enrollment and for the course. + +From the **Settings** menu, select **Schedule and Details**. + +.. image:: Images/schedule.png + +Follow the on-screen text to enter the course and enrollment schedule. + +.. note:: + + The Time fields on this page reflect the current time zone in your browser, depending on your geography. Course start times for students are shown as UTC. + +.. _`Describe Your Course`: + +************************ +Describe Your Course +************************ + +The description of your course appears on the Course Summary page that students see, and includes a course summary, prerequisites, staff information and FAQs. + +#. From the **Settings** menu, select **Schedule & Details**. +#. Scroll down to the **Introducing Your Course** section, then locate the **Course Overview** field. + +.. image:: Images/course_overview.png + :width: 800 + +3. Overwrite the content as needed for your course, following the directions in the boilerplate text. Do not edit HTML tags. For a template that includes placeholders, see :doc:`appendices/a`. + + .. note:: There is no save button. Studio automatically saves your changes. + +4. Click **your course summary page** in the text beneath the field to test how the description will appear to students. + +.. _`Add a Course Image`: + +************************ +Add a Course Image +************************ + +The course image appears on the Course Summary page that students see. + +The course image should be a minimum of 660 pixels in width by 240 pixels in height, and in .JPG or .PNG format. + +#. From the **Settings** menu, select **Schedule & Details**. +#. Scroll down to the **Course Image** section. +#. To select an image from your computer, click **Upload Course Image**, then follow the prompts to find and upload your image. +#. View your course summary page to test how the image will appear to students. + +.. _`Add a Course Video`: + +************************ +Add a Course Video +************************ +The course video appears on the Course Summary page that students see. + + +#. Upload the course video to YouTube. Make note of the code that appears between **watch?v =** and **&feature** in the URL. This code appears in the green box below. + + .. image:: Images/image127.png + :width: 800 + +2. From the **Settings** menu, select **Schedule & Details**. +#. Scroll down to the **Course Introduction Video** section. +#. In the field below the video box, enter the YouTube video ID. When you add the code, the video automatically loads in the video box. Studio automatically saves your changes. +#. View your course summary page to test how the video will appear to students. + +.. _`Set Course Requirements`: + +************************ +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. +#. 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. + +.. _`Add Files to a Course`: + +********************** +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 +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: + +#. 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**. +#. 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. + +================== +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 +================== +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. + +================== +Delete a file +================== +To delete a file, click the **x** icon next to the file. You are prompted to confirm the deletion. + +.. warning:: If you have links to a file you delete, those links will be broken. Ensure you change those links before deleting the file. + +.. _`Add Static Pages`: + +**************** +Add Static Pages +**************** +You can add static pages to your course. Each static page appears in your courses navigation bar. +For example, the following navigation bar includes a +**Syllabus** and **Projects** static pages. + +.. image:: Images/image157.png + +You can use static pages for a syllabus, grading policy, course handouts, or any other purpose. + +.. note:: The Course Info, Discussion, Wiki, and Progress pages are displayed to students by default. You cannot delete these pages. + +To create a static page: + +#. From the **Content** menu, select **Static Pages**. +#. Click **New Page**. The following screen opens: + + .. image:: Images/image161.png + :width: 800 + +3. Click **Edit**. + +#. Enter text for your page. You can switch to HTML mode if needed. +#. To edit the Display Name, click **Settings**. +#. Click **Save**. + +To delete a static page, click **Delete** in the row for the page. Confirm the deletion. + + +================== +Add a Calendar +================== +You can also use a static page to show a course calendar. + +You can embed a Google calendar. Paste the embed code for the calendar in the static page. + +You can also create a dynamic HTML calendar. See :ref:`Appendix B`. + +.. _`Add a Course Update`: + +********************** +Add a Course Update +********************** + +You add updates to notify students of exams, changes in the course schedule, or anything else of a more urgent nature. + +Students see course updates in **Course Info** tab when they log in to the course: + +.. image:: Images/course_info.png + :width: 800 + +To add a course update: + +#. From the **Content** menu, select **Updates**. +#. Click **New Update**. +#. Enter your update as as HTML. + + .. note:: You must enter the update in HTML. For a template that includes placeholders, see :ref:`Appendix A`. + +4. Click **Save**. + +.. _`Add Course Handouts`: + +********************** +Add Course Handouts +********************** +You can add course handouts that are visible to students on the **Course Info** page. + +.. note:: You must :ref:`Add Files to a Course` before you can add them as course handouts. + +#. From the **Content** menu, select **Updates**. +#. In the **Course Handouts** page, click **Edit**. +#. Edit the HTML to add links to the files you uploaded. See :ref:`Add a Link in an HTML Component` for more information. +#. Click **Save**. + +.. _`Add Textbooks`: + +**************** +Add Textbooks +**************** +You can add textbooks for your course as PDF files. + +Each textbook that you add is displayed to students as a tab in the course navigation bar. + +It's recommended that you upload a separate PDF file for each chapter of your textbook. + +When students open the textbook tab in the course, they can navigate the textbook by chapter: + +.. image:: Images/textbook_chapters.png + :width: 800 + +To add a textbook: + +#. From the **Content** menu, select **Textbooks**. +#. Click **New Textbook**. The following screen opens: + + .. image:: Images/textbook_new.png + :width: 800 + +3. Enter the **Textbook Name**. +#. Enter the first **Chapter Name**. +#. To upload a PDF file from your computer, click **Upload PDF**. Follow the prompts to upload your file. +#. To add addition chapters, click **+Add a Chapter** and repeat steps 3 and 4. +#. Click **Save**. \ No newline at end of file diff --git a/docs/course_authors/source/create_problem.rst b/docs/course_authors/source/create_problem.rst deleted file mode 100644 index 3fe8264b4dc6..000000000000 --- a/docs/course_authors/source/create_problem.rst +++ /dev/null @@ -1,374 +0,0 @@ - -**************** -Create a Problem -**************** - -Overview -******** - - -The problem component allows you to add interactive, automatically graded exercises to your course content. You can create many different types of problems -in Studio. - -By default, all problems are ungraded practice problems. To change the problems to graded problems, change the assignment type of the subsection. - -To create a problem, determine: - -• The type of problem that you want. - -• The weight to assign to the problem. - -• Whether you want to randomize the problem. - -• How to close the problem-that is, how to set the number of attempts a student has, [as well as set the due date]. - -• How you want to provide feedback to students; show answer on/off. - -This course contains several places with more information about creating exercises and integrating them into your course. - -• `Writing Exercises `_ has more in-depth discussion about problem types, and some general pedagogical considerations for adapting to the online format and a `Gallery of Response Types `_ - -• `Appendix E ` contains XML documentaion for the different problem response types. - -• The `Discussion Forum `_ for this class is a good place to ask questions about exercise types, report any errors or oddities that you may encounter, and get technical support. - -• Creating problems for the online format opens a new playing field in the educational process. A big part of the community aspect of edX is to initiate and grow a `Creative Problems `_ . Please look here to be inspired by new approaches when first making your class. Please also come back to post interesting approaches that you came up with while running your class, and to share with the community what worked well and what did not. - -**Simple Editor and Advanced Editor** - - -Studio offers two interfaces for editing problem components. - -• The **Simple Editor** allows you to edit problems visually, without having to work with XML. - -• The **Advanced Editor** converts the problem to edX's XML standard and allows you to edit that XML directly. For more information about the XML for different problem types, see `Appendix E ` . - - -Some of the simpler problem templates, including multiple choice, open in the Simple Editor and allow you to switch to the Advanced Editor. The more complicated problem types, such as Circuit Response, open in the Advanced Editor. - -.. note:: - - You can switch at any time from the Simple Editor to the Advanced Editor by clicking "Advanced Editor" in the Simple Editor interface. However, there is no way to go back from the Advanced Editor to the Simple Editor without making a new component. - -To open the Advanced Editor, click **Advanced Editor** in the top right corner of the Simple Editor. - -.. image:: Images/image275.png - :width: 600px - - -The following is a multiple choice problem in the Advanced Editor. - -.. image:: Images/image276.png - :width: 600px - -.. raw:: latex - - \newpage % - - -Problem Type -************ - -Links to description of all the different problem types-brief. Then include links to all the XML, etc. - -You may want to create a problem that has more than one response type. For example, you may want to create a multiple choice question, and then ask the -student to explain his or her response. You may also want a student to be able to check the answers to many problems at one time. To accomplish these -tasks, you can include multiple problems inside a single Problem component. (LINK) - -.. raw:: latex - - \newpage % - -Randomizing -*********** - -The **rerandomize** setting determines whether any random variable inputs for a problem are randomized each time a student loads the problem. -(This is only applicable to problems with randomly generated numeric variables.) - -.. raw:: latex - - \newpage % - -Scoring and Weight -****************** - -Problems store a **point score** for submitted responses. The score that a student earns is the number of correct responses the student -submits divided by the maximum score for the problem. The default maximum score, or weight, is the integer number of response type inputs the problem has. -Thus, the weight attribute for a problem with one response type input is set to 1 (one point). You can change the maximum score for an individual problem -by manually changing the problem **weight** attribute to another number. When you do this, the number of points that you specify appears next -to the problem title ( to one decimal precision). - -**WEIGHT: 0 POINTS** - -Scores are stored for all problems, but they only contribute to a student's grade in the course if they are part of a subsection marked as graded. For more -information, see the material on attempts and closing problems in 7B: Feedback and Grading. - -.. raw:: latex - - \newpage % - -**Computing Point Scores** - -The point score of a response for a problem reflects the correctness of the response and is recorded as the number of points earned out of the maximum -possible score for the problem (also known as the problem weight). The formula used for computing the recorded point score is the following: - -• **point score of response = problem weight * (# inputs correct / # total inputs)** - -• **point score of response** is the point score "earned" by this response for the problem. - -• **problem weight** is the maximum possible point score that can be earned for the problem. By default, this is the integer number of response types in that problem. This can be changed to another value by setting the weight attribute of the problem, as described in Setting Problem Attributes. - -• ** # inputs correct** is the number of values for this response that were evaluated as correct by the response type fields. - -• **# total inputs** is the total number of response type fields in the problem. - -.. raw:: latex - - \newpage % - -**Examples** - -The following are some examples of setting problem weight and computing problem scores. - - -**Example 1** - -A problem with two response type inputs and a blank weight attribute has a maximum score of 2.0 points. - -A student response to this problem that consists of one correct input value and one incorrect input value would be marked as having a score of 1.0 points -out of 2.0 points possible. - - -**Example 2** - -A problem with three response type inputs and a weight attribute of 12 has a maximum score of 12.0 points. - -A student response to this problem that consists of one correct input value and two incorrect input values would be marked as having a score of 4.0 points out of 12.0 points possible. - - -**Example 3** - -A problem with four response type inputs and a weight attribute of 2 has a maximum score of 2.0 points. - -A student response to this problem that consists of two correct input values and two incorrect input values would be marked as having a score of 0.5 of a point out of 2.0 points total. - -**PROBLEM: 20.0 POINTS** - -• The weight attribute for this problem has been changed from the default. - -• How many points is the entire problem worth? - -• What number is the weight attribute of this problem set to? - -• How many response inputs does this problem have? - -• What is the default maximum score for this problem? - -• If a response to this problem got one value right and the rest wrong, what score would it be assigned? - -.. raw:: latex - - \newpage % - -Close -***** - -To stop accepting responses and recording points, problems can be **closed.** Closed problems do not display a **Check** button. Students -can still see questions, solutions, and revealed explanations in a closed problem, but they can no longer check their work, submit responses, or change their stored score. - -There are several ways that you can close problems: - -• Set a due date for the problems in a subsection. Note that you cannot set due dates for individual problems -- only for containing subsections (assignments). By default, due dates are not set. To set a due date, see LINK. - -• Specify a grace period for your course. Note that the grace period applies to the entire course. To set a grace period, see LINK. - -• Set the number of attempts for the individual problem component. The attempts setting determines the number of times a student is allowed to check their answer by clicking Check before the problem closes. If this field is left blank, a student has unlimited attempts. If you specify a number for the attempts setting, the number of total allowed and remaining attempts appears next to the Check button for the problem. Problems with a limited number of attempts also always display a Save button that allows response values to be saved without being submitted. When there is only one submission left, the student will receive a warning, and the Check button will be replaced with a Final Check button. When no attempts are left, both the Save and Check button will disappear.For more information, see Problem Attributes. - -• Manually increase the number of attempts left for a given problem for a particular student from the Instructor tab in the live view of your course, when accessed in the Instructor view on Edge. This is recommended only for unusual situations, such as if you have to fix live problems during an exam. - -.. raw:: latex - - \newpage % - -Feedback -******** - -Studio includes several tools to provide feedback to students: the **Check** button, the **Show Answer** button, and the**Attempts** setting. When you use the **Show Answer** button, you can also provide a detailed explanation of the answer. - -TBD-SCREENSHOT OF PROBLEM WITH THESE ELEMENTS CIRCLED - -**Check Button** - -The student clicks the **Check** button to submit a response. The problem module then performs the following steps. - -• Accepts and stores the responses entered into each input. - -• Checks the response values against the correct answers or solutions using an automatic grader. - -• Visually marks the correct responses with a green check mark and the incorrect responses with a red x. - -• Stores the point score earned by this response for this problem for this student. - -If a student wants to save but not submit a response, the student can click **Save**. - -In the following problem, enter a response, and then click **Check**. The problem tells you if your response is correct or incorrect. -Additionally, although you don't see it, a point score is also automatically stored for the response you submit. - -.. image:: Images/image277.png - :width: 600px - -**Show Answer button** - -When a student clicks **Show Answer**, the problem shows the correct answers next to the corresponding response inputs and reveals any -additional explanations that you have provided. **Show Answer** is controlled by the **showanswer** attribute in the problem -editor. It can be set to be never visible, always visible, or visible only when the problem has closed. [Reference: Setting Problem Attributes.] - -In the following problem, the **Show Answer ** button appears after the student has made at least one attempt to answer. Enter a response that you know is wrong, and then click **Check**. - -.. image:: Images/image278.png - :width: 600px - -Now, click **Show Answer** to view the correct answer and its explanation. - -.. image:: Images/image279.png - :width: 600px - - -.. raw:: latex - - \newpage % - - - -Create a Problem -**************** - -.. note:: - - You can also include non-graded exercises throughout your course. - - -To add interactive, automatically graded exercises to your course content, use the Problem component. This component allows you to include an explanation -that the student can see when the student clicks **Show Answer**. - - Studio offers several templates that you can use. Alternatively, you can create your own problem type in XML. - For detailed information about different problem types, see `Appendix E `. - - -1. Under **Add New Component**, click **Problem**. - -.. image:: Images/image096.png - :width: 600px - - -The **Select Problem Component Type** screen appears. By default, the **Common Problem Types** tab is selected. - -.. image:: Images/image097.png - :width: 600px - - -To see a list of more complex problem types, click the **Advanced** tab. - - -.. image:: Images/image099.png - :width: 600px - - -2. Click the problem type that you want. - -.. note:: - - To create your own problem in XML, click "Empty" to open a blank XML editor. - -A new problem component with sample template text appears. - -For example, if you click **Multiple Choice**, the following problem component appears. - -.. image:: Images/image101.png - :width: 600px - - - -3. Click **Edit**. This opens the Simple Editor for the problem component. The following example shows this view for a multiple choice -problem. - -.. image:: Images/image103.jpg - :width: 600px - - -4. Set the problem attributes. - -In the **display_name** box, type the text that you want the student to see when the student hovers over the icon in the bar at the top of the page. This text also appears as a header for the problem. - -a. In the **weight** box, set a weight for the problem. If you want the problem to be a practice problem, set this to zero (0). - -b. In the **rerandomize** box, - -c. In the **attempts** box, specify the number of attempts that you want to allow the student. - -d. In the **showanswer** box, enter one of the following settings. - -.. raw:: latex - - \newpage % - -**Reference** - -• **never** = The Show Answer button is never visible. - -• **closed** = The Show Answer button is not visible if either the due date has passed, or the student has no attempts left. - -• **attempted** = The Show Answer button appears after the student has checked an answer once, regardless of correctness. - -• **always** = The Show Answer button always appears. - - -5. Modify the problem text, and then click **Save** to save and check your work. Make sure to publish the draft you are working on to view the problem live. - -.. raw:: latex - - \newpage % - -Modify a Released Problem -************************* - - **WARNING: Be careful when you modify problems after they have been released!** - -Currently, problems cache the following information per student: - -• The student's last **submitted** response. - -• The score the student earned for that last response. - -• The maximum point score for that problem. - -This information is updated when a student submits a response to a problem. If the student refreshes the **Progress** page, solutions are not re-checked. If a student refreshes the page of a problem, the latest version of the problem statement is loaded, but their previous response is NOT reevaluated. Rather, the previous response is loaded on top of the current problem statement. That is **existing** student responses for a problem are not reevaluated if the problem statement or attributes are changed, until a student goes back and resubmits the problem. Furthermore, as of the time of writing, if the problem weight attribute is changed, stored scores are re-weighted (without rechecking the response) when the student reloads the **Progress** page. - -For example, you may release a problem that has two inputs. After some students have submitted answers, if you change the solution to one of the inputs, the existing student scores are not updated. - -Example: If you change the number of inputs to three, students who submitted answers before the change will have a score of 0, 1, or 2 out of 2.0. Students who submitted answers after the change will have scores of 0, 1, 2, or 3 out of 3.0 for the same problem. - -However, if you go in and change the weight of the problem, the existing scores update when you refresh the **Progress** page. - -Note that the behavior of re-grading in case of error is an edX Edge case. It is dependent on the implementation of grading, and may change. The goal in the future is to include re-grading that will allow some basic updates to live problems, whether or not students have submitted a response. - -.. raw:: latex - - \newpage % - - -Workarounds -=========== - -If you have to modify a released problem in a way that affects grading, you have two options. Note that both options require you to ask your students to go back and resubmit a problem. - - -1. Increase the number of attempts on the problem in the same Problem component. Then ask all the students in your class to redo the problem. - -2. Delete the entire Problem component in Studio and create a new Problem component with the content and settings that you want. Then ask all the students in your course to go back to this assignment and complete problem. - -Check your **Progress** view or the **Instructor** tab on Edge as described in the Viewing Scores unit to see if point scores are being stored as you expect. If there are issues with stored scores that you do not understand or cannot fix, contact support on the Studio help page. - -For a discussion of some trade-offs and some suggestions for cleaner solutions in the future, see the following `discussion thread `_ on the Studio help desk. - -You can include multiple problems of different types inside a single Problem component, even if you select a particular template when you create a problem. A template is simply an XML editor with template text already filled in. You can add to or replace the template text. diff --git a/docs/course_authors/source/create_problem_component.rst b/docs/course_authors/source/create_problem_component.rst new file mode 100644 index 000000000000..696baf9fd602 --- /dev/null +++ b/docs/course_authors/source/create_problem_component.rst @@ -0,0 +1,421 @@ +.. _Working with Problem Components: + +################################ +Working with Problem Components +################################ + +********* +Overview +********* + +The problem component allows you to add interactive, automatically +graded exercises to your course content. You can create many different +types of problems in Studio. + +All problems receive a point score, but, by default, problems do not count +toward a student's grade. If you want the problems to count toward the +student's grade, change the assignment type of the subsection that contains the +problems. + +See the following topics: + +* :ref:`Components and the User Interface` +* :ref:`Problem Settings` +* :ref:`Multiple Problems in One Component` +* :ref:`Modifying a Released Problem` + + +.. _Components and the User Interface: + +************************************ +Components and the User Interface +************************************ + +This section contains a description of the various components of a +problem as students see it in the LMS, as well as an introduction to the +Studio user interface for course creators. + +============================== +The Student View of a Problem +============================== + +All problems on the edX platform have several component parts. + +.. image:: Images/AnatomyOfExercise1.gif + +#. **Problem text.** The problem text can contain any standard HTML formatting. + +#. **Response field with the student’s answer.** Students enter answers + in *response fields*. The appearance of the response field depends on + the type of the problem. + +#. **Rendered answer.** For some problem types, Studio uses MathJax to + render plain text as “beautiful math.” + +#. **Check button.** The student clicks **Check** to submit a response + or find out if his answer is correct. If the answer is correct, a green + check mark appears. If it is incorrect, a red X appears. When the + student clicks the **Check button**, Studio saves the grade and current + state of the problem. + +#. **Save button.** The student can click **Save** to save his current + response without submitting it for a grade. This allows the student to + stop working on a problem and come back to it later. + +#. **Show Answer button.** This button is optional. When the student + clicks **Show Answer**, the student sees both the correct answer (see 2 + above) and the explanation (see 10 below). The instructor sets whether + the **Show Answer** button is visible. + +#. **Attempts.** The instructor may set a specific number of attempts or + allow unlimited attempts. + + .. image:: Images/AnatomyOfExercise2.gif + +#. **Feedback.** After a student clicks **Check**, all problems return a + green check mark or a red X. + + .. image:: Images/AnatomyofaProblem_Feedback.gif + +#. **Correct answer.** Most problems require that the instructor specify + a single correct answer. + +#. **Explanation.** The instructor may include an explanation that + appears when a student clicks **Show Answer**. + +#. **Reset button.** This button clears the student input, so that the + problem looks the way it did originally. + +#. **Hide Answer button.** + + .. image:: Images/AnatomyOfExercise3.gif + +#. **Grading.** The instructor may specify whether a group of problems + is graded. If a group of problems is graded, a clock icon appears for + that assignment in the course accordion. + + .. image:: Images/clock_icon.gif + +#. **Due date.** The date that the problem is due. A problem that is + past due does not have a **Check** button. It also does not accept + answers or provide feedback. + +.. note:: Problems can be **open** or **closed.** Closed problems do not + have a **Check** button. Students can still see questions, solutions, + and revealed explanations, but they cannot check their work, submit + responses, or change their stored score. + +There are also some attributes of problems that are not immediately +visible. + +- **Randomization.** For some problems, the instructor can specify + whether a problem will use randomly generated numbers that vary from + student to student. +- **Weight.** Different problems in a particular problem set may be + given different weights. + +.. _Studio UI: + +============================== +The Studio User Interface +============================== + +Studio offers two interfaces for editing problem components: the Simple +Editor and the Advanced Editor. + +- The **Simple Editor** allows you to edit problems visually, without + having to work with XML. +- The **Advanced Editor** converts the problem to edX’s XML standard + and allows you to edit that XML directly. + +.. note:: You can switch at any time from the Simple Editor to the + Advanced Editor by clicking **Advanced Editor** in the top right corner + of the Simple Editor interface. However, it is not possible to switch from + the Advanced Editor to the Simple Editor. + +The Simple Editor +~~~~~~~~~~~~~~~~~ +The Common Problem templates, including multiple choice, open in the Simple Editor. The +following image shows a multiple choice problem in the Simple Editor. + +The Simple Editor includes a toolbar that helps you format the text of your problem. +When you select text and then click the formatting buttons, the Simple Editor formats +the text for you automatically. The toolbar buttons are the following: + +1. Create a level 1 heading. +2. Create multiple choice options. +3. Create checkbox options. +4. Create text input options. +5. Create numerical input options. +6. Create dropdown options. +7. Create an explanation that appears when students click **Show Answer**. +8. Open the problem in the Advanced Editor. +9. Open a list of formatting hints. + +The following image shows a multiple choice problem in the Simple Editor. + +.. image:: Images/MultipleChoice_SimpleEditor.gif + +.. _Advanced Editor: + +The Advanced Editor +~~~~~~~~~~~~~~~~~~~ +The **Advanced Editor** opens a problem in XML. The Advanced Problem templates, +such as the circuit schematic builder, open directly in the Advanced Editor. + +For more information about the XML for different problem types, see :ref:`Appendix E`. + +The following image shows the multiple choice problem above in the Advanced Editor +instead of the Simple Editor. + +.. image:: Images/MultipleChoice_AdvancedEditor.gif + +.. _Problem Settings: + +****************** +Problem Settings +****************** + +All problems except word cloud and open response assessment problems +have the following settings. These settings appear on the **Settings** tab in +the component editor. (The settings for open response assessments and word clouds +are listed on the page for those problem types.) + +- Display Name +- Maximum Attempts +- Problem Weight +- Randomization +- Show Answer + +.. image:: Images/ProbComponent_Attributes.gif + +=============== +Display Name +=============== + +This setting indicates the name of your problem. The display name +appears as a heading over the problem in the LMS and in the course +ribbon at the top of the page. + +.. image:: Images/ProbComponent_LMS_DisplayName.gif + +============================== +Maximum Attempts +============================== + +This setting specifies the number of times a student can try to answer +the problem. By default, a student has an unlimited number of attempts. + +.. _Problem Weight: + +============================== +Problem Weight +============================== + +.. note:: Studio stores scores for all problems, but scores only count + toward a student’s final grade if they are in a subsection that is + graded. + +This setting specifies the maximum number of points possible for the +problem. The problem weight appears next to the problem title. + +.. image:: Images/ProblemWeight_DD.gif + +By default, each response field, or “answer space,” in a Problem +component is worth one point. Any Problem component can have multiple +response fields. For example, the Problem component above +contains one dropdown problem that has three separate questions for students +to answer, and thus has three response fields. + +The following Problem component contains one text input problem, +and has just one response field. + +.. image:: Images/ProblemWeight_TI.gif + +Computing Scores +~~~~~~~~~~~~~~~~ + +The score that a student earns for a problem is the result of the +following formula: + +**Score = Weight × (Correct answers / Response fields)** + +- **Score** is the point score that the student receives. +- **Weight** is the problem’s maximum possible point score. +- **Correct answers** is the number of response fields that contain + correct answers. +- **Response fields** is the total number of response fields in the + problem. + +**Examples** + +The following are some examples of computing scores. + +*Example 1* + +A problem’s **Weight** setting is left blank. The problem has two +response fields. Because the problem has two response fields, the +maximum score is 2.0 points. + +If one response field contains a correct answer and the other response +field contains an incorrect answer, the student’s score is 1.0 out of 2 +points. + +*Example 2* + +A problem’s weight is set to 12. The problem has three response fields. + +If a student’s response includes two correct answers and one incorrect +answer, the student’s score is 8.0 out of 12 points. + +*Example 3* + +A problem’s weight is set to 2. The problem has four response fields. + +If a student’s response contains one correct answer and three incorrect +answers, the student’s score is 0.5 out of 2 points. + +=============== +Randomization +=============== + +This setting only applies to problems that have randomly generated +numeric values. It specifies whether random variable inputs are +randomized when a student loads the problem. + +=============== +Show Answer +=============== + +This setting defines when the problem shows the answer to the student. +This setting has seven options. + ++-------------------+--------------------------------------+ +| **Always** | Always show the answer when the | +| | student clicks the **Show Answer** | +| | button. | ++-------------------+--------------------------------------+ +| **Answered** | Show the answer after the student | +| | has submitted her final answer. | ++-------------------+--------------------------------------+ +| **Attempted** | Show the answer after the student | +| | has tried to answer the problem one | +| | time, whether or not the student | +| | answered the problem correctly. | ++-------------------+--------------------------------------+ +| **Closed** | Show the answer after the student | +| | has used up all his attempts to | +| | answer the problem or the due date | +| | has passed. | ++-------------------+--------------------------------------+ +| **Finished** | Show the answer after the student | +| | has answered the problem correctly, | +| | the student has no attempts left, or | +| | the problem due date has passed. | ++-------------------+--------------------------------------+ +| **Past Due** | Show the answer after the due date | +| | for the problem has passed. | ++-------------------+--------------------------------------+ +| **Never** | Never show the answer. In this case, | +| | the **Show Answer** button does not | +| | appear next to the problem in Studio | +| | or in the LMS. | ++-------------------+--------------------------------------+ + +=============== +Problem Types +=============== + +Studio includes templates for many different types of problems, from +simple multiple choice problems to advanced problems that require the +student to “build” a virtual circuit. Details about each problem type, +including information about how to create the problem, appears in the +page for the problem type. + +- :ref:`Common Problems` appear on the **Common Problem Types** tab when you + create a new Problem component in Studio. You create these problems + using the Simple Editor. +- :ref:`Advanced Problems` appear on the **Advanced** tab when you create a + new Problem component. You create these problems using the Advanced + Editor. +- :ref:`Specialized Problems` are advanced problems that aren’t available by + default. To add these problems, you first have to modify the advanced + settings in your course. The Advanced component then appears under + **Add New Component** in each unit, and these problems are available + in the Advanced component. +- :ref:`Open Response Assessment Problems` are a new kind of problem that allow you, the + students in your course, or a computer algorithm to grade responses in the form + of essays, files such as computer code, and images. + +.. _Multiple Problems in One Component: + +************************************ +Multiple Problems in One Component +************************************ + +You may want to create a problem that has more than one response type. +For example, you may want to create a numerical input problem, and then +include a multiple choice question about the numerical input problem. +Or, you may want a student to be able to check the answers to +many problems at one time. To do this, you can include multiple problems +inside a single Problem component. The problems can be different types. + +To create multiple problems in one component, create a new Blank +Advanced Problem component, and then paste the XML for each problem in +the component editor. You only need to include the XML for the problem +and its answers. You don’t have to include the code for other elements, +such as the **Check** button. + +Elements such as the **Check**, **Show Answer**, and **Reset** buttons, +as well as the settings that you select for the Problem component, apply +to all of the problems in that component. Thus, if you set the maximum +number of attempts to 3, the student has three attempts to answer +the entire set of problems in the component as a whole rather than three +attempts to answer each problem individually. If a student clicks +**Check**, the LMS scores all of the problems in the component at once. +If a student clicks **Show Answer**, the answers for all the problems in +the component appear. + +.. _Modifying a Released Problem: + +************************************ +Modifying a Released Problem +************************************ + +.. warning:: Be careful when you modify problems after they have been released! + +After a student submits a response to a problem, Studio stores the +student’s response, the score that the student received, and the maximum +score for the problem. Studio updates these values when a student +submits a new response to a problem. However, if an instructor changes a +problem or its attributes, Studio does not automatically update existing +student information for that problem. + +For example, you may release a problem and specify that its answer is 3. +After some students have submitted responses, you notice that the answer +should be 2 instead of 3. When you update the problem with the correct +answer, Studio doesn’t update scores for students who answered 2 for the +original problem and thus received the wrong score. + +For another example, you may change the number of response fields to +three. Students who submitted answers before the change have a score of +0, 1, or 2 out of 2.0 for that problem. Students who submitted answers +after the change have scores of 0, 1, 2, or 3 out of 3.0 for the same +problem. + +If you change the weight of the problem, however, the existing scores +update when you refresh the **Progress** page. + +=============== +Workarounds +=============== + +If you have to modify a released problem in a way that affects grading, +you have two options. Note that both options require you to ask your +students to go back and resubmit a problem. + +- In the Problem component, increase the number of attempts for the + problem. Then ask all your students to redo the problem. +- Delete the entire Problem component in Studio and create a new + Problem component with the content and settings that you want. Then + ask all your students to complete the new problem. diff --git a/docs/course_authors/source/create_section_sub_section.rst b/docs/course_authors/source/create_section_sub_section.rst deleted file mode 100644 index ebd509d394ce..000000000000 --- a/docs/course_authors/source/create_section_sub_section.rst +++ /dev/null @@ -1,67 +0,0 @@ - -******************************* -Create a Section and Subsection -******************************* - - -1. Sign in to Studio, and then click the course that you want. - - -2. On the **Course Outline** page, click **New Section.** - - -.. image:: Images/image039.png - :width: 800 - - - -3. In the **New Section** Name box, type a section name, and then click -**Save**. - -.. note:: - - In most courses, the name of the first section is Week 1. - The section that you have created appears on the **Course Outline** page. - -.. image:: Images/image041.png - :width: 800 - - -The name you enter also appears in the navigation ribbon, as follows. - - -.. image:: Images/image043.png - :width: 800 - - -4. To create a new lesson or assessment in your section, click **New -Subsection.** - - -5. In the **New Subsection** box, enter the name for this subsection, and then -click **Save.** - -For example, if you enter **Week 1** as the section title and **Subsection 1** -as the subsection title, you see the following. - - -.. image:: Images/image045.png - :width: 800 - - -If you view your course as a student would see it, you see the following. - - -.. image:: Images/image047.png - :width: 800 - - -6. Click the new subsection that you just created. In this example, you would -click **Subsection 1.** You see the following screen. - - -.. image:: Images/image049.png - :width: 800 - - - diff --git a/docs/course_authors/source/create_seed_wiki b/docs/course_authors/source/create_seed_wiki deleted file mode 100644 index 3eb688f50592..000000000000 --- a/docs/course_authors/source/create_seed_wiki +++ /dev/null @@ -1,7 +0,0 @@ - -************************ -Create and Seed the Wiki -************************ - -Create wiki ("seed" the wiki) - \ No newline at end of file diff --git a/docs/course_authors/source/create_seed_wiki.rst b/docs/course_authors/source/create_seed_wiki.rst deleted file mode 100644 index c6c66c923e0f..000000000000 --- a/docs/course_authors/source/create_seed_wiki.rst +++ /dev/null @@ -1,7 +0,0 @@ - -************************ -Create and Seed the Wiki -************************ - -Create wiki ("seed" the wiki) - diff --git a/docs/course_authors/source/create_unit.rst b/docs/course_authors/source/create_unit.rst deleted file mode 100644 index 5136b935e36b..000000000000 --- a/docs/course_authors/source/create_unit.rst +++ /dev/null @@ -1,25 +0,0 @@ - -************* -Create a Unit -************* - - 1. On the **Course Outline** page, click to open the subsection where you want to create the unit. - - 2. Click **New Unit.** The following screen appears. - - .. image:: Images/image051.png - :width: 800 - - - 3. In the **Display Name** box, type the name of the unit. This name appears in the course ribbon at - the top of the screen on Edge. - - Each unit has one or more components. - - -To create a discussion space where you or your students can post questions or participate in a discussion, click **Discussion.** - - -To create a component where you can add text, images, or other content, click **html.** - - -To create a problem for your students to solve, click **Problem.** - - -To add a video, click **Video.** diff --git a/docs/course_authors/source/create_video.rst b/docs/course_authors/source/create_video.rst index 3423f93d8a47..6484b5334ef0 100644 --- a/docs/course_authors/source/create_video.rst +++ b/docs/course_authors/source/create_video.rst @@ -1,60 +1,112 @@ +.. _Working with Video Components: -************** -Create a Video -************** +############################# +Working with Video Components +############################# -Many instructors use videos to take the place of in-class lectures. You can create a video of your lecture, and interweave other components—such as discussions and problems—to promote active learning. -To add a video to the unit, you must upload your video to YouTube, and then create a video component. You can also add a transcript to your video. +******************* +Overview +******************* +You can create a video of your lecture, and add it to your course with other components—such as discussions and problems—to promote active learning. -You can include videos that run at 0.75 speed, 1.25 speed, and 1.50 speed as well as at normal speed. To do this, you must upload each of these videos to YouTube separately. +You can also associate a timed transcript with your video, which students can read and download. -.. note:: +When you add a video to your course, you first post the video online, and then create a link to that video in the body of your course. - YouTube only hosts videos of up to 15 minutes. If you encode a 0.75 speed option, you must make - sure that source video segments are only 11.25 minutes long so that YouTube can host all speeds. - YouTube offers paid accounts that relax this restriction. +See the following topics: + +* :ref:`Video Formats` +* :ref:`Video Hosting` +* :ref:`Create a Video Component` + +.. note:: Review :ref:`Best Practices for Accessible Media` before adding videos to your course. + +.. _Video Formats: + +******************* +Video Formats +******************* + +The edX video player supports videos in .mp4, .ogg, and .mpeg format. + + +.. _Video Hosting: + +******************* +Video Hosting +******************* + +All course videos should be posted to YouTube. +By default, the edX video player accesses your YouTube videos. +However, because YouTube is not available in all locations, we recommend that you also post copies of your videos on a third-party site such as Amazon S3. +When a student views a video in your course, if YouTube is not available in that student's location or if the YouTube video doesn't play, the video on the backup site starts playing automatically. +The student can also click a link to download the video from the backup site. + +You can use any video backup site that you want. Keep in mind, however, that the site where you post the videos may have to handle a lot of traffic. -1. Upload the video that you want to YouTube. Make note of the code that appears between **watch?v** -= and **&feature** in the URL. This code appears in the green box below. +.. _Create a Video Component: -.. image:: Images/image053.png - :width: 800 px +************************* +Create a Video Component +************************* -2. In Studio, go to the unit that you want. +To add a video to the unit, you must obtain the YouTube ID for the video, obtain the URL for the backup video, and then create a video component. -3. Under **Add New Component,** click **Video.** +To determine the YouTube ID for a video, locate the video on YouTube and make a note of the code that appears between **watch?v =** and **&feature** in the URL. +This code appears circled below. -4. In the screen that appears, click **default.** +.. note:: If **&feature** does not appear in the URL, just use the code that follows **watch?v=** in the URL. -5. When the new video component appears, click **edit**.** A video component opens, and a sample video -begins playing automatically. +.. image:: Images/VideoComponent_YouTubeCode.png -6. In the **display_name** box, type the text that you want the student to see when the student hovers -the mouse over the icon in the bar at the top of the page. This text also appears as a headerfor the video. -7. Change the codes in the green boxes to the YouTube codes that you noted in step 1. The first -code (immediately to the right of "0.75:") corresponds to the video at 0.75 speed, the next -corresponds to 1.0 speed, etc. +You can include videos that run at 0.75 speed, 1.25 speed, and 1.50 speed as well as at normal speed. To do this, you must upload each of these videos to YouTube separately. -.. image:: Images/image055.png - :width: 800 +.. note:: YouTube only hosts videos of up to 15 minutes. If you encode a 0.75 speed option, you must make + sure that source video segments are only 11.25 minutes long so that YouTube can host all speeds. + YouTube offers paid accounts that relax this restriction. -8. Click **Save.** +After you have uploaded the video to YouTube: -.. note:: +#. Under **Add New Component**, click the **video** icon. - All videos embedded using the edX player begin playing automatically. - There is currently no way to turn off the autoplay feature. + .. image:: Images/NewComponent_Discussion.png + The Video component is added: + + .. image:: Images/VideoComponent_Default.png + + +2. When the new video component appears, click **edit**. The video editor opens and displays the Basic settings. + + .. image:: Images/video-edit.png + +3. In the **Display Name** field, enter the name you want students to see when they hover the mouse over the icon unit icon in the course accordian. This text also appears as a header for the video. -**To add a transcript for your video:** +#. Enter the URL of the YouTube video. -1. Save your srt.sjson file as **subs_YOUTUBEID.srt.sjson,** where **YOUTUBEID** is the YouTube ID of your video. + When you enter a video URL, Studio checks to see if a timed transcript for that video exists on edX. + If the transcript exists, Studio automatically associates the transcript with the video. -2. Upload the **subs_YOUTUBEID.srt.sjson** file to the **Files & Uploads** page. + If your video is on YouTube, you can import a timed transcript from YouTube. This YouTube transcript overwrites the edX version of the transcript. + +#. If no transcript exists, click **Upload New Timed Transcript** to upload a transcript file from your computer. + +#. If you want to modify the transcript, click **Download to Edit**. You can then make your changes and upload the new file. + +#. To specify additional sources for the video, click **Add more video sources**, and enter the URL and file type for the video. + +#. Optionally, click **Advanced** to set the following for the video: + + * **Download Transcript**: the external URL for non-YouTube video transcripts. + * **Download Video**: the external URL to download the video. + * **Start Time** and **End Time** for the video + * **Video Sources**: URLs and filenames for other sources of the video. + * **Youtube ID**: IDs for different speed videos on YouTube. + +#. Click **Save.** + -3. Create a link to this file by following the steps in the Add Items to the Handouts Sidebar -section. diff --git a/docs/course_authors/source/create_welcome_announcement.rst b/docs/course_authors/source/create_welcome_announcement.rst deleted file mode 100644 index 4bf5bbd7ba52..000000000000 --- a/docs/course_authors/source/create_welcome_announcement.rst +++ /dev/null @@ -1,14 +0,0 @@ - -**************************************** -Create a Welcome Announcement and E-Mail -**************************************** - - -Send e-mail (welcome and weekly) (surveys?) (TBD) - -Create welcome announcement - -Create landing page announcement (change "landing page" to "Course Info" -page) - -Create discussion forum diff --git a/docs/course_authors/source/establish_course_settings.rst b/docs/course_authors/source/establish_course_settings.rst deleted file mode 100644 index ce63aa9e4e93..000000000000 --- a/docs/course_authors/source/establish_course_settings.rst +++ /dev/null @@ -1,232 +0,0 @@ -************************* -Establish Course Settings -************************* - -Add Collaborators -***************** - - - Studio has support for rudimentary collaborative editing of a course. Users must have registered at studio.edge.edx.org, and must have activated their account via the mail link. If a user is not found, you will be notified. - - - Before you add a new user, consider the following. - - - · Invited users have full permissions to edit your course, including deleting content created by anyone else. - - - · Invited users cannot currently grant new permissions on the course. - - - · Editing conflicts are currently not managed. Thus, the state of the course might change between refreshes of the page. - - - To give another user permission to edit your course: - - - 1. On the navigation bar, click **Course Settings**, and then click **Course Team**. - - - .. image:: Images/image115.png - - - - 2. Click **New User**. - - - .. image:: Images/image117.png - - - 3. In the **email** box, type the mail address of the user, and then click **Add User**. - - -.. raw:: latex - - \newpage % - - - -Add Manual Policy Data -********************** - - - - You can add manual policy data on the **Advanced Settings** page. These advanced configuration options are specified using JSON key and value - pairs. - - - You should only add manual policy data if you are very familiar with valid configuration key value pairs and the ways these pairs will affect your course. - Errors on this page can cause significant problems with your course. - - - The edX program managers can help you learn about how to apply these settings. - - - 1. On the navigation bar, click **Course Settings**, and then click **Advanced Settings**. - - - 2. Click **New Manual Policy** . - - - .. image:: Images/image119.png - - - 3. In the **Policy Key** box, enter the policy key. - - - 4. In the **Policy Value** box, enter the value of the policy. - - -.. raw:: latex - - \newpage % - - -Add About Page Information -*************************** - - - To add scheduling information, a description, and other information for your course, use the **Course Settings** menu. - - - .. image:: Images/image121.png - - - This takes you to the - -Schedule and Details Page -========================= - - -1. At the top of this page, you will find a section with the **Basic Information** for your course. It is here that you can locate the title of your course and find the URL for your course, which you can mail to students to invite students to enroll in your course. - - .. image:: Images/image281.png - - -2. In the **Course Schedule** section, enter the date you want your course to start in the **Course Start Date** box, and then enter the time you want your course to start in the **Course** **Start Time** box. - - -.. note:: - - The Course Start Time on this screen will reflect the current time zone in your browser, depending on your geography. Course start times for students will show as UTC on Edge. - - -3. In the **Course Schedule** section, enter the date you want your course to end in the **Course** **End Date** - box, and then enter the time you want your course to end in the **Course** **End Time** box. - - -Add Enrollment Information -========================== - - -1. On the navigation bar, click **Course **Settings, and then click **Schedule & Details** . - - -2. In the **Course Schedule** section, enter the date you want enrollment for your course to start in the **Enrollment Start Date** box, and then enter the time you want enrollment for your course to start in the **Enrollment Start Time** box. - - -3. In the **Course Schedule** section, enter the date you want enrollment for your course to end in the **Enrollment End Date** -box, and then enter the time you want enrollment for your course to end in the **Enrollment End Time** box. - - -.. note:: - - The Enrollment dates on this screen will reflect the current time zone in your browser, depending on your geography. Enrollment times for students will show as UTC on Edge. - - - -Add a Course Overview -===================== - - -1. On the navigation bar, click **Course Settings**, and then click **Schedule & Details** . - - -2. Scroll down to the **Introducing Your Course** section, and then locate the **Course Overview** box. - -.. image:: Images/image123.png - - - - -3. In the **Course Overview** box, enter a description of your course. - - -The content for this box must be formated in HTML. For a template that you -can use that includes placeholders, see :doc:`appendices/a`. - - - -If your course has prerequisites, you can include that information in the course overview. - - -.. note:: - - There is no save button. Studio automatically saves your changes. - - -The following is example content for the **Course Overview** box: - - -.. image:: Images/image125.png - -Add a Descriptive Picture -========================= - -1. Select a high-resolution image that is a minimum of 660 pixels in width by 240 pixels in height. - -2. Change the file name of the picture that you want to use to **images_course_image.jpg**. - -3. Upload the file to the **Files & Uploads** page. - - -The picture that is named **images_course_image.jpg** automatically appears on the course About page. - -Add an About Video -================== - - -You can create an About video that will appear on the **About** page for your course. - - -1. Upload the video that you want to YouTube. Make note of the code that appears between ** watch?v =** and ** &feature** in the URL. This code appears in the green box below. - - -.. image:: Images/image127.png - - -2. On the navigation bar, click **Course Settings**, and then click **Schedule & Details** . - - -3. Scroll down to the **Introducing Your Course** section, and then locate the **Course** **Introduction Video** - field. If you have not already added a video, you see a blank field above an **id** box. - - -.. image:: Images/image129.png - - -4. In the **your YouTube video's ID** box, enter your video code. When you add the code, the video automatically appears in the field above the **your YouTube video's ID** box. - - -.. note:: - - There is no save button. Studio automatically saves your changes. - - -For example, your course introduction video appears as follows. - - -.. image:: Images/image131.png - - -Add Weekly Time Requirements Information -======================================== - - -1. On the navigation bar, click **Course Settings**, and then click **Schedule & Details** . - - -2. Scroll down to the **Requirments** section. - - -3. In the **Hours of Effort per Week** box, enter the number of hours you expect students to work on this course each week. diff --git a/docs/course_authors/source/establish_grading_policy.rst b/docs/course_authors/source/establish_grading_policy.rst index 9e6c5f6fe8ba..45e54a36f4a7 100644 --- a/docs/course_authors/source/establish_grading_policy.rst +++ b/docs/course_authors/source/establish_grading_policy.rst @@ -1,216 +1,166 @@ -*************************** -Establish a Grading Policy -*************************** - +.. _Establish a Grading Policy: -Overview -******** - - -Grades in edX courses are based on homework assignments and exams. - - -Setting up grading in edX Studio has several steps. These steps will be explained in more detail later in the course. To skip to the detailed information, click the links below. - +############################## +Establishing a Grading Policy +############################## -1. Establish an overall grading policy, also see :ref:`Set Grade Brackets`. - -.. image:: Images/image139.png - -This is done at the course level in the **Course Settings** menu. - - -Establish whether your course is pass-fail or graded by letter, and what the thresholds are for each grade. - - -Create assignment types for the course and determine the weight of the student's total grade for each assignment type. For example, you may have 10 homework assignments, worth a total of 50% of the grade; three exams, worth a total of 10% of the grade; and one final exam, worth 20% of the grade. By default, Studio includes four assignment types when you create the course: homework, lab, midterm exam, and final exam. You can also create additional assignment types, such as quizzes. - - -2. Create subsections that contain graded assignments in the body of the course, see :ref:`Create Subsections that Contain Graded Assignments`. - +******************* +Overview +******************* -.. image:: Images/image135.png +Establishing a grading policy takes several steps. You must: - -Each subsection in your course can be designated as one of the assignment types that you have specified in the grading policy. You can also specify a release date and a due date. - - -.. note:: - - You can create problems in Studio without specifying that the subsection is an assignment type. However, problems do not count toward a student's grade unless you set the subsection as a graded assignment type. +#. :ref:`grade` +#. :ref:`Set the Grace Period` +#. :ref:`configure` +#. :ref:`set_assignment` +#. :ref:`student_view` -For more information on creating problems, see `Create a Problem `_ . - -3. In the assignment subsections, create individual problems -.. image:: Images/image137.png - - -You can then establish the settings for these problems (including the number of attempts a student has and the problem's point value, or weight). +.. _grade: -Once a grading policy is in place, students can view both their problem scores and the percent completed and current grade at the top of their **Progress** tab for the course. - -Additionally, as an instructor, you can access your students' scores on graded content. On the live published page of your course on Edge (not from the Preview page in Studio), click the **Instructor** tab. Many options appear for viewing or downloading a snapshot of the currently stored student grades. On the **Instructor** tab you can also request a link to a view of the student's individual progress page, including both graded and not graded scores. For more information, see Progress and Certificates. +******************* +Set the Grade Range +******************* - -.. _Set-Grade-Brackets: +You must set the grade range for the course. For example, your course can be pass/fail, or can have letter grades A through F. + +To set the grade range, from the **Settings** menu, select **Grading**. + +The control for the grade range is at the top of the Grading page. + +.. image:: Images/grade_range.png + :width: 800 + +The above example shows that you have a pass/fail grade range, with a score of 50 as the cutoff. This is the default setting used when you create a course. -Set Grade Brackets -++++++++++++++++++ +You use the grade range control to change these settings: + +* To add a grade in the range, click the **+** icon. + + A new grade is added to the range between the existing grades. For example, if you add a grade in the default setting, + the grade range changes to **F** (0 to 50), **B** (50 to 75), and **A** (75 to 100): + + .. image:: Images/grade_range_b.png + :width: 800 + +* To change the score range, hover the mouse over the line dividing two grades, click and drag the line left or right. + + You can see the range numbers of the two grades adjacent to the line change. Release the mouse button when the line is where you want it. -To set the thresholds for course grades: - -1. On the navigation bar, click **Course Settings**, and then click **Grading**. +* To remove a grade, hover the mouse button over the grade. + + A **remove** link appears above the grade. Click the link. -2. Under **Overall Grade Range**, click and drag the dividing line between grade divisions to move each threshold up or down. + You cannot remove F or A. -.. note:: +After you make any changes to the grade range, you must click **Save Changes** at the bottom of the page. + + +.. _Set the Grace Period: - The default grade divisions are Pass and Fail. To add more grade divisions (such as A, B, C, or D), click the plus sign (+). +************************* +Set the Grace Period +************************* +You can set a grace period that extends homework due dates for your students. + +.. note:: The grace period applies to the whole course; you cannot set a grace period for individual assignments. -.. image:: Images/image133.png +In the Grading page, under **Grading Rules & Policies**, enter a value in the **Grace Period on Deadline** field. Enter the value in Hours:Minutes format. + +.. _configure: -To remove a grade division, hover the mouse over the grade division (shown above) and then click the **Remove** link that appears above the grade division. +****************************** +Configure the Assignment Types +****************************** -.. _Set-Grace-Period: +You must create assignment types for your course and determine the weight of the student's total grade for each assignment type. -Set a Grace Period -++++++++++++++++++ +For example, you may have: + +* 10 homework assignments, worth a total of 50% of the grade; +* A midterm exam, worth a total of 20% of the grade; +* A final exam, worth 30% of the grade. + +By default, a new course you create has four assignment types: + +* Homework +* Lab +* Midterm Exam +* Final Exam + +You can use these assignment types, modify or remove them, and create new assignment types. + +To create a new assignment type, in the bottom of the Grading page, click **New Assignment Type**, then configure the fields described below. + +========================== +Assignment Type Fields +========================== +You configure the following fields for each assignment type: -You can set a grace period that extends homework due dates for your students. Note that this setting applies to the whole course; you cannot set a grace period for individual assignments. - - -1. On the navigation bar, click **Course Settings**, and then click **Grading**. - - -2. Under **Grading Rules & Policies** enter a value in the **Grace Period on Deadline** box. - - -Create Assignment Types -+++++++++++++++++++++++ - - -By default, Studio includes four assignment types for your course when you create the course: homework, lab, midterm exam, and final exam. You decide the weight of the student's total grade for each assignment type. - - -To set an assignment type: - - -1. On the navigation bar, click **Course Settings**, and then click **Grading**. - - -2. Under **Assignment Types**, locate the settings for the assignment type that you want. - - -If you want to create a new assignment type, scroll to the bottom of the page, and then click **New Assignment Type**. +* **Assignment Type Name:** + The general category of the assignment. This name will be visible to students. + + .. note:: All assignments of a particular type are automatically worth the same amount. Thus, a homework assignment that contains 10 problems is worth the same percentage of a student's grade as a homework assignment that contains 20 problems. -3. Enter values in each of the following boxes. +* **Abbreviation:** -**Assignment Type Name:** -This is a general category of assessment (homework, exam, exercise). All assignments within an assignment type are given equal weight. This name will be visible to students. + This is the short name that appears next to an assignment on a student's **Progress** tab. + + +* **Weight of Total Grade:** + The assignments of this type together account for the percent value set in **Weight of Total Grade**. -**Abbreviation:** -This is the short name that will appear next to an assignment on every student's **Progress** tab (see below). + The total weight of all assignment types must equal 100. -.. image:: Images/image141.png - + .. note:: Do not include the percent sign (%) in this field. -**Weight of Total Grade:** -The assignments of a particular type together account for the percent value set in **Weight of Total Grade**. -**Total Number:** -The number of assignments of that type that you plan to present in your course. +* **Total Number:** + The number of assignments of this type that you plan to include in your course. -**Number of Droppable** -(optional): Specify the number of assignments that the grader will drop. The grader will omit the lowest-scored assignments first. -For example, the following course has two types of assignments. The overall course grade is broken down as 40% Homework and 60% Final Exam. There are eight Homework assignments, and the grader will omit the lowest-scored assignment from the final grade. Thus, the seven remaining Homework assignments are each worth 40 7 = 5.8% of the final grade. +* **Number of Droppable** -.. image:: Images/image143.png - -Troubleshooting -+++++++++++++++ - -If you have problems creating assignment types, try the following. - -In the **Weight of Total Grade** field, omit the % sign. Be sure that your **Weight of Total Grade** fields add up to 100. - -.. _Create-Graded-Subsections: + The number of assignments of this type that the grader will drop. The grader will drop the lowest-scored assignments first. -.. raw:: latex - - \newpage % +.. _set_assignment: -Create Subsections Containing Graded Assignments -************************************************** - -After you establish your grading rubric, you can create a graded assignment or a test for your students. To do this, you must first create a subsections and then set up grading for the subsection. This includes setting the assignment type, the assignment release date, and the due date. - +********************************************** +Set the Assignment Type for Graded Subsections +********************************************** +After you configure assignment types, as you are organizing your course, +you set the assignment type for Subsections that contain problems that are to be graded. -.. note:: - - When you set a due date, keep in mind that students will be in different time zones across the world. By default, the time zone appears as UTC-not the student's local time. If you tell your students an assignment is due at 5:00 PM, make sure to specify that the time is 5:00 PM UTC and point them to a time converter. - +You can designate a Subsection as one, and only one, of the assignment types you configured. You can also set a due date. -Alternatively, you can :ref:`set a grace period` for your assignments to cover any misunderstandings about time. For example, some classes have set a grace period of 1 day, 6 hours, and 1 minute. This grace period applies to the entire course. - -Keep in mind that a subsection can only have one assignment type. If you want to create a homework assignment and a lab for a specific topic, you would create two subsections for that topic. You would set one subsection as the Homework assignment type and the other as the Lab assignment type. Both subsections can contain other content as well as the actual homework or lab problems. - - -All assignments of a particular type are automatically worth the same amount. Thus, a homework assignment that contains 10 problems is worth the same percentage of a student's grade as a homework assignment that contains 20 problems. If you want the assignment with 20 problems to be worth twice as much as the assignment with 10 problems, you can create two assignments. - - -1. On the navigation bar, click **Course Content**, and then click **Outline**. - - -.. image:: Images/image145.png - - -2. Under **Course Outline**, locate the section where you want to add an assignment. - -3. Under the name of the section, click **New Subsection**. - -4. In the text box, replace **New Subsection** with the name of your subsection, and then click **Save**. - -Click the subsection you want. The edit page for the subsection opens. In the top right corner of the page, locate the **Subsection Settings** box. +See :ref:`subsections` for instructions on configuring a Subsection. +Within a graded Subsection, you create problems of the type designated for that Subsection. +You should not mix problems of different assignment types in the same Subsection. -.. image:: Images/image147.png - -Set the assignment type. To do this, locate the blue link next to **Graded as**. Because all subsections are set to **Not Graded** by default, the text for this link is **NOT GRADED**. +For example, if you want to create a homework assignment and a lab for a specific topic, create two Subsections. +Set one Subsection as the Homework assignment type and the other as the Lab assignment type. +Both Subsections can contain other content as well as the actual homework or lab problems. -.. image:: Images/image149.png - -Click this link to open a list of the assignment types that you specified in your grading rubric, and then click the assignment type that you want. - - -.. image:: Images/image151.png +.. note:: You can create problems in Studio without specifying that the Subsection is an assignment type. However, such problems will not count toward a student's grade. -Set the assignment's release date and time. To set the date, click inside the **Release date** field, and then select the date that you want in the calendar that appears. To set the release time, click inside the time input field, and then specify the time you want. - -Set a due date for the assignment. To do this, click the blue **SET A DUE DATE** link, and click inside the **Due date** box, and then select the date you want in the calendar that appears. To set the time, click inside the time input field, and then specify the time you want. +See :ref:`Working with Problem Components` for instructions on creating problems. -Change a Subsection's Assignment Type -+++++++++++++++++++++++++++++++++++++ - -To set the assignment type for a subsection: - -1. On the navigation bar, click **Course Content**, and then click **Course Outline**. +.. _student_view: -2. Under **Course Outline**, locate the subsection that you want. - -3. On the right side of the screen, click the blue check mark for the subsection, and then select the assignment type. +************************** +The Student View of Grades +************************** +Once a grading policy is in place, students can view both their problem scores and the percent completed and current grade in the **Progress** tab for the course. -.. image:: Images/image153.png - -.. note:: - - If you change an assignment type name in the Grading page, make sure the assignment type names on the Course Outline still match. + .. image:: Images/Progress_tab.png + :width: 800 \ No newline at end of file diff --git a/docs/course_authors/source/export_import_course.rst b/docs/course_authors/source/export_import_course.rst index db45b4a225cf..9fc5c3c6f376 100644 --- a/docs/course_authors/source/export_import_course.rst +++ b/docs/course_authors/source/export_import_course.rst @@ -1,116 +1,86 @@ - -************************* -Export or Import a Course -************************* - -Studio has an Import tool and an Export tool that allow you to import and -export courses. +.. _Exporting and Importing a Course: - +##################################### +Exporting and Importing a Course +##################################### + +You can :ref:`Export a Course` and :ref:`Import a Course` through Studio. + +.. _Export a Course: + +*************** Export a Course *************** - -You can export a course that has been created in Studio. You can export a -course for use by another instructor, or you can back up your course. - - -For example, you may create a course in Studio, and then run that course. A -friend or colleague, including a friend from another institution, may be -interested in running their own customized version of that course. You can -export the course that you have created and give it to the other instructor. -That instructor can then import the course, make any changes that are -necessary to reflect that instructor's situation, and then release the -course to students. - - -Or, you may export your course, and then make changes to your course in -Studio. If you later want to revert to the earlier version of your course, -you can import the version that you exported. Be careful if you do this -while you are running your course, as you could lose your students' work. +There are several reasons you may want to export your course: + +* To edit the XML in your course directly +* To create a backup copy of your course, which you can import if you want to revert the course back to a previous state +* To create a copy of your course that you can later import into another course instance and customize +* To share with another instructor for another class When you export your course, Studio creates a **.tar.gz** file that includes the following course data: - -1. Course structure (the order of sections and subsections) - - -2. Individual units - - -3. Individual problems - - -4. Additional pages - - -5. Files on the Files & Uploads page +* Course content (all Sections, Subsections, and Units) +* Course structure +* Individual problems +* Static pages +* Course assets +* Course settings +The following data is not exported with your course: -The exported file does not include the following data: - - -1. Student or user data - - -2. Discussion forum data - - -3. Course settings - - -4. Certificates - +* User data +* Course team data +* Forum/discussion data +* Certificates + +To export a course: -5. Grading information +#. From the **Tools** menu, select **Export**. +#. Click **Export Course Content**. +When the export completes you can then access the .tar.gz file on your computer. -.. raw:: latex - - \newpage % - +.. _Import a Course: + +*************** Import a Course *************** - - .. warning:: - This feature should be used with caution! - Importing a new course will delete all course content currently associated - with your course and replace it with the contents of the uploaded file. - Importing a course cannot be undone. - - -You can import courses that have already been created in Studio. These can -be courses that you or someone else has created and exported. - - -The file that you import must be a **.tar.gz** file that contains, at a -minimum, a Course.xml file in a course data directory. The tar.gz file must -have the same name as the course data directory. + Content of the imported course replaces all the content of this course. + **You cannot undo a course import**. We recommend that you first export the current course, + so you have a backup copy of it. +There are several reasons you may want to import a course: + +* To run a new version of an existing course +* To replace an existing course +* To load a course you developed outside of Studio + + +The course that you import must be in a .tar.gz file (that is, a .tar file compressed with GNU Zip). +This .tar.gz file must contain a course.xml file in a course data directory. The tar.gz file must +have the same name as the course data directory. It may also contain other files. If your course uses legacy layout structures, you may not be able to edit the course in Studio, although it will probably appear correctly on Edge. To make sure that your course is completely editable, ensure that all of your material is embedded in a unit. +The import process has five stages. During the first two stages, you must stay on the Course Import page. +You can leave this page after the Unpacking stage has completed. We recommend, however, +that you don't make important changes to your course until the import operation has completed. To import a course: - -1. On the navigation bar, click **Tools**, and then click **Import**. - - -.. image:: Images/image243.png - - -2. Under **Course to Import**, click **Choose File**. - - -3. Locate the file that you want, and then click **Open**. +#. From the **Tools** menu, select **Import**. +#. Click **Choose a File to Import**. +#. Locate the file that you want, and then click **Open**. +#. Click **Replace my course with the one above**. diff --git a/docs/course_authors/source/get_started.rst b/docs/course_authors/source/get_started.rst index b7d854abe9d6..138fafb54518 100644 --- a/docs/course_authors/source/get_started.rst +++ b/docs/course_authors/source/get_started.rst @@ -1,178 +1,176 @@ .. image:: Images/image001.png + :width: 800 +.. _Getting Started with Studio: ########################### Getting Started with Studio ########################### - -************ -Introduction -************ - -Since the launch of edX to our original partners, we have been working to provide opportunities for additional educators to create courses on our platform. The fruits of our efforts are Edge and Studio. These tools are available not only to our edX partners, but to all faculty at consortium universities. - -EdX (http://edx.org) is our original, premiere learning portal. Publication to -edX is available on a limited basis, depending on your university’s agreement -with edX. You need specific approval from your university to release your -course on the edX portal. Once a course is released on the edX portal, it -becomes a publicly available massively open online course (MOOC). - +*************** +Overview +*************** -Edge (http://edge.edx.org) is our newest online learning portal. It is almost identical to edX.org both visibly and functionally. +This chapter describes the tools you use to build an edX course, and how to create your first course: -Edge is where you view the content you create with Studio, our course authoring -tool. Courses on Edge cannot be seen publicly; rather, only you, your -colleagues, and the students with whom you explicitly share a course link can -see your course. Instructors are encouraged to use Edge to experiment with -creating courses. You do not need approval to release a course on Edge--you can -create a course and release it immediately. +* :ref:`What is Studio?` +* :ref:`What is Edge?` +* :ref:`Get Started on Edge` +* :ref:`Use Studio on Edge` +* :ref:`Create Your First Course` +* :ref:`View Your Course on Edge` +* :ref:`Register Your Course on edX.org` +If you are using an instance of Open edX, some specifics in this chapter may not apply. -Studio (http://studio.edge.edx.org) is our web-based course authoring tool. It is the easiest way for educators to develop courses for the edX platform. You can create courses in Studio and view and enroll in them instantly on Edge—even before you have finished creating the course. +.. _What is Studio?: + +*************** +What is Studio? +*************** +Studio is the edX tool you use to build your courses. +You use Studio to create course content, problems, videos, and other resoruces for students. -**There is a workflow to getting started.** Here is a quick summary: +With Studio, you can also manage your schedule and course team, set grading policies, publish your course, and more. +You use Studio directly through your browser. You do not need any additional software. -1. First, go to: https://studio.edge.edx.org. Sign up and create an account. +.. _What is Edge?: +****************** +What is Edge? +****************** -.. image:: Images/image009.png - :width: 800 +EdX Edge_ is the site where you can create courses with Studio, then run courses through the edX Learning Management System. +Visually and functionally, edX Edge is the same as edX.org_. +However, on Edge you can freely publish courses. +There is no course catalog on Edge and other users will not find your course. You must explicitly invite students to participate in your course. -**then** +Courses on Edge are not published on edX.org. All course data and accounts on Edge and edX.org are separate. +To publish courses on edX.org, you must have an agreement with edX and specific approval from your university. -2. Create a course in Studio. +.. _Edge: http://edge.edx.org +.. _edX.org: http://edx.org + +.. _Get Started on Edge: + +******************* +Get Started on Edge +******************* -.. image:: Images/image021.png - :width: 800 +Go to https://edge.edx.org, click **Register**, and fill out required information to create your account. +.. note:: Students will see your **Public Username**, not your **Full Name**. -**then** +.. note:: If you are at an edX consortium university, you should use your institutional e-mail + address. +After you click \ **Create My Account**, you will receive an activation +e-mail message. To finish creating your account, click the link in the e-mail. -3. View your course on Edge. +When you log in to Edge, you can view edX101_. +edX101 is both an example of a course you can build with Studio, +and a self-paced walk through of planning, building, and running your own online course. -.. image:: Images/image027.png - :width: 800 +.. _edX101: https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/about -.. raw:: latex - - \newpage % +.. _Use Studio on Edge: +****************** +Use Studio on Edge +****************** -***************** -Create an Account -***************** +You can use Studio_ on Edge to build your own courses. -To begin using Studio, create an account with a unique user ID and password. A Studio account isn't the same as an edX account. Even if you already have an edX account, you still need to create a separate Studio account. You can use the same e-mail address for both accounts. +Go to: https://studio.edge.edx.org. Sign in with the account you created on Edge. -When you create your account on Studio, an account on Edge is automatically created using the same user name and password. You don't have to create separate accounts on Studio and Edge. +You must then request access to create courses: -Edge has two views - an Instructor view and a Student view. When you view your course on Edge, you view your course as an instructor, and you see the **Instructor** tab at the top of the page. +#. Click the **+** sign to expland the field labeled **Becoming a Course Creator in Studio**. -.. image:: Images/image007.png - :width: 800 - +#. Click **Request the Ability to Create Courses**. -Your students will view your courses in Student view, which is similar to Instructor view, but does not include the Instructor tab or release dates. +EdX then evaluates your request. When course creation permissions are granted, you receive an email message. -To create an account: +.. _Studio: https://studio.edge.edx.org + +.. _Create Your First Course: + +*************************** +Create Your First Course +*************************** -1. Go to http://studio.edge.edX.org. The Welcome to edX Studio page opens. +When you receive notice that you can create courses, log into Studio_. -.. image:: Images/image009.png - :width: 800 +You see the following page: - -2. Scroll to the bottom of the page and click **Sign Up & Start Making an edX Course.** +.. image:: Images/first_course.png + :width: 800 -.. image:: Images/image011.png - :width: 800 +#. Click **Create Your First Course**. +#. Enter course information as needed and click **Create**. - -3. In the page that opens, fill in the fields. Required fields are marked with an asterisk (*). + .. image:: Images/new_course_info.png + :width: 800 + .. note:: Enter new course information carefully. This information becomes part of the URL for your course. To change the URL after the course is created, you must contact edX through the Help site (http://help.edge.edx.org). Additionally, because this information becomes part of your course URL, the total number of characters in the following three fields must be 65 or fewer. -.. image:: Images/image013.png - :width: 800 + * For **Course Name**, enter the title of your course. For example, the name may be “Sets, Maps and Symmetry Groups". Use title capitalization for the course title. - -a. In the **Email Address** box, type your e-mail address. -b. In the **Password** box, type a unique password. -c. In the **Public Username** field, type the name you want students to see when you post on the user forum. Most websites call this the "user name". -d. In the **Full Name** box, type your full name. This name only appears in Studio. - Your students will not see this name. -e. Click to select I agree to the Terms of Service. + * For **Organization**, enter the name of your university. Do not include whitespace or special characters. -.. image:: Images/image017.png - :width: 800 + * For **Course Number**, enter both a subject abbreviation and a number. For example, for public health course number 207, enter **PH207**. For math course 101x, enter **Math101x**. Do not include whitespace or special characters in the course number. -4. Click **Create My Account & Start Authoring Courses,** After you click this button, the following page opens. + *Note: If your course will be open to the world, be sure to include the "x". If it is exclusively an on-campus offering, do not include the "x".* -.. image:: Images/image015.png - :width: 800 +3. Click **Save.** -5. To finish creating your account, click the link that you receive in the activation e-mail. When you click this link, the following page opens. +You then see the empty Course Outline. -.. image:: Images/image017.png - :width: 800 +In your browser’s address bar, notice that the URL of your course includes the course organization, number, and course run. -.. raw:: latex +The rest of this documentation describes how you now build and run your course. But first, lets view your empty course on Edge. - \newpage % - -******************* -Create a New Course -******************* +.. _View Your Course on Edge: + +************************ +View Your Course on Edge +************************ +You can now view the course you just created, even though it doesn't have any content. -The first time that you log in to Studio, the following page opens. +In the Course Outline in Studio, click **View Live**. The course opens on Edge. -.. image:: Images/image017.png - :width: 800 - -Click the **dashboard** link, and the **My Courses** page opens. +You can also go directly to Edge_. Log in if prompted. You see the course you just created listed: -.. image:: Images/image021.png +.. image:: Images/new_course.png :width: 800 -Once you have created a course in Studio, it will be listed on this page. From here, you can start creating courses immediately by clicking the **New Course** button. - +You can view the course and see that there is no content yet. -To create a new course: +To build your course, keep reading this document. -1. Click **New Course.** A screen opens. +.. _Register Your Course on edx.org: +************************************ +Register Your Course on edX.org +************************************ -.. note:: +If you're creating your course on **edX**, you must register +for your course. - Enter your new course information carefully. This information becomes part of the URL for your course. To change the URL after the course is created, you must contact edX through the Help site (http://help.edge.edx.org).Additionally, because this information becomes part of your course URL, the total number of characters in the following three fields must be 65 or fewer. +#. On the **Course Outline** page, click the blue **View + Live** button in the upper-right corner of your screen. + Your course registration page opens in a new tab on the LMS. -2. For **Course Name**, enter the title of your course. For example, the name may be “Sets, Maps and Symmetry Groups". Use title capitalization for the course title. - -3. For **Organization**, enter the name of your university. Do not include whitespace or special characters. - -4. For **Course Number**, enter both a subject abbreviation and a number. For example, for public health course number 207, enter "PH207". For math course 101x, enter “Math101x”. Do not include whitespace or special characters in the course number. - - *Note: If your course will be open to the world, be sure to include the "x". If it is exclusively anon-campus offering, do not include the "x".* - -5. Click **Save.** - -.. image:: Images/image025.png - :width: 800 - -If you click **View Live** your course appears as follows on Edge. - -.. image:: Images/image027.png - :width: 800 - -*Note: Although the start date is set to the current date by default, your course will not be advertised, so it will not be visible to the general public. You can change the start date of your course in Studio.* +#. Click the blue **Register** button to register for your course. +#. In your browser, switch back to the tab that shows Studio. You will + still be on the **Course Outline** page. diff --git a/docs/course_authors/source/glossary.rst b/docs/course_authors/source/glossary.rst new file mode 100644 index 000000000000..ffa3b941a29a --- /dev/null +++ b/docs/course_authors/source/glossary.rst @@ -0,0 +1,604 @@ +.. _Glossary: + +################################################### +Glossary +################################################### + +.. _A: + +**** +A +**** + +.. _About Page: + +**About Page** + +The course page that provides potential students with a course summary, prerequisites, a course video and image, +and important dates. + +See :ref:`Setting up a New Course` for more information. + +.. _Advanced Editor-g: + +**Advanced Editor** + +An XML-only editor in a Problem component that allows you to can create and edit any type of problem. For more information, see :ref:`Advanced Editor`. + + + + +.. _Assignment Type: + +**Assignment Type** + +The category of graded student work, such as homework, exams, and exercises. + +For more information, see :ref:`Establish a Grading Policy`. + +.. _C: + +**** +C +**** + + +.. _Certificate: + +**Certificate** + +A document issued to a registered student who successfully completes a course. +Not all edX courses offer certificates, and not all students register as certificate candidates. + + + +.. _Checkbox Problem: + +**Checkbox Problem** + +A problem that prompts the student to select one or more options from a list of possible answers. For more information, see :ref:`Checkbox`. + + +.. _Chemical Equation Response Problem: + +**Chemical Equation Response Problem** + +A problem that allows the student to enter chemical equations as answers. For +more information, see :ref:`Chemical Equation Response`. + + +.. _Circuit Schematic Builder Problem: + +**Circuit Schematic Builder Problem** + +A problem that allows the student to construct a schematic answer +(such as an electronics circuit) on an interactive grid. + +See :ref:`Circuit Schematic Builder` for more information. + + +.. _Cohort: + +**Cohort** + +A group of students that participate in the class together. A cohort can have forum discussions apart from the rest of the students. + + +.. _Component_g: + +**Component** + +The part of a unit that contains your actual course content. A unit can contain one or more components. +For more information, see :ref:`Components`. + + +.. _Course Accordion: + +**Course Accordion** + +The left-hand navigation bar in the courseware that shows the sections and subsections for a course. +The word “accordion” is intended to evoke the folding and unfolding of an accordion, +because when you click a section, the section expands to show subsections. + + +.. _Course Catalog: + +**Course Catalog** + +The page that lists all courses offered in the edX learning management system. + + + +.. _Course Handouts: + +**Course Handouts** + +Course handouts are files you make available to students in the Course Info page. + +See :ref:`Add Course Handouts` for more information. + + +.. _Course Info Page: + +**Course Info Page** + +The page that opens first every time students access your course. You can post announcements on the Course Info page. +The Course Handouts sidebar appears in the right pane of this page. + + +.. _Run: + +**Course Run** + +The term in which your course takes place. You set the course run when you create your course. +For more information, see :ref:`Create a New Course`. + +.. _Courseware: + + +**Courseware** +The page where students access the primary instructional materials for your course. +Sections, subsections, units and components are all accessed from the Courseware page. + + +.. _Custom Response Problem: + +**Custom Response Problem** + +A custom response problem evaluates text responses from students using an embedded Python script. These +problems are also called "write-your-own-grader" problems. +For more information, see :ref:`Custom Response` and :ref:`Write-Your-Own-Grader`. + +.. _D: + +**** +D +**** + +.. _Discussion Forum: + +**Discussion Forum** + +The page where students can communicate with peers and staff by +typing in questions and responding to each other. + +See :ref:`Working with Discussion Components` for more information. + + +.. _Discussion Component: + +**Discussion Component** + +Forums that course staff can add directly to units. For example, a Video component can be followed by a Discussion component so that students can discuss the +video content without having to leave the page. + +See :ref:`Working with Discussion Components` for more information. + +.. _Dropdown Problem: + +**Dropdown Problem** + +A problem that asks students to choose from a collection of answer options, presented as a drop-down list. For +more information, see :ref:`Dropdown`. + + +.. _E: + +**** +E +**** + +.. _edX101_g: + +**edX101** + +edX’s online course about how to create online courses. The intended audience is faculty and university administrators +It is also the first course ever to have been developed entirely using edX Studio. + +.. _edX101: https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/about + + +.. _edX Edge: + +**edX Edge** + +A less restricted site than edX.org. While only consortium members can create and post +content on edX.org, any users with course creator permissions can create courses with Studio +on studio.edge.edx.org, then view the courses on the learning management system at edge.edx.org. + +.. _Edge: http://edge.edx.org + + + + +.. _edX Studio: + +**edX Studio** + +The edX tool you use to build your courses. + +See :ref:`What is Studio?` for more information. + + +.. _Exercises: + +**Exercises** + +Practice or practical problems interspersed in edX course content to keep the learner engaged. +Exercises are also an important measure of teaching effectiveness and learner comprehension. + + + +.. _G: + +**** +G +**** + +.. _grade: + +**Grade Range** + +Thresholds that specify how numerical scores are associated with grades, and the score required to pass a course. + +See :ref:`Set the Grade Range` for more information. + + + +.. _Grading Rubric: + +**Grading Rubric** + +List of the items that a student's response should cover in an open response assessment. + +See :ref:`Rubrics` for more information. + + +.. _H: + +**** +H +**** + +.. _HTML Component: + +**HTML Component** + +The component where you add and format text for your course. An HTML component can contain text, lists, links and images. + +See :ref:`Working with HTML Components` for more information. + + +.. _HTML View: + +**HTML View** + +The view in the HTML component editor allows you to enter HTML code directly. + +See :ref:`Work with the Visual and HTML Editors` for more information. + + +.. _I: + +**** +I +**** + + +.. _Image Mapped Input Problem: + +**Image Mapped Input Problem** + +A problem that presents an image and accepts clicks on the image as an answer. + +See :ref:`Image Mapped Input` for more information. + +.. _Import: + +**Import** + +A tool in edX Studio that loads a new course into your existing course. When you use the +Import tool, Studio replaces all of your existing course content +with the content from the imported course. + +See :ref:`Import a Course` for more information. + + + + +.. _L: + +**** +L +**** + + +.. _LaTeX: + +**LaTeX** + +A document markup language and document preparation system for the TeX typesetting program. + +In edX Studio, you can :ref:`Import Content from LaTex`. + +You can also create a :ref:`Problem Written in LaTeX`. + + + +.. _Learning Management System: + +**Learning Management System (LMS)** + +The platform that students use to view courses. + + + +.. _Live Mode: + +**Live Mode** + +A view that allows course staff to review all public units as students see them, +regardless of the release dates of the section and subsection that contain the units. + +See :ref:`View Your Live Course` for more information. + + +.. _M: + +**** +M +**** + +.. _Math Expression Input Problem: + +**Math Expression Input Problem** + +A problem that requires students to enter a mathematical expression as text, such as e=m*c^2. + +See :ref:`Math Expression Syntax` for more information. + + +.. _MathJax: + +**MathJax** + +A LaTeX-like language you use to write equations. Studio uses MathJax to render +text input such as x^2 and sqrt(x^2-4) as "beautiful math." + +See :ref:`MathJax in Studio` for more information. + + + + +.. _Multiple Choice Problem: + +**Multiple Choice Problem** + +A problem that asks students to select one answer from a list of options. + +See :ref:`Multiple Choice` for more information. + + +.. _N: + +**** +N +**** + +.. _Numerical Input Problem: + +**Numerical Input Problem** + +A problem that asks students to enter numbers or specific and relatively simple mathematical expressions. + +See :ref:`Numerical Input` for more information. + + + +.. _P: + +**** +P +**** + +.. _Preview Mode: + +**Preview Mode** + +A view that allows you to see all the units of your course as students see them, regardless of whether the +visibility of each unit is set to Public or Private and regardless of whether the release dates have passed. + +See :ref:`Preview Your Course` for more information. + + +.. _Private Unit: + +**Private Unit** + +A unit whose **Visibility** option is set to Private so that students cannot see the unit, even if it is located in a subsection that has been released. + +See :ref:`Public and Private Units` for more information. + + + + +.. _Problem Component: + +**Problem Component** + +A component that allows you to add interactive, automatically +graded exercises to your course content. You can create many different +types of problems. + +See :ref:`Working with Problem Components` for more information. + + + +.. _Progress Page: + +**Progress Page** + +The page in the learning management system that shows students their scores on graded assignments in the course. + + + +.. _Public Unit: + +**Public Unit** + +A unit whose **Visibility** option is set to Public so that the unit is visible to students, if +the subsection that contains the unit has been released. + +See :ref:`Public and Private Units` for more information. + +.. _R: + +**** +R +**** + +.. _Rubric: + +**Rubric** + +List of the items that a student's response should cover in an open response assessment. + +See :ref:`Rubrics` for more information. + + + +.. _S: + +**** +S +**** + + + + +.. _Section_g: + +**Section** +The topmost category in your course. A section can represent a time period in your course, or another organizing principle. + +See :ref:`Sections` for more information. + + + +.. _Simple Editor_g: + +**Simple Editor** + +The graphical user interface in a Problem component that contains formatting buttons and is available for some problem types. +For more information, see :ref:`Studio UI`. + + + +.. _Static Pages_g: + +**Static Pages** + +Pages that supplement the courseware for a course. Each static page appears in your course's navigation bar. + +See :ref:`Add Static Pages` for more information. + + + +.. _Subsection: + +**Subsection** + +A division that represents a topic in your course, or another organizing principle. Subsections are +found inside sections and contain units. Subsections can also be called "lessons." + +See :ref:`Subsections` for more information. + + + +.. _Short Course Description: + +**Short Course Description** + +The description of your course that appears on the edX `Course List `_ page. + +See :ref:`Describe Your Course` for more information. + + +.. _T: + +**** +T +**** + +.. _Text Input Problem: + +**Text Input Problem** + +A problem that asks the student to enter a line of text, which is then checked against a specified expected answer. + +See :ref:`Text Input` for more information. + + +.. _Transcript: + +**Transcript** + +A printed version of the content of a video. You can make video transcripts available to students. + +See :ref:`Working with Video Components` for more information. + + +.. _V: + +**** +V +**** + +.. _Video Component: + +**Video Component** + +A component that you can use to add recorded videos to your course. + +See :ref:`Working with Video Components` for more information. + + +.. _Visual View: + +**Visual View** + +The view in the HTML component editor that allows you format text without using HTML code. + +See :ref:`Work with the Visual and HTML Editors` for more information. + + +.. _W: + +**** +W +**** + +.. _Wiki: + +**Wiki** + +The page in each edX course that allows students as well as course staff to add, modify, or delete content. + +Students can use the wiki to share links, notes, and other helpful information with each other. + + +.. _X: + +**** +X +**** + +.. _XBlock: + +**XBlock** + +EdX’s component architecture for writing courseware components. + +Third parties can create components as web applications that can run within the edX learning management system. + + diff --git a/docs/course_authors/source/index.rst b/docs/course_authors/source/index.rst index 1708770eece0..b5bbc60976ba 100755 --- a/docs/course_authors/source/index.rst +++ b/docs/course_authors/source/index.rst @@ -4,43 +4,39 @@ contain the root `toctree` directive. - Contents ======== - .. toctree:: + :numbered: :maxdepth: 5 read_me get_started - create_lesson - create_section_sub_section - create_unit + create_new_course + establish_grading_policy + organizing_course + create_html_component create_video create_discussion - create_html_component + create_problem_component + common_problems + advanced_problems + javascript_input create_lti - create_problem + specialized_problems + open_response_assessment set_content_releasedates - establish_course_settings - establish_grading_policy - add_syllabus view_course_content - modify_published_content export_import_course - create_welcome_announcement - create_seed_wiki - invite_students_to_register + accessibility checking_student_progress + ora_students + glossary change_log - - - - Appendices ========== diff --git a/docs/course_authors/source/invite_students_to_register.rst b/docs/course_authors/source/invite_students_to_register.rst deleted file mode 100644 index 4efeee3cf8b9..000000000000 --- a/docs/course_authors/source/invite_students_to_register.rst +++ /dev/null @@ -1,29 +0,0 @@ - -*************************** -Invite Students to Register -*************************** - -To invite students to register for your course on Edge through the course -registration page, direct students to the registration page, and provide -instructions for completing the registration process. - - -1. Determine the link to your class registration page on Edge. To do this: - - -a. Click the **Settings **tab of your course in Studio, and then locate the -**Course Details** section. - - -b. Under **Basic Information**, you will see a link to email and invite -students to enroll in your course. - - -c. Click "**Invite Your Students**" link. Clicking the link creates an email -template. - - -.. image:: Images/image286.png - - -d. Email this to your chosen mail list. \ No newline at end of file diff --git a/docs/course_authors/source/javascript_input.rst b/docs/course_authors/source/javascript_input.rst new file mode 100644 index 000000000000..639e30a4d25d --- /dev/null +++ b/docs/course_authors/source/javascript_input.rst @@ -0,0 +1,113 @@ +.. _JavaScript Input: + +JavaScript Input +---------------- + +The JavaScript Input problem type allows you to create your own learning tool +using HTML and other standard Internet languages and then add the tool directly +into Studio. When you use this problem type, Studio embeds your tool in an +IFrame so that your students can interact with it in the LMS. You can grade +your students' work using JavaScript and some basic Python, and the grading +is integrated into the edX grading system. + +This problem type doesn't appear in the menu of advanced problems in Studio. To +create a JavaScript input problem type, you'll create a blank advanced problem, +and then enter your code into the component editor. + +.. image:: /Images/JavaScriptInputExample.gif + +Create a JavaScript Input Problem +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. Create your JavaScript application, and then upload all files associated with + that application to the **Files & Uploads** page. +#. In the unit where you want to create the problem, click **Problem** + under **Add New Component**, and then click the **Advanced** tab. +#. Click **Blank Advanced Problem**. +#. In the component that appears, click **Edit**. +#. Click the **Settings** tab. +#. Set **Maximum Attempts** to a number larger than zero. +#. In the component editor, enter your code. +#. Click **Save**. + +To re-create the example problem above, follow these steps. + +#. Go to :ref:`Appendix F` and create the following files: + + - webGLDemo.html + - webGLDemo.js + - webGLDemo.css + - three.min.js + +#. On the **Files & Uploads** page, upload the four files you just created. +#. Create a new blank advanced problem component. +#. On the **Settings** tab, set **Maximum Attempts** to a number larger than + zero. +#. In the problem component editor, paste the code below. +#. Click **Save.** + + + +JavaScript Input Problem Code +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + + In the image below, click the cone. + + + + + + + + +**Notes** + +- The webGLDemo.js file defines the three JavaScript functions (**WebGLDemo.getGrade**, + **WebGLDemo.getState**, and **WebGLDemo.setState**). + +- The JavaScript input problem code uses **WebGLDemo.getGrade**, **WebGLDemo.getState**, + and **WebGLDemo.setState** to grade, save, or restore a problem. These functions must + be global in scope. + +- **WebGLDemo.getState** and **WebGLDemo.setState** are optional. You only have to define + these functions if you want to conserve the state of the problem. + +- **Width** and **height** represent the dimensions of the IFrame that holds the + application. + +- When the problem opens, the cone and the cube are both blue, or "unselected." When + you click either shape once, the shape becomes yellow, or "selected." To unselect + the shape, click it again. Continue clicking the shape to select and unselect it. + +- The response is graded as correct if the cone is selected (yellow) when the user + clicks **Check**. + +- Clicking **Check** or **Save** registers the problem's current state. \ No newline at end of file diff --git a/docs/course_authors/source/modify_published_content.rst b/docs/course_authors/source/modify_published_content.rst deleted file mode 100644 index fe13490be73f..000000000000 --- a/docs/course_authors/source/modify_published_content.rst +++ /dev/null @@ -1,62 +0,0 @@ -*************************** -Modifying Published Content -*************************** - -When you set a Unit to Public, that content appears on edX or Edge when you -view the content as an instructor. If the release date has passed, the -content is also visible to students. - - -If you want to modify content after it has been set to Public, you must -create a draft. The draft does not appear on edX or Edge. However, the draft -does appear when you view your content in Preview mode. - - -To create a draft, open the Unit that you want. Note that no **Edit** button -appears on the page for that Unit, and you cannot make changes to the Unit. - - -.. image:: Images/image231.png - :width: 600 - - -In the right pane, click the blue **edit a draft** link in the **Unit -Settings** box. - - -.. image:: Images/image233.png - :width: 600 - - -After you click **edit a draft**, you can make changes to the Unit. You can -edit existing content or add new content. - - -.. image:: Images/image235.png - :width: 600 - - -If you want to view the version of your content that is currently live, -click **Preview the published version **in the yellow banner at the top of -the page. - - -.. image:: Images/image237.png - :width: 600 - - -If you want to view the draft version that you are working on, click -**Preview** under **Unit Settings**. This opens your course in Preview -mode.**** - - -.. image:: Images/image239.png - :width: 600 - - -When you are done making changes to the Unit, click the blue **replace it -with this draft** link under **Unit Settings**. - - -.. image:: Images/image241.png - :width: 600 diff --git a/docs/course_authors/source/open_response_assessment.rst b/docs/course_authors/source/open_response_assessment.rst new file mode 100644 index 000000000000..034224adfe9e --- /dev/null +++ b/docs/course_authors/source/open_response_assessment.rst @@ -0,0 +1,689 @@ +.. _Open Response Assessment Problems: + +Open Response Assessment Problems +--------------------------------- + +Introduction to Open Response Assessments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. note:: Open response assessments are still in beta. We recommend that + you test them thoroughly in a practice course and only add them to + courses that are **not** already running. + +Open response assessments allow instructors to assess student learning +through questions that may not have definite answers. Tens of thousands +of students can receive feedback on written responses of varying lengths +as well as files, such as computer code or images, that the students +upload. Open response assessment technologies include self assessment, +peer assessment, and artificial intelligence (AI) assessment (sometimes +called "machine assessment" or "machine grading"). With self +assessments, students learn by comparing their answers to a rubric that +you create. With peer assessments, students compare their peers' answers +to the rubric. + +A Few Notes about Open Response Assessments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Open response assessment technology is still in beta.** For a good +experience with open response assessments, you'll need to follow a few +guidelines. + +- Do not create a new open response assessment in a running course. + Only create open response assessments in a test course. +- If your course will include open response assessments, add and + thoroughly test all the open response assessments *before* the course + is live. +- Set open response assessments to be optional, ungraded, or droppable + exercises until you've used the technology a few times and have + become familiar with it. +- Use open response assessments sparingly at first. Only include a few + in your course, and make sure that you have contingency plans in case + you run into problems. + +Finally, if you're at an edX consortium university and you plan to +include open response assessments in a MOOC, make sure to notify your +edX project manager (PM). + +Components of an Open Response Assessment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An open response assessment has three elements: + +- The assessment type or types--self, peer, or artificial intelligence + (AI). The type of assessment and the order in which the assessments + run appears in the upper right corner of the ORA problem. In the + following example, the student performs a self assessment, then peers + perform peer assessments, and then an AI assessment runs. + + .. image:: Images/CITL_AssmtTypes.gif + +- The question that you want your students to answer. This appears near + the top of the component, followed by a field where the student + enters a response. + + .. image:: Images/CITLsample.gif + +- A rubric that you design. After the student enters a response and + clicks **Submit**, if the assessment is a self assessment, the + student sees the rubric below his answer and compares his answer to + the rubric. (If the assessment is an AI or peer assessment, the + student sees a "Your response has been submitted" message but doesn't + see the rubric.) + + .. image:: Images/CITL_SA_Rubric.gif + +Open Response Assessment Types +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There are three types of assessments for ORAs: self assessment, AI +assessment, and peer assessment. + +- Self assessment allows students to answer a question, and then assess + their response according to the rubric you created for the question. +- In AI assessment, a computer algorithm learns how to grade according + to the rubric from 100 or more instructor-graded responses, and + attempts to grade the rest of the student responses in the same way. +- Peer assessment allows students to score each other and provide + feedback, again using the same rubric. + +You can use one or more of these assessments in any problem. You can +also set thresholds within the problem for each assessment, so that a +response with a low score in one assessment does not move on to the next +assessment. + +Effective Questions +~~~~~~~~~~~~~~~~~~~ + +When you write your question, we recommend that you specify an +approximate number of words or sentences that a student's response has +to have in the body of your question. You may also want to provide +information about how to use the LMS. If you require students to upload +a file as a response, you can provide specific instructions about how to +upload and submit their files. You can let students know what to expect +after they submit responses. You can also mention the number of times +that a student will be able to submit a response for the problem. + +.. _Rubrics: + +Rubrics +~~~~~~~ + +The same rubric is used for all three ORA types, and it can include +anything that you want it to include. + +In Studio, rubrics are arranged by *categories*. Each category has two +or more *options*, and each option has a point value. + +Options must be listed in ascending order starting at 0 points. For +example, in a category with three options, the first option is worth 0 +points, the second is worth 1 point, and the third is worth 2 points. +The person or algorithm that grades the problem selects one value for +each category. + +Different categories in the same problem can have different numbers of +options. + +Create an Open Response Assessment Problem +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Creating an open response assessment is a multi-step process. + +#. Create the component for the open response assessment. +#. Add the question. +#. Add the rubric. +#. Set the assessment type and scoring. +#. Set the problem name. +#. Set other options. +#. Save the problem. +#. Add the peer grading interface (for peer assessments only). +#. Test the problem. + +Each of these steps is described in detail below. + +Step 1. Create the Component +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. Add the advanced component for open response assessments. To do this, + add the "peergrading","combinedopenended" key value to the **Advanced + Settings** page. (For more information, see the instructions in + :ref:`Specialized Problems`.) +#. In Studio, open the unit where you want to create the ORA. +#. Under **Add New Component**, click **Advanced**, and then click + **Open Response Assessment**. +#. In the problem component that appears, click **Edit**, and then click + **OK** in the dialog box that appears. +#. The component editor opens. The component editor contains a sample + question ("prompt"), rubric, and the code for the assessment type and + scoring. You'll replace this sample content with the content for your + problem. + +.. image:: Images/ORAComponentEditor.gif + +Step 2. Add the Question +~~~~~~~~~~~~~~~~~~~~~~~~ + +#. In the component editor, locate the [prompt] tags. + + .. image:: Images/ORA_Prompt.gif + +#. Replace the sample text between the **[prompt]** tags with the text of + your question. When you replace the sample text, make sure you follow + these guidelines to avoid common formatting mistakes. + + - Leave the **[prompt]** tags in place. + - Enclose all text in HTML tags. + +Step 3. Add the Rubric +~~~~~~~~~~~~~~~~~~~~~~ + +.. note:: After you release your problem to students in your live course, make sure + you don't make any changes to the rubric that affect scoring, such as adding or removing an option + in a category. Changing the rubric can cause errors in live courses.* + +#. In the component editor, locate the [rubric] tags. (The sample rubric + is long, so you'll have to scroll down to locate the second tag.) + + .. image:: Images/ORA_Rubric.gif + +#. Replace the sample rubric with the text of your rubric. Make sure to + do the following. + + - Include the beginning and ending [rubric] tags. + - Precede the categories with a plus (+) sign. + - Precede the options with a minus (-) sign. + - List the option that scores zero points first, followed by the option that scores one point, and so on. + + For example, your rubric might resemble the following rubric. + +:: + + [rubric] + + + Writing Applications + - The essay loses focus, has little information or supporting details, and the organization makes it difficult to follow. + - The essay presents a mostly unified theme, includes sufficient information to convey the theme, and is generally organized well. + + + Language Conventions + - The essay demonstrates a reasonable command of proper spelling and grammar. + - The essay demonstrates superior command of proper spelling and grammar. + + [rubric] + +Step 4. Set the Assessment Type and Scoring +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. note:: After you release your problem to students in your live course, make sure + you don't make any changes to the code for the assessment type and scoring. Changing + this code can cause errors in live courses.* + +To set the assessment type and scoring for your open response assessment, you'll +enter code that specifies the type and order of assessments to use along with +the scoring thresholds for each assessment. The code uses the following format. + +:: + + [tasks] + (Type 1), ({min-max}Type 2), ({min-max}Type 3) + [tasks] + +- The **[tasks]** tags surround the code. +- **Type 1**, **Type 2**, and **Type 3** are the names of the types of + assessments. Assessments run in the order in which they're listed. +- **min** is the point value the response must receive in the previous + assessment to move to this assessment. Note that you do not define a + scoring threshold for the first assessment, because there is no + required previous assessment. +- **max** is the maximum point value for the assessment. The maximum + score is the second number in the pair of numbers for each assessment + after the first assessment. + +For example, a problem might contain the following code. + +:: + + [tasks] + (Self), ({5-7}Peer), ({4-7}AI) + [tasks] + +The problem that includes this code has the following characteristics. + +- The problem has a self assessment, a peer assessment, and then an AI + assessment. +- The maximum score for the problem is 7. +- To advance to the peer assessment, the response must have a self + assessment score of 5 or greater. +- To advance to the AI assessment, the response must have a peer + assessment score of 4 or greater. + +Set the Type and Scoring +^^^^^^^^^^^^^^^^^^^^^^^^ + +#. In the component editor, locate the [tasks] tags. + + .. image:: Images/ORA_Tasks.gif + +#. Replace the sample code with the code for your problem. + +Step 5. Set the Problem Name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. note:: After you release your problem to students in your live course, make sure + you don't change the name of the problem. Changing the display name when the problem + is live can cause a loss of student data. + + You can change the display name of a problem while you're still testing the problem. + However, note that all the test responses and scores associated with the problem + will be lost when you change the name. To update the problem name on the + instructor dashboard, submit a new test response to the problem. + +The name of the problem appears as a heading above the problem in the +courseware. It also appears in the list of problems on the **Staff +Grading** page. + +.. image:: Images/ORA_ProblemName1.gif + +To change the name: + +#. In the upper-right corner of the component editor, click + **Settings**. +#. In the **Display Name** field, replace **Open Response Assessment** + with the name of your problem. + +Step 6. Set Other Options +~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you want to change the problem settings, which include the number of +responses a student has to peer grade and whether students can upload +files as part of their response, click the **Settings** tab, and then +specify the options that you want. + +.. image:: Images/ORA_Settings.gif + +Open response assessments include the following settings. + ++---------------------------------------------+--------------------------------------------------------------------+ +| **Allow "overgrading" of peer submissions** | This setting applies only to peer grading. If all of the responses | +| | for a question have been graded, the instructor can allow | +| | additional students to grade responses that were previously | +| | graded. This can be helpful if an instructor feels that peer | +| | grading has helped students learn, or if some students haven't | +| | graded the required number of responses yet, but all available | +| | responses have been graded. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Allow File Uploads** | This setting specifies whether a student can upload a file, such | +| | as an image file or a code file, as a response. Files can be of | +| | any type. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Disable Quality Filter** | This setting applies to peer grading and AI grading. When the | +| | quality filter is disabled (when this value is set to True), | +| | Studio allows submissions that are of "poor quality" (such as | +| | responses that are very short or that have many spelling or | +| | grammatical errors) to be peer graded. For example, you may | +| | disable the quality filter if you want students to include URLs to | +| | external content - otherwise Studio sees a URL, which may contain a| +| | long string of seemingly random characters, as a misspelled word. | +| | When the quality filter is enabled (when this value is set to | +| | False), Studio does not allow poor-quality submissions to be peer | +| | graded. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Display Name** | This name appears in two places in the LMS: in the course ribbon | +| | at the top of the page and above the exercise. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Graded** | This setting specifies whether the problem counts toward a | +| | student's grade. By default, if a subsection is set as a graded | +| | assignment, each problem in that subsection is graded. However, if | +| | a subsection is set as a graded assignment, and you want this | +| | problem to be a "test" problem that doesn't count toward a | +| | student's grade, you can change this setting to **False**. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Maximum Attempts** | This setting specifies the number of times the student can try to | +| | answer the problem. Note that each time a student answers a | +| | problem, the student's response is graded separately. If a student | +| | submits two responses to a peer-assessed problem (for example, by | +| | using the **New Submission** button after her first response | +| | receives a bad grade or because she wants to change her original | +| | response), and the problem requires three peer graders, three | +| | separate peer graders will have to grade each of the student's two | +| | responses. We thus recommend keeping the maximum number of | +| | attempts for each question low. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Maximum Peer Grading Calibrations** | This setting applies only to peer grading. You can set the maximum | +| | number of responses a student has to "practice grade" before the | +| | student can start grading other students' responses. The default | +| | value is 6, but you can set this value to any number from 1 to 20. | +| | This value must be greater than or equal to the value set for | +| | **Minimum Peer Grading Calibrations**. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Minimum Peer Grading Calibrations** | This setting applies only to peer grading. You can set the minimum | +| | number of responses a student has to "practice grade" before the | +| | student can start grading other students' responses. The default | +| | value is 3, but you can set this value to any number from 1 to 20. | +| | This value must be less than or equal to the value set for | +| | **Maximum Peer Grading Calibrations**. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Peer Graders per Response** | This setting applies only to peer grading. This setting specifies | +| | the number of times a response must be graded before the score and | +| | feedback are available to the student who submitted the response. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Peer Track Changes** | This setting is new and still under development. This setting | +| | applies only to peer grading. When this setting is enabled (set to | +| | **True**), peer graders can make inline changes to the responses | +| | they're grading. These changes are visible to the student who | +| | submitted the response, along with the rubric and comments for the | +| | problem. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Problem Weight** | This setting specifies the number of points the problem is worth. | +| | By default, each problem is worth one point. | +| | | +| | **Note** *Every problem must have a problem weight of at least | +| | one point. Problems that have a problem weight of zero points | +| | don't appear on the instructor dashboard. | ++---------------------------------------------+--------------------------------------------------------------------+ +| **Required Peer Grading** | This setting specifies the number of responses that each student | +| | who submits a response has to grade before the student receives a | +| | grade for her response. This value can be the same as the value | +| | for the **Peer Graders per Response** setting, but we recommend | +| | that you set this value higher than the **Peer Graders per | +| | Response** setting to make sure that every student's work is | +| | graded. (If no responses remain to be graded, but a student still | +| | needs to grade responses, you can set the **Allow "overgrading" of | +| | peer submissions** setting to allow more students to grade | +| | previously graded responses.) | ++---------------------------------------------+--------------------------------------------------------------------+ + +Step 7. Save the Problem +~~~~~~~~~~~~~~~~~~~~~~~~ + +- After you have created the prompt and the rubric, set the assessment + type and scoring, changed the name of the problem, and specified any + additional settings, click **Save**. + + The component appears in Studio. In the upper right corner, you can + see the type of assessments that you have set for this problem. + + .. image:: Images/ORA_Component.gif + +Step 8. Add the Peer Grading Interface (for peer assessments only) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can add just one peer grading interface for the whole course, or you +can add a separate peer grading interface for each individual problem. + +Add a Single Peer Grading Interface for the Course +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When you add just one peer grading interface for the entire course, we +recommend that you create that peer grading interface in its own section +so that students can find it easily. Students will be able to access all +the ORA problems for the course through this peer grading interface. + +#. Create a new section, subsection, and unit. You can use any names + that you want. One course used "Peer Grading Interface" for all + three. +#. Under **Add New Component** in the new unit, click **Advanced**, and + then click **Peer Grading Interface**. + + A new Peer Grading Interface component appears. + +#. To see the peer grading interface in the course, set the visibility + of the unit to **Public**, and then click **View Live**. + + The following page opens. + + .. image:: Images/PGI_Single.gif + + When students submit responses for peer assessments in your course, + the names of the problems appear in this interface. + +Add the Peer Grading Interface to an Individual Problem +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When you add a peer grading interface for an individual problem, you +must add the identifier for the problem to that peer grading interface. +If you don't add the identifier, the interface will show all of the peer +assessments in the course. + +Note that the peer grading interface doesn't have to appear under the +problem you want it to be associated with. As long as you've added the +identifier of the problem, the peer grading interface will be associated +with the problem, even if you include the peer grading interface in a +later unit (for example, if you want the problem to be due after a +week). + +#. Open the unit that contains the ORA. +#. If the visibility of the unit is set to Public, click **View Live**. + If the visibility is set to Private, click **Preview**. The unit + opens in the LMS in a new tab. Make sure you're in Staff view rather + than Student view. +#. Scroll down to the bottom of the ORA, and then click **Staff Debug + Info**. +#. In the image that opens, locate the string of alphanumeric characters + to the right of the word **location**. Press CTRL+C to copy this + string, starting with **i4x**. + + .. image:: Images/PA_StaffDebug_Location.gif + +#. Switch back to the unit in Studio. If the visibility of the unit is + set to **Public**, change the visibility to **Private**. +#. Scroll to the bottom of the unit, click **Advanced** under **Add New + Component**, and then click **Peer Grading Interface**. +#. On the Peer Grading Interface component that opens, click **Edit**. +#. In the Peer Grading Interface component editor, click **Settings**. +#. In the **Link to Problem Location** field, paste the string of + alphanumeric characters that you copied in step 4. Then, change the + **Show Single Problem** setting to **True**. + + .. image:: Images/PGI_CompEditor_Settings.gif + +#. Click **Save** to close the component editor. + +Step 9. Test the Problem +~~~~~~~~~~~~~~~~~~~~~~~~ + +Test your problem by adding and grading a response. + +#. In Studio, open the unit that contains your ORA problem. +#. Under **Unit Settings**, change the **Visibility** setting to + **Public**, and then click **View Live**. + + When you click **View Live**, the unit opens in the LMS in a new tab. + +#. In the LMS, locate your ORA question, and then type your response in + the Response field under the question. + + .. image:: Images/ThreeAssmts_NoResponse.gif + + Note that when you view your ORA problem in the LMS as an instructor, + you see the following message below the problem. This message never + appears to students. + + .. image:: Images/ORA_DuplicateWarning.gif + +#. Test the problem to make sure that it works as expected. + +To test your open response assessment, you may want to sign into your +course as a student, using an account that's different from the account +that you use as an instructor. + +- If you want to keep your course open as an instructor when you sign + in as a student, either open a window in Incognito Mode in Firefox or + Chrome or use a different browser to access your course. For example, + if you used Firefox to create the course, use Chrome when you sign in + as a student. +- If you don't need to keep your course open, sign out of your course, + and then sign back in using a different account. Note that if you do + this, you can't make changes to your course without signing out and + signing back in as an instructor. + +When you test your problem, you may want to submit test responses that contain little +text, random characters, or other content that doesn't resemble the responses that you +expect from your students. Open response assessments include a quality filter that +prevents instructors and other students from seeing these "low-quality" responses. +This quality filter is enabled by default. If you want to see all of your test +responses, including the "low-quality" responses, disable the quality filter. + +To disable the quality filter, open the problem component, click the **Settings** tab, +and then set the **Disable Quality Filter** setting to **True**. + +Grade an Open Response Assessment Problem +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You'll grade student responses to both AI assessments and peer +assessments from the **Staff Grading** page in the LMS. Take a moment to +familiarize yourself with the features of this page. + +The Staff Grading Page +^^^^^^^^^^^^^^^^^^^^^^^ + +When a response is available for you to grade, a yellow exclamation mark +appears next to **Open Ended Panel** at the top of the screen. + +.. image:: Images/OpenEndedPanel.gif + +To access the **Staff Grading** page, click **Open Ended Panel**. + +When the **Open Ended Console** page opens, click **Staff Grading**. +Notice the **New submissions to grade** notification. + +.. image:: Images/OpenEndedConsole_NewSubmissions.gif + +When the **Staff Grading** page opens, information about your open +response assessment appears in several columns. + +.. image:: Images/ProblemList-DemoCourse.gif + ++----------------------------------------------------+--------------------------------------------------------------------+ +| **Problem Name** | The name of the problem. Click the name of the problem to open it. | +| | Problems in your course do not appear under **Problem Name** on | +| | the **Staff Grading** page until at least one response to the | +| | problem has been submitted and is available to grade. | ++----------------------------------------------------+--------------------------------------------------------------------+ +| **Graded** | The number of responses for that problem that you have already | +| | graded. Even if the AI algorithm has graded all available | +| | responses, you can still grade the responses that the algorithm | +| | designates as low-confidence responses by clicking the problem | +| | name in the list. | ++----------------------------------------------------+--------------------------------------------------------------------+ +| **Available to grade** | The total number of ungraded student submissions. | ++----------------------------------------------------+--------------------------------------------------------------------+ +| **Required** | The number of responses remaining to be graded to train the | +| | algorithm for AI or to calibrate the responses for peer grading. | +| | If your open response assessment calls for both AI and peer | +| | assessment, the 20 responses that you grade for the peer | +| | assessment count toward the 100 responses for the AI assessment. | ++----------------------------------------------------+--------------------------------------------------------------------+ +| **Progress** | A visual indication of your progress through the grading process. | ++----------------------------------------------------+--------------------------------------------------------------------+ + +Grade Responses +^^^^^^^^^^^^^^^ + +#. Go to the **Staff Grading** page. +#. Under **Problem Name**, click the name of the problem that you want. + + When the problem opens, the information about the number of responses + that are still available to grade, that have been graded, and that an + instructor is required to grade appears under the problem name. You + can also find out about the AI algorithm's error rate. The error rate + is a calculation of the difference between the scores that AI + algorithm provides and the scores that the instructor provides. + + .. image:: Images/ResponseToGrade.gif + +#. In the rubric below the response, select the option that best + describes the response. +#. If applicable, add additional feedback. + + - You can provide comments for the student in the **Written Feedback** field. + - If you do not feel that you can grade the response (for example, + if you're a member of course staff but you would rather have the + instructor grade the response), you can click **Skip** to skip it. + - If the response contains inappropriate content, you can select the + **Flag as inappropriate content for later review** check box. + Flagged content is accessed on the **Staff Grading** page. If + necessary, course staff can ban a student from peer grading. + + .. image:: Images/AdditionalFeedback.gif + +#. When you are done grading the response, click **Submit**. + +When your course is running, another response opens automatically after +you grade the first response, and a message appears at the top of the +page. + +.. image:: Images/FetchingNextSubmission.gif + +After you've graded all responses for this problem, **No more +submissions to grade** appears on the page. + +.. image:: Images/NoMoreSubmissions.gif + +Click **Back to problem list** to return to the list of problems. You +can also wait for a few minutes and click **Re-check for submissions** +to see if any other students have submitted responses. + +.. note:: After you've graded enough responses for AI assessments to start, the number + of responses in the **Available to grade** column decreases rapidly as + the algorithm grades responses and returns them to your students in just + a few seconds. No student data is lost. + +.. note:: When a response opens for you to grade, it leaves the current "grading pool" + that other instructors or students are grading from, which prevents other + instructors or students from grading the response while you are working on + it. If you do not submit a score for this response within 30 minutes, + the response returns to the grading pool (so that it again becomes available + for others to grade), even if you still have the response open on your screen. + + If the response returns to the grading pool (because the 30 minutes have passed), + but the response is still open on your screen, you can still submit feedback for + that response. If another instructor or student grades the response after it returns to the + grading pool but before you submit your feedback, the response receives two grades. + + If you click your browser's **Back** button to return to the problem list before you + click **Submit** to submit your feedback for a response, the response stays outside + the grading pool until 30 minutes have passed. When the response returns to the + grading pool, you can grade it. + +Access Scores and Feedback +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You access your scores for your responses to AI and peer assessment +problems through the **Open Ended Console** page. + +#. From any page in the LMS, click the **Open Ended Panel** tab at the + top of the page. + + .. image:: Images/OpenEndedPanel.gif + +#. On the **Open Ended Console** page, click **Problems You Have + Submitted**. + + .. image:: Images/ProblemsYouHaveSubmitted.gif + +#. On the **Open Ended Problems** page, check the **Status** column to + see whether your responses have been graded. +#. When grading for a problem has been finished, click the name of a + problem in the list to see your score for that problem. When you + click the name of the problem, the problem opens in the courseware. + +For both AI and peer assessments, the score appears below your response +in an abbreviated version of the rubric. For peer assessments, you can +also see the written feedback that your response received from different +graders. + +**Graded AI Assessment** + +.. image:: Images/AI_ScoredResponse.gif + +**Graded Peer Assessment** + +.. image:: Images/Peer_ScoredResponse.gif + +If you want to see the full rubric for either an AI or peer assessment, +click **Toggle Full Rubric**. + +.. note:: For a peer assessment, if you haven't yet graded enough + problems to see your score, you receive a message that lets you know how + many problems you still need to grade. + +.. image:: Images/FeedbackNotAvailable.gif diff --git a/docs/course_authors/source/ora_students.rst b/docs/course_authors/source/ora_students.rst new file mode 100644 index 000000000000..846128f1ecaf --- /dev/null +++ b/docs/course_authors/source/ora_students.rst @@ -0,0 +1,366 @@ +.. _ORA for Students: + +Open Response Assessments for Students +====================================== + +.. _ORA Introduction: + +Introduction to Open Response Assessments +----------------------------------------- + +Open response assessments allow you to submit a short written answer, +an essay, or a file such as an image or computer code file. + +When you come to an open response assessment problem, you see the name of the +problem, the assessment types, the text of the question, the field where you'll +enter your response, and the **Save** and **Submit** buttons. + +.. image:: /Images/ExampleORA.gif + +If an open response assessment asks you to submit a file, you'll also see a button +that you'll click to upload your file. + +.. image:: /Images/ExampleORA_File.gif + +The *assessment types* can include *self assessment*, *peer assessment*, and *artificial intelligence (AI) assessment*. The +assessment types run in the order in which they appear in the problem. + +- In a self assessment, you assess your response according a rubric that the + instructor has created. For more information, see :ref:`ORA Self Assessment`. + +- In a peer assessment, you grade + responses that your peers have submitted while several of your peers + grade your response. For more information, see + :ref:`ORA Peer Assessment`. + +- In an AI assessment, a computer algorithm grades your response. For more information, + see :ref:`ORA AI Assessment`. + +An open response assessment problem doesn't have to use all assessment types. For example, one problem +may use self assessment and AI assessment, while another problem uses self assessment +and peer assessment, and another problem uses only peer assessment. + +You'll answer open response assessment problems in much the same way that you answer other +problems. For more information about how to submit responses, see :ref:`ORA Submit a Response`. + +When you submit a response to an open response assessment, the next step +depends on the type of assessment that the problem uses. For more information, +see :ref:`ORA Self Assessment`, :ref:`ORA Peer Assessment`, and :ref:`ORA AI Assessment`. + +After you submit your response, your score will be available shortly - sometimes within a few +minutes. For information about how to access your score after your response has been graded, +see :ref:`ORA Access Scores`. + +If you want to experiment with open response assessments, you can try out the open +assessment problems in the `EdX Demo `_ +course. To get started, go +to the `Self-Assessed Essay `_ +unit, and then enter a response in the **Response** field under the +question. You can enter your own response, or you can use one of the sample +responses in the `Sample Answers `_ +unit. + +.. _ORA Submit a Response: + +Submit a Response +----------------- + +Submitting a response is slightly different if you're submitting a written response +or uploading a file. + +#. Enter the response that you want to submit. + + - If you're submitting a written response, type your response in the + **Response** field. + + - If you're uploading a file, click **Choose File** under the **Response** + field. In the dialog box that opens, select the file that you want to upload, + and then click **Open**. + +#. Click **Submit**, and then click **OK** in the dialog box to continue. + + **Note** If you want to save your response and work on it again later, click **Save**. + An "Answer saved, but not yet submitted" message appears directly under the **Save** and + **Submit** buttons. + +After you submit your response, the assessment types start running in the order in which they +appear in the problem. For more information, +see :ref:`ORA Self Assessment`, :ref:`ORA Peer Assessment`, or :ref:`ORA AI Assessment`. + +.. _ORA Self Assessment: + +Self Assessment +--------------- + +In a self assessment, the rubric for the problem appears below your response immediately +after you submit the response. You then assess your response based on the rubric. + +Perform a Self Assessment +~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. Submit a response to a self-assessed ORA problem. + +#. When the rubric appears, compare your response with the rubric, and select the + option that you think is appropriate for each category. + + .. image:: /Images/Rubric1.gif + +#. Click **Submit assessment**. + + Your response appears, and you can see the scores that you gave + yourself. + +.. _ORA Peer Assessment: + +Peer Assessment +--------------- + +In a peer assessment, several students in the course grade your response while you grade +other students' responses. You have to grade a number of your peers' responses before +you receive your score. (After you grade the minimum number of responses required to +receive your score, you can grade as many additional responses as you want.) + +After you submit your response for grading, the following +message appears under your response. + + **Your response has been submitted. Please check back later for your grade.** + +Peer Grading Interface +~~~~~~~~~~~~~~~~~~~~~~ + +The area where you'll grade responses is the *peer +grading interface*. Each course that has peer assessments has at least +one peer grading interface. There may be just one peer grading interface +for the whole course, or each individual problem may have its own +separate peer grading interface. + +.. image:: /Images/PGI_FromOEC_2Problems.gif + + +Perform a Peer Assessment +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Performing a peer assessment has several steps. You can find detailed instructions for each step +below. + +#. :ref:`Access Responses`, either in the body of the + course or from the **Open Ended Console** page. +#. :ref:`Learn to Grade` (this process is called + *calibration*). +#. :ref:`Grade Responses` from other students. + +.. _Access Responses: + +Step 1: Access responses from other students +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Note** *You can only grade a response if you've submitted a response to the +question, an instructor has already graded at least 20 responses, and +there are more essays from other students left to grade. If you haven't submitted +a response or no responses are available for grading, you see a yellow message in the +interface.* + +.. image:: /Images/PAStudent_NoSubmissions.gif + +There are several ways to access other students' responses, depending on +the way that the course is set up. + +- Through the **Open Ended Console** page. This option is always + available for every course. To access the **Open Ended Console** page, + click the **Open Ended Panel** tab at the top of any page in the course. + When you see the list of problems that have responses available to grade, + click the name of the problem that you want to open it. + + .. image:: /Images/PGI_FromOEC_2Problems.gif + +- Through the courseware, in a specific unit. This option is only available if the + instructor has included a peer grading interface for the problem in the body of + the course. To access responses in the courseware, go to the unit that contains + the open response assessment problem. Scroll down past the response that you + submitted until you see the peer grading interface that appears below the problem. + + .. image:: /Images/PGI_InUnitComposite.gif + +- Through the courseware, in a separate section. This option may not be available + for your course. If it is, you'll see the section for peer grading in the + course accordion on the left side of your screen. For example, MIT's 6.00x: + Introduction to Computer Science and Programming course has a separate section + that holds all the course peer grading interfaces. To access peer grading for + a problem, you click the problem name. + + .. image:: /Images/PGI_Multiple-600x.gif + + +.. _Learn to Grade: + +Step 2: Learn to grade +^^^^^^^^^^^^^^^^^^^^^^ + +Before you grade your peers' responses, you must learn to grade +the same way that an instructor would. In this process, called +*calibration*, you'll grade several responses that an instructor has already +graded. If your grading is similar to the instructor's, you can begin grading +other students' responses to the question. + +#. Click the name of the problem. When the **Learning to grade** page + opens, click **Start learning to grade**. + +#. When the problem opens, compare the student's response with the + rubric. Select the options that best apply to the response, and then + click **Submit**. + +#. Review the **How did I do?** message that you receive, and then click + **Continue**. + + .. image:: /Images/PG_Calibration_Correct.gif + + .. image:: /Images/PG_Calibration_Incorrect.gif + + When you click **Continue**, the next student response appears for + you to grade, and you see a yellow **Calibration essay saved** message in + the top left corner of the page. + +#. Continue to grade responses. After you grade the required number of + responses correctly, you receive a **Ready to grade!** message. You + can then start to grade responses for other students. + +.. _Grade Responses: + +Step 3: Grade responses +^^^^^^^^^^^^^^^^^^^^^^^ + +When you grade a peer assessment response, you can not only select +options in the rubric, but also provide additional feedback for the +student who submitted the response. + +#. When the response opens, select the options in the rubric that you + feel best apply to the response, as you did in the calibration process. + + If you have concerns about the response, you can select other + options to flag the response for instructor review. You don't have to fill + out the rubric before you select these options. + + - If you aren't sure how to grade the response, select the **I am unsure about + the scores I have given above** check box. + - If the response is offensive, or if you suspect that it contains plagiarized + material, select the **This submission has explicit, offensive, or (I suspect) + plagiarized content** check box. + +#. Under **Written Feedback**, write a comment about the score that you + gave the response. + +#. Click **Submit**. You see a **Successfully saved your feedback** + message at the top of the screen, and the next response opens. + +#. Continue to grade until you've graded the required number of + responses (usually 3). When you've graded enough responses, you + receive the following message. + + .. image:: /Images/DoneGrading.gif + + When you see this message, you can access the score for your own + response. For more information, see :ref:`ORA Access Scores`. + +If you want to grade additional responses at any time, you can go back +to the **Peer Grading** page and click the name of the problem that you want +to continue grading. + +**Note** + +When a response opens for you to grade, it leaves the current "grading pool" +that other instructors or students are grading from, which prevents other +instructors or students from +grading the response while you are working on it. If you do not submit a score +for this response within 30 minutes, the response returns to the grading pool +(so that it again becomes available for others to grade), even if you still have +the response open on your screen. + +If the response returns to the grading pool (because the 30 minutes have passed), +but the response is still open on your screen, you can still submit feedback for +that response. If another instructor or student grades the response after it returns to the +grading pool but before you submit your feedback, the response receives two grades. + +If you click your browsers **Back** button to return to the problem list before you +click **Submit** to submit your feedback for a response, the response stays outside +the grading pool until 30 minutes have passed. When the response returns to the +grading pool, you can grade it. + +.. _ORA AI Assessment: + +Artificial Intelligence (AI) Assessment +--------------------------------------- + +In an AI assessment, an instructor grades a sample set of student responses to the +open response assessment problem. A machine learning algorithm then creates a model +based on the instructor's scores and grades the remaining students' responses. + +After you submit your response to an AI assessment, the following message appears under your +response. + + **Your response has been submitted. Please check back later for your grade.** + +Depending on the time that it takes for the instructor to grade a sample set of +responses, you may receive your grade within minutes, or you may have to wait +a few days. You won't receive a notification when your score is ready, so keep +checking back. + +For more information about accessing your scores, see :ref:`ORA Access Scores`. + +.. _ORA Access Scores: + +Access Scores and Feedback +-------------------------- + +For *self assessments*, the score that you give yourself appears as soon as you submit +the score. + +For *peer assessments* and *AI assessments*, you'll access your scores through the **Open Ended Console** page. + +#. In the EdX Demo course, click the **Open Ended Panel** tab at the top + of the page. + +#. On the **Open Ended Console** page, click **Problems You Have + Submitted**. + +#. On the **Open Ended Problems** page, check the **Status** column to + see whether your responses have been graded. The status for each problem is + either **Waiting to be Graded** or **Finished**. + +#. If **Finished** appears in the **Status** column for the problem you want, + click the name of the problem to see your score for that problem. When you + click the name of the problem, the problem opens in the courseware. + +For both AI and peer assessments, the score appears below your response +in an abbreviated version of the rubric. + +.. image:: /Images/AIScoredResponse.gif + +For peer assessments, you can +also see the written feedback that your response received from different +graders. + +.. image:: /Images/PeerScoredResponse.gif + +If you want to see the full rubric for either an AI or peer assessment, +click **Toggle Full Rubric**. + +**Note** *For a peer assessment, if you haven't yet graded enough +problems to see your score, you receive a message that lets you know how +many problems you still need to grade.* + +.. image:: /Images/FeedbackNotAvailable.gif + +For more information about grading peer assessments, see :ref:`ORA Peer Assessment`. + +Resubmitting a Response +----------------------- + +Some open response assessments allow multiple attempts. For these +problems, a **New Submission** button appears below your original +response. + +If you want to answer the question again, click **New Submission** to +clear your former response, and click **OK** in the dialog box that +appears. You can then enter a new response for the problem. + + \ No newline at end of file diff --git a/docs/course_authors/source/organizing_course.rst b/docs/course_authors/source/organizing_course.rst new file mode 100644 index 000000000000..5181d58ad585 --- /dev/null +++ b/docs/course_authors/source/organizing_course.rst @@ -0,0 +1,223 @@ +.. _Organizing Your Course Content: + +############################### +Organizing Your Course Content +############################### + +.. _How a Course is Organized: + +************************* +How a Course is Organized +************************* + +You organize your course in the following hierarchy: + +- :ref:`Sections`, which contain + - :ref:`Subsections`, which contain + - :ref:`Units`, which contain + - :ref:`Components`, which contain your actual course content. + + +Studio provides you with flexibility when organizing your course. +A common course model is for Sections to correspond to weeks, and for Subsections to correspond to lessons. + +.. note:: We recommend that you review :ref:`Guidelines for Creating Accessible Content` before developing content for your course. + + +================== +The Course Outline +================== + +In Studio, you view your course organization through the Course Outline. + +To open the Course Outline, from the **Content** menu, select **Outline**. + +The following example shows a course outline with callouts to identify the different course elements: + +.. image:: Images/course_outline.png + :width: 800 + +The following example shows how a student would view this course content: + +.. image:: Images/course_outline_student_view.png + :width: 800 + +.. _Sections: + +******** +Sections +******** + +A Section is the topmost category in your course. A Section can represent a time-period in your course, or another organizing principle. + +To create a Section: + +#. In the Course Outline, click **New Section**. +#. In the field that opens at the top of the outline, enter the new Section name. +#. Click **Save**. + +The new, empty Section is placed at the bottom of the course outline. +You must now add Subsections to the Section. + +Whether or not students see the new Section depends on the release date. +See :ref:`Publishing Your Course` for more information. + +.. _Subsections: + +**************** +Subsections +**************** + +Sections are divided into Subsections. A Subsection may represent a topic in your course, or another organizing principle. + +You can set a Subsection to an assignment type that you created when +you set up grading. You can then include assignments in the body of that +Subsection. For more information on grading, see LINK. + +To create a Subsection: + +#. Within the Section, click **New Subsection**. +#. In the field that opens at the bottom of the section, enter the new Subsection name. +#. Click **Save**. + +The new, empty Subsection is placed at the bottom of the Section. +You must now add Units to the Subsection. + +Whether or not students see the new Subsection depends on its release date. +See LINK for more information on releasing your course. + + +================== +Edit a Subsection +================== + +You can add and delete Subsections, and select the grading policy, directly from the Course Outline. + +You can also open the Subsection in its own page, to perform those tasks as well as to +set the Subsection release date, set a due date, preview a draft of the Subsection, or view the live course. + +Click on the Subsection title. The Subsection opens in its own page: + + .. image:: Images/subsection.png + :width: 800 + + +======================= +Set the Grading Policy +======================= + +You can designate a Subsection as one of the assignment types that you specified in the grading policy. + +You set the grading policy for the Subsection from the Course Outline or from the Subsection page. + +From the Course Outline, click the checkmark next to the Subsection. Then select a grading policy from the popup menu: + + .. image:: Images/course_outline_set_grade.png + :width: 800 + +From the Subsection page, click the text next to the **Graded as** label, then select a grading policy from the popup menu: + + .. image:: Images/subsection_set_grade.png + :width: 800 + +See :ref:`Establish a Grading Policy` for more information. + + +================== +Set the Due Date +================== + +For Subsections that contain graded problems, you can set a due date. Students must complete the problems in the Subsection before the due date to get credit. + +#. From the Subsection page, click **SET A DUE DATE**. The Due Day and Due Time fields appear. +#. Place the cursor in the Due Date field, and pick a day from the popup calendar. +#. Place the cursor in the Due Time field and pick a time. + +.. note:: When you set a due date, keep in mind that students will be in different time zones. By default, the time zone appears as UTC, not the student's local time. If you tell your students an assignment is due at 5:00 PM, make sure to specify that the time is 5:00 PM UTC and point them to a time converter. + +Alternatively, you can :ref:`Set the Grace Period` for your assignments to cover any misunderstandings about time. For example, some classes have set a grace period of 1 day, 6 hours, and 1 minute. The grace period applies to all assignments. + +For more information, see :ref:`Establish a Grading Policy`. + +.. _Units: + +****** +Units +****** + +Subsections are divided into Units. A Unit contains one or more Components. + +For students, each Unit in the Subsection is represented as a link on the accordian at the top of the page. +The following page shows a Subsection that has nine Units: + +.. image:: Images/units_students.png + :width: 800 + +.. warning:: + + Studio does not have versioning or automatic + updating of your browser between refreshes. Versioning is planned for future + releases, but, in the meantime, only one author should edit a unit, in one + browser, on only one tab. If a unit is open for editing in multiple browser + sessions, the session that saves last will overwrite any previously saved + content without displaying a warning. Also, older browser sessions can overwrite + more recent content, so refresh your browser before you start working every time + you work with a private unit or edit a draft of a public unit. + + +To create a Unit from the Course Outline or the Subsection page: + +#. Within the Subsection, click **New Unit**. +#. Enter the Display Name that students will see. +#. Click a Component type to add a the first Component in the Unit. + + .. image:: Images/Unit_DisplayName_Studio.png + +#. Follow the instructions for the type of Component, listed below. +#. By default, the Unit visibility is **Private**, meaning students will not be able to see the Unit. Unless you want to publish the Unit to students immediately, leave this setting. See LINK for more information on releasing your course. + +The Unit with the single Component is placed at the bottom of the Subsection. + +.. _Components: + +********** +Components +********** + +A component is the part of a unit that contains your actual course content. A unit can can contain one or more components + +A student can view the name of all components in a unit by hovering over the unit icon in the accordian at the top of the page. + +You add the first component when creating the unit. + +To add another component to the unit: + +#. If the Unit is Public, change the **Visibility** setting to **Private**. You cannot modify a Public Unit. +#. In the **Add New Component** panel at the bottom of the Unit, click the type of Component to add. + .. image:: Images/Unit_DisplayName_Studio.png +#. Follow the instructions for the type of Component: + + * :ref:`Working with HTML Components` + * :ref:`Working with Video Components` + * :ref:`Working with Discussion Components` + * :ref:`Working with Problem Components` + + + +.. _Reorganize Your Course: + +********************** +Reorganize Your Course +********************** + +You can reorganize your course by dragging and dropping elements in the Course Outline. + +To move a Section, Subsection, or Unit, click the mouse on the element's handle on the right side of the outline, then move the element to the new location. +Element handles are highlighed in the following image: + + .. image:: Images/drag_drop.png + :width: 800 + +When you move a course element, a blue line indicates the new position. You can move a Subsection to a new Section, and a Unit to a new Subsection. + +You can reorganize Components within a Unit in the same way. \ No newline at end of file diff --git a/docs/course_authors/source/read_me.rst b/docs/course_authors/source/read_me.rst index c305df3f4e12..b414160d132e 100644 --- a/docs/course_authors/source/read_me.rst +++ b/docs/course_authors/source/read_me.rst @@ -2,17 +2,17 @@ Read Me ******* -The edX "Getting Started with Studio" help and PDF documentation is created -using Sphinx_ and LaTeX_. You, the user community, can help update and revise +The edX *Building a course with Studio* documentation is created +using RST_ files and Sphinx_. You, the user community, can help update and revise this documentation project on GitHub:: https://github.com/edx/edx-platform/tree/master/docs/course_authors/source To suggest a revision, fork the project, make changes in your fork, and submit a pull request back to the original project: this is known as the `GitHub Flow`_. -All pull requests will need approval from an engineering contact at edX. For -more information, contact edX at docs@edx.org. +All pull requests need approval from edX. For more information, contact edX at docs@edx.org. .. _Sphinx: http://sphinx-doc.org/ .. _LaTeX: http://www.latex-project.org/ .. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser +.. _RST: http://docutils.sourceforge.net/rst.html \ No newline at end of file diff --git a/docs/course_authors/source/set_content_releasedates.rst b/docs/course_authors/source/set_content_releasedates.rst index b55afc1e8c10..f33447247260 100644 --- a/docs/course_authors/source/set_content_releasedates.rst +++ b/docs/course_authors/source/set_content_releasedates.rst @@ -1,82 +1,167 @@ +.. _Publishing Your Course: -***************************************** -Set Content Release Dates and Visibility -***************************************** +########################### +Publishing Your Course +########################### -The release schedule for course material is determined by setting release dates -for sections and subsections. +When you have set up your course, established a grading system, and organized your course content, +you are ready to publish your course and make it available to students. -Section -******* +Understanding the content your students can view, and knowing how to change what students can view, is complex. +Read the following sections carefully: - To set the release date for a section: +* :ref:`Understanding Content Students Can View` +* :ref:`Release Dates` +* :ref:`Public and Private Units` +* :ref:`Modifying Public Units` - 1. On the **Course Content** menu, click **Course Outline**. - 2. Find the section you are looking for in the course outline. +.. _Understanding Content Students Can View: - 3. Under **Will Release**, click **Edit**, and then change the date. - .. image:: Images/image280.png +****************************************** +Understanding Content Students Can View +****************************************** -Subsection -********** +When you create a course on Studio, students cannot see any of your course content until the course start date has passed. +After the course start date has passed, whether a student can see your course materials depends on two settings that you can control: release dates and visibility. + +* The **Release Date**. Sections and subsections have release dates. If the current date + of a section or subsection is before the release date, the content of that course element is + not yet published, and not visible to students. + + For a student to view a subsection, both it and its containing section must be have a release date + earlier than the current date. It is possible that a section is released, but a subsection within it + is not released. In this case, students cannot view that subsection. + + Course staff can see sections and subsections before the release date in the LMS. + +* The unit must be **Public**. All units have a **Visibility** setting that is **Public** or **Private**. + When you create a unit, it is **Private** by default. + + Students cannot view a **Private** unit, even if the containing section and subsection are released. + + Students cannot view a **Public** unit if the containing section and subsection are *not* released. + + Course staff *cannot* see Private units in the LMS. + +In summary, for students to see content, the unit must be **Public**, and the containing section and +subsection must be released. If all these criteria are not met, students do not see that unit. + +Continue reading this chapter for more details. + + +.. _Release Dates: + +******************* +Release Dates +******************* + +Release dates specify the dates when content is available to students. +Release dates are set at the section and subsection levels. +Neither a section nor its contents are visible to students until the release date passes. +However, course staff can see content in the LMS regardless of its release date. + +======================================== +Set the Release Date for a Section +======================================== + +You can set release date and time for each section. +Before the release date and time, students are not able to view any content in that section. + +To set a release date for a section: + +#. In the **Will Release:** field next to the section title, click **Edit**. +#. Enter the release date in MM/DD/YYYY format, and the UTC time. +#. Click **Save**. + + +======================================== +Set the Release Date for a Subsection +======================================== Subsections inherit the release date of the section they are in, but you can change this date so that different subsections are released at different times. Note that if the release date for a subsection falls before the release date for the section that contains it, students will not be able to see the subsection -until the release date for the *section *has passed. Section release dates +until the release date for the *section* has passed. Section release dates override subsection release dates. - To set the release date for a subsection: +To set the release date for a subsection: - 1. Click to open the subsection. +#. Open the subsection. +#. Locate the **Subsection Settings** box in the top right corner. +#. Enter the release date in MM/DD/YYYY format, and the UTC time. - 2. Locate the **Subsection Settings** box in the top right corner. - 3. Under **Release Date**, change the date. +================================================ +Synch the Release Date for a Subsection +================================================ -Unit -**** - -Individual units inherit the release date of the subsection they are in, but -have an additional **Visibility** setting that can be set to **Public** or -**Private**. Private units are never visible to students. +You or other course staff could inadvertantly set the release date for a subsection +earlier than the release date for the containing section. In this situation, the subsection is +not released until the section is released. -.. note:: +To help you keep your course and release dates organized, Studio flags subsections with earlier release dates +than their containing section. In this situation, when you open the subsection, in the Subsection Settings, +you see the following message: -You can modify private units directly. To modify a unit that is marked -Public you must create a draft. +``The date above differs from the release date of
    -
    . Sync to
    .`` -For more information, see :doc:`modify_published_content` . +Click **Sync to
    ** to have the subsection inherit the later section release date. + +.. _Public and Private Units: + +************************* +Public and Private Units +************************* + +Units are released at the release date of the subsection they are in. + +In addition, unites have a **Visibility** setting that you can set to **Public** or +**Private**. + +When you create a unit, it is Private by default. +A Private unit is never visible to students, even if it is contained by a subsection that has been released. + +When you change the visibility setting of a unit from Private to Public, you publish the unit and its contents. +You must set the Visibility to Public for students to be able to see the unit. + +Course staff cannot see Private units in the LMS. + + +.. _Modifying Public Units: + +************************* +Modifying Public Units +************************* + +To make revisions to a unit that has been published, you create and edit a draft of that unit. + +.. warning:: There are additional implications to modifying the public unit that has graded problem + components students may have already completed. See :ref:`Modifying a Released Problem` for more information. + +To create a draft, go to the unit's page, and then click **edit a draft** in the right pane. + +.. image:: Images/Viz_Revise_EditDraft.png + :width: 800 + +When you edit a draft of a unit, you can view the unit's contents in two ways. + +* To view the already-published content as it appears in the live course, click **View the Live Version** in the upper-right corner of the page. +* To view the unpublished content as you're working on it, click **Preview**. + +.. image:: Images/Viz_Revise_ViewLiveandPreview.png + :width: 800 + +When you're ready to publish the draft of your revised content, +click **replace it with this draft** in the right pane. + +If you decide you don't want to keep the revised content, click **Delete Draft**. + +.. image:: Images/Viz_Revise_ReplaceorDelete.png + +.. Warning:: Historical versions of units are not stored by Studio. After you replace the live version with a new draft, you cannot revert the unit to the previous version. - - - To change the **Visibility** setting for a private unit: - - - 1. Click to open the unit. - - - 2. Locate the **Unit Settings** box in the top right corner. - - - 3. For **Visibility**, select **Public**. - - - To change the **Visibility** setting for a public unit: - - - 1. Click to open the unit. - - - 2. Locate the **Unit Settings** box in the top right corner. - - - 3. Under **Unit Settings**, click **edit a draft**. - - - 4. For **Visibility**, select **Private**. \ No newline at end of file diff --git a/docs/course_authors/source/specialized_problems.rst b/docs/course_authors/source/specialized_problems.rst new file mode 100644 index 000000000000..81f1ef62716b --- /dev/null +++ b/docs/course_authors/source/specialized_problems.rst @@ -0,0 +1,239 @@ +.. _Specialized Problems: + +Specialized Problems +==================== + +Specialized problems are advanced problems such as annotations, open +response assessments, and word clouds. These problems are available +through the Advanced component in Studio. To add the Advanced component +to your course, you'll modify your course's advanced settings. The +Advanced component then appears under **Add New Component** in each +unit. + +- :ref:`Annotation` Annotation problems ask students to respond to + questions about a specific block of text. The question appears above + the text when the student hovers the mouse over the highlighted text + so that students can think about the question as they read. +- :ref:`Open Response Assessment` Open response assessment problems allow students + to enter short answer or essay responses that students or a computer + algorithm can then grade. +- :ref:`Word Cloud` Word cloud problems show a colorful graphic of the + words that students enter as responses to a prompt. + +.. _ Add Advanced Component: + +**Add the Advanced Component to Your Course** + +By default, when you create a new component in Studio, you see the +following options. + +.. image:: Images/AddNewComponent.gif + +To create a specialized problem, you must first add the Advanced +component to your course. To do this, follow these steps. + +#. On the **Settings** menu, click **Advanced Settings**. + +#. On the **Advanced Settings** page, locate the **Manual Policy + Definition** section, and then locate the **advanced_modules** + policy key (this key is at the top of the list). + + .. image:: Images/AdvancedModulesEmpty.gif + +#. Under **Policy Value**, place your cursor between the brackets, and + then enter the value for the type of problem that you want to create. + Make sure to include the quotation marks, but not the period. + + - For annotations, enter **"annotatable"**. + + - For open response assessments, enter + **"combinedopenended","peergrading"**. (Include the comma but no + spaces between the words.) + + - For word clouds, enter **"word_cloud"**. + + You can enter more than one problem type at a time. When you do, + make sure to surround each problem type with quotation marks and + separate each problem type with a comma, but do not include any + spaces. + + For example, if you wanted to add annotations, open response + assessments, and word cloud problems in your course, you would enter + the following between the brackets. + + :: + + "annotatable","combinedopenended","peergrading","word_cloud" + + .. image:: Images/AdvSettings_Before.gif + +#. At the bottom of the page, click **Save Changes**. + + The page refreshes automatically. At the top of the page, you see a + notification that your changes have been saved. + + The text in the **Policy Value** field now appears as follows. + + .. image:: Images/AdvSettings_After.gif + +#. Return to the unit where you want to add the specialized problem. The + list of possible components now contains an Advanced component. + + .. image:: Images/AdvancedComponent.gif + +When you click the Advanced component, you see the following list. + +.. image:: Images/SpecProbs_List.gif + +You can now create annotations, open response assessments, and word +clouds in your course. More information about how to create each problem +is provided in the page for that problem type. + +.. _Annotation: + +Annotation +---------- + + +In an annotation problem, the instructor highlights specific text +inside a larger text block and then asks questions about that text. The +questions appear when students hover the mouse over the highlighted +text. The questions also appear in a section below the text block, along +with space for students' responses. + +.. image:: Images/AnnotationExample.gif + +Create an Annotation Problem +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +To create an annotation problem: + +Add the Annotation advanced component. To do this, add the "annotatable" +key value to the **Advanced Settings** page. (For more information, see +the instructions in :ref:`Specialized Problems`.) + +Add the **Instructions** and **Guided Discussion** segments of the +problem. + + +#. In the unit where you want to create the problem, click **Advanced** + under **Add New Component**. +#. In the list of problem types, click **Annotation**. +#. In the component that appears, click **Edit**. +#. In the component editor, replace the example code with your own code. +#. Click **Save**. + + +Add the **Annotation problem** segment of the problem. + + +#. Under the Annotation component, create a new blank Advanced Problem + component. +#. Paste the following code in the Advanced Problem component, replacing + placeholders with your own information. + + + :: + + + + + PLACEHOLDER: Text of annotation + PLACEHOLDER: Text of question + PLACEHOLDER: Type your response below: + PLACEHOLDER: In your response to this question, which tag below + do you choose? + + + + + + + + +

    PLACEHOLDER: Detailed explanation of solution

    +     +     + +#. Click **Save**. + + +.. _Open Response Assessment: + +Open Response Assessment +------------------------ + + +In open response assessments, tens of thousands of students can receive feedback +on written responses of varying lengths as well as files, such as computer code or +images, that the students upload. + + +Because open response assessments are more complex than most other problem types, +they have a separate section. For more information about these problems, see +:ref:`Open Response Assessment Problems`. + + + +.. _Word Cloud: + +Word Cloud +---------- + + +In a word cloud problem, students enter words into a field in response +to a question or prompt. The words all the students have entered then +appear instantly as a colorful graphic, with the most popular responses +appearing largest. The graphic becomes larger as more students answer. +Students can both see the way their peers have answered and contribute +their thoughts to the group. + + +For example, the following word cloud was created from students' +responses to a question in a HarvardX course. + +.. image:: Images/WordCloudExample.gif + +Create a Word Cloud Problem +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To create a word cloud problem: + + +#. Add the Word Cloud advanced component. To do this, add the + "word_cloud" key value to the **Advanced Settings** page. (For more + information, see the instructions in :ref:`Specialized Problems`.) +#. In the unit where you want to create the problem, click **Advanced** + under **Add New Component**. +#. In the list of problem types, click **Word Cloud**. +#. In the component that appears, click **Edit**. +#. In the component editor, specify the settings that you want. You can + leave the default value for everything except **Display Name**. + + + - **Display Name**: The name that appears in the course ribbon and + as a heading above the problem. + - **Inputs**: The number of text boxes into which students can enter + words, phrases, or sentences. + - **Maximum Words**: The maximum number of words that the word cloud + displays. If students enter 300 different words but the maximum is + set to 250, only the 250 most commonly entered words appear in the + word cloud. + - **Show Percents**: The number of times that students have entered + a given word as a percentage of all words entered appears near + that word. + + +#. Click **Save**. + + +For more information, see `Xml Format of "Word Cloud" Module +`_. \ No newline at end of file diff --git a/docs/course_authors/source/view_course_content.rst b/docs/course_authors/source/view_course_content.rst index 9f5dac88afb3..7f98568e1a78 100644 --- a/docs/course_authors/source/view_course_content.rst +++ b/docs/course_authors/source/view_course_content.rst @@ -1,340 +1,80 @@ -******************* -View Course Content -******************* +.. _Testing Your Course: -When you create a course on Studio, you can control when students can see -the content of your course. This means that you can continue building a -course, but students won't be able to see the changes you make until you -make those changes available. You can set release dates that control when -content is released to the internet. You can also set the visibility of -specific Units (a subdivision that helps you organize your course content) -to Public or Private. By default, all content is set to Private. - - -Your content is not visible to students on edX or Edge until three -conditions are met: +########################### +Testing Your Course +########################### -1. The course start date has passed. +The way your course looks in Studio is not the way students see and experience your course. -2. The release dates for the Section and Subsection that contain the - content have passed. - - -* Sections and Subsections are categories that you use to organize your -course. For example, Sections may correspond to weeks in your course, while -Subsections may correspond to the topics in your course. - - -* Neither a Section nor its contents are visible until the release date -passes. If the release date for the Section has passed, but the release date -for the Subsection has not passed, the student can see the Section heading -in the left pane. However, the student cannot see the Subsection heading or -any of the Subsection's content. - - -* Subsections inherit the release date of the Section they are in, but you -can change this date so that individual Subsections are released at different -times after the Section has been released. - - -.. image:: Images/image189.png - - -.. image:: Images/image191.png +Therefore, as and after you develop course content, you must view and test your course from a students' point of view. - -3. You set the Unit that contains the content to Public.** By default, all -Units are set to Private. - - -There are four ways of viewing your course on edX or Edge while you are -still creating it: - - -* In Studio +From within Studio, you can test your course in two ways: +* :ref:`Preview Your Course` +* :ref:`View Your Live Course` -.. note:: +.. _Preview Your Course: - The way your course looks in Studio is not the way it looks to students on - edX or Edge. - - -* On edX or Edge in Preview mode - - Any content that is set to Private is only visible in Preview mode. - - -* On edX or Edge as an Instructor - - When you view content as an instructor, you see the **Instructor** tab at the - the top of the screen. - - -* On edX or Edge as a Student - -.. raw:: latex - - \newpage % - - -Outline View -============ - - -When you want to see the overall organization of your course in Studio, you can -go to the **Course Outline **page. On the**Course Outline **page, you can -see the "macro" outline of your course, down to individual Units. - - -.. image:: Images/image193.png - - -.. raw:: latex - - \newpage % - -Subsection View -=============== - -You can also view content by Subsection. In this view, you can see the name -of the Subsection and the Units that the Subsection contains. You can see if -the Section is graded or not graded; if it is graded, you can see the -assignment type of the Subsection. You can also see if the individual Units -are set to Public or Private. Private Units appear in light gray text with -"PRIVATE" next to the Unit name. All other Units are Public. - - -.. image:: Images/image195.png - - -.. raw:: latex - - \newpage % - -Unit View -========= - -When you want to see the actual text, problems, and other content in your -course, you can open an individual Unit. You then see the Components for -that Unit. You can see this content whether it is set to Public or Private, -and whether or not the release date has passed. - - -The following example shows the Studio view of two Units in the "What Does -an edX Course Look Like?" Subsection. - - -The following Unit is set to Public. The release date for the Subsection has -passed. - - -.. image:: Images/image197.png - - -The following Unit is set to Private. The release date for the Subsection -has passed. - - -.. image:: Images/image199.png - - -If you change the release date for the "What Does an edX Course Look Like?" -Subsection to a date in the future (in this example, January 1, 2099), you -still see both Units in Studio. - - -Public Unit -^^^^^^^^^^^ - - - -.. image:: Images/image201.png - - -Private Unit -^^^^^^^^^^^^ - - - -.. image:: Images/image203.png - - - -.. raw:: latex - - \newpage % - - -Preview Mode -============ +*********************** +Preview Your Course +*********************** -When you view your course on edX or Edge using Preview mode, you see all the +When you view your course through Preview mode, you see all the Units of your course, regardless of whether they are set to Public or Private and regardless of whether the release dates have passed. -**Using Preview mode is the only way to see content that is set to Private +Using Preview mode is the only way to see content that is set to Private **as a student would see it.** You can enter Preview mode in two ways. - -1. On any Subsection page, click** Preview Drafts**. - - +* On any subsection page, click **Preview Drafts**. + .. image:: Images/image205.png + :width: 800 +* On any Unit page, click **Preview**. -2. On any Unit page, click **Preview**. - - -The following example shows the **Preview** button on a page for a Unit that +The following example shows the **Preview** button for a unit that is set to Public. - .. image:: Images/image207.png + :width: 800 -The following example shows the **Preview** button on a page for a Unit that +The following example shows the **Preview** button for a unit that is set to Private. - .. image:: Images/image209.png + :width: 800 -Example -======= - -The following example shows the first Unit of the "What Does an edX Course -Look Like?" Subsection in Preview mode. - - -.. image:: Images/image211.png - - -Remember that the release date for the Subsection is in the past. However, -even if you change the release date for the "What Does an edX Course Look -Like?" Subsection to a date in the future, you still see both Units in -Preview. - - -In the "What Does an edX Course Look Like?" Subsection, Unit 1 ("Welcome to -edX 101") is set to Public, and Unit 2 ("New edX Information") is set to -Private. Both Units appear in the course ribbon at the top of the screen. - - -.. image:: Images/image213.png +.. _View Your Live Course: -When you click Unit 2 in the course ribbon, you see the content in Unit 2: - - -.. image:: Images/image215.png - -**On edX or Edge as an Instructor** - -When you view your course on edX or Edge as an instructor: - - -* You see all the Units of your course that you have set to Public. -* Release dates do not matter. - - -You do not see Units that are set to Private. - - -Additionally, at the top of the page on edX or Edge, you can see the -**Instructor** tab. - - -To view your course on edX or Edge as an instructor, click **View Live**. The -**View Live **button is available in three places.** ** - -The **Course Outline** page. - - -.. image:: Images/image217.png - - -Any Subsection page. - - -.. image:: Images/image219.png - - - -The Unit page, if the Unit is Public. - - -.. image:: Images/image221.png - -Example -======= - -The following example shows the first Unit of the "What Does an edX Course -Look Like?" Subsection as if you were viewing it on edX or Edge as an -instructor. Notice the **Instructor** tab at the top of the page. - - -.. image:: Images/image223.png - - -The release date for the "What Does an edX Course Look Like?" Subsection is -set to January 1, 2099. However, you still see this Unit on edX or Edge as -an instructor. - - -On the other hand, remember that Unit 1 is set to Public, and Unit 2 is set -to Private. Unit 2 does not appear in the course ribbon at the top of the -screen. Instead, the next public unit, **Tabs**, appears. - - -.. image:: Images/image225.png - -**On edX or Edge as a Current Student** - -When you view your course as a current student would see it, you can only -see material that meets all three publishing conditions: - - -The course start date has passed. - - -* The release dates for the Section and Subsection have passed. - -* The Unit that contains the material is set to Public. - - -You can use this view to make sure that material does not appear in your -course prematurely. - - -To view your course as a student, set up a test account on edX or Edge with -an e-mail address that is not associated with your Course Team, and then go -to your course URL and register for your course. +*********************** +View Your Live Course +*********************** -Example -======= - -The following example shows the first Unit of the "What Does an edX Course -Look Like?" Subsection as if you were viewing it on edX or Edge as a -student. Notice that the **Instructor** tab does not appear at the top of -the page. - +When you view your course as an staff member (that is, using the same account you use to build the course in Studio), +you see all the units of your course that are set to **Public**, regardless of the release dates of the containing section or subsection. -.. image:: Images/image227.png +You do not see units that are set to **Private**. To see Private units, you must use Preview mode as described above. +You can view the live course from three different places in Studio: -Remember that Unit 1 is set to Public, and Unit 2 is set to Private. Unit 2 -does not appear in the course ribbon at the top of the screen. Instead, the -next public unit, **Tabs**, appears. - - -.. image:: Images/image229.png +* The **Course Outline** page. + + .. image:: Images/image217.png + :width: 800 +* Any Subsection page. -If you change the release date of the Subsection to a future date (such as -January 1, 2099), the student cannot see it. + .. image:: Images/image219.png + :width: 800 +* The Unit page, if the Unit is Public. -If you set the Unit to Private, the student cannot see it. + .. image:: Images/image221.png + :width: 800 + diff --git a/docs/data/source/conf.py b/docs/data/source/conf.py index 90a78f48fd57..b0a2deec1e5c 100644 --- a/docs/data/source/conf.py +++ b/docs/data/source/conf.py @@ -22,4 +22,10 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path.append('source/_static') +project = u'edX Data Documentation' +copyright = u'2013, edX Documentation Team' +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' \ No newline at end of file diff --git a/docs/data/source/course_data_formats/conditional_module/conditional_module.rst b/docs/data/source/course_data_formats/conditional_module/conditional_module.rst index c0c3a3c338ae..b5ec2063a8b9 100644 --- a/docs/data/source/course_data_formats/conditional_module/conditional_module.rst +++ b/docs/data/source/course_data_formats/conditional_module/conditional_module.rst @@ -23,7 +23,7 @@ be specified for this tag:: sources - location id of required modules, separated by ';' [message | ""] - message for case, where one or more are not passed. Here you can use variable {link}, which generate link to required module. - + [submitted] - map to `is_submitted` module method. (pressing RESET button makes this function to return False.) @@ -77,4 +77,4 @@ Examples of conditional depends on problem You see this, cause "lec27_Q1" is not attempted. - \ No newline at end of file + diff --git a/docs/data/source/index.rst b/docs/data/source/index.rst index 7c1a1512f3ae..acaf88941161 100644 --- a/docs/data/source/index.rst +++ b/docs/data/source/index.rst @@ -43,6 +43,7 @@ These document describe how we store course structure, student state/progress, a internal_data_formats/sql_schema.rst internal_data_formats/discussion_data.rst + internal_data_formats/wiki_data.rst internal_data_formats/tracking_logs.rst Indices and tables diff --git a/docs/data/source/internal_data_formats/sql_schema.rst b/docs/data/source/internal_data_formats/sql_schema.rst index 6cfeec31791d..b698ea415f30 100644 --- a/docs/data/source/internal_data_formats/sql_schema.rst +++ b/docs/data/source/internal_data_formats/sql_schema.rst @@ -374,6 +374,29 @@ A row in this table represents a student's enrollment for a particular course ru String indicating what kind of enrollment this was. The default is "honor" (honor certificate) and all enrollments prior to 2013-08-20 will be of that type. Other types being considered are "audit" and "verified_id". +`user_id_map` +========================== +A row in this table maps a student's real user ID to an anonymous ID generated to obfuscate the student's identity. + +`id` +---- + Primary key. + +`user_id` +--------- + Student's ID in `auth_user.id` + +`anonymous_user_id` +----------- + The user ID generated to obfuscate the student's identity. + +`course_id` +----------- + The ID of the course run the student is enrolled in. + + + + ******************* Courseware Progress ******************* diff --git a/docs/data/source/internal_data_formats/wiki_data.rst b/docs/data/source/internal_data_formats/wiki_data.rst new file mode 100644 index 000000000000..a9f001c3e6a0 --- /dev/null +++ b/docs/data/source/internal_data_formats/wiki_data.rst @@ -0,0 +1,134 @@ +############################## +Wiki Data +############################## + +The following sections detail how edX stores Wiki data internally, and is useful for developers and researchers who are examining database exports. This information includes demographic information collected at signup, course enrollment, course progress, and certificate status. + +Conventions to keep in mind: + +* edX currently uses an external application called Django Wiki for Wiki functionality within courses. + + + +**************** +Notification Type +**************** + +The `notifications` table stores . It has the following fields:: + + +------------------------------+--------------+------+-----+ + | Field | Type | Null | Key | + +------------------------------+--------------+------+-----+ + | key | varchar(128) | NO | PRI | + | label | varchar(128) | YES | | + | content_type | ForeignKey | YES | | + +------------------------------+--------------+------+-----+ + +`key` +---- + Primary key . . . + +`label` +---------- + The label for the notification . . . + +`content_type` +------------ + A foreign key . . . + + + +**************** +Settings +**************** + +The `Settings` table stores . It has the following fields:: + + +------------------------------+--------------+------+-----+ + | Field | Type | Null | Key | + +------------------------------+--------------+------+-----+ + | user | ForeignKey | NO | PRI | + | interval | smallint(6) | NO | | + +------------------------------+--------------+------+-----+ + +`user` +---- + Primary key . . . + +`interval` +---------- + The . . . + + +**************** +Subscriptions +**************** + +The `Subscriptions` table stores . It has the following fields:: + + +------------------------------+--------------+------+-----+ + | Field | Type | Null | Key | + +------------------------------+--------------+------+-----+ + | settings | ForeignKey | NO | PRI | + | notification_type | ForeignKey | NO | | + | object_id | varchar(64) | YES | | + | send_emails | boolean | NO | | + +------------------------------+--------------+------+-----+ + +`settings` +---- + Primary key . . . + +`notification type` +---------- + The . . . + +`object_id` +---- + Primary key . . . + +`send_emails` +---------- + The . . . + + +**************** +Notification +**************** + +The `Notification` table stores . It has the following fields:: + + +------------------------------+--------------+------+-----+ + | Field | Type | Null | Key | + +------------------------------+--------------+------+-----+ + | subscription | ForeignKey | NO | PRI | + | message | text | NO | | + | url | URLField | YES | | + | is_viewed | boolean | NO | | + | is_emailed | boolean | NO | | + | created | datetime | NO | | + +------------------------------+--------------+------+-----+ + +`subscription` +---- + Primary key . . . + +`message` +---------- + The . . . + +`url` +---- + Primary key . . . + +`is_viewed` +---------- + The . . . + +`is_emailed` +---------- + The . . . + +`created` +---------- + The . . . diff --git a/docs/developers/Makefile b/docs/developers/Makefile index faa8708cd47e..a43b3b449f0a 100644 --- a/docs/developers/Makefile +++ b/docs/developers/Makefile @@ -12,7 +12,7 @@ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif -Q_FLAG = +Q_FLAG = ifeq ($(quiet), true) Q_FLAG = -Q @@ -88,17 +88,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MITx.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/edX.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MITx.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/edX.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/MITx" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MITx" + @echo "# mkdir -p $$HOME/.local/share/devhelp/edX" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/edX" @echo "# devhelp" epub: diff --git a/docs/internal/development.md b/docs/internal/development.md index 5b0e606adbe9..f322d00f17e7 100644 --- a/docs/internal/development.md +++ b/docs/internal/development.md @@ -97,9 +97,9 @@ Instead, hit /migrate/modules to see a list of all modules loaded, and click on github (or other equivalent git-based repository systems) used for course content can be setup to trigger an automatic reload when changes are pushed. Here is how: -1. Each content directory in mitx_all/data should be a clone of a git repo +1. Each content directory in edx_all/data should be a clone of a git repo -2. The user running the mitx gunicorn process should have its ssh key registered with the git repo +2. The user running the edx gunicorn process should have its ssh key registered with the git repo 3. The list settings.ALLOWED_GITRELOAD_IPS should contain the IP address of the git repo originating the gitreload request. By default, this list is ['207.97.227.253', '50.57.128.197', '108.171.174.178'] (the github IPs). @@ -109,12 +109,12 @@ course content can be setup to trigger an automatic reload when changes are push { "repository" : { "name" : reload_dir } - where reload_dir is the directory name of the content to reload (ie mitx_all/data/reload_dir should exist) + where reload_dir is the directory name of the content to reload (ie edx_all/data/reload_dir should exist) - The mitx server will then do "git reset --hard HEAD; git clean -f -d; git pull origin" in that directory. After the pull, + The edx server will then do "git reset --hard HEAD; git clean -f -d; git pull origin" in that directory. After the pull, it will reload the modulestore for that course. Note that the gitreload-based workflow is not meant for deployments on AWS (or elsewhere) which use collectstatic, since collectstatic is not run by a gitreload event. -Also, the gitreload feature needs MITX_FEATURES['ENABLE_LMS_MIGRATION'] = True in the django settings. +Also, the gitreload feature needs FEATURES['ENABLE_LMS_MIGRATION'] = True in the django settings. diff --git a/docs/internal/mongo.md b/docs/internal/mongo.md index 5ce0362e95fe..9a84b0f7e81a 100644 --- a/docs/internal/mongo.md +++ b/docs/internal/mongo.md @@ -1,5 +1,5 @@ # Notes on using mongodb backed LMS and CMS - + These are some random notes for developers, on how things are stored in mongodb, and how to debug mongodb data. ## Databases @@ -62,7 +62,7 @@ Under ubuntu, do: - apt-get install php5-fpm php-pear - pecl install mongo - - edit /etc/php5/fpm/php.ini to add "extension=mongo.so" + - edit /etc/php5/fpm/php.ini to add "extension=mongo.so" - /etc/init.d/php5-fpm restart and also setup nginx to run php through fastcgi. diff --git a/docs/internal/overview.md b/docs/internal/overview.md index a74c512fbfb5..dc79b7ea67f1 100644 --- a/docs/internal/overview.md +++ b/docs/internal/overview.md @@ -101,8 +101,6 @@ The LMS is a django site, with root in `lms/`. It runs in many different enviro - ajax calls go to `module_render.py:handle_xblock_callback()`, which passes it to one of the `XBlock`s handler functions - - [This diagram](https://github.com/MITx/mitx/wiki/MITx-Architecture) visually shows how the clients communicate with problems + modules. - - See `lms/urls.py` for the wirings of urls to views. - Tracking: there is support for basic tracking of client-side events in `lms/djangoapps/track`. @@ -120,7 +118,7 @@ environments, defined in `cms/envs`. - javascript -- we use coffeescript, which compiles to js, and is much nicer to work with. Look for `*.coffee` files. We use _jasmine_ for testing js. -- _mako_ -- we use this for templates, and have wrapper called mitxmako that makes mako look like the django templating calls. +- _mako_ -- we use this for templates, and have wrapper called edxmako that makes mako look like the django templating calls. We use a fork of django-pipeline to make sure that the js and css always reflect the latest `*.coffee` and `*.sass` files (We're hoping to get our changes merged in the official version soon). This works differently in development and production. Test uses the production settings. diff --git a/docs/internal/remote_gradebook.md b/docs/internal/remote_gradebook.md index 3743e987531e..39dd946f27e0 100644 --- a/docs/internal/remote_gradebook.md +++ b/docs/internal/remote_gradebook.md @@ -2,7 +2,7 @@ Grades can be pushed to a remote gradebook, and course enrollment membership can 1. Definitions -An "xserver" is a web-based server that is part of the MITx eco system. There are a number of "xserver" programs, including one which does python code grading, an xqueue server, and graders for other coding languages. +An "xserver" is a web-based server that is part of the edX ecosystem. There are a number of "xserver" programs, including one which does python code grading, an xqueue server, and graders for other coding languages. "Stellar" is the MIT on-campus gradebook system. @@ -10,14 +10,14 @@ An "xserver" is a web-based server that is part of the MITx eco system. There a The remote gradebook xserver should be specified in the lms.envs configuration using - MITX_FEATURES[REMOTE_GRADEBOOK_URL] + FEATURES[REMOTE_GRADEBOOK_URL] Each course, in addition, should define the name of the gradebook being used. A class "section" may also be specified. This goes in the policy.json file, eg: - "remote_gradebook": { - "name" : "STELLAR:/project/mitxdemosite", - "section" : "r01" - }, + "remote_gradebook": { + "name" : "STELLAR:/project/edxdemosite", + "section" : "r01" + }, 3. The API for the remote gradebook xserver is an almost RESTful service model, which only employs POSTs, to the xserver url, with form data for the fields: @@ -26,13 +26,13 @@ Each course, in addition, should define the name of the gradebook being used. A - user: username of staff person initiating the request (for logging) - section: (optional) name of section -The return body content should be a JSON string, of the format {'msg': message, 'data': data}. The message is displayed in the instructor dashboard. +The return body content should be a JSON string, of the format {'msg': message, 'data': data}. The message is displayed in the instructor dashboard. The data is a list of dicts (associative arrays). Each dict should be key:value. ## For submit=post-grades: -A file is also posted, with the field name "datafile". This file is CSV format, with two columns, one being "External email" and the other being the name of the assignment (that column contains the grades for the assignment). +A file is also posted, with the field name "datafile". This file is CSV format, with two columns, one being "External email" and the other being the name of the assignment (that column contains the grades for the assignment). ## For submit=get-assignments diff --git a/docs/release_notes/Makefile b/docs/release_notes/Makefile new file mode 100644 index 000000000000..d02280e2fd6b --- /dev/null +++ b/docs/release_notes/Makefile @@ -0,0 +1,183 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +Q_FLAG = + +ifeq ($(quiet), true) +Q_FLAG = -Q +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/getting_started.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/getting_started.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/getting_started" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/release_notes/__init__.py b/docs/release_notes/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/release_notes/source/10-23-2013.rst b/docs/release_notes/source/10-23-2013.rst new file mode 100644 index 000000000000..f085b6d26714 --- /dev/null +++ b/docs/release_notes/source/10-23-2013.rst @@ -0,0 +1,146 @@ +################################### +October 23, 2013 +################################### + +************* +edX Studio +************* + +============= +New Features +============= + +* **Improved import experience** (STUD-595) + + When you import a course, the Import screen now provides real-time status updates. The Import screen tells you when the import is in the + following stages: + * Uploading + * Unpacking + * Verifying + * Updated Course + * Success (Complete) + +* **Improved drag and drop experience in course outlines** (STUD-575) + + The ability to drag and drop sections, subsections, and units in the course outline is enhanced in the following ways: + + * The visual representation of where you are moving the course element to is improved, with a pointer and blue line indicating the + new position. + + * You can more easily drag units from one subsection to another. + + * When you cancel a drop, the course element returns to its original position. + + * You can no longer drag a course element below the New Unit button, which was causing confusion. + +* **Text customization capability** + + You can now customize some of the UI text that your students see. You do this through the text_customization key in the Advanced + Settings for the course. (However, edX recommends that you contact your Program Manager before you modify the text_customization key.) + +* **JavaScript loading performance** + + JavaScript loading is changed in ways that should improve the performance on some pages. + Code contributors should note that JavaScript is now loaded through require.js. + + + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* In a course outline, you can no longer drag and drop a unit below the New Unit button. (STUD-152) + +* Course update content outside of HTML tags is no longer erroneously removed.(STUD-590) + +* In a course outline, dragging a unit over the Units label no longer causes the unit to be removed. (STUD-755) + +* Support text in the Assignment Types section of the Grading page is updated to clarify that you enter an integer, not a percent, in the W + eight of Total Grade field. (STUD-771) + +* Certain component errors no longer prevent the course from saving correctly. (STUD-786) + +* When you delete a Discussion component, the discussion is completely removed from the course. (STUD-811, STUD-817) + +* When you are editing a course update, the update no longer disappears if you click outside of the Edit window. (STUD-822) + +* When you enter the integer 7 in the Total Weight of Grade field, the value is no longer changed to a decimal. (STUD-826) + + +*************************************** +edX Learning Management System +*************************************** + +============= +New Features +============= + +The following changes are included in this release: + +* **Fixed views in Internet Explorer 9.x** + + Problems with pages in Internet Explorer 9.x are resolved. + +* **Disabled downloading data for large courses** + + For courses with over 200 students, downloading large data sets could fail. The Download Data button on the Instructor Dashboard is now + temporarily disabled to avoid this problem. + +* **Improved Beta Instructor Dashboard** + + You can access the Beta Instructor Dashboard from the current Instructor Dashboard by clicking Try the New Beta Dashboard. The Beta + version continued so evolve with a streamlined design and improved architecture. Both dashboards are currently available. + +* **Improved video and transcript experience** (BLD-420) + + When you are playing a video with the transcript hidden, you can display the transcript by hovering the mouse pointer over the CC button. + You can then click a paragraph in the displayed transcript to move to that point in the video. When you move the pointer off the CC button, + the transcript is hidden. + +* **Improved Learning Tools Interoperability (LTI)** (BLD-330, BLD-347) + + You can now use multiple LTI tools per page. You can also have an LTI module load external content in a new window. + + +========================== +Changes and Updates +========================== + +* The link to open and close the calculator has additional aria attributes for accessibility. (BLD-164) + +* The Hints panel for the calculator is now accessible to screen readers. (BLD-165) + +* Students can now download video subtitles. (BLD-245) + +* Multi-speed video playback now works in Firefox browsers as expected. (BLD-287) + +* Window resizing no longer cuts off videos. (BLD-289) + +* Video HD control is now handicap accessible. (BLD-387) + +* You can now export courses that have LTI modules. (BLD-389) + +* A malformed custom parameter in an LTI component no longer permanently breaks the unit. (BLD-390) + +* The styles and text for the download links for videos and transcripts are updated for clarity and accessibility. (BLD-403) + +* The CC button in the video player now includes explanatory text that is accessible with a screen reader. (BLD-404) + +* LTI with the Piazza platform now works as expected. (BLD-405) + +* The **Close** button on dialog boxes is now defined as an HTML button and is accessible to screen readers. (LMS-582) + + +****************** +Forums +****************** + +The following changes are included in this release: + +* The color contrast of the Report Misuse link is updated for accessibility. (FOR-200) + +* The Report Misuse link now includes a tooltip that is accessible to screen readers. (FOR-201) + +* The Report Misuse link is now included in the page tab order, for keyboard accessibility. (FOR-209) diff --git a/docs/release_notes/source/10-29-2013.rst b/docs/release_notes/source/10-29-2013.rst new file mode 100644 index 000000000000..c833f6ae7054 --- /dev/null +++ b/docs/release_notes/source/10-29-2013.rst @@ -0,0 +1,89 @@ +################################### +October 29, 2013 +################################### + +************* +edX Studio +************* + +============= +New Features +============= + +* **New video editing interface, enabling an enhanced workflow for adding timed transcripts to videos** (BLD-238) + + When you enter a video URL in the Editing: Video dialog box, the system checks if a timed transcript for that video exists on edX, and if + so, automatically associates the transcript with the video. If no transcript is found, you click Upload New Timed Transcript to locate and + upload the .SRT file for the transcript. + + When there is an associated timed transcript, you can click Download to Edit to download a local copy of the .SRT file. You can then + modify the transcript and upload the new file. + + For YouTube videos, you can also import a timed transcript from YouTube, overwriting the version of the transcript on edX with the version + from YouTube. + + Backwards compatibility with the other transcript workflow is maintained with a tabbed interface. + +==================================================== +Known Issues and Workarounds +==================================================== + +* **Uploading a large number of files** (STUD-813, STUD-837) + + When you go to the Files & Uploads page, if your course has a large number of files, the Files & Uploads page can time out before it lists + all the files. The page becomes unresponsive, and you cannot upload more files. + + **Workaround**: To upload new files files when the Files & Uploads page is timing out, limit the number of files that appear on the Files & + Uploads page by adding start and max parameters to the URL. For example, you can append the following parameters to the URL in your + browser: + `https://studio.edge.edx.org/assets/organization.course-number.course-name/branch/block/course-name?start=5&max=15` + + This example tells the page to load a maximum of 10 files, starting with the 6th file. You can use other values as needed, as long as the list + is not so long that the page does not load successfully. Note that file counts begin at 0, not 1, and that files are listed chronologically, with + the most recent first. + + + + + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* Because Course IDs are not case sensitive, all Course IDs must be unique regardless of capitalization. For example, you cannot have + both edX101 and EdX101 as course IDs. (STUD-873) + + +*************************************** +edX Learning Management System +*************************************** + + +The following changes are included in this release: + +* The cheatsheet available when you are adding a new Wiki article is now accessible to screen readers. (LMS-1303) + +* In the Wiki, active links are now displayed as bold, and have additional text labels, to be accessible to screen readers. (LMS-1306) + +* In the Wiki, when you navigate through links with the Tab key, the active link is updated in the same was as when you hover over it with + the mouse pointer. (LMS-1336) + +* Default Wiki permissions are updated so that only course staff can delete Wiki pages. (LMS-1355) + +* The Reset Password and Password Reset Confirmation pages are updated to use styles consistent with the system. (LMS-1357) + +* In certain situations, students received a 500 error when viewing the Progress page. This problem was resolved in a patch on October 23, 2013. (LMS-1367) + +* A visual indicator has been added to the video player to indicate which part of the video will play, when it is not the default. (BLD-391) + +* Forum views are updated to improve performance. (FOR-250) + +****************** +Analytics +****************** + +The following changes are included in this release: + +* Course exports are included with weekly data dumps delivered to university data representatives. (AN-57) diff --git a/docs/release_notes/source/11-06-2013.rst b/docs/release_notes/source/11-06-2013.rst new file mode 100644 index 000000000000..11e9bbe31b76 --- /dev/null +++ b/docs/release_notes/source/11-06-2013.rst @@ -0,0 +1,112 @@ +################################### +November 6, 2013 +################################### + +************* +edX Studio +************* + +============= +New Features +============= + +* **Improved Course Export page** + + The Course Export page has a new layout, with enhanced help text. + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* The Forgot Password link on the Studio Sign In page now works correctly. (STUD-689) + +* In the Create a New Course page Organization field, text now suggests the generic UniversityX, instead of MITx. (STUD-885) + +* The Create a New Course page Course Run field, text now suggests the using the year and trimester (for example, 2014_T1), instead + of the year and season. (STUD-916) + +* Studio now continues working correctly when a YouTube video in the page fails to load. (STUD-472) + +* To avoid potential problems with browser security, you can no longer enter video URLs with http://. You must use https://. (BLD-408) + +* By default, the options to add a Problem Written in LaTex and a Problem with Adaptive Hint in Latex are no longer included in the + Advanced tab of the Problems component. In addition, the option to add E-text Written in LaTeX is no longer included in the HTML component. + + To enable these options, open the Advanced Settings page and set the value of the use_latex_compiler policy key to true. (BLD-426) + +========================== +Technical Changes +========================== + +Contributors to the open source edX Platform should note the following change: + +The Course Export page is updated to use a RESTFul interface. (STUD-846) + +*************************************** +edX Learning Management System +*************************************** +========================== +New Features +========================== + +* **Upgrading the Course Track** + + A student in the Honor Code or Audit track can now upgrade to the Verified Certificate track. (LMS-1127) + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* After registering for a course, a student could use the browser's Back button to return to the Registration page and change the + registration type. Now, if the user tries to go back to the Registration page, the Learning Management System redirects the student to the + courseware, where the student must unregister first to change the course mode. (LMS-1062) + +* When a student fails verification for the Verified track, the Learning Management System now notifies the user through the Student + Dashboard, and prompts them to retry. The student must send another set of photos, but does not have to pay again. If the student does + not retry, they can get a refund. (LMS-1133) + +* In the Beta Instructor Dashboard, the layout is improved and the Pending Instructor Tasks section now functions correctly. (LMS-1242) + +* You can now tab through the Wiki pages without getting stuck in the content area. (LMS-1307) + +* Default settings now include the generic email address @example.com instead of @edx.org. (LMS-1363) + +* The user experience and help text during course registration and upgrading are enhanced, and the last day to register for verified certificates is more clear. (LMS-1384) + +* Keyboard navigation is now updated in the Wiki to skip repetitive content, allowing users to go directly to unique content on a page. (LMS-1387) + +* Errors that prevented the Progress page from successfully loading are fixed. (LMS-1388) + +* In the Sign Up page, the Public Display Name field was renamed to Public Username. (LMS-1393) + +* Errors when creating a new account are resolved. (LMS-1418) + +* A typo was removed from the course registration email template. (LMS-1419) + +* The Saving a Word Cloud component generated an error message. This problem no longer occurs. (BLD-205) + +* When viewing a video, if a student clicked on the video timeline before or after the specified end time, the video jumped to the beginning. This problem is resolved. (BLD-392) + +* Students can now change the video speed when the video is paused. (BLD-424) + +* Several problems with the video player are resolved: + * The Start time did not work in Flash mode. + * Students could not change the speed before the video started. + * The end point in the video slider was inaccurate for short videos. + * The video slider showed the incorrect position after the video stopped. (BLD-468) + +* Sorting of the forums thread list now works correctly when a topic is selected from the drop-down menu. (FOR-224) + +* Forum follow buttons are now accessible to screen readers, have the ARIA checkbox role, and activate with the space or Enter key.(FOR-240) + +****************** +Analytics +****************** + +The following changes are included in this release: + +* The user_id field is added to tracking events. (AN-213) diff --git a/docs/release_notes/source/12-03-2013.rst b/docs/release_notes/source/12-03-2013.rst new file mode 100644 index 000000000000..fa3dd0752213 --- /dev/null +++ b/docs/release_notes/source/12-03-2013.rst @@ -0,0 +1,56 @@ +################################### +December 3, 2013 +################################### + +************* +edX Studio +************* + + +The following Studio changes are included in this release: + +* As part of a database architecture change and the implementation of a RESTful interface, URLs in Studio are changing to use a new + period-separated locator syntax. This change currently affects a subset of pages in Studio. In future releases, the other pages in Studio + will be changed to use the new URL syntax. + +* Video transcripts now load correctly even if any part of https is in capital letters. (BLD-496) + +* The Problem component now includes a template for creating checkbox problems. (BLD-193) + +* In Internet Explorer 9, Save notifications now appear correctly when a user locks or unlocks assets. (STUD-815) + + + +******************************* +edX Learning Management System +******************************* + + + +The following changes are included in this release: + +* Discrepancies in how the number of enrolled students were calculated in the Instructor Dashboard and the Beta Instructor Dashboard are + fixed. Now, in all cases, the number represents the currently enrolled students. (AN-115) + +* Incorrect student responses to problems are now saved after the student clicks Check. (LMS-469) + +* JavaScript errors are now fixed in the Reset Password pages. (LMS-1265) + The Wiki Changes page is now accessible to screen readers. (LMS-1309) + +* Course staff can now set granular permissions for Wiki articles. In the main Wiki page, you can click Settings to see and set + permissions. (LMS-1355) + +* In the Instructor Dashboard, the Edit Course in Studio link now correctly opens the course in Studio. (LMS-1455) + +* Taking a photograph for a verified certificate now works correctly. (LMS-1487) + +* Links within videos no longer have a white background or obscure part of the video content. (BLD-521) + +* In checkbox problems, using bold and italics no longer causes display problems. (BLD-449) + +* The speed change option now works correctly in all video configurations. (BLD-457) + +* A spinning icon now shows users with slow connections when a video is loading. (BLD-502) + +* In the Forums, an AJAX request that results in a 500 error now informs the user to try again, instead of silently timing out. (FOR-37) + diff --git a/docs/release_notes/source/12-09-2013.rst b/docs/release_notes/source/12-09-2013.rst new file mode 100644 index 000000000000..320a3124ad3d --- /dev/null +++ b/docs/release_notes/source/12-09-2013.rst @@ -0,0 +1,69 @@ +################################### +December 9, 2013 +################################### + +************* +edX Studio +************* + +.. note:: You can now access the public edX roadmap_ for details about the currently planned product direction. + +.. _roadmap: https://edx-wiki.atlassian.net/wiki/display/OPENPROD/OpenEdX+Public+Product+Roadmap + +============= +New Features +============= + +* You can now allow multiple strings as correct answers to text response problems. (BLD-474) + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* If you entered invalid HTML in the Course Handouts, you were not able to edit the Course Handouts to fix the HTML. This problem is resolved (STUD-293) + +* When you created a new video, you received a 500 error and could not import a timed transcript. This problem is resolved. (BLD-530) + +* In Internet Explorer 9.x, when you locked and unlocked assets, the Save notification was not displayed. This problem is resolved. (STUD-815) + +* In Firefox, when viewing a unit, you could not select and copy the unit identifier. This problem is resolved. (STUD-863) + +* When you viewed problems within Studio, italics did not render properly. This problem is resolved. (STUD-963) + + +*************************************** +edX Learning Management System +*************************************** + + +The following changes are included in this release: + +* All dialog boxes in the Wiki are now fully accessible to screen readers. (LMS-1337) + +* The reset password function allowed others to determine valid usersnames. This problem is resolved. [DETAILS] (LMS-1507) + +* If a user registered for a verified certificate, then switched to audit the course, the student + remained listed as signed up for a verified certificate. This problem is resolved. (LMS-1526) + +* In code response questions, the button to hide the output is now shown for each test case, so students do + not need to scroll through all test cases to get to the button to hide all output. (BLD-126) + +* The calculator tooltips now show all options for inputing numbers. (BLD-400) + +* The video player now alerts screen readers when the video is over. (BLD-488) + +* Numerical input problems now support mathematical operations. (BLD-525) + +* The calculator tooltips are now fully accessible to screen readers. (BLD-533) + +****************** +Forums +****************** + +The following changes are included in this release: + +* An update to enhance accessibility was made so that when users load additional forum threads, + focus remains on the loading element. (FOR-238) + diff --git a/docs/release_notes/source/conf.py b/docs/release_notes/source/conf.py new file mode 100644 index 000000000000..62753762c425 --- /dev/null +++ b/docs/release_notes/source/conf.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# + +import sys, os + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +sys.path.append(os.path.abspath('../../../')) +sys.path.append(os.path.abspath('../../')) + +from docs.shared.conf import * + +sys.path.insert(0, os.path.abspath('.')) + +master_doc = 'index' + +# Add any paths that contain templates here, relative to this directory. +templates_path.append('source/_templates') + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path.append('source/_static') + + +# General information about the project. +project = u'Release Notes for edX Course Staff' +copyright = u'2013, edX Documentation Team' + +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' \ No newline at end of file diff --git a/docs/release_notes/source/index.rst b/docs/release_notes/source/index.rst new file mode 100755 index 000000000000..55fda969109f --- /dev/null +++ b/docs/release_notes/source/index.rst @@ -0,0 +1,25 @@ +.. Getting_Started documentation master file, created by + sphinx-quickstart on Tue Apr 16 11:19:12 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + + +Contents +======== + +.. toctree:: + :numbered: + :maxdepth: 5 + + read_me + 12-09-2013 + 12-03-2013 + 11-06-2013 + 10-29-2013 + 10-23-2013 + + + + + + diff --git a/docs/release_notes/source/latex/Makefile b/docs/release_notes/source/latex/Makefile new file mode 100644 index 000000000000..6b87ad8814cc --- /dev/null +++ b/docs/release_notes/source/latex/Makefile @@ -0,0 +1,66 @@ +# Makefile for Sphinx LaTeX output + +ALLDOCS = $(basename $(wildcard *.tex)) +ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) +ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) + +# Prefix for archive names +ARCHIVEPRREFIX = +# Additional LaTeX options +LATEXOPTS = + +all: $(ALLPDF) +all-pdf: $(ALLPDF) +all-dvi: $(ALLDVI) +all-ps: all-dvi + for f in *.dvi; do dvips $$f; done + +all-pdf-ja: + for f in *.pdf *.png *.gif *.jpg *.jpeg; do extractbb $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + -for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.dvi; do dvipdfmx $$f; done + +zip: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +tar: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +bz2: tar + bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +# The number of LaTeX runs is quite conservative, but I don't expect it +# to get run often, so the little extra time won't hurt. +%.dvi: %.tex + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + +%.pdf: %.tex + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + +clean: + rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla + +.PHONY: all all-pdf all-dvi all-ps clean +.PHONY: all-pdf-ja + diff --git a/docs/release_notes/source/read_me.rst b/docs/release_notes/source/read_me.rst new file mode 100644 index 000000000000..44d03492b06f --- /dev/null +++ b/docs/release_notes/source/read_me.rst @@ -0,0 +1,20 @@ +******* +Read Me +******* + +The edX *Release Notes for Course Staff* documentation provides a cumulative list of changes +that affect course authoring in edX Studio and the edX Learning Management System. + +This document is created using RST_ files and Sphinx_. You, the user community, can help update and revise +this documentation project on GitHub:: + + https://github.com/edx/edx-platform/tree/master/docs/release_notes/source + +To suggest a revision, fork the project, make changes in your fork, and submit +a pull request back to the original project: this is known as the `GitHub Flow`_. +All pull requests need approval from edX. For more information, contact edX at docs@edx.org. + +.. _Sphinx: http://sphinx-doc.org/ +.. _LaTeX: http://www.latex-project.org/ +.. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser +.. _RST: http://docutils.sourceforge.net/rst.html \ No newline at end of file diff --git a/i18n/config.py b/i18n/config.py index 6f3e5d777377..4f6a0e0195ed 100644 --- a/i18n/config.py +++ b/i18n/config.py @@ -1,13 +1,15 @@ -import os, json +import os +import json from path import path # BASE_DIR is the working directory to execute django-admin commands from. -# Typically this should be the 'mitx' directory. +# Typically this should be the 'edx-platform' directory. BASE_DIR = path(__file__).abspath().dirname().joinpath('..').normpath() # LOCALE_DIR contains the locale files. -# Typically this should be 'mitx/conf/locale' -LOCALE_DIR = BASE_DIR.joinpath('conf', 'locale') +# Typically this should be 'edx-platform/conf/locale' +LOCALE_DIR = BASE_DIR.joinpath('conf', 'locale') + class Configuration: """ @@ -50,7 +52,7 @@ def source_locale(self): def dummy_locale(self): """ Returns a locale to use for the dummy text, e.g. 'eo'. - Throws exception if no dummy-locale is declared. + Throws exception if no dummy-locale is declared. The locale is a string. """ dummy = self._config.get('dummy-locale', None) @@ -61,7 +63,7 @@ def dummy_locale(self): def get_messages_dir(self, locale): """ Returns the name of the directory holding the po files for locale. - Example: mitx/conf/locale/fr/LC_MESSAGES + Example: edx-platform/conf/locale/fr/LC_MESSAGES """ return LOCALE_DIR.joinpath(locale, 'LC_MESSAGES') @@ -69,7 +71,7 @@ def get_messages_dir(self, locale): def source_messages_dir(self): """ Returns the name of the directory holding the source-language po files (English). - Example: mitx/conf/locale/en/LC_MESSAGES + Example: edx-platform/conf/locale/en/LC_MESSAGES """ return self.get_messages_dir(self.source_locale) diff --git a/i18n/generate.py b/i18n/generate.py index 65c65c00d6d1..34fef4915d7b 100755 --- a/i18n/generate.py +++ b/i18n/generate.py @@ -4,12 +4,12 @@ See https://edx-wiki.atlassian.net/wiki/display/ENG/PO+File+workflow - This task merges and compiles the human-readable .pofiles on the + This task merges and compiles the human-readable .pofiles on the local filesystem into machine-readable .mofiles. This is typically necessary as part of the build process since these .mofiles are needed by Django when serving the web app. - The configuration file (in mitx/conf/locale/config) specifies which + The configuration file (in edx-platform/conf/locale/config) specifies which languages to generate. """ @@ -21,6 +21,7 @@ LOG = logging.getLogger(__name__) + def merge(locale, target='django.po', fail_if_missing=True): """ For the given locale, merge django-partial.po, messages.po, mako.po -> django.po @@ -52,6 +53,7 @@ def merge(locale, target='django.po', fail_if_missing=True): django_filename = locale_directory.joinpath(target) os.rename(merged_filename, django_filename) # can't overwrite file on Windows + def clean_metadata(file): """ Clean up redundancies in the metadata caused by merging. @@ -59,6 +61,7 @@ def clean_metadata(file): """ pofile(file).save() + def validate_files(dir, files_to_merge): """ Asserts that the given files exist. @@ -71,7 +74,8 @@ def validate_files(dir, files_to_merge): if not pathname.exists(): raise Exception("I18N: Cannot generate because file not found: {0}".format(pathname)) -def main (): + +def main(): logging.basicConfig(stream=sys.stdout, level=logging.INFO) for locale in CONFIGURATION.locales: @@ -81,5 +85,6 @@ def main (): compile_cmd = 'django-admin.py compilemessages' execute(compile_cmd, working_directory=BASE_DIR) + if __name__ == '__main__': main() diff --git a/i18n/make_dummy.py b/i18n/make_dummy.py index 20eac03522a2..022287c68918 100755 --- a/i18n/make_dummy.py +++ b/i18n/make_dummy.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # Generate test translation files from human-readable po files. -# +# # Dummy language is specified in configuration file (see config.py) # two letter language codes reference: # see http://www.loc.gov/standards/iso639-2/php/code_list.php @@ -20,7 +20,7 @@ # $ ./make_dummy.py ../conf/locale/en/LC_MESSAGES/django.po # # generates output to -# mitx/conf/locale/eo/LC_MESSAGES/django.po +# edx-platform/conf/locale/eo/LC_MESSAGES/django.po import os, sys import polib @@ -28,6 +28,7 @@ from config import CONFIGURATION from execute import create_dir_if_necessary + def main(file, locale): """ Takes a source po file, reads it, and writes out a new po file @@ -44,6 +45,7 @@ def main(file, locale): create_dir_if_necessary(new_file) pofile.save(new_file) + def new_filename(original_filename, new_locale): """Returns a filename derived from original_filename, using new_locale as the locale""" orig_dir = os.path.dirname(original_filename) @@ -57,10 +59,10 @@ def new_filename(original_filename, new_locale): if __name__ == '__main__': # required arg: file - if len(sys.argv)<2: + if len(sys.argv) < 2: raise Exception("missing file argument") # optional arg: locale - if len(sys.argv)<3: + if len(sys.argv) < 3: locale = CONFIGURATION.get_dummy_locale() else: locale = sys.argv[2] diff --git a/lms/djangoapps/branding/__init__.py b/lms/djangoapps/branding/__init__.py index aae57ac2e9eb..d70ffb1cc990 100644 --- a/lms/djangoapps/branding/__init__.py +++ b/lms/djangoapps/branding/__init__.py @@ -20,7 +20,7 @@ def get_visible_courses(domain=None): if isinstance(c, CourseDescriptor)] courses = sorted(courses, key=lambda course: course.number) - if domain and settings.MITX_FEATURES.get('SUBDOMAIN_COURSE_LISTINGS'): + if domain and settings.FEATURES.get('SUBDOMAIN_COURSE_LISTINGS'): subdomain = pick_subdomain(domain, settings.COURSE_LISTINGS.keys()) visible_ids = frozenset(settings.COURSE_LISTINGS[subdomain]) return [course for course in courses if course.id in visible_ids] @@ -33,7 +33,7 @@ def get_university(domain=None): Return the university name specified for the domain, or None if no university was specified """ - if not settings.MITX_FEATURES['SUBDOMAIN_BRANDING'] or domain is None: + if not settings.FEATURES['SUBDOMAIN_BRANDING'] or domain is None: return None subdomain = pick_subdomain(domain, settings.SUBDOMAIN_BRANDING.keys()) diff --git a/lms/djangoapps/branding/tests.py b/lms/djangoapps/branding/tests.py index 3d900e3ec31f..e880ccb62d7a 100644 --- a/lms/djangoapps/branding/tests.py +++ b/lms/djangoapps/branding/tests.py @@ -12,10 +12,10 @@ from courseware.tests.tests import TEST_DATA_MONGO_MODULESTORE import student.views -MITX_FEATURES_WITH_STARTDATE = settings.MITX_FEATURES.copy() -MITX_FEATURES_WITH_STARTDATE['DISABLE_START_DATES'] = False -MITX_FEATURES_WO_STARTDATE = settings.MITX_FEATURES.copy() -MITX_FEATURES_WO_STARTDATE['DISABLE_START_DATES'] = True +FEATURES_WITH_STARTDATE = settings.FEATURES.copy() +FEATURES_WITH_STARTDATE['DISABLE_START_DATES'] = False +FEATURES_WO_STARTDATE = settings.FEATURES.copy() +FEATURES_WO_STARTDATE['DISABLE_START_DATES'] = True @override_settings(MODULESTORE=TEST_DATA_MONGO_MODULESTORE) @@ -31,7 +31,7 @@ def setUp(self): self.course.enrollment_start = datetime.datetime.now(UTC) + datetime.timedelta(days=3) self.store.save_xmodule(self.course) - @override_settings(MITX_FEATURES=MITX_FEATURES_WITH_STARTDATE) + @override_settings(FEATURES=FEATURES_WITH_STARTDATE) def test_none_user_index_access_with_startdate_fails(self): """ This was a "before" test for a bugfix. If someone fixes the bug another way in the future @@ -40,12 +40,12 @@ def test_none_user_index_access_with_startdate_fails(self): with self.assertRaisesRegexp(AttributeError, "'NoneType' object has no attribute 'is_authenticated'"): student.views.index(self.factory.get('/'), user=None) # pylint: disable=E1101 - @override_settings(MITX_FEATURES=MITX_FEATURES_WITH_STARTDATE) + @override_settings(FEATURES=FEATURES_WITH_STARTDATE) def test_anon_user_with_startdate_index(self): response = self.client.get('/') self.assertEqual(response.status_code, 200) - @override_settings(MITX_FEATURES=MITX_FEATURES_WO_STARTDATE) + @override_settings(FEATURES=FEATURES_WO_STARTDATE) def test_anon_user_no_startdate_index(self): response = self.client.get('/') self.assertEqual(response.status_code, 200) diff --git a/lms/djangoapps/branding/views.py b/lms/djangoapps/branding/views.py index 3ce8dbd40177..b725f7e1996a 100644 --- a/lms/djangoapps/branding/views.py +++ b/lms/djangoapps/branding/views.py @@ -3,12 +3,12 @@ from django.http import Http404 from django.shortcuts import redirect from django_future.csrf import ensure_csrf_cookie -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response import student.views import branding import courseware.views -from mitxmako.shortcuts import marketing_link +from edxmako.shortcuts import marketing_link from util.cache import cache_if_anonymous @@ -22,10 +22,10 @@ def index(request): if settings.COURSEWARE_ENABLED and request.user.is_authenticated(): return redirect(reverse('dashboard')) - if settings.MITX_FEATURES.get('AUTH_USE_MIT_CERTIFICATES'): + if settings.FEATURES.get('AUTH_USE_MIT_CERTIFICATES'): from external_auth.views import ssl_login return ssl_login(request) - if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE'): + if settings.FEATURES.get('ENABLE_MKTG_SITE'): return redirect(settings.MKTG_URLS.get('ROOT')) university = branding.get_university(request.META.get('HTTP_HOST')) @@ -46,10 +46,10 @@ def courses(request): to that. Otherwise, if subdomain branding is on, this is the university profile page. Otherwise, it's the edX courseware.views.courses page """ - if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE', False): + if settings.FEATURES.get('ENABLE_MKTG_SITE', False): return redirect(marketing_link('COURSES'), permanent=True) - if not settings.MITX_FEATURES.get('COURSES_ARE_BROWSABLE'): + if not settings.FEATURES.get('COURSES_ARE_BROWSABLE'): raise Http404 # we do not expect this case to be reached in cases where diff --git a/lms/djangoapps/bulk_email/models.py b/lms/djangoapps/bulk_email/models.py index 83a691f18e3c..4eceff13d993 100644 --- a/lms/djangoapps/bulk_email/models.py +++ b/lms/djangoapps/bulk_email/models.py @@ -231,9 +231,9 @@ def instructor_email_enabled(cls, course_id): If email has not been explicitly enabled, returns False. """ - # If settings.MITX_FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] is + # If settings.FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] is # set to False, then we enable email for every course. - if not settings.MITX_FEATURES['REQUIRE_COURSE_EMAIL_AUTH']: + if not settings.FEATURES['REQUIRE_COURSE_EMAIL_AUTH']: return True try: diff --git a/lms/djangoapps/bulk_email/tests/test_course_optout.py b/lms/djangoapps/bulk_email/tests/test_course_optout.py index 378610eeb369..086d51b87a58 100644 --- a/lms/djangoapps/bulk_email/tests/test_course_optout.py +++ b/lms/djangoapps/bulk_email/tests/test_course_optout.py @@ -59,7 +59,7 @@ def navigate_to_email_view(self): selected_email_link = 'Email' self.assertTrue(selected_email_link in response.content) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) def test_optout_course(self): """ Make sure student does not receive course email after opting out. @@ -88,7 +88,7 @@ def test_optout_course(self): # Assert that self.student.email not in mail.to, outbox should be empty self.assertEqual(len(mail.outbox), 0) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) def test_optin_course(self): """ Make sure student receives course email after opting in. diff --git a/lms/djangoapps/bulk_email/tests/test_email.py b/lms/djangoapps/bulk_email/tests/test_email.py index 4bb7299f5b73..952d017283e1 100644 --- a/lms/djangoapps/bulk_email/tests/test_email.py +++ b/lms/djangoapps/bulk_email/tests/test_email.py @@ -46,7 +46,7 @@ class TestEmailSendFromDashboard(ModuleStoreTestCase): Test that emails send correctly. """ - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) def setUp(self): self.course = CourseFactory.create() diff --git a/lms/djangoapps/bulk_email/tests/test_forms.py b/lms/djangoapps/bulk_email/tests/test_forms.py index 60a8abf95e1c..0b8634437998 100644 --- a/lms/djangoapps/bulk_email/tests/test_forms.py +++ b/lms/djangoapps/bulk_email/tests/test_forms.py @@ -32,7 +32,7 @@ def tearDown(self): """ patch.stopall() - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_authorize_mongo_course(self): # Initially course shouldn't be authorized self.assertFalse(CourseAuthorization.instructor_email_enabled(self.course.id)) @@ -45,7 +45,7 @@ def test_authorize_mongo_course(self): # Check that this course is authorized self.assertTrue(CourseAuthorization.instructor_email_enabled(self.course.id)) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_form_typo(self): # Munge course id bad_id = self.course.id + '_typo' @@ -63,7 +63,7 @@ def test_form_typo(self): with self.assertRaisesRegexp(ValueError, "The CourseAuthorization could not be created because the data didn't validate."): form.save() - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_course_name_only(self): # Munge course id - common bad_id = self.course.id.split('/')[-1] @@ -86,7 +86,7 @@ def test_course_name_only(self): class CourseAuthorizationXMLFormTest(ModuleStoreTestCase): """Check that XML courses cannot be authorized for email.""" - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_xml_course_authorization(self): course_id = 'edX/toy/2012_Fall' # Assert this is an XML course diff --git a/lms/djangoapps/bulk_email/tests/test_models.py b/lms/djangoapps/bulk_email/tests/test_models.py index 30713e178c57..f812972fc6e2 100644 --- a/lms/djangoapps/bulk_email/tests/test_models.py +++ b/lms/djangoapps/bulk_email/tests/test_models.py @@ -107,7 +107,7 @@ def test_render_plain(self): class CourseAuthorizationTest(TestCase): """Test the CourseAuthorization model.""" - @patch.dict(settings.MITX_FEATURES, {'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_creation_auth_on(self): course_id = 'abc/123/doremi' # Test that course is not authorized by default @@ -133,7 +133,7 @@ def test_creation_auth_on(self): "Course 'abc/123/doremi': Instructor Email Not Enabled" ) - @patch.dict(settings.MITX_FEATURES, {'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'REQUIRE_COURSE_EMAIL_AUTH': False}) def test_creation_auth_off(self): course_id = 'blahx/blah101/ehhhhhhh' # Test that course is authorized by default, since auth is turned off diff --git a/lms/djangoapps/circuit/views.py b/lms/djangoapps/circuit/views.py index cc85c2a4525e..5af9ce1b4456 100644 --- a/lms/djangoapps/circuit/views.py +++ b/lms/djangoapps/circuit/views.py @@ -4,7 +4,7 @@ from django.http import Http404 from django.http import HttpResponse -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from .models import ServerCircuit diff --git a/lms/djangoapps/course_wiki/editors.py b/lms/djangoapps/course_wiki/editors.py index ab68c0572cac..d5d0d2c3f34b 100644 --- a/lms/djangoapps/course_wiki/editors.py +++ b/lms/djangoapps/course_wiki/editors.py @@ -57,7 +57,7 @@ class Media: } js = ("js/vendor/CodeMirror/codemirror.js", "js/vendor/CodeMirror/xml.js", - "js/vendor/CodeMirror/mitx_markdown.js", + "js/vendor/CodeMirror/edx_markdown.js", "js/wiki/accessible.js", "js/wiki/CodeMirror.init.js", ) diff --git a/lms/djangoapps/course_wiki/utils.py b/lms/djangoapps/course_wiki/utils.py index 5f75dcad946e..2fb5412d352b 100644 --- a/lms/djangoapps/course_wiki/utils.py +++ b/lms/djangoapps/course_wiki/utils.py @@ -9,14 +9,14 @@ def user_is_article_course_staff(user, article): """ The root of a course wiki is /. This means in case there are two courses which have the same course_number they will end up with - the same course wiki root e.g. MITX/Phy101/Spring and HarvardX/Phy101/Fall + the same course wiki root e.g. MITx/Phy101/Spring and HarvardX/Phy101/Fall will share /Phy101. This looks at the course wiki root of the article and returns True if the user belongs to a group whose name starts with 'instructor_' or 'staff_' and contains '//'. So if the user is - staff on course MITX/Phy101/Spring they will be in - 'instructor_MITX/Phy101/Spring' or 'staff_MITX/Phy101/Spring' groups and + staff on course MITx/Phy101/Spring they will be in + 'instructor_MITx/Phy101/Spring' or 'staff_MITx/Phy101/Spring' groups and so this will return True. """ diff --git a/lms/djangoapps/courseware/access.py b/lms/djangoapps/courseware/access.py index 8c4fb662f931..9c456afc2f5b 100644 --- a/lms/djangoapps/courseware/access.py +++ b/lms/djangoapps/courseware/access.py @@ -134,7 +134,7 @@ def can_enroll(): (staff can always enroll) """ # if using registration method to restrict (say shibboleth) - if settings.MITX_FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: + if settings.FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: if user is not None and user.is_authenticated() and \ ExternalAuthMap.objects.filter(user=user, external_domain=course.enrollment_domain): debug("Allow: external_auth of " + course.enrollment_domain) @@ -173,7 +173,7 @@ def see_exists(): # VS[compat] -- this setting should go away once all courses have # properly configured enrollment_start times (if course should be # staff-only, set enrollment_start far in the future.) - if settings.MITX_FEATURES.get('ACCESS_REQUIRE_STAFF_FOR_COURSE'): + if settings.FEATURES.get('ACCESS_REQUIRE_STAFF_FOR_COURSE'): # if this feature is on, only allow courses that have ispublic set to be # seen by non-staff if course.ispublic: @@ -234,7 +234,7 @@ def can_load(): don't have to hit the enrollments table on every module load. """ # If start dates are off, can always load - if settings.MITX_FEATURES['DISABLE_START_DATES'] and not is_masquerading_as_student(user): + if settings.FEATURES['DISABLE_START_DATES'] and not is_masquerading_as_student(user): debug("Allow: DISABLE_START_DATES") return True @@ -361,7 +361,7 @@ def _adjust_start_date_for_beta_testers(user, descriptor, course_context=None): the user is looking at. Once we have proper usages and definitions per the XBlock design, this should use the course the usage is in. - NOTE: If testing manually, make sure MITX_FEATURES['DISABLE_START_DATES'] = False + NOTE: If testing manually, make sure FEATURES['DISABLE_START_DATES'] = False in envs/dev.py! """ if descriptor.days_early_for_beta is None: diff --git a/lms/djangoapps/courseware/features/certificates.feature b/lms/djangoapps/courseware/features/certificates.feature index 4a4ceb44b103..ced2a1c2a26a 100644 --- a/lms/djangoapps/courseware/features/certificates.feature +++ b/lms/djangoapps/courseware/features/certificates.feature @@ -95,4 +95,4 @@ Feature: LMS.Verified certificates Then I see the course on my dashboard And I see that I am on the verified track And a "edx.course.enrollment.activated" server event is emitted - + And a "edx.course.enrollment.upgrade.succeeded" server event is emitted diff --git a/lms/djangoapps/courseware/features/lti.feature b/lms/djangoapps/courseware/features/lti.feature index eb2da7436b31..b9f03e7f02f0 100644 --- a/lms/djangoapps/courseware/features/lti.feature +++ b/lms/djangoapps/courseware/features/lti.feature @@ -45,7 +45,7 @@ Feature: LMS.LTI component Given the course has correct LTI credentials And the course has an LTI component with correct fields: | open_in_a_new_page | weight | is_graded | has_score | - | False | 10 | True | True | + | False | 10 | True | True | And I submit answer to LTI question And I click on the "Progress" tab Then I see text "Problem Scores: 5/10" diff --git a/lms/djangoapps/courseware/features/lti.py b/lms/djangoapps/courseware/features/lti.py index 772877fa2a4b..f2b80a8787c7 100644 --- a/lms/djangoapps/courseware/features/lti.py +++ b/lms/djangoapps/courseware/features/lti.py @@ -7,28 +7,28 @@ from lettuce.django import django_url from common import course_id -from student.models import CourseEnrollment +from courseware.tests.factories import InstructorFactory @step('I view the LTI and error is shown$') def lti_is_not_rendered(_step): # error is shown - assert world.is_css_present('.error_message') + assert world.is_css_present('.error_message', wait_time=0) # iframe is not presented - assert not world.is_css_present('iframe') + assert not world.is_css_present('iframe', wait_time=0) # link is not presented - assert not world.is_css_present('.link_lti_new_window') + assert not world.is_css_present('.link_lti_new_window', wait_time=0) def check_lti_iframe_content(text): #inside iframe test content is presented location = world.scenario_dict['LTI'].location.html_id() - iframe_name = 'ltiLaunchFrame-' + location + iframe_name = 'ltiFrame-' + location with world.browser.get_iframe(iframe_name) as iframe: # iframe does not contain functions from terrain/ui_helpers.py - assert iframe.is_element_present_by_css('.result', wait_time=5) + assert iframe.is_element_present_by_css('.result', wait_time=0) assert (text == world.retry_on_exception( lambda: iframe.find_by_css('.result')[0].text, max_attempts=5 @@ -38,18 +38,18 @@ def check_lti_iframe_content(text): @step('I view the LTI and it is rendered in (.*)$') def lti_is_rendered(_step, rendered_in): if rendered_in.strip() == 'iframe': - assert world.is_css_present('iframe') - assert not world.is_css_present('.link_lti_new_window') - assert not world.is_css_present('.error_message') + assert world.is_css_present('iframe', wait_time=2) + assert not world.is_css_present('.link_lti_new_window', wait_time=0) + assert not world.is_css_present('.error_message', wait_time=0) # iframe is visible assert world.css_visible('iframe') check_lti_iframe_content("This is LTI tool. Success.") elif rendered_in.strip() == 'new page': - assert not world.is_css_present('iframe') - assert world.is_css_present('.link_lti_new_window') - assert not world.is_css_present('.error_message') + assert not world.is_css_present('iframe', wait_time=2) + assert world.is_css_present('.link_lti_new_window', wait_time=0) + assert not world.is_css_present('.error_message', wait_time=0) check_lti_popup() else: # incorrent rendered_in parameter assert False @@ -57,9 +57,9 @@ def lti_is_rendered(_step, rendered_in): @step('I view the LTI but incorrect_signature warning is rendered$') def incorrect_lti_is_rendered(_step): - assert world.is_css_present('iframe') - assert not world.is_css_present('.link_lti_new_window') - assert not world.is_css_present('.error_message') + assert world.is_css_present('iframe', wait_time=2) + assert not world.is_css_present('.link_lti_new_window', wait_time=0) + assert not world.is_css_present('.error_message', wait_time=0) #inside iframe test content is presented check_lti_iframe_content("Wrong LTI signature") @@ -195,15 +195,12 @@ def i_am_registered_for_the_course(course, metadata): # Create the course create_course(course, metadata) - # Create the user - world.create_user('robot', 'test') - usr = User.objects.get(username='robot') + # Create an instructor + instructor = InstructorFactory(course=world.scenario_dict['COURSE'].location) - # If the user is not already enrolled, enroll the user. - CourseEnrollment.enroll(usr, course_id(course)) - - world.add_to_course_staff('robot', world.scenario_dict['COURSE'].number) - world.log_in(username='robot', password='test') + # Enroll the user in the course and log them in + world.enroll_user(instructor, course_id(course)) + world.log_in(username=instructor.username, password='test') def check_lti_popup(): @@ -237,10 +234,11 @@ def check_progress(_step, text): @step('I see graph with total progress "([^"]*)"$') def see_graph(_step, progress): SELECTOR = 'grade-detail-graph' - node = world.browser.find_by_xpath('//div[@id="{parent}"]//div[text()="{progress}"]'.format( + XPATH = '//div[@id="{parent}"]//div[text()="{progress}"]'.format( parent=SELECTOR, progress=progress, - )) + ) + node = world.browser.find_by_xpath(XPATH) assert node @@ -262,7 +260,7 @@ def see_value_in_the_gradebook(_step, label, text): @step('I submit answer to LTI question$') def click_grade(_step): location = world.scenario_dict['LTI'].location.html_id() - iframe_name = 'ltiLaunchFrame-' + location + iframe_name = 'ltiFrame-' + location with world.browser.get_iframe(iframe_name) as iframe: iframe.find_by_name('submit-button').first.click() assert iframe.is_text_present('LTI consumer (edX) responded with XML content') diff --git a/lms/djangoapps/courseware/grades.py b/lms/djangoapps/courseware/grades.py index f17a3486d537..49b67ecc40ac 100644 --- a/lms/djangoapps/courseware/grades.py +++ b/lms/djangoapps/courseware/grades.py @@ -22,7 +22,7 @@ from .models import StudentModule from .module_render import get_module, get_module_for_descriptor -log = logging.getLogger("mitx.courseware") +log = logging.getLogger("edx.courseware") def yield_module_descendents(module): diff --git a/lms/djangoapps/courseware/management/commands/import.py b/lms/djangoapps/courseware/management/commands/import.py new file mode 120000 index 000000000000..36b7e3c6fcd7 --- /dev/null +++ b/lms/djangoapps/courseware/management/commands/import.py @@ -0,0 +1 @@ +../../../../../cms/djangoapps/contentstore/management/commands/import.py \ No newline at end of file diff --git a/lms/djangoapps/courseware/masquerade.py b/lms/djangoapps/courseware/masquerade.py index 27135f727e77..a044e89d91e4 100644 --- a/lms/djangoapps/courseware/masquerade.py +++ b/lms/djangoapps/courseware/masquerade.py @@ -40,7 +40,7 @@ def setup_masquerade(request, staff_access=False): if request.user is None: return None - if not settings.MITX_FEATURES.get('ENABLE_MASQUERADE', False): + if not settings.FEATURES.get('ENABLE_MASQUERADE', False): return None if not staff_access: # can masquerade only if user has staff access to course diff --git a/lms/djangoapps/courseware/module_render.py b/lms/djangoapps/courseware/module_render.py index 3b804c4ba96f..92d4ad7f02c7 100644 --- a/lms/djangoapps/courseware/module_render.py +++ b/lms/djangoapps/courseware/module_render.py @@ -22,7 +22,7 @@ from courseware.model_data import FieldDataCache, DjangoKeyValueStore from lms.lib.xblock.field_data import LmsFieldData from lms.lib.xblock.runtime import LmsModuleSystem, handler_prefix, unquote_slashes -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from psychometrics.psychoanalyze import make_psychometrics_data_update_handler from student.models import anonymous_id_for_user, user_by_anonymous_id from util.json_request import JsonResponse @@ -363,7 +363,7 @@ def publish(event, custom_user=None): reverse('jump_to_id', kwargs={'course_id': course_id, 'module_id': ''}), )) - if settings.MITX_FEATURES.get('DISPLAY_HISTOGRAMS_TO_STAFF'): + if settings.FEATURES.get('DISPLAY_HISTOGRAMS_TO_STAFF'): if has_access(user, descriptor, 'staff', course_id): block_wrappers.append(partial(add_histogram, user)) @@ -423,7 +423,7 @@ def publish(event, custom_user=None): # pass position specified in URL to module through ModuleSystem system.set('position', position) - if settings.MITX_FEATURES.get('ENABLE_PSYCHOMETRICS'): + if settings.FEATURES.get('ENABLE_PSYCHOMETRICS'): system.set( 'psychometrics_handler', # set callback for updating PsychometricsData make_psychometrics_data_update_handler(course_id, user, descriptor.location.url()) diff --git a/lms/djangoapps/courseware/tabs.py b/lms/djangoapps/courseware/tabs.py index 7ee16adcfb28..7bc1c0473fb3 100644 --- a/lms/djangoapps/courseware/tabs.py +++ b/lms/djangoapps/courseware/tabs.py @@ -100,7 +100,7 @@ def _discussion(tab, user, course, active_page, request): """ This tab format only supports the new Berkeley discussion forums. """ - if settings.MITX_FEATURES.get('ENABLE_DISCUSSION_SERVICE'): + if settings.FEATURES.get('ENABLE_DISCUSSION_SERVICE'): link = reverse('django_comment_client.forum.views.forum_form_discussion', args=[course.id]) return [CourseTab(tab['name'], link, active_page == 'discussion')] @@ -129,7 +129,7 @@ def _textbooks(tab, user, course, active_page, request): """ Generates one tab per textbook. Only displays if user is authenticated. """ - if user.is_authenticated() and settings.MITX_FEATURES.get('ENABLE_TEXTBOOK'): + if user.is_authenticated() and settings.FEATURES.get('ENABLE_TEXTBOOK'): # since there can be more than one textbook, active_page is e.g. "book/0". return [CourseTab(textbook.title, reverse('book', args=[course.id, index]), active_page == "textbook/{0}".format(index)) @@ -211,7 +211,7 @@ def _combined_open_ended_grading(tab, user, course, active_page, request): def _notes_tab(tab, user, course, active_page, request): - if user.is_authenticated() and settings.MITX_FEATURES.get('ENABLE_STUDENT_NOTES'): + if user.is_authenticated() and settings.FEATURES.get('ENABLE_STUDENT_NOTES'): link = reverse('notes', args=[course.id]) return [CourseTab(tab['name'], link, active_page == 'notes')] return [] @@ -349,7 +349,7 @@ def get_discussion_link(course): """ if course.discussion_link: return course.discussion_link - elif not settings.MITX_FEATURES.get('ENABLE_DISCUSSION_SERVICE'): + elif not settings.FEATURES.get('ENABLE_DISCUSSION_SERVICE'): return None elif hasattr(course, 'tabs') and course.tabs and not any([tab['type'] == 'discussion' for tab in course.tabs]): return None diff --git a/lms/djangoapps/courseware/tests/__init__.py b/lms/djangoapps/courseware/tests/__init__.py index 9a17073a372c..fcca925f3574 100644 --- a/lms/djangoapps/courseware/tests/__init__.py +++ b/lms/djangoapps/courseware/tests/__init__.py @@ -11,7 +11,7 @@ from django.core.urlresolvers import reverse from django.test.client import Client -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from student.tests.factories import UserFactory, CourseEnrollmentFactory from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE from xblock.field_data import DictFieldData diff --git a/lms/djangoapps/courseware/tests/factories.py b/lms/djangoapps/courseware/tests/factories.py index 38ad365011d2..b2ccbcb30dd2 100644 --- a/lms/djangoapps/courseware/tests/factories.py +++ b/lms/djangoapps/courseware/tests/factories.py @@ -1,7 +1,7 @@ import json from functools import partial - -from factory import DjangoModelFactory, SubFactory, post_generation +import factory +from factory.django import DjangoModelFactory # Imported to re-export # pylint: disable=unused-import @@ -40,7 +40,7 @@ class InstructorFactory(UserFactory): """ last_name = "Instructor" - @post_generation + @factory.post_generation def course(self, create, extracted, **kwargs): if extracted is None: raise ValueError("Must specify a course location for a course instructor user") @@ -54,7 +54,7 @@ class StaffFactory(UserFactory): """ last_name = "Staff" - @post_generation + @factory.post_generation def course(self, create, extracted, **kwargs): if extracted is None: raise ValueError("Must specify a course location for a course staff user") @@ -68,7 +68,7 @@ class BetaTesterFactory(UserFactory): """ last_name = "Beta-Tester" - @post_generation + @factory.post_generation def course(self, create, extracted, **kwargs): if extracted is None: raise ValueError("Must specify a course location for a beta-tester user") @@ -82,7 +82,7 @@ class OrgStaffFactory(UserFactory): """ last_name = "Org-Staff" - @post_generation + @factory.post_generation def course(self, create, extracted, **kwargs): if extracted is None: raise ValueError("Must specify a course location for an org-staff user") @@ -96,7 +96,7 @@ class OrgInstructorFactory(UserFactory): """ last_name = "Org-Instructor" - @post_generation + @factory.post_generation def course(self, create, extracted, **kwargs): if extracted is None: raise ValueError("Must specify a course location for an org-instructor user") @@ -109,7 +109,7 @@ class GlobalStaffFactory(UserFactory): """ last_name = "GlobalStaff" - @post_generation + @factory.post_generation def set_staff(self, create, extracted, **kwargs): GlobalStaff().add_users(self) @@ -118,7 +118,7 @@ class StudentModuleFactory(DjangoModelFactory): FACTORY_FOR = StudentModule module_type = "problem" - student = SubFactory(UserFactory) + student = factory.SubFactory(UserFactory) course_id = "MITx/999/Robot_Super_Course" state = None grade = None @@ -139,7 +139,7 @@ class StudentPrefsFactory(DjangoModelFactory): field_name = 'existing_field' value = json.dumps('old_value') - student = SubFactory(UserFactory) + student = factory.SubFactory(UserFactory) module_type = 'MockProblemModule' @@ -148,4 +148,4 @@ class StudentInfoFactory(DjangoModelFactory): field_name = 'existing_field' value = json.dumps('old_value') - student = SubFactory(UserFactory) + student = factory.SubFactory(UserFactory) diff --git a/lms/djangoapps/courseware/tests/test_grades.py b/lms/djangoapps/courseware/tests/test_grades.py new file mode 100644 index 000000000000..5ee6953161b6 --- /dev/null +++ b/lms/djangoapps/courseware/tests/test_grades.py @@ -0,0 +1,122 @@ +""" +Test grade calculation. +""" +from django.http import Http404 +from django.test.utils import override_settings +from mock import patch + +from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE +from student.tests.factories import UserFactory +from xmodule.modulestore.tests.factories import CourseFactory +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase + +from courseware.grades import grade, iterate_grades_for + + +def _grade_with_errors(student, request, course, keep_raw_scores=False): + """This fake grade method will throw exceptions for student3 and + student4, but allow any other students to go through normal grading. + + It's meant to simulate when something goes really wrong while trying to + grade a particular student, so we can test that we won't kill the entire + course grading run. + """ + if student.username in ['student3', 'student4']: + raise Exception("I don't like {}".format(student.username)) + + return grade(student, request, course, keep_raw_scores=keep_raw_scores) + + +@override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) +class TestGradeIteration(ModuleStoreTestCase): + """ + Test iteration through student gradesets. + """ + COURSE_NUM = "1000" + COURSE_NAME = "grading_test_course" + + def setUp(self): + """ + Create a course and a handful of users to assign grades + """ + self.course = CourseFactory.create( + display_name=self.COURSE_NAME, + number=self.COURSE_NUM + ) + self.students = [ + UserFactory.create(username='student1'), + UserFactory.create(username='student2'), + UserFactory.create(username='student3'), + UserFactory.create(username='student4'), + UserFactory.create(username='student5'), + ] + + def test_empty_student_list(self): + """If we don't pass in any students, it should return a zero-length + iterator, but it shouldn't error.""" + gradeset_results = list(iterate_grades_for(self.course.id, [])) + self.assertEqual(gradeset_results, []) + + def test_nonexistent_course(self): + """If the course we want to get grades for does not exist, a `Http404` + should be raised. This is a horrible crossing of abstraction boundaries + and should be fixed, but for now we're just testing the behavior. :-(""" + with self.assertRaises(Http404): + gradeset_results = iterate_grades_for("I/dont/exist", []) + gradeset_results.next() + + def test_all_empty_grades(self): + """No students have grade entries""" + all_gradesets, all_errors = self._gradesets_and_errors_for(self.course.id, self.students) + self.assertEqual(len(all_errors), 0) + for gradeset in all_gradesets.values(): + self.assertIsNone(gradeset['grade']) + self.assertEqual(gradeset['percent'], 0.0) + + @patch('courseware.grades.grade', _grade_with_errors) + def test_grading_exception(self): + """Test that we correctly capture exception messages that bubble up from + grading. Note that we only see errors at this level if the grading + process for this student fails entirely due to an unexpected event -- + having errors in the problem sets will not trigger this. + + We patch the grade() method with our own, which will generate the errors + for student3 and student4. + """ + all_gradesets, all_errors = self._gradesets_and_errors_for(self.course.id, self.students) + student1, student2, student3, student4, student5 = self.students + self.assertEqual( + all_errors, + { + student3: "I don't like student3", + student4: "I don't like student4" + } + ) + + # But we should still have five gradesets + self.assertEqual(len(all_gradesets), 5) + + # Even though two will simply be empty + self.assertFalse(all_gradesets[student3]) + self.assertFalse(all_gradesets[student4]) + + # The rest will have grade information in them + self.assertTrue(all_gradesets[student1]) + self.assertTrue(all_gradesets[student2]) + self.assertTrue(all_gradesets[student5]) + + ################################# Helpers ################################# + def _gradesets_and_errors_for(self, course_id, students): + """Simple helper method to iterate through student grades and give us + two dictionaries -- one that has all students and their respective + gradesets, and one that has only students that could not be graded and + their respective error messages.""" + students_to_gradesets = {} + students_to_errors = {} + + for student, gradeset, err_msg in iterate_grades_for(course_id, students): + students_to_gradesets[student] = gradeset + if err_msg: + students_to_errors[student] = err_msg + + return students_to_gradesets, students_to_errors diff --git a/lms/djangoapps/courseware/tests/test_lti_integration.py b/lms/djangoapps/courseware/tests/test_lti_integration.py index 9a70d217cce9..7faa40d2f9c4 100644 --- a/lms/djangoapps/courseware/tests/test_lti_integration.py +++ b/lms/djangoapps/courseware/tests/test_lti_integration.py @@ -5,8 +5,6 @@ from collections import OrderedDict import mock import urllib -from xmodule.lti_module import LTIModule -from mock import Mock class TestLTI(BaseTestXmodule): @@ -85,7 +83,6 @@ def test_lti_constructor(self): Makes sure that all parameters extracted. """ generated_context = self.item_module.render('student_view').content - expected_context = { 'display_name': self.item_module.display_name, 'input_fields': self.correct_headers, @@ -93,6 +90,7 @@ def test_lti_constructor(self): 'element_id': self.item_module.location.html_id(), 'launch_url': 'http://www.example.com', # default value 'open_in_a_new_page': True, + 'form_url': self.item_descriptor.xmodule_runtime.handler_url(self.item_module, 'preview_handler').rstrip('/?'), } self.assertEqual( diff --git a/lms/djangoapps/courseware/tests/test_module_render.py b/lms/djangoapps/courseware/tests/test_module_render.py index 649ad3c8ad8e..ea40b19e8151 100644 --- a/lms/djangoapps/courseware/tests/test_module_render.py +++ b/lms/djangoapps/courseware/tests/test_module_render.py @@ -79,7 +79,7 @@ def test_module_render_with_jump_to_id(self): module = render.get_module( self.mock_user, mock_request, - ['i4x', 'edX', 'toy', 'html', 'toyjumpto'], + Location('i4x', 'edX', 'toy', 'html', 'toyjumpto'), field_data_cache, self.course_id ) diff --git a/lms/djangoapps/courseware/tests/test_tabs.py b/lms/djangoapps/courseware/tests/test_tabs.py index 4274ebf85d92..94ebe611f353 100644 --- a/lms/djangoapps/courseware/tests/test_tabs.py +++ b/lms/djangoapps/courseware/tests/test_tabs.py @@ -35,13 +35,13 @@ def test_progress(self): self.assertEqual(tab_constructor(self.stagnation_page, self.course, self.anonymous_user), []) self.assertEqual(tab_constructor(self.progress_page, self.course, self.user)[0].name, 'same') - + tab_list = tab_constructor(self.progress_page, self.course, self.user) expected_link = reverse('progress', args=[self.course.id]) self.assertEqual(tab_list[0].link, expected_link) - + self.assertEqual(tab_constructor(self.stagnation_page, self.course, self.user)[0].is_active, False) - + self.assertEqual(tab_constructor(self.progress_page, self.course, self.user)[0].is_active, True) @@ -166,7 +166,7 @@ def setUp(self): self.textbook_1 = 'textbook/1' self.prohibited_page = 'you_shouldnt_be_seein_this' - @override_settings(MITX_FEATURES={'ENABLE_TEXTBOOK': True}) + @override_settings(FEATURES={'ENABLE_TEXTBOOK': True}) def test_textbooks1(self): tab_list = tab_constructor( @@ -211,7 +211,7 @@ def test_textbooks1(self): ) self.assertEqual(tab_list[1].is_active, False) - @override_settings(MITX_FEATURES={'ENABLE_TEXTBOOK': False}) + @override_settings(FEATURES={'ENABLE_TEXTBOOK': False}) def test_textbooks0(self): tab_list = tab_constructor( @@ -304,34 +304,34 @@ def patched_reverse(viewname, args): return None return patch("courseware.tabs.reverse", patched_reverse) - @patch.dict("django.conf.settings.MITX_FEATURES", {"ENABLE_DISCUSSION_SERVICE": False}) + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": False}) def test_explicit_discussion_link(self): """Test that setting discussion_link overrides everything else""" course = CourseFactory.create(discussion_link="other_discussion_link", tabs=self.tabs_with_discussion) self.assertEqual(tabs.get_discussion_link(course), "other_discussion_link") - @patch.dict("django.conf.settings.MITX_FEATURES", {"ENABLE_DISCUSSION_SERVICE": False}) + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": False}) def test_discussions_disabled(self): """Test that other cases return None with discussions disabled""" for i, t in enumerate([None, self.tabs_with_discussion, self.tabs_without_discussion]): course = CourseFactory.create(tabs=t, number=str(i)) self.assertEqual(tabs.get_discussion_link(course), None) - @patch.dict("django.conf.settings.MITX_FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) def test_no_tabs(self): """Test a course without tabs configured""" course = CourseFactory.create(tabs=None) with self._patch_reverse(course): self.assertEqual(tabs.get_discussion_link(course), "default_discussion_link") - @patch.dict("django.conf.settings.MITX_FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) def test_tabs_with_discussion(self): """Test a course with a discussion tab configured""" course = CourseFactory.create(tabs=self.tabs_with_discussion) with self._patch_reverse(course): self.assertEqual(tabs.get_discussion_link(course), "default_discussion_link") - @patch.dict("django.conf.settings.MITX_FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) def test_tabs_without_discussion(self): """Test a course with tabs configured but without a discussion tab""" course = CourseFactory.create(tabs=self.tabs_without_discussion) diff --git a/lms/djangoapps/courseware/tests/test_video_mongo.py b/lms/djangoapps/courseware/tests/test_video_mongo.py index d364dc6fe53a..e3c4ea5bd110 100644 --- a/lms/djangoapps/courseware/tests/test_video_mongo.py +++ b/lms/djangoapps/courseware/tests/test_video_mongo.py @@ -53,7 +53,7 @@ def test_video_constructor(self): 'sub': u'a_sub_file.srt.sjson', 'track': '', 'youtube_streams': _create_youtube_string(self.item_module), - 'autoplay': settings.MITX_FEATURES.get('AUTOPLAY_VIDEOS', False), + 'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', False), 'yt_test_timeout': 1500, 'yt_test_url': 'https://gdata.youtube.com/feeds/api/videos/' } @@ -107,7 +107,7 @@ def test_video_constructor(self): 'sub': u'a_sub_file.srt.sjson', 'track': '', 'youtube_streams': '1.00:OEoXaMPEzfM', - 'autoplay': settings.MITX_FEATURES.get('AUTOPLAY_VIDEOS', True), + 'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', True), 'yt_test_timeout': 1500, 'yt_test_url': 'https://gdata.youtube.com/feeds/api/videos/' } diff --git a/lms/djangoapps/courseware/tests/test_video_xml.py b/lms/djangoapps/courseware/tests/test_video_xml.py index cf202db21265..87e430c6b0cf 100644 --- a/lms/djangoapps/courseware/tests/test_video_xml.py +++ b/lms/djangoapps/courseware/tests/test_video_xml.py @@ -88,7 +88,7 @@ def test_video_get_html(self): 'sources': sources, 'youtube_streams': _create_youtube_string(module), 'track': '', - 'autoplay': settings.MITX_FEATURES.get('AUTOPLAY_VIDEOS', False), + 'autoplay': settings.FEATURES.get('AUTOPLAY_VIDEOS', False), 'yt_test_timeout': 1500, 'yt_test_url': 'https://gdata.youtube.com/feeds/api/videos/' } diff --git a/lms/djangoapps/courseware/tests/test_view_authentication.py b/lms/djangoapps/courseware/tests/test_view_authentication.py index 9ed0dea8e5d8..acb307e4650e 100644 --- a/lms/djangoapps/courseware/tests/test_view_authentication.py +++ b/lms/djangoapps/courseware/tests/test_view_authentication.py @@ -253,7 +253,7 @@ def test_global_staff_access(self): for url in urls: check_for_get_code(self, 200, url) - @patch.dict('courseware.access.settings.MITX_FEATURES', {'DISABLE_START_DATES': False}) + @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_dark_launch_enrolled_student(self): """ Make sure that before course start, students can't access course @@ -280,7 +280,7 @@ def test_dark_launch_enrolled_student(self): self._check_non_staff_light(self.test_course) self._check_non_staff_dark(self.test_course) - @patch.dict('courseware.access.settings.MITX_FEATURES', {'DISABLE_START_DATES': False}) + @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_dark_launch_instructor(self): """ Make sure that before course start instructors can access the @@ -303,7 +303,7 @@ def test_dark_launch_instructor(self): self._check_non_staff_dark(self.test_course) self._check_staff(self.course) - @patch.dict('courseware.access.settings.MITX_FEATURES', {'DISABLE_START_DATES': False}) + @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_dark_launch_global_staff(self): """ Make sure that before course start staff can access @@ -324,7 +324,7 @@ def test_dark_launch_global_staff(self): self._check_staff(self.course) self._check_staff(self.test_course) - @patch.dict('courseware.access.settings.MITX_FEATURES', {'DISABLE_START_DATES': False}) + @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_enrollment_period(self): """ Check that enrollment periods work. @@ -371,7 +371,7 @@ def setUp(self): self.normal_student = UserFactory() self.beta_tester = BetaTesterFactory(course=self.course.location) - @patch.dict('courseware.access.settings.MITX_FEATURES', {'DISABLE_START_DATES': False}) + @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_course_beta_period(self): """ Check that beta-test access works for courses. @@ -384,7 +384,7 @@ def test_course_beta_period(self): # now the student should see it self.assertTrue(has_access(self.beta_tester, self.course, 'load')) - @patch.dict('courseware.access.settings.MITX_FEATURES', {'DISABLE_START_DATES': False}) + @patch.dict('courseware.access.settings.FEATURES', {'DISABLE_START_DATES': False}) def test_content_beta_period(self): """ Check that beta-test access works for content. diff --git a/lms/djangoapps/courseware/tests/test_views.py b/lms/djangoapps/courseware/tests/test_views.py index 17198c372d17..91ec1e87c1ba 100644 --- a/lms/djangoapps/courseware/tests/test_views.py +++ b/lms/djangoapps/courseware/tests/test_views.py @@ -17,7 +17,7 @@ from student.models import CourseEnrollment from student.tests.factories import AdminFactory -from mitxmako.middleware import MakoMiddleware +from edxmako.middleware import MakoMiddleware from xmodule.modulestore import Location from xmodule.modulestore.django import modulestore @@ -86,8 +86,8 @@ def setUp(self): chapter = 'Overview' self.chapter_url = '%s/%s/%s' % ('/courses', self.course_id, chapter) - @unittest.skipUnless(settings.MITX_FEATURES.get('ENABLE_SHOPPING_CART'), "Shopping Cart not enabled in settings") - @patch.dict(settings.MITX_FEATURES, {'ENABLE_PAID_COURSE_REGISTRATION': True}) + @unittest.skipUnless(settings.FEATURES.get('ENABLE_SHOPPING_CART'), "Shopping Cart not enabled in settings") + @patch.dict(settings.FEATURES, {'ENABLE_PAID_COURSE_REGISTRATION': True}) def test_course_about_in_cart(self): in_cart_span = '' # don't mock this course due to shopping cart existence checking diff --git a/lms/djangoapps/courseware/views.py b/lms/djangoapps/courseware/views.py index 69fd33f41767..137b52916905 100644 --- a/lms/djangoapps/courseware/views.py +++ b/lms/djangoapps/courseware/views.py @@ -11,7 +11,7 @@ from django.contrib.auth.decorators import login_required from django.http import Http404, HttpResponse, HttpResponseRedirect from django.shortcuts import redirect -from mitxmako.shortcuts import render_to_response, render_to_string +from edxmako.shortcuts import render_to_response, render_to_string from django_future.csrf import ensure_csrf_cookie from django.views.decorators.cache import cache_control from django.db import transaction @@ -38,7 +38,7 @@ from xmodule.course_module import CourseDescriptor import shoppingcart -log = logging.getLogger("mitx.courseware") +log = logging.getLogger("edx.courseware") template_imports = {'urllib': urllib} @@ -263,12 +263,12 @@ def index(request, course_id, chapter=None, section=None, 'fragment': Fragment(), 'staff_access': staff_access, 'masquerade': masq, - 'xqa_server': settings.MITX_FEATURES.get('USE_XQA_SERVER', 'http://xqa:server@content-qa.mitx.mit.edu/xqa') + 'xqa_server': settings.FEATURES.get('USE_XQA_SERVER', 'http://xqa:server@content-qa.mitx.mit.edu/xqa') } # Only show the chat if it's enabled by the course and in the # settings. - show_chat = course.show_chat and settings.MITX_FEATURES['ENABLE_CHAT'] + show_chat = course.show_chat and settings.FEATURES['ENABLE_CHAT'] if show_chat: context['chat'] = chat_settings(course, user) # If we couldn't load the chat settings, then don't show @@ -388,7 +388,7 @@ def jump_to_id(request, course_id, module_id): course_location = CourseDescriptor.id_to_location(course_id) items = modulestore().get_items( - ['i4x', course_location.org, course_location.course, None, module_id], + Location('i4x', course_location.org, course_location.course, None, module_id), course_id=course_id ) @@ -514,7 +514,7 @@ def registered_for_course(course, user): @ensure_csrf_cookie @cache_if_anonymous def course_about(request, course_id): - if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE', False): + if settings.FEATURES.get('ENABLE_MKTG_SITE', False): raise Http404 course = get_course_with_access(request.user, course_id, 'see_exists') @@ -526,14 +526,14 @@ def course_about(request, course_id): course_target = reverse('about_course', args=[course.id]) show_courseware_link = (has_access(request.user, course, 'load') or - settings.MITX_FEATURES.get('ENABLE_LMS_MIGRATION')) + settings.FEATURES.get('ENABLE_LMS_MIGRATION')) # Note: this is a flow for payment for course registration, not the Verified Certificate flow. registration_price = 0 in_cart = False reg_then_add_to_cart_link = "" - if (settings.MITX_FEATURES.get('ENABLE_SHOPPING_CART') and - settings.MITX_FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION')): + if (settings.FEATURES.get('ENABLE_SHOPPING_CART') and + settings.FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION')): registration_price = CourseMode.min_course_price_for_currency(course_id, settings.PAID_COURSE_REGISTRATION_CURRENCY[0]) if request.user.is_authenticated(): @@ -579,7 +579,7 @@ def mktg_course_about(request, course_id): allow_registration = has_access(request.user, course, 'enroll') show_courseware_link = (has_access(request.user, course, 'load') or - settings.MITX_FEATURES.get('ENABLE_LMS_MIGRATION')) + settings.FEATURES.get('ENABLE_LMS_MIGRATION')) course_modes = CourseMode.modes_for_course(course.id) return render_to_response( diff --git a/lms/djangoapps/dashboard/management/__init__.py b/lms/djangoapps/dashboard/management/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/lms/djangoapps/dashboard/management/commands/__init__.py b/lms/djangoapps/dashboard/management/commands/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/lms/djangoapps/dashboard/management/commands/git_add_course.py b/lms/djangoapps/dashboard/management/commands/git_add_course.py new file mode 100644 index 000000000000..1d095b11a62c --- /dev/null +++ b/lms/djangoapps/dashboard/management/commands/git_add_course.py @@ -0,0 +1,242 @@ +""" +Script for importing courseware from git/xml into a mongo modulestore +""" + +import os +import re +import datetime +import StringIO +import subprocess +import logging + +from django.conf import settings +from django.core import management +from django.core.management.base import BaseCommand, CommandError +from django.utils.translation import ugettext as _ +import mongoengine + +from dashboard.models import CourseImportLog +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.xml import XMLModuleStore + +log = logging.getLogger(__name__) + +GIT_REPO_DIR = getattr(settings, 'GIT_REPO_DIR', '/opt/edx/course_repos') +GIT_IMPORT_STATIC = getattr(settings, 'GIT_IMPORT_STATIC', True) + +GIT_IMPORT_NO_DIR = -1 +GIT_IMPORT_URL_BAD = -2 +GIT_IMPORT_CANNOT_PULL = -3 +GIT_IMPORT_XML_IMPORT_FAILED = -4 +GIT_IMPORT_UNSUPPORTED_STORE = -5 +GIT_IMPORT_MONGODB_FAIL = -6 +GIT_IMPORT_BAD_REPO = -7 + + +def add_repo(repo, rdir_in): + """This will add a git repo into the mongo modulestore""" + # pylint: disable=R0915 + + # Set defaults even if it isn't defined in settings + mongo_db = { + 'host': 'localhost', + 'user': '', + 'password': '', + 'db': 'xlog', + } + + # Allow overrides + if hasattr(settings, 'MONGODB_LOG'): + for config_item in ['host', 'user', 'password', 'db', ]: + mongo_db[config_item] = settings.MONGODB_LOG.get( + config_item, mongo_db[config_item]) + + if not os.path.isdir(GIT_REPO_DIR): + log.critical(_("Path {0} doesn't exist, please create it, " + "or configure a different path with " + "GIT_REPO_DIR").format(GIT_REPO_DIR)) + return GIT_IMPORT_NO_DIR + + # pull from git + if not repo.endswith('.git') or not ( + repo.startswith('http:') or + repo.startswith('https:') or + repo.startswith('git:') or + repo.startswith('file:')): + + log.error(_('Oops, not a git ssh url?')) + log.error(_('Expecting something like ' + 'git@github.com:mitocw/edx4edx_lite.git')) + return GIT_IMPORT_URL_BAD + + if rdir_in: + rdir = rdir_in + rdir = os.path.basename(rdir) + else: + rdir = repo.rsplit('/', 1)[-1].rsplit('.git', 1)[0] + + log.debug('rdir = {0}'.format(rdir)) + + rdirp = '{0}/{1}'.format(GIT_REPO_DIR, rdir) + if os.path.exists(rdirp): + log.info(_('directory already exists, doing a git pull instead ' + 'of git clone')) + cmd = ['git', 'pull', ] + cwd = '{0}/{1}'.format(GIT_REPO_DIR, rdir) + else: + cmd = ['git', 'clone', repo, ] + cwd = GIT_REPO_DIR + + log.debug(cmd) + cwd = os.path.abspath(cwd) + try: + ret_git = subprocess.check_output(cmd, cwd=cwd) + except subprocess.CalledProcessError: + log.exception(_('git clone or pull failed!')) + return GIT_IMPORT_CANNOT_PULL + log.debug(ret_git) + + # get commit id + cmd = ['git', 'log', '-1', '--format=%H', ] + try: + commit_id = subprocess.check_output(cmd, cwd=rdirp) + except subprocess.CalledProcessError: + log.exception(_('Unable to get git log')) + return GIT_IMPORT_BAD_REPO + + ret_git += _('\nCommit ID: {0}').format(commit_id) + + # get branch + cmd = ['git', 'rev-parse', '--abbrev-ref', 'HEAD', ] + try: + branch = subprocess.check_output(cmd, cwd=rdirp) + except subprocess.CalledProcessError: + log.exception(_('Unable to get branch info')) + return GIT_IMPORT_BAD_REPO + + ret_git += ' \nBranch: {0}'.format(branch) + + # Get XML logging logger and capture debug to parse results + output = StringIO.StringIO() + import_log_handler = logging.StreamHandler(output) + import_log_handler.setLevel(logging.DEBUG) + + logger_names = ['xmodule.modulestore.xml_importer', 'git_add_course', + 'xmodule.modulestore.xml', 'xmodule.seq_module', ] + loggers = [] + + for logger_name in logger_names: + logger = logging.getLogger(logger_name) + logger.old_level = logger.level + logger.setLevel(logging.DEBUG) + logger.addHandler(import_log_handler) + loggers.append(logger) + + try: + management.call_command('import', GIT_REPO_DIR, rdir, + nostatic=not GIT_IMPORT_STATIC) + except CommandError: + log.exception(_('Unable to run import command.')) + return GIT_IMPORT_XML_IMPORT_FAILED + except NotImplementedError: + log.exception(_('The underlying module store does not support import.')) + return GIT_IMPORT_UNSUPPORTED_STORE + + ret_import = output.getvalue() + + # Remove handler hijacks + for logger in loggers: + logger.setLevel(logger.old_level) + logger.removeHandler(import_log_handler) + + course_id = 'unknown' + location = 'unknown' + + # extract course ID from output of import-command-run and make symlink + # this is needed in order for custom course scripts to work + match = re.search('(?ms)===> IMPORTING course to location ([^ \n]+)', + ret_import) + if match: + location = match.group(1).strip() + log.debug('location = {0}'.format(location)) + course_id = location.replace('i4x://', '').replace( + '/course/', '/').split('\n')[0].strip() + + cdir = '{0}/{1}'.format(GIT_REPO_DIR, course_id.split('/')[1]) + log.debug(_('Studio course dir = {0}').format(cdir)) + + if os.path.exists(cdir) and not os.path.islink(cdir): + log.debug(_(' -> exists, but is not symlink')) + log.debug(subprocess.check_output(['ls', '-l', ], + cwd=os.path.abspath(cdir))) + try: + os.rmdir(os.path.abspath(cdir)) + except OSError: + log.exception(_('Failed to remove course directory')) + + if not os.path.exists(cdir): + log.debug(_(' -> creating symlink between {0} and {1}').format(rdirp, cdir)) + try: + os.symlink(os.path.abspath(rdirp), os.path.abspath(cdir)) + except OSError: + log.exception(_('Unable to create course symlink')) + log.debug(subprocess.check_output(['ls', '-l', ], + cwd=os.path.abspath(cdir))) + + # store import-command-run output in mongo + mongouri = 'mongodb://{user}:{password}@{host}/{db}'.format(**mongo_db) + + try: + if mongo_db['user'] and mongo_db['password']: + mdb = mongoengine.connect(mongo_db['db'], host=mongouri) + else: + mdb = mongoengine.connect(mongo_db['db'], host=mongo_db['host']) + except mongoengine.connection.ConnectionError: + log.exception(_('Unable to connect to mongodb to save log, please ' + 'check MONGODB_LOG settings')) + return GIT_IMPORT_MONGODB_FAIL + cil = CourseImportLog( + course_id=course_id, + location=location, + repo_dir=rdir, + created=datetime.datetime.now(), + import_log=ret_import, + git_log=ret_git, + ) + cil.save() + + log.debug(_('saved CourseImportLog for {0}').format(cil.course_id)) + mdb.disconnect() + return 0 + + +class Command(BaseCommand): + """ + Pull a git repo and import into the mongo based content database. + """ + + help = _('Import the specified git repository into the ' + 'modulestore and directory') + + def handle(self, *args, **options): + """Check inputs and run the command""" + + if isinstance(modulestore, XMLModuleStore): + raise CommandError(_('This script requires a mongo module store')) + + if len(args) < 1: + raise CommandError(_('This script requires at least one argument, ' + 'the git URL')) + + if len(args) > 2: + raise CommandError(_('This script requires no more than two ' + 'arguments')) + + rdir_arg = None + + if len(args) > 1: + rdir_arg = args[1] + + if add_repo(args[0], rdir_arg) != 0: + raise CommandError(_('Repo was not added, check log output ' + 'for details')) diff --git a/lms/djangoapps/dashboard/management/commands/tests/test_git_add_course.py b/lms/djangoapps/dashboard/management/commands/tests/test_git_add_course.py new file mode 100644 index 000000000000..0b3c685fbd21 --- /dev/null +++ b/lms/djangoapps/dashboard/management/commands/tests/test_git_add_course.py @@ -0,0 +1,104 @@ +""" +Provide tests for git_add_course management command. +""" + +import unittest +import os +import shutil +import subprocess + +from django.conf import settings +from django.core.management import call_command +from django.core.management.base import CommandError +from django.test.utils import override_settings + +from courseware.tests.tests import TEST_DATA_MONGO_MODULESTORE +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +import dashboard.management.commands.git_add_course as git_add_course + +TEST_MONGODB_LOG = { + 'host': 'localhost', + 'user': '', + 'password': '', + 'db': 'test_xlog', +} + +FEATURES_WITH_SSL_AUTH = settings.FEATURES.copy() +FEATURES_WITH_SSL_AUTH['AUTH_USE_MIT_CERTIFICATES'] = True + + +@override_settings(MODULESTORE=TEST_DATA_MONGO_MODULESTORE) +@override_settings(MONGODB_LOG=TEST_MONGODB_LOG) +@unittest.skipUnless(settings.FEATURES.get('ENABLE_SYSADMIN_DASHBOARD'), + "ENABLE_SYSADMIN_DASHBOARD not set") +class TestGitAddCourse(ModuleStoreTestCase): + """ + Tests the git_add_course management command for proper functions. + """ + + TEST_REPO = 'https://github.com/mitocw/edx4edx_lite.git' + + def assertCommandFailureRegexp(self, regex, *args): + """ + Convenience function for testing command failures + """ + with self.assertRaises(SystemExit): + self.assertRaisesRegexp(CommandError, regex, + call_command('git_add_course', *args)) + + def test_command_args(self): + """ + Validate argument checking + """ + self.assertCommandFailureRegexp( + 'This script requires at least one argument, the git URL') + self.assertCommandFailureRegexp( + 'This script requires no more than two arguments', + 'blah', 'blah', 'blah') + self.assertCommandFailureRegexp( + 'Repo was not added, check log output for details', + 'blah') + # Test successful import from command + try: + os.mkdir(getattr(settings, 'GIT_REPO_DIR')) + except OSError: + pass + + # Make a course dir that will be replaced with a symlink + # while we are at it. + if not os.path.isdir(getattr(settings, 'GIT_REPO_DIR') / 'edx4edx'): + os.mkdir(getattr(settings, 'GIT_REPO_DIR') / 'edx4edx') + + call_command('git_add_course', self.TEST_REPO, + getattr(settings, 'GIT_REPO_DIR') / 'edx4edx_lite') + if os.path.isdir(getattr(settings, 'GIT_REPO_DIR')): + shutil.rmtree(getattr(settings, 'GIT_REPO_DIR')) + + def test_add_repo(self): + """ + Various exit path tests for test_add_repo + """ + self.assertEqual(git_add_course.GIT_IMPORT_NO_DIR, + git_add_course.add_repo(self.TEST_REPO, None)) + try: + os.mkdir(getattr(settings, 'GIT_REPO_DIR')) + except OSError: + pass + self.assertEqual(git_add_course.GIT_IMPORT_URL_BAD, + git_add_course.add_repo('foo', None)) + + self.assertEqual( + git_add_course.GIT_IMPORT_CANNOT_PULL, + git_add_course.add_repo('file:///foobar.git', None) + ) + + # Test git repo that exists, but is "broken" + bare_repo = os.path.abspath('{0}/{1}'.format(settings.TEST_ROOT, 'bare.git')) + os.mkdir(os.path.abspath(bare_repo)) + subprocess.call(['git', '--bare', 'init', ], cwd=bare_repo) + + self.assertEqual( + git_add_course.GIT_IMPORT_BAD_REPO, + git_add_course.add_repo('file://{0}'.format(bare_repo), None) + ) + shutil.rmtree(bare_repo) diff --git a/lms/djangoapps/dashboard/models.py b/lms/djangoapps/dashboard/models.py index 6b2021999398..096288f6d4e8 100644 --- a/lms/djangoapps/dashboard/models.py +++ b/lms/djangoapps/dashboard/models.py @@ -1 +1,17 @@ -# Create your models here. +"""Models for dashboard application""" + +import mongoengine + + +class CourseImportLog(mongoengine.Document): + """Mongoengine model for git log""" + # pylint: disable=R0924 + + course_id = mongoengine.StringField(max_length=128) + location = mongoengine.StringField(max_length=168) + import_log = mongoengine.StringField(max_length=20 * 65535) + git_log = mongoengine.StringField(max_length=65535) + repo_dir = mongoengine.StringField(max_length=128) + created = mongoengine.DateTimeField() + meta = {'indexes': ['course_id', 'created'], + 'allow_inheritance': False} diff --git a/lms/djangoapps/dashboard/sysadmin.py b/lms/djangoapps/dashboard/sysadmin.py new file mode 100644 index 000000000000..9627e37f0b96 --- /dev/null +++ b/lms/djangoapps/dashboard/sysadmin.py @@ -0,0 +1,692 @@ +""" +This module creates a sysadmin dashboard for managing and viewing +courses. +""" +import csv +import json +import logging +import os +import subprocess +import time +import StringIO +from datetime import datetime + +from django.conf import settings +from django.contrib.auth import authenticate +from django.contrib.auth.decorators import login_required +from django.contrib.auth.models import User +from django.core.exceptions import PermissionDenied +from django.db import IntegrityError +from django.http import HttpResponse, Http404 +from django.utils.decorators import method_decorator +from django.utils.html import escape +from django.utils.translation import ugettext as _ +from django.views.decorators.cache import cache_control +from django.views.generic.base import TemplateView +from django.views.decorators.http import condition +from django_future.csrf import ensure_csrf_cookie +from edxmako.shortcuts import render_to_response +import mongoengine + +from courseware.courses import get_course_by_id +from courseware.roles import CourseStaffRole, CourseInstructorRole +import dashboard.management.commands.git_add_course as git_add_course +from dashboard.models import CourseImportLog +from external_auth.models import ExternalAuthMap +from external_auth.views import generate_password +from student.models import CourseEnrollment, UserProfile, Registration +import track.views +from xmodule.contentstore.django import contentstore +from xmodule.modulestore import MONGO_MODULESTORE_TYPE +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.store_utilities import delete_course +from xmodule.modulestore.xml import XMLModuleStore + + +log = logging.getLogger(__name__) + + +class SysadminDashboardView(TemplateView): + """Base class for sysadmin dashboard views with common methods""" + + template_name = 'sysadmin_dashboard.html' + + def __init__(self, **kwargs): + """ + Initialize base sysadmin dashboard class with modulestore, + modulestore_type and return msg + """ + + self.def_ms = modulestore() + self.is_using_mongo = True + if isinstance(self.def_ms, XMLModuleStore): + self.is_using_mongo = False + self.msg = u'' + self.datatable = [] + super(SysadminDashboardView, self).__init__(**kwargs) + + @method_decorator(ensure_csrf_cookie) + @method_decorator(login_required) + @method_decorator(cache_control(no_cache=True, no_store=True, + must_revalidate=True)) + @method_decorator(condition(etag_func=None)) + def dispatch(self, *args, **kwargs): + return super(SysadminDashboardView, self).dispatch(*args, **kwargs) + + def get_courses(self): + """ Get an iterable list of courses.""" + + courses = self.def_ms.get_courses() + courses = dict([c.id, c] for c in courses) # no course directory + + return courses + + def return_csv(self, filename, header, data): + """ + Convenient function for handling the http response of a csv. + data should be iterable and is used to stream object over http + """ + + csv_file = StringIO.StringIO() + writer = csv.writer(csv_file, dialect='excel', quotechar='"', + quoting=csv.QUOTE_ALL) + + writer.writerow(header) + + # Setup streaming of the data + def read_and_flush(): + """Read and clear buffer for optimization""" + csv_file.seek(0) + csv_data = csv_file.read() + csv_file.seek(0) + csv_file.truncate() + return csv_data + + def csv_data(): + """Generator for handling potentially large CSVs""" + for row in data: + writer.writerow(row) + csv_data = read_and_flush() + yield csv_data + response = HttpResponse(csv_data(), mimetype='text/csv') + response['Content-Disposition'] = 'attachment; filename={0}'.format( + filename) + return response + + +class Users(SysadminDashboardView): + """ + The status view provides Web based user management, a listing of + courses loaded, and user statistics + """ + + def fix_external_auth_map_passwords(self): + """ + This corrects any passwords that have drifted from eamap to + internal django auth. Needs to be removed when fixed in external_auth + """ + + msg = '' + for eamap in ExternalAuthMap.objects.all(): + euser = eamap.user + epass = eamap.internal_password + if euser is None: + continue + try: + testuser = authenticate(username=euser.username, password=epass) + except (TypeError, PermissionDenied, AttributeError), err: + msg += _('Failed in authenticating {0}, error {1}\n' + ).format(euser, err) + continue + if testuser is None: + msg += _('Failed in authenticating {0}\n').format(euser) + msg += _('fixed password') + euser.set_password(epass) + euser.save() + continue + if not msg: + msg = _('All ok!') + return msg + + def create_user(self, uname, name, password=None): + """ Creates a user (both SSL and regular)""" + + if not uname: + return _('Must provide username') + if not name: + return _('Must provide full name') + + email_domain = getattr(settings, 'SSL_AUTH_EMAIL_DOMAIN', 'MIT.EDU') + + msg = u'' + if settings.FEATURES['AUTH_USE_MIT_CERTIFICATES']: + if not '@' in uname: + email = '{0}@{1}'.format(uname, email_domain) + else: + email = uname + if not email.endswith('@{0}'.format(email_domain)): + msg += u'{0} @{1}'.format(_('email must end in'), email_domain) + return msg + mit_domain = 'ssl:MIT' + if ExternalAuthMap.objects.filter(external_id=email, + external_domain=mit_domain): + msg += _('Failed - email {0} already exists as ' + 'external_id').format(email) + return msg + new_password = generate_password() + else: + if not password: + return _('Password must be supplied if not using certificates') + + email = uname + + if not '@' in email: + msg += _('email address required (not username)') + return msg + new_password = password + + user = User(username=uname, email=email, is_active=True) + user.set_password(new_password) + try: + user.save() + except IntegrityError: + msg += _('Oops, failed to create user {0}, ' + 'IntegrityError').format(user) + return msg + + reg = Registration() + reg.register(user) + + profile = UserProfile(user=user) + profile.name = name + profile.save() + + if settings.FEATURES['AUTH_USE_MIT_CERTIFICATES']: + credential_string = getattr(settings, 'SSL_AUTH_DN_FORMAT_STRING', + '/C=US/ST=Massachusetts/O=Massachusetts Institute of Technology/OU=Client CA v1/CN={0}/emailAddress={1}') + credentials = credential_string.format(name, email) + eamap = ExternalAuthMap( + external_id=email, + external_email=email, + external_domain=mit_domain, + external_name=name, + internal_password=new_password, + external_credentials=json.dumps(credentials), + ) + eamap.user = user + eamap.dtsignup = datetime.now() + eamap.save() + + msg += _('User {0} created successfully!').format(user) + return msg + + def delete_user(self, uname): + """Deletes a user from django auth""" + + if not uname: + return _('Must provide username') + if '@' in uname: + try: + user = User.objects.get(email=uname) + except User.DoesNotExist, err: + msg = _('Cannot find user with email address {0}').format(uname) + return msg + else: + try: + user = User.objects.get(username=uname) + except User.DoesNotExist, err: + msg = _('Cannot find user with username {0} - {1}' + ).format(uname, str(err)) + return msg + user.delete() + return _('Deleted user {0}').format(uname) + + def make_common_context(self): + """Returns the datatable used for this view""" + + self.datatable = {} + courses = self.get_courses() + + self.datatable = dict(header=[_('Statistic'), _('Value')], + title=_('Site statistics')) + self.datatable['data'] = [[_('Total number of users'), + User.objects.all().count()]] + + self.msg += u'

    {0}

    '.format( + _('Courses loaded in the modulestore')) + self.msg += u'
      ' + for (cdir, course) in courses.items(): + self.msg += u'
    1. {0} ({1})
      2. '.format( + escape(cdir), course.location.url()) + self.msg += u'
    ' + + def get(self, request): + + if not request.user.is_staff: + raise Http404 + self.make_common_context() + + context = { + 'datatable': self.datatable, + 'msg': self.msg, + 'djangopid': os.getpid(), + 'modeflag': {'users': 'active-section'}, + 'mitx_version': getattr(settings, 'VERSION_STRING', ''), + } + return render_to_response(self.template_name, context) + + def post(self, request): + """Handle various actions available on page""" + + if not request.user.is_staff: + raise Http404 + + self.make_common_context() + + action = request.POST.get('action', '') + track.views.server_track(request, action, {}, page='user_sysdashboard') + + if action == 'download_users': + header = [_('username'), _('email'), ] + data = ([u.username, u.email] for u in + (User.objects.all().iterator())) + return self.return_csv('users_{0}.csv'.format( + request.META['SERVER_NAME']), header, data) + elif action == 'repair_eamap': + self.msg = u'

    {0}

    {1}
    {2}'.format( + _('Repair Results'), + self.fix_external_auth_map_passwords(), + self.msg) + self.datatable = {} + elif action == 'create_user': + uname = request.POST.get('student_uname', '').strip() + name = request.POST.get('student_fullname', '').strip() + password = request.POST.get('student_password', '').strip() + self.msg = u'

    {0}

    {1}

    {2}'.format( + _('Create User Results'), + self.create_user(uname, name, password), self.msg) + elif action == 'del_user': + uname = request.POST.get('student_uname', '').strip() + self.msg = u'

    {0}

    {1}

    {2}'.format( + _('Delete User Results'), self.delete_user(uname), self.msg) + + context = { + 'datatable': self.datatable, + 'msg': self.msg, + 'djangopid': os.getpid(), + 'modeflag': {'users': 'active-section'}, + 'mitx_version': getattr(settings, 'VERSION_STRING', ''), + } + return render_to_response(self.template_name, context) + + +class Courses(SysadminDashboardView): + """ + This manages adding/updating courses from git, deleting courses, and + provides course listing information. + """ + + def git_info_for_course(self, cdir): + """This pulls out some git info like the last commit""" + + cmd = '' + gdir = settings.DATA_DIR / cdir + info = ['', '', ''] + if not os.path.exists(gdir): + return info + + cmd = ['git', 'log', '-1', + '--format=format:{ "commit": "%H", "author": "%an %ae", "date": "%ad"}', ] + try: + output_json = json.loads(subprocess.check_output(cmd, cwd=gdir)) + info = [output_json['commit'], + output_json['date'], + output_json['author'], ] + except (ValueError, subprocess.CalledProcessError): + pass + + return info + + def get_course_from_git(self, gitloc, datatable): + """This downloads and runs the checks for importing a course in git""" + + if not (gitloc.endswith('.git') or gitloc.startswith('http:') or + gitloc.startswith('https:') or gitloc.startswith('git:')): + return _("The git repo location should end with '.git', " + "and be a valid url") + + if self.is_using_mongo: + return self.import_mongo_course(gitloc) + + return self.import_xml_course(gitloc, datatable) + + def import_mongo_course(self, gitloc): + """ + Imports course using management command and captures logging output + at debug level for display in template + """ + + msg = u'' + + logging.debug(_('Adding course using git repo {0}').format(gitloc)) + + # Grab logging output for debugging imports + output = StringIO.StringIO() + import_log_handler = logging.StreamHandler(output) + import_log_handler.setLevel(logging.DEBUG) + + logger_names = ['xmodule.modulestore.xml_importer', + 'dashboard.management.commands.git_add_course', + 'xmodule.modulestore.xml', 'xmodule.seq_module', ] + loggers = [] + + for logger_name in logger_names: + logger = logging.getLogger(logger_name) + logger.old_level = logger.level + logger.setLevel(logging.DEBUG) + logger.addHandler(import_log_handler) + loggers.append(logger) + + git_add_course.add_repo(gitloc, None) + ret = output.getvalue() + + # Remove handler hijacks + for logger in loggers: + logger.setLevel(logger.old_level) + logger.removeHandler(import_log_handler) + + msg = u"

    {0} {1}

    ".format( + _('Added course from'), gitloc) + msg += _("
    {0}
    ").format(escape(ret)) + return msg + + def import_xml_course(self, gitloc, datatable): + """Imports a git course into the XMLModuleStore""" + + msg = u'' + if not getattr(settings, 'GIT_IMPORT_WITH_XMLMODULESTORE', False): + return _('Refusing to import. GIT_IMPORT_WITH_XMLMODULESTORE is ' + 'not turned on, and it is generally not safe to import ' + 'into an XMLModuleStore with multithreaded. We ' + 'recommend you enable the MongoDB based module store ' + 'instead, unless this is a development environment.') + cdir = (gitloc.rsplit('/', 1)[1])[:-4] + gdir = settings.DATA_DIR / cdir + if os.path.exists(gdir): + msg += _("The course {0} already exists in the data directory! " + "(reloading anyway)").format(cdir) + cmd = ['git', 'pull', ] + cwd = gdir + else: + cmd = ['git', 'clone', gitloc, ] + cwd = settings.DATA_DIR + cwd = os.path.abspath(cwd) + try: + cmd_output = escape(subprocess.check_output(cmd, cwd=cwd)) + except subprocess.CalledProcessError: + return _('Unable to clone or pull repository. Please check your url.') + + msg += u'
    {0}
    '.format(cmd_output) + if not os.path.exists(gdir): + msg += _('Failed to clone repository to {0}').format(gdir) + return msg + self.def_ms.try_load_course(os.path.abspath(gdir)) + errlog = self.def_ms.errored_courses.get(cdir, '') + if errlog: + msg += u'
    {0}
    '.format(escape(errlog)) + else: + course = self.def_ms.courses[os.path.abspath(gdir)] + msg += _('Loaded course {0} {1}
    Errors:').format( + cdir, course.display_name) + errors = self.def_ms.get_item_errors(course.location) + if not errors: + msg += u'None' + else: + msg += u'
      ' + for (summary, err) in errors: + msg += u'
    • {0}: {1}
      • '.format(escape(summary), + escape(err)) + msg += u'
    ' + datatable['data'].append([course.display_name, cdir] + + self.git_info_for_course(cdir)) + return msg + + def make_datatable(self): + """Creates course information datatable""" + + data = [] + courses = self.get_courses() + + for (cdir, course) in courses.items(): + gdir = cdir + if '/' in cdir: + gdir = cdir.rsplit('/', 1)[1] + data.append([course.display_name, cdir] + + self.git_info_for_course(gdir)) + + return dict(header=[_('Course Name'), _('Directory/ID'), + _('Git Commit'), _('Last Change'), + _('Last Editor')], + title=_('Information about all courses'), + data=data) + + def get(self, request): + """Displays forms and course information""" + + if not request.user.is_staff: + raise Http404 + + context = { + 'datatable': self.make_datatable(), + 'msg': self.msg, + 'djangopid': os.getpid(), + 'modeflag': {'courses': 'active-section'}, + 'mitx_version': getattr(settings, 'VERSION_STRING', ''), + } + return render_to_response(self.template_name, context) + + def post(self, request): + """Handle all actions from courses view""" + + if not request.user.is_staff: + raise Http404 + + action = request.POST.get('action', '') + track.views.server_track(request, action, {}, + page='courses_sysdashboard') + + courses = self.get_courses() + if action == 'add_course': + gitloc = request.POST.get('repo_location', '').strip().replace(' ', '').replace(';', '') + datatable = self.make_datatable() + self.msg += self.get_course_from_git(gitloc, datatable) + + elif action == 'del_course': + course_id = request.POST.get('course_id', '').strip() + course_found = False + if course_id in courses: + course_found = True + course = courses[course_id] + else: + try: + course = get_course_by_id(course_id) + course_found = True + except Exception, err: # pylint: disable=broad-except + self.msg += _('Error - cannot get course with ID ' + '{0}
    {1}
    ').format( + course_id, escape(str(err)) + ) + + is_mongo_course = (modulestore().get_modulestore_type(course_id) == MONGO_MODULESTORE_TYPE) + if course_found and not is_mongo_course: + cdir = course.data_dir + self.def_ms.courses.pop(cdir) + + # now move the directory (don't actually delete it) + new_dir = "{course_dir}_deleted_{timestamp}".format( + course_dir=cdir, + timestamp=int(time.time()) + ) + os.rename(settings.DATA_DIR / cdir, settings.DATA_DIR / new_dir) + + self.msg += (u"Deleted " + u"{0} = {1} ({2})".format( + cdir, course.id, course.display_name)) + + elif course_found and is_mongo_course: + # delete course that is stored with mongodb backend + loc = course.location + content_store = contentstore() + commit = True + delete_course(self.def_ms, content_store, loc, commit) + # don't delete user permission groups, though + self.msg += \ + u"{0} {1} = {2} ({3})".format( + _('Deleted'), loc, course.id, course.display_name) + datatable = self.make_datatable() + + context = { + 'datatable': datatable, + 'msg': self.msg, + 'djangopid': os.getpid(), + 'modeflag': {'courses': 'active-section'}, + 'mitx_version': getattr(settings, 'VERSION_STRING', ''), + } + return render_to_response(self.template_name, context) + + +class Staffing(SysadminDashboardView): + """ + The status view provides a view of staffing and enrollment in + courses that include an option to download the data as a csv. + """ + + def get(self, request): + """Displays course Enrollment and staffing course statistics""" + + if not request.user.is_staff: + raise Http404 + data = [] + + courses = self.get_courses() + + for (cdir, course) in courses.items(): # pylint: disable=unused-variable + datum = [course.display_name, course.id] + datum += [CourseEnrollment.objects.filter( + course_id=course.id).count()] + datum += [CourseStaffRole(course.location).users_with_role().count()] + datum += [','.join([x.username for x in CourseInstructorRole( + course.location).users_with_role()])] + data.append(datum) + + datatable = dict(header=[_('Course Name'), _('course_id'), + _('# enrolled'), _('# staff'), + _('instructors')], + title=_('Enrollment information for all courses'), + data=data) + context = { + 'datatable': datatable, + 'msg': self.msg, + 'djangopid': os.getpid(), + 'modeflag': {'staffing': 'active-section'}, + 'mitx_version': getattr(settings, 'VERSION_STRING', ''), + } + return render_to_response(self.template_name, context) + + def post(self, request): + """Handle all actions from staffing and enrollment view""" + + action = request.POST.get('action', '') + track.views.server_track(request, action, {}, + page='staffing_sysdashboard') + + if action == 'get_staff_csv': + data = [] + roles = [CourseInstructorRole, CourseStaffRole, ] + + courses = self.get_courses() + + for (cdir, course) in courses.items(): # pylint: disable=unused-variable + for role in roles: + for user in role(course.location).users_with_role(): + datum = [course.id, role, user.username, user.email, + user.profile.name] + data.append(datum) + header = [_('course_id'), + _('role'), _('username'), + _('email'), _('full_name'), ] + return self.return_csv('staff_{0}.csv'.format( + request.META['SERVER_NAME']), header, data) + + return self.get(request) + + +class GitLogs(TemplateView): + """ + This provides a view into the import of courses from git repositories. + It is convenient for allowing course teams to see what may be wrong with + their xml + """ + + template_name = 'sysadmin_dashboard_gitlogs.html' + + @method_decorator(login_required) + def get(self, request, *args, **kwargs): + """Shows logs of imports that happened as a result of a git import""" + + course_id = kwargs.get('course_id') + + # Set mongodb defaults even if it isn't defined in settings + mongo_db = { + 'host': 'localhost', + 'user': '', + 'password': '', + 'db': 'xlog', + } + + # Allow overrides + if hasattr(settings, 'MONGODB_LOG'): + for config_item in ['host', 'user', 'password', 'db', ]: + mongo_db[config_item] = settings.MONGODB_LOG.get( + config_item, mongo_db[config_item]) + + mongouri = 'mongodb://{user}:{password}@{host}/{db}'.format(**mongo_db) + + error_msg = '' + + try: + if mongo_db['user'] and mongo_db['password']: + mdb = mongoengine.connect(mongo_db['db'], host=mongouri) + else: + mdb = mongoengine.connect(mongo_db['db'], host=mongo_db['host']) + except mongoengine.connection.ConnectionError: + logging.exception(_('Unable to connect to mongodb to save log, ' + 'please check MONGODB_LOG settings.')) + + if course_id is None: + # Require staff if not going to specific course + if not request.user.is_staff: + raise Http404 + cilset = CourseImportLog.objects.all().order_by('-created') + else: + try: + course = get_course_by_id(course_id) + except Exception: # pylint: disable=broad-except + cilset = None + error_msg = _('Cannot find course {0}').format(course_id) + + # Allow only course team, instructors, and staff + if not (request.user.is_staff or + CourseInstructorRole(course.location).has_user(request.user) or + CourseStaffRole(course.location).has_user(request.user)): + raise Http404 + log.debug('course_id={0}'.format(course_id)) + cilset = CourseImportLog.objects.filter( + course_id=course_id).order_by('-created') + log.debug('cilset length={0}'.format(len(cilset))) + mdb.disconnect() + context = {'cilset': cilset, + 'course_id': course_id, + 'error_msg': error_msg} + + return render_to_response(self.template_name, context) diff --git a/lms/djangoapps/dashboard/sysadmin_urls.py b/lms/djangoapps/dashboard/sysadmin_urls.py new file mode 100644 index 000000000000..e543537415e7 --- /dev/null +++ b/lms/djangoapps/dashboard/sysadmin_urls.py @@ -0,0 +1,18 @@ +""" +Urls for sysadmin dashboard feature +""" +# pylint: disable=E1120 + +from django.conf.urls import patterns, url + +from dashboard import sysadmin + +urlpatterns = patterns( + '', + url(r'^$', sysadmin.Users.as_view(), name="sysadmin"), + url(r'^courses/?$', sysadmin.Courses.as_view(), name="sysadmin_courses"), + url(r'^staffing/?$', sysadmin.Staffing.as_view(), name="sysadmin_staffing"), + url(r'^gitlogs/?$', sysadmin.GitLogs.as_view(), name="gitlogs"), + url(r'^gitlogs/(?P.+)$', sysadmin.GitLogs.as_view(), + name="gitlogs_detail"), +) diff --git a/lms/djangoapps/dashboard/tests/test_sysadmin.py b/lms/djangoapps/dashboard/tests/test_sysadmin.py new file mode 100644 index 000000000000..37080723d028 --- /dev/null +++ b/lms/djangoapps/dashboard/tests/test_sysadmin.py @@ -0,0 +1,506 @@ +""" +Provide tests for sysadmin dashboard feature in sysadmin.py +""" + +import unittest +import os +import shutil + +from django.conf import settings +from django.contrib.auth.hashers import check_password +from django.contrib.auth.models import User +from django.core.urlresolvers import reverse +from django.test.client import Client +from django.test.utils import override_settings +from django.utils.html import escape +from django.utils.translation import ugettext as _ +import mongoengine + +from courseware.roles import CourseStaffRole, GlobalStaff +from courseware.tests.tests import TEST_DATA_MONGO_MODULESTORE +from dashboard.models import CourseImportLog +from dashboard.sysadmin import Users +from external_auth.models import ExternalAuthMap +from student.tests.factories import UserFactory +from xmodule.modulestore.django import modulestore +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase +from xmodule.modulestore.xml import XMLModuleStore + + +TEST_MONGODB_LOG = { + 'host': 'localhost', + 'user': '', + 'password': '', + 'db': 'test_xlog', +} + +FEATURES_WITH_SSL_AUTH = settings.FEATURES.copy() +FEATURES_WITH_SSL_AUTH['AUTH_USE_MIT_CERTIFICATES'] = True + + +class SysadminBaseTestCase(ModuleStoreTestCase): + """ + Base class with common methods used in XML and Mongo tests + """ + + @classmethod + def tearDownClass(cls): + """Delete all repos imported during tests.""" + super(SysadminBaseTestCase, cls).tearDownClass() + try: + shutil.rmtree(getattr(settings, 'GIT_REPO_DIR')) + except OSError: + pass + + def setUp(self): + """Setup test case by adding primary user.""" + super(SysadminBaseTestCase, self).setUp() + self.user = UserFactory.create(username='test_user', + email='test_user+sysadmin@edx.org', + password='foo') + self.client = Client() + + def _setstaff_login(self): + """Makes the test user staff and logs them in""" + GlobalStaff().add_users(self.user) + self.client.login(username=self.user.username, password='foo') + + def _add_edx4edx(self): + """Adds the edx4edx sample course""" + return self.client.post(reverse('sysadmin_courses'), { + 'repo_location': 'https://github.com/mitocw/edx4edx_lite.git', + 'action': 'add_course', }) + + def _rm_edx4edx(self): + """Deletes the sample course from the XML store""" + def_ms = modulestore() + try: + # using XML store + course = def_ms.courses.get('{0}/edx4edx_lite'.format( + os.path.abspath(settings.DATA_DIR)), None) + except AttributeError: + # Using mongo store + course = def_ms.get_course('MITx/edx4edx/edx4edx') + + # Delete git loaded course + return self.client.post(reverse('sysadmin_courses'), + {'course_id': course.id, + 'action': 'del_course', }) + + +@unittest.skipUnless(settings.FEATURES.get('ENABLE_SYSADMIN_DASHBOARD'), + "ENABLE_SYSADMIN_DASHBOARD not set") +@override_settings(GIT_IMPORT_WITH_XMLMODULESTORE=True) +class TestSysadmin(SysadminBaseTestCase): + """ + Test sysadmin dashboard features using XMLModuleStore + """ + + def test_staff_access(self): + """Test access controls.""" + + test_views = ['sysadmin', 'sysadmin_courses', 'sysadmin_staffing', ] + for view in test_views: + response = self.client.get(reverse(view)) + self.assertEqual(response.status_code, 302) + + logged_in = self.client.login(username=self.user.username, + password='foo') + self.assertTrue(logged_in) + + for view in test_views: + response = self.client.get(reverse(view)) + self.assertEqual(response.status_code, 404) + + response = self.client.get(reverse('gitlogs')) + self.assertEqual(response.status_code, 404) + + self.user.is_staff = True + self.user.save() + + self.client.logout() + self.client.login(username=self.user.username, password='foo') + + for view in test_views: + response = self.client.get(reverse(view)) + self.assertTrue(response.status_code, 200) + + response = self.client.get(reverse('gitlogs')) + self.assertTrue(response.status_code, 200) + + def test_user_mod(self): + """Create and delete a user""" + + self._setstaff_login() + + self.client.login(username=self.user.username, password='foo') + + # Create user tests + + # No uname + response = self.client.post(reverse('sysadmin'), + {'action': 'create_user', + 'student_fullname': 'blah', + 'student_password': 'foozor', }) + self.assertIn(_('Must provide username'), response.content) + # no full name + response = self.client.post(reverse('sysadmin'), + {'action': 'create_user', + 'student_uname': 'test_cuser+sysadmin@edx.org', + 'student_password': 'foozor', }) + self.assertIn(_('Must provide full name'), response.content) + + # Test create valid user + self.client.post(reverse('sysadmin'), + {'action': 'create_user', + 'student_uname': 'test_cuser+sysadmin@edx.org', + 'student_fullname': 'test cuser', + 'student_password': 'foozor', }) + + self.assertIsNotNone( + User.objects.get(username='test_cuser+sysadmin@edx.org', + email='test_cuser+sysadmin@edx.org')) + + # login as new user to confirm + self.assertTrue(self.client.login( + username='test_cuser+sysadmin@edx.org', password='foozor')) + + self.client.logout() + self.client.login(username=self.user.username, password='foo') + + # Delete user tests + + # Try no username + response = self.client.post(reverse('sysadmin'), + {'action': 'del_user', }) + self.assertIn(_('Must provide username'), response.content) + + # Try bad usernames + response = self.client.post(reverse('sysadmin'), + {'action': 'del_user', + 'student_uname': 'flabbergast@example.com', + 'student_fullname': 'enigma jones', }) + self.assertIn(_('Cannot find user with email address'), response.content) + + response = self.client.post(reverse('sysadmin'), + {'action': 'del_user', + 'student_uname': 'flabbergast', + 'student_fullname': 'enigma jones', }) + self.assertIn(_('Cannot find user with username'), response.content) + + self.client.post(reverse('sysadmin'), + {'action': 'del_user', + 'student_uname': 'test_cuser+sysadmin@edx.org', + 'student_fullname': 'test cuser', }) + + self.assertEqual(0, len(User.objects.filter( + username='test_cuser+sysadmin@edx.org', + email='test_cuser+sysadmin@edx.org'))) + + self.assertEqual(1, len(User.objects.all())) + + def test_user_csv(self): + """Download and validate user CSV""" + + num_test_users = 100 + self._setstaff_login() + + # Stuff full of users to test streaming + for user_num in xrange(num_test_users): + Users().create_user('testingman_with_long_name{}'.format(user_num), + 'test test') + + response = self.client.post(reverse('sysadmin'), + {'action': 'download_users', }) + + self.assertIn('attachment', response['Content-Disposition']) + self.assertEqual('text/csv', response['Content-Type']) + self.assertIn('test_user', response.content) + self.assertTrue(num_test_users + 2, len(response.content.splitlines())) + + # Clean up + User.objects.filter( + username__startswith='testingman_with_long_name').delete() + + @override_settings(FEATURES=FEATURES_WITH_SSL_AUTH) + def test_authmap_repair(self): + """Run authmap check and repair""" + + self._setstaff_login() + + Users().create_user('test0', 'test test') + # Will raise exception, so no assert needed + eamap = ExternalAuthMap.objects.get(external_name='test test') + mitu = User.objects.get(username='test0') + + self.assertTrue(check_password(eamap.internal_password, mitu.password)) + mitu.set_password('not autogenerated') + mitu.save() + self.assertFalse(check_password(eamap.internal_password, mitu.password)) + + # Create really non user AuthMap + ExternalAuthMap(external_id='ll', + external_domain='ll', + external_credentials='{}', + external_email='a@b.c', + external_name='c', + internal_password='').save() + + response = self.client.post(reverse('sysadmin'), + {'action': 'repair_eamap', }) + + self.assertIn('{0} test0'.format(_('Failed in authenticating')), + response.content) + self.assertIn(_('fixed password'), response.content) + + self.assertTrue(self.client.login(username='test0', + password=eamap.internal_password)) + + # Check for all OK + self._setstaff_login() + response = self.client.post(reverse('sysadmin'), + {'action': 'repair_eamap', }) + self.assertIn(_('All ok!'), response.content) + + def test_xml_course_add_delete(self): + """add and delete course from xml module store""" + + self._setstaff_login() + + # Try bad git repo + response = self.client.post(reverse('sysadmin_courses'), { + 'repo_location': 'github.com/mitocw/edx4edx_lite', + 'action': 'add_course', }) + self.assertIn(_("The git repo location should end with '.git', " + "and be a valid url"), response.content.decode('utf-8')) + + response = self.client.post(reverse('sysadmin_courses'), { + 'repo_location': 'http://example.com/not_real.git', + 'action': 'add_course', }) + self.assertIn(_('Unable to clone or pull repository'), + response.content.decode('utf-8')) + # Create git loaded course + response = self._add_edx4edx() + + def_ms = modulestore() + self.assertIn('xml', str(def_ms.__class__)) + course = def_ms.courses.get('{0}/edx4edx_lite'.format( + os.path.abspath(settings.DATA_DIR)), None) + self.assertIsNotNone(course) + + # Delete a course + response = self._rm_edx4edx() + course = def_ms.courses.get('{0}/edx4edx_lite'.format( + os.path.abspath(settings.DATA_DIR)), None) + self.assertIsNone(course) + + # Try and delete a non-existent course + response = self.client.post(reverse('sysadmin_courses'), + {'course_id': 'foobar/foo/blah', + 'action': 'del_course', }) + self.assertIn(_('Error - cannot get course with ID'), + response.content.decode('utf-8')) + + @override_settings(GIT_IMPORT_WITH_XMLMODULESTORE=False) + def test_xml_safety_flag(self): + """Make sure the settings flag to disable xml imports is working""" + + self._setstaff_login() + response = self._add_edx4edx() + self.assertIn('GIT_IMPORT_WITH_XMLMODULESTORE', response.content) + + def_ms = modulestore() + course = def_ms.courses.get('{0}/edx4edx_lite'.format( + os.path.abspath(settings.DATA_DIR)), None) + self.assertIsNone(course) + + def test_git_pull(self): + """Make sure we can pull""" + + self._setstaff_login() + + response = self._add_edx4edx() + response = self._add_edx4edx() + self.assertIn(_("The course {0} already exists in the data directory! " + "(reloading anyway)").format('edx4edx_lite'), + response.content.decode('utf-8')) + self._rm_edx4edx() + + def test_staff_csv(self): + """Download and validate staff CSV""" + + self._setstaff_login() + self._add_edx4edx() + + def_ms = modulestore() + course = def_ms.get_course('MITx/edx4edx/edx4edx') + CourseStaffRole(course.location).add_users(self.user) + + response = self.client.post(reverse('sysadmin_staffing'), + {'action': 'get_staff_csv', }) + self.assertIn('attachment', response['Content-Disposition']) + self.assertEqual('text/csv', response['Content-Type']) + columns = [_('course_id'), _('role'), _('username'), + _('email'), _('full_name'), ] + self.assertIn(','.join('"' + c + '"' for c in columns), + response.content) + + self._rm_edx4edx() + + def test_enrollment_page(self): + """ + Adds a course and makes sure that it shows up on the staffing and + enrollment page + """ + + self._setstaff_login() + self._add_edx4edx() + response = self.client.get(reverse('sysadmin_staffing')) + self.assertIn('edx4edx', response.content) + self._rm_edx4edx() + + +@override_settings(MODULESTORE=TEST_DATA_MONGO_MODULESTORE) +@override_settings(MONGODB_LOG=TEST_MONGODB_LOG) +@unittest.skipUnless(settings.FEATURES.get('ENABLE_SYSADMIN_DASHBOARD'), + "ENABLE_SYSADMIN_DASHBOARD not set") +class TestSysAdminMongoCourseImport(SysadminBaseTestCase): + """ + Check that importing into the mongo module store works + """ + + @classmethod + def tearDownClass(cls): + """Delete mongo log entries after test.""" + super(TestSysAdminMongoCourseImport, cls).tearDownClass() + try: + mongoengine.connect(TEST_MONGODB_LOG['db']) + CourseImportLog.objects.all().delete() + except mongoengine.connection.ConnectionError: + pass + + def _setstaff_login(self): + """ + Makes the test user staff and logs them in + """ + + self.user.is_staff = True + self.user.save() + + self.client.login(username=self.user.username, password='foo') + + def test_missing_repo_dir(self): + """ + Ensure that we handle a missing repo dir + """ + + self._setstaff_login() + + if os.path.isdir(getattr(settings, 'GIT_REPO_DIR')): + shutil.rmtree(getattr(settings, 'GIT_REPO_DIR')) + + # Create git loaded course + response = self._add_edx4edx() + self.assertIn(escape(_("Path {0} doesn't exist, please create it, or " + "configure a different path with " + "GIT_REPO_DIR").format(settings.GIT_REPO_DIR)), + response.content.decode('UTF-8')) + + def test_mongo_course_add_delete(self): + """ + This is the same as TestSysadmin.test_xml_course_add_delete, + but it uses a mongo store + """ + + self._setstaff_login() + if not os.path.isdir(getattr(settings, 'GIT_REPO_DIR')): + os.mkdir(getattr(settings, 'GIT_REPO_DIR')) + + def_ms = modulestore() + self.assertFalse(isinstance(def_ms, XMLModuleStore)) + + self._add_edx4edx() + course = def_ms.get_course('MITx/edx4edx/edx4edx') + self.assertIsNotNone(course) + + self._rm_edx4edx() + course = def_ms.get_course('MITx/edx4edx/edx4edx') + self.assertIsNone(course) + + def test_gitlogs(self): + """ + Create a log entry and make sure it exists + """ + + self._setstaff_login() + try: + os.mkdir(getattr(settings, 'GIT_REPO_DIR')) + except OSError: + pass + + self._add_edx4edx() + response = self.client.get(reverse('gitlogs')) + + # Check that our earlier import has a log with a link to details + self.assertIn('/gitlogs/MITx/edx4edx/edx4edx', response.content) + + response = self.client.get( + reverse('gitlogs_detail', kwargs={ + 'course_id': 'MITx/edx4edx/edx4edx'})) + + self.assertIn('======> IMPORTING course to location', + response.content) + + self._rm_edx4edx() + + def test_gitlog_bad_course(self): + """ + Make sure we gracefully handle courses that don't exist. + """ + self._setstaff_login() + response = self.client.get( + reverse('gitlogs_detail', kwargs={ + 'course_id': 'Not/Real/Testing'})) + self.assertIn(_('Cannot find course'), response.content) + + def test_gitlog_courseteam_access(self): + """ + Ensure course team users are allowed to access only their own course. + """ + + try: + os.mkdir(getattr(settings, 'GIT_REPO_DIR')) + except OSError: + pass + + self._setstaff_login() + self._add_edx4edx() + self.user.is_staff = False + self.user.save() + logged_in = self.client.login(username=self.user.username, + password='foo') + response = self.client.get(reverse('gitlogs')) + # Make sure our non privileged user doesn't have access to all logs + self.assertEqual(response.status_code, 404) + # Or specific logs + response = self.client.get(reverse('gitlogs_detail', kwargs={ + 'course_id': 'MITx/edx4edx/edx4edx'})) + self.assertEqual(response.status_code, 404) + + # Add user as staff in course team + def_ms = modulestore() + course = def_ms.get_course('MITx/edx4edx/edx4edx') + CourseStaffRole(course.location).add_users(self.user) + + self.assertTrue(CourseStaffRole(course.location).has_user(self.user)) + logged_in = self.client.login(username=self.user.username, + password='foo') + self.assertTrue(logged_in) + + response = self.client.get( + reverse('gitlogs_detail', kwargs={ + 'course_id': 'MITx/edx4edx/edx4edx'})) + self.assertIn('======> IMPORTING course to location', + response.content) + + self._rm_edx4edx() diff --git a/lms/djangoapps/dashboard/views.py b/lms/djangoapps/dashboard/views.py index 630222d7bfe2..cefa41252b51 100644 --- a/lms/djangoapps/dashboard/views.py +++ b/lms/djangoapps/dashboard/views.py @@ -1,5 +1,5 @@ from django.http import Http404 -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from django.db import connection from student.models import CourseEnrollment @@ -12,7 +12,7 @@ def dictfetchall(cursor): desc = cursor.description table = [] table.append([col[0] for col in desc]) - + # ensure response from db is a list, not a tuple (which is returned # by MySQL backed django instances) rows_from_cursor=cursor.fetchall() @@ -27,7 +27,7 @@ def SQL_query_to_list(cursor, query_string): def dashboard(request): """ Slightly less hackish hack to show staff enrollment numbers and other - simple queries. + simple queries. All queries here should be indexed and simple. Mostly, this means don't touch courseware_studentmodule, as tempting as it may be. @@ -45,7 +45,7 @@ def dashboard(request): # count how many users we have results["scalars"]["Unique Usernames"]=User.objects.filter().count() results["scalars"]["Activated Usernames"]=User.objects.filter(is_active=1).count() - + # count how many enrollments we have results["scalars"]["Total Enrollments Across All Courses"] = CourseEnrollment.objects.filter(is_active=1).count() diff --git a/lms/djangoapps/debug/views.py b/lms/djangoapps/debug/views.py index 317ebcada988..5a5927e35008 100644 --- a/lms/djangoapps/debug/views.py +++ b/lms/djangoapps/debug/views.py @@ -6,7 +6,7 @@ from django.http import Http404 from django.contrib.auth.decorators import login_required from django_future.csrf import ensure_csrf_cookie -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from codejail.safe_exec import safe_exec diff --git a/lms/djangoapps/django_comment_client/base/tests.py b/lms/djangoapps/django_comment_client/base/tests.py index 8709d670ebed..513780ecda3c 100644 --- a/lms/djangoapps/django_comment_client/base/tests.py +++ b/lms/djangoapps/django_comment_client/base/tests.py @@ -21,7 +21,7 @@ @patch('lms.lib.comment_client.utils.requests.request') class ViewsTestCase(UrlResetMixin, ModuleStoreTestCase): - @patch.dict("django.conf.settings.MITX_FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) def setUp(self): # Patching the ENABLE_DISCUSSION_SERVICE value affects the contents of urls.py, diff --git a/lms/djangoapps/django_comment_client/base/urls.py b/lms/djangoapps/django_comment_client/base/urls.py index 5b653e1c68a4..97ba282db216 100644 --- a/lms/djangoapps/django_comment_client/base/urls.py +++ b/lms/djangoapps/django_comment_client/base/urls.py @@ -2,7 +2,6 @@ urlpatterns = patterns('django_comment_client.base.views', # nopep8 url(r'upload$', 'upload', name='upload'), - url(r'users/(?P\w+)/update_moderator_status$', 'update_moderator_status', name='update_moderator_status'), url(r'threads/tags/autocomplete$', 'tags_autocomplete', name='tags_autocomplete'), url(r'threads/(?P[\w\-]+)/update$', 'update_thread', name='update_thread'), url(r'threads/(?P[\w\-]+)/reply$', 'create_comment', name='create_comment'), diff --git a/lms/djangoapps/django_comment_client/base/views.py b/lms/djangoapps/django_comment_client/base/views.py index 4600f121f707..4e3331e59275 100644 --- a/lms/djangoapps/django_comment_client/base/views.py +++ b/lms/djangoapps/django_comment_client/base/views.py @@ -19,7 +19,7 @@ from django.utils.translation import ugettext as _ from django.contrib.auth.models import User -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from courseware.courses import get_course_with_access, get_course_by_id from course_groups.cohorts import get_cohort_id, is_commentable_cohorted @@ -508,41 +508,6 @@ def unfollow_user(request, course_id, followed_user_id): return JsonResponse({}) -@require_POST -@login_required -@permitted -def update_moderator_status(request, course_id, user_id): - """ - given a course id and user id, check if the user has moderator - and send back a user profile - """ - is_moderator = request.POST.get('is_moderator', '').lower() - if is_moderator not in ["true", "false"]: - return JsonError("Must provide is_moderator as boolean value") - is_moderator = is_moderator == "true" - user = User.objects.get(id=user_id) - role = Role.objects.get(course_id=course_id, name="Moderator") - if is_moderator: - user.roles.add(role) - else: - user.roles.remove(role) - if request.is_ajax(): - course = get_course_with_access(request.user, course_id, 'load') - discussion_user = cc.User(id=user_id, course_id=course_id) - context = { - 'course': course, - 'course_id': course_id, - 'user': request.user, - 'django_user': user, - 'profiled_user': discussion_user.to_dict(), - } - return JsonResponse({ - 'html': render_to_string('discussion/ajax_user_profile.html', context) - }) - else: - return JsonResponse({}) - - @require_GET def search_similar_threads(request, course_id, commentable_id): """ diff --git a/lms/djangoapps/django_comment_client/forum/tests.py b/lms/djangoapps/django_comment_client/forum/tests.py index aac03d54ce12..e8ebdb3e0038 100644 --- a/lms/djangoapps/django_comment_client/forum/tests.py +++ b/lms/djangoapps/django_comment_client/forum/tests.py @@ -18,7 +18,7 @@ @override_settings(MODULESTORE=TEST_DATA_MIXED_MODULESTORE) class ViewsExceptionTestCase(UrlResetMixin, ModuleStoreTestCase): - @patch.dict("django.conf.settings.MITX_FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) + @patch.dict("django.conf.settings.FEATURES", {"ENABLE_DISCUSSION_SERVICE": True}) def setUp(self): # Patching the ENABLE_DISCUSSION_SERVICE value affects the contents of urls.py, diff --git a/lms/djangoapps/django_comment_client/forum/views.py b/lms/djangoapps/django_comment_client/forum/views.py index dac91512d6a0..83516fc3ac3f 100644 --- a/lms/djangoapps/django_comment_client/forum/views.py +++ b/lms/djangoapps/django_comment_client/forum/views.py @@ -8,7 +8,7 @@ from django.contrib.auth.models import User import newrelic.agent -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from courseware.courses import get_course_with_access from course_groups.cohorts import (is_course_cohorted, get_cohort_id, is_commentable_cohorted, get_cohorted_commentables, get_course_cohorts, get_cohort_by_id) diff --git a/lms/djangoapps/django_comment_client/permissions.py b/lms/djangoapps/django_comment_client/permissions.py index 5cc4ff18df9e..3c83556a7e75 100644 --- a/lms/djangoapps/django_comment_client/permissions.py +++ b/lms/djangoapps/django_comment_client/permissions.py @@ -102,7 +102,6 @@ def test(user, per, operator="or"): 'unfollow_commentable': ['unfollow_commentable'], 'unfollow_user': ['unfollow_user'], 'create_thread': ['create_thread'], - 'update_moderator_status': ['manage_moderator'], } diff --git a/lms/djangoapps/django_comment_client/tests/factories.py b/lms/djangoapps/django_comment_client/tests/factories.py index 4a82c8f1bb4f..a3393b60104e 100644 --- a/lms/djangoapps/django_comment_client/tests/factories.py +++ b/lms/djangoapps/django_comment_client/tests/factories.py @@ -1,4 +1,4 @@ -from factory import DjangoModelFactory +from factory.django import DjangoModelFactory from django_comment_common.models import Role, Permission diff --git a/lms/djangoapps/django_comment_client/utils.py b/lms/djangoapps/django_comment_client/utils.py index 527a7d0860c8..c8422fb14bb0 100644 --- a/lms/djangoapps/django_comment_client/utils.py +++ b/lms/djangoapps/django_comment_client/utils.py @@ -12,10 +12,11 @@ from django_comment_common.models import Role, FORUM_ROLE_STUDENT from django_comment_client.permissions import check_permissions_by_view -import mitxmako +import edxmako import pystache_custom as pystache from xmodule.modulestore.django import modulestore +from xmodule.modulestore import Location from django.utils.timezone import UTC log = logging.getLogger(__name__) @@ -56,7 +57,7 @@ def has_forum_access(uname, course_id, rolename): def _get_discussion_modules(course): all_modules = modulestore().get_items( - ['i4x', course.location.org, course.location.course, 'discussion', None], + Location('i4x', course.location.org, course.location.course, 'discussion', None), course_id=course.id ) @@ -117,7 +118,7 @@ def _filter_unstarted_categories(category_map): return result_map - + def _sort_map_entries(category_map, sort_alpha): things = [] for title, entry in category_map["entries"].items(): @@ -310,7 +311,7 @@ def url_for_tags(course_id, tags): def render_mustache(template_name, dictionary, *args, **kwargs): - template = mitxmako.lookup['main'].get_template(template_name).source + template = edxmako.lookup['main'].get_template(template_name).source return pystache.render(template, dictionary) diff --git a/lms/djangoapps/instructor/enrollment.py b/lms/djangoapps/instructor/enrollment.py index 508271fa8b8c..a7c4fe0b6554 100644 --- a/lms/djangoapps/instructor/enrollment.py +++ b/lms/djangoapps/instructor/enrollment.py @@ -12,7 +12,7 @@ from student.models import CourseEnrollment, CourseEnrollmentAllowed from courseware.models import StudentModule -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string # For determining if a shibboleth course SHIBBOLETH_DOMAIN_PREFIX = 'shib:' diff --git a/lms/djangoapps/instructor/features/bulk_email.feature b/lms/djangoapps/instructor/features/bulk_email.feature index 695fe3b9cbec..39d2c00c83a3 100644 --- a/lms/djangoapps/instructor/features/bulk_email.feature +++ b/lms/djangoapps/instructor/features/bulk_email.feature @@ -1,11 +1,12 @@ @shard_2 -Feature: LMS.Bulk Email +Feature: LMS.Instructor Dash Bulk Email As an instructor or course staff, In order to communicate with students and staff I want to send email to staff and students in a course. Scenario: Send bulk email - Given I am "" for a course + Given there is a course with a staff, instructor and student + And I am logged in to the course as "" When I send email to "" Then Email is sent to "" diff --git a/lms/djangoapps/instructor/features/bulk_email.py b/lms/djangoapps/instructor/features/bulk_email.py index f2f541b9e68a..891b17488058 100644 --- a/lms/djangoapps/instructor/features/bulk_email.py +++ b/lms/djangoapps/instructor/features/bulk_email.py @@ -11,12 +11,14 @@ from django.core.management import call_command from django.conf import settings +from courseware.tests.factories import StaffFactory, InstructorFactory -@step(u'Given I am "([^"]*)" for a course') -def i_am_an_instructor(step, role): # pylint: disable=W0613 - # Store the role - assert_in(role, ['instructor', 'staff']) +@step(u'Given there is a course with a staff, instructor and student') +def make_populated_course(step): # pylint: disable=unused-argument + ## This is different than the function defined in common.py because it enrolls + ## a staff, instructor, and student member regardless of what `role` is, then + ## logs `role` in. This is to ensure we have 3 class participants to email. # Clear existing courses to avoid conflicts world.clear_courses() @@ -24,50 +26,37 @@ def i_am_an_instructor(step, role): # pylint: disable=W0613 # Create a new course course = world.CourseFactory.create( org='edx', - number='999', - display_name='Test Course' + number='888', + display_name='Bulk Email Test Course' ) + world.bulk_email_course_id = 'edx/888/Bulk_Email_Test_Course' - # Register the instructor as staff for the course - world.register_by_course_id( - 'edx/999/Test_Course', - username='instructor', - password='password', - is_staff=True - ) - world.add_to_course_staff('instructor', '999') + try: + # See if we've defined the instructor & staff user yet + world.bulk_email_instructor + except AttributeError: + # Make & register an instructor for the course + world.bulk_email_instructor = InstructorFactory(course=course.location) + world.enroll_user(world.bulk_email_instructor, world.bulk_email_course_id) - # Register another staff member - world.register_by_course_id( - 'edx/999/Test_Course', - username='staff', - password='password', - is_staff=True - ) - world.add_to_course_staff('staff', '999') + # Make & register a staff member + world.bulk_email_staff = StaffFactory(course=course.location) + world.enroll_user(world.bulk_email_staff, world.bulk_email_course_id) - # Register a student + # Make & register a student world.register_by_course_id( - 'edx/999/Test_Course', + 'edx/888/Bulk_Email_Test_Course', username='student', - password='password', + password='test', is_staff=False ) - # Log in as the an instructor or staff for the course - world.log_in( - username=role, - password='password', - email="instructor@edx.org", - name="Instructor" - ) - # Store the expected recipients # given each "send to" option + staff_emails = [world.bulk_email_staff.email, world.bulk_email_instructor.email] world.expected_addresses = { - 'myself': [role + '@edx.org'], - 'course staff': ['instructor@edx.org', 'staff@edx.org'], - 'students, staff, and instructors': ['instructor@edx.org', 'staff@edx.org', 'student@edx.org'] + 'course staff': staff_emails, + 'students, staff, and instructors': staff_emails + ['student@edx.org'] } @@ -80,8 +69,35 @@ def i_am_an_instructor(step, role): # pylint: disable=W0613 } +@step(u'I am logged in to the course as "([^"]*)"') +def log_into_the_course(step, role): # pylint: disable=unused-argument + # Store the role + assert_in(role, ['instructor', 'staff']) + + # Log in as the an instructor or staff for the course + my_email = world.bulk_email_instructor.email + if role == 'instructor': + world.log_in( + username=world.bulk_email_instructor.username, + password='test', + email=my_email, + name=world.bulk_email_instructor.profile.name + ) + else: + my_email = world.bulk_email_staff.email + world.log_in( + username=world.bulk_email_staff.username, + password='test', + email=my_email, + name=world.bulk_email_staff.profile.name + ) + + # Store the "myself" send to option + world.expected_addresses['myself'] = [my_email] + + @step(u'I send email to "([^"]*)"') -def when_i_send_an_email(step, recipient): +def when_i_send_an_email(step, recipient): # pylint: disable=unused-argument # Check that the recipient is valid assert_in( @@ -99,8 +115,8 @@ def when_i_send_an_email(step, recipient): call_command('loaddata', 'course_email_template.json') # Go to the email section of the instructor dash - world.visit('/courses/edx/999/Test_Course') - world.css_click('a[href="/courses/edx/999/Test_Course/instructor"]') + world.visit('/courses/edx/888/Bulk_Email_Test_Course') + world.css_click('a[href="/courses/edx/888/Bulk_Email_Test_Course/instructor"]') world.css_click('div.beta-button-wrapper>a') world.css_click('a[data-section="send_email"]') @@ -130,8 +146,7 @@ def when_i_send_an_email(step, recipient): @step(u'Email is sent to "([^"]*)"') -def then_the_email_is_sent(step, recipient): - +def then_the_email_is_sent(step, recipient): # pylint: disable=unused-argument # Check that the recipient is valid assert_in( recipient, SEND_TO_OPTIONS, diff --git a/lms/djangoapps/instructor/features/common.py b/lms/djangoapps/instructor/features/common.py new file mode 100644 index 000000000000..433992a72e0f --- /dev/null +++ b/lms/djangoapps/instructor/features/common.py @@ -0,0 +1,103 @@ +""" +Define common steps for instructor dashboard acceptance tests. +""" + +# pylint: disable=C0111 +# pylint: disable=W0621 + +from __future__ import absolute_import + +from lettuce import world, step +from nose.tools import assert_in # pylint: disable=E0611 + +from courseware.tests.factories import StaffFactory, InstructorFactory + + +@step(u'Given I am "([^"]*)" for a course') +def i_am_staff_or_instructor(step, role): # pylint: disable=unused-argument + ## In summary: makes a test course, makes a new Staff or Instructor user + ## (depending on `role`), and logs that user in to the course + + # Store the role + assert_in(role, ['instructor', 'staff']) + + # Clear existing courses to avoid conflicts + world.clear_courses() + + # Create a new course + course = world.CourseFactory.create( + org='edx', + number='999', + display_name='Test Course' + ) + + world.course_id = 'edx/999/Test_Course' + world.role = 'instructor' + # Log in as the an instructor or staff for the course + if role == 'instructor': + # Make & register an instructor for the course + world.instructor = InstructorFactory(course=course.location) + world.enroll_user(world.instructor, world.course_id) + + world.log_in( + username=world.instructor.username, + password='test', + email=world.instructor.email, + name=world.instructor.profile.name + ) + + else: + world.role = 'staff' + # Make & register a staff member + world.staff = StaffFactory(course=course.location) + world.enroll_user(world.staff, world.course_id) + + world.log_in( + username=world.staff.username, + password='test', + email=world.staff.email, + name=world.staff.profile.name + ) + + +def go_to_section(section_name): + # section name should be one of + # course_info, membership, student_admin, data_download, analytics, send_email + world.visit('/courses/edx/999/Test_Course') + world.css_click('a[href="/courses/edx/999/Test_Course/instructor"]') + world.css_click('div.beta-button-wrapper>a') + world.css_click('a[data-section="{0}"]'.format(section_name)) + + +@step(u'I click "([^"]*)"') +def click_a_button(step, button): # pylint: disable=unused-argument + + if button == "Generate Grade Report": + # Go to the data download section of the instructor dash + go_to_section("data_download") + + # Click generate grade report button + world.css_click('input[name="calculate-grades-csv"]') + + # Expect to see a message that grade report is being generated + expected_msg = "Your grade report is being generated! You can view the status of the generation task in the 'Pending Instructor Tasks' section." + world.wait_for_visible('#grade-request-response') + assert_in( + expected_msg, world.css_text('#grade-request-response'), + msg="Could not find grade report generation success message." + ) + + elif button == "Grading Configuration": + # Go to the data download section of the instructor dash + go_to_section("data_download") + + world.css_click('input[name="dump-gradeconf"]') + + elif button == "List enrolled students' profile information": + # Go to the data download section of the instructor dash + go_to_section("data_download") + + world.css_click('input[name="list-profiles"]') + + else: + raise ValueError("Unrecognized button option " + button) diff --git a/lms/djangoapps/instructor/features/data_download.feature b/lms/djangoapps/instructor/features/data_download.feature new file mode 100644 index 000000000000..8f4d980cbf8b --- /dev/null +++ b/lms/djangoapps/instructor/features/data_download.feature @@ -0,0 +1,36 @@ +@shard_2 +Feature: LMS.Instructor Dash Data Download + As an instructor or course staff, + In order to manage my class + I want to view and download data information about my students. + + ### todos when more time can be spent on instructor dashboard + #Scenario: Download profile information as a CSV + #Scenario: Download student anonymized IDs as a CSV + + Scenario: List enrolled students' profile information + Given I am "" for a course + When I click "List enrolled students' profile information" + Then I see a table of student profiles + Examples: + | Role | + | instructor | + | staff | + + Scenario: View the grading configuration + Given I am "" for a course + When I click "Grading Configuration" + Then I see the grading configuration for the course + Examples: + | Role | + | instructor | + | staff | + + Scenario: Generate & download a grade report + Given I am "" for a course + When I click "Generate Grade Report" + Then I see a csv file in the grade reports table + Examples: + | Role | + | instructor | + | staff | diff --git a/lms/djangoapps/instructor/features/data_download.py b/lms/djangoapps/instructor/features/data_download.py new file mode 100644 index 000000000000..966dfd348cb7 --- /dev/null +++ b/lms/djangoapps/instructor/features/data_download.py @@ -0,0 +1,75 @@ +""" +Define steps for instructor dashboard - data download tab +acceptance tests. +""" + +# pylint: disable=C0111 +# pylint: disable=W0621 + +from lettuce import world, step +from nose.tools import assert_in, assert_regexp_matches # pylint: disable=E0611 +from terrain.steps import reload_the_page + + +@step(u'I see a table of student profiles') +def find_student_profile_table(step): # pylint: disable=unused-argument + # Find the grading configuration display + world.wait_for_visible('#data-student-profiles-table') + + # Wait for the data table to be populated + world.wait_for(lambda _: world.css_text('#data-student-profiles-table') not in [u'', u'Loading...']) + + if world.role == 'instructor': + expected_data = [ + world.instructor.username, + world.instructor.email, + world.instructor.profile.name, + world.instructor.profile.gender, + world.instructor.profile.goals + ] + elif world.role == 'staff': + expected_data = [ + world.staff.username, + world.staff.email, + world.staff.profile.name, + world.staff.profile.gender, + world.staff.profile.goals + ] + for datum in expected_data: + assert_in(datum, world.css_text('#data-student-profiles-table')) + + +@step(u"I see the grading configuration for the course") +def find_grading_config(step): # pylint: disable=unused-argument + # Find the grading configuration display + world.wait_for_visible('#data-grade-config-text') + # expected config is the default grading configuration from common/lib/xmodule/xmodule/course_module.py + expected_config = u"""----------------------------------------------------------------------------- +Course grader: + + +Graded sections: + subgrader=, type=Homework, category=Homework, weight=0.15 + subgrader=, type=Lab, category=Lab, weight=0.15 + subgrader=, type=Midterm Exam, category=Midterm Exam, weight=0.3 + subgrader=, type=Final Exam, category=Final Exam, weight=0.4 +----------------------------------------------------------------------------- +Listing grading context for course edx/999/Test_Course +graded sections: +[] +all descriptors: +length=0""" + assert_in(expected_config, world.css_text('#data-grade-config-text')) + + +@step(u"I see a csv file in the grade reports table") +def find_grade_report_csv_link(step): # pylint: disable=unused-argument + # Need to reload the page to see the grades download table + reload_the_page(step) + world.wait_for_visible('#grade-downloads-table') + # Find table and assert a .csv file is present + expected_file_regexp = 'edx_999_Test_Course_grade_report_\d{4}-\d{2}-\d{2}-\d{4}\.csv' + assert_regexp_matches( + world.css_html('#grade-downloads-table'), expected_file_regexp, + msg="Expected grade report filename was not found." + ) diff --git a/lms/djangoapps/instructor/hint_manager.py b/lms/djangoapps/instructor/hint_manager.py index 9f555b9c56f2..ab903e190944 100644 --- a/lms/djangoapps/instructor/hint_manager.py +++ b/lms/djangoapps/instructor/hint_manager.py @@ -4,7 +4,7 @@ Get to these views through courseurl/hint_manager. For example: https://courses.edx.org/courses/MITx/2.01x/2013_Spring/hint_manager -These views will only be visible if MITX_FEATURES['ENABLE_HINTER_INSTRUCTOR_VIEW'] = True +These views will only be visible if FEATURES['ENABLE_HINTER_INSTRUCTOR_VIEW'] = True """ import json @@ -13,7 +13,7 @@ from django.http import HttpResponse, Http404 from django_future.csrf import ensure_csrf_cookie -from mitxmako.shortcuts import render_to_response, render_to_string +from edxmako.shortcuts import render_to_response, render_to_string from courseware.courses import get_course_with_access from courseware.models import XModuleUserStateSummaryField diff --git a/lms/djangoapps/instructor/tests/test_email.py b/lms/djangoapps/instructor/tests/test_email.py index f3b4194228e2..6a2b71f2e87d 100644 --- a/lms/djangoapps/instructor/tests/test_email.py +++ b/lms/djangoapps/instructor/tests/test_email.py @@ -47,7 +47,7 @@ def tearDown(self): # In order for bulk email to work, we must have both the ENABLE_INSTRUCTOR_EMAIL_FLAG # set to True and for the course to be Mongo-backed. # The flag is enabled and the course is Mongo-backed (should work) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) def test_email_flag_true_mongo_true(self): # Assert that instructor email is enabled for this course - since REQUIRE_COURSE_EMAIL_AUTH is False, # all courses should be authorized to use email. @@ -61,14 +61,14 @@ def test_email_flag_true_mongo_true(self): self.assertEqual(response.status_code, 200) # The course is Mongo-backed but the flag is disabled (should not work) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False}) def test_email_flag_false_mongo_true(self): # Assert that the URL for the email view is not in the response response = self.client.get(self.url) self.assertFalse(self.email_link in response.content) # Flag is enabled, but we require course auth and haven't turned it on for this course - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_course_not_authorized(self): # Assert that instructor email is not enabled for this course self.assertFalse(CourseAuthorization.instructor_email_enabled(self.course.id)) @@ -77,7 +77,7 @@ def test_course_not_authorized(self): self.assertFalse(self.email_link in response.content) # Flag is enabled, we require course auth and turn it on for this course - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_course_authorized(self): # Assert that instructor email is not enabled for this course self.assertFalse(CourseAuthorization.instructor_email_enabled(self.course.id)) @@ -96,7 +96,7 @@ def test_course_authorized(self): self.assertTrue(self.email_link in response.content) # Flag is disabled, but course is authorized - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_course_authorized_feature_off(self): # Authorize the course to use email cauth = CourseAuthorization(course_id=self.course.id, email_enabled=True) @@ -128,13 +128,13 @@ def setUp(self): # The flag is enabled, and since REQUIRE_COURSE_EMAIL_AUTH is False, all courses should # be authorized to use email. But the course is not Mongo-backed (should not work) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) def test_email_flag_true_mongo_false(self): response = self.client.get(self.url) self.assertFalse(self.email_link in response.content) # The flag is disabled and the course is not Mongo-backed (should not work) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False, 'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False, 'REQUIRE_COURSE_EMAIL_AUTH': False}) def test_email_flag_false_mongo_false(self): response = self.client.get(self.url) self.assertFalse(self.email_link in response.content) diff --git a/lms/djangoapps/instructor/tests/test_legacy_email.py b/lms/djangoapps/instructor/tests/test_legacy_email.py index 25a70e4f8a28..c91d1cce2f22 100644 --- a/lms/djangoapps/instructor/tests/test_legacy_email.py +++ b/lms/djangoapps/instructor/tests/test_legacy_email.py @@ -42,7 +42,7 @@ def tearDown(self): """ patch.stopall() - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': False}) def test_email_flag_true(self): # Assert that the URL for the email view is in the response response = self.client.get(self.url) @@ -60,14 +60,14 @@ def test_email_flag_true(self): send_to_label = '' self.assertTrue(send_to_label in response.content) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_email_flag_unauthorized(self): # Assert that the URL for the email view is not in the response # email is enabled, but this course is not authorized to send email response = self.client.get(self.url) self.assertFalse(self.email_link in response.content) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True, 'REQUIRE_COURSE_EMAIL_AUTH': True}) def test_email_flag_authorized(self): # Assert that the URL for the email view is in the response # email is enabled, and this course is authorized to send email @@ -86,13 +86,13 @@ def test_email_flag_authorized(self): response = self.client.get(self.url) self.assertTrue(self.email_link in response.content) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': False}) def test_email_flag_false(self): # Assert that the URL for the email view is not in the response response = self.client.get(self.url) self.assertFalse(self.email_link in response.content) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True}) + @patch.dict(settings.FEATURES, {'ENABLE_INSTRUCTOR_EMAIL': True}) def test_email_flag_true_xml_store(self): # If the enable email setting is enabled, but this is an XML backed course, # the email view shouldn't be available on the instructor dashboard. diff --git a/lms/djangoapps/instructor/views/instructor_dashboard.py b/lms/djangoapps/instructor/views/instructor_dashboard.py index de14df29404e..d170d09360e6 100644 --- a/lms/djangoapps/instructor/views/instructor_dashboard.py +++ b/lms/djangoapps/instructor/views/instructor_dashboard.py @@ -6,7 +6,7 @@ from django.utils.translation import ugettext as _ from django_future.csrf import ensure_csrf_cookie from django.views.decorators.cache import cache_control -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from django.core.urlresolvers import reverse from django.utils.html import escape from django.http import Http404 @@ -56,7 +56,7 @@ def instructor_dashboard_2(request, course_id): ] # Gate access to course email by feature flag & by course-specific authorization - if settings.MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] and \ + if settings.FEATURES['ENABLE_INSTRUCTOR_EMAIL'] and \ is_studio_course and CourseAuthorization.instructor_email_enabled(course_id): sections.append(_section_send_email(course_id, access, course)) @@ -66,7 +66,7 @@ def instructor_dashboard_2(request, course_id): enrollment_count = sections[0]['enrollment_count'] disable_buttons = False - max_enrollment_for_buttons = settings.MITX_FEATURES.get("MAX_ENROLLMENT_INSTR_BUTTONS") + max_enrollment_for_buttons = settings.FEATURES.get("MAX_ENROLLMENT_INSTR_BUTTONS") if max_enrollment_for_buttons is not None: disable_buttons = enrollment_count > max_enrollment_for_buttons diff --git a/lms/djangoapps/instructor/views/legacy.py b/lms/djangoapps/instructor/views/legacy.py index 98c18dc68bea..51c29da728eb 100644 --- a/lms/djangoapps/instructor/views/legacy.py +++ b/lms/djangoapps/instructor/views/legacy.py @@ -34,23 +34,26 @@ from courseware import grades from courseware.access import has_access from courseware.courses import get_course_with_access, get_cms_course_link -from courseware.roles import CourseStaffRole, CourseInstructorRole, CourseBetaTesterRole +from courseware.roles import ( + CourseStaffRole, CourseInstructorRole, CourseBetaTesterRole, GlobalStaff +) from courseware.models import StudentModule -from django_comment_common.models import (Role, - FORUM_ROLE_ADMINISTRATOR, - FORUM_ROLE_MODERATOR, - FORUM_ROLE_COMMUNITY_TA) +from django_comment_common.models import ( + Role, FORUM_ROLE_ADMINISTRATOR, FORUM_ROLE_MODERATOR, FORUM_ROLE_COMMUNITY_TA +) from django_comment_client.utils import has_forum_access from instructor.offline_gradecalc import student_grades, offline_grades_available from instructor.views.tools import strip_if_string -from instructor_task.api import (get_running_instructor_tasks, - get_instructor_task_history, - submit_rescore_problem_for_all_students, - submit_rescore_problem_for_student, - submit_reset_problem_attempts_for_all_students, - submit_bulk_course_email) +from instructor_task.api import ( + get_running_instructor_tasks, + get_instructor_task_history, + submit_rescore_problem_for_all_students, + submit_rescore_problem_for_student, + submit_reset_problem_attempts_for_all_students, + submit_bulk_course_email +) from instructor_task.views import get_task_completion_info -from mitxmako.shortcuts import render_to_response, render_to_string +from edxmako.shortcuts import render_to_response, render_to_string from psychometrics import psychoanalyze from student.models import CourseEnrollment, CourseEnrollmentAllowed, unique_id_for_user from student.views import course_from_id @@ -133,8 +136,10 @@ def return_csv(func, datatable, file_pointer=None): else: response = file_pointer writer = csv.writer(response, dialect='excel', quotechar='"', quoting=csv.QUOTE_ALL) - writer.writerow(datatable['header']) + encoded_row = [unicode(s).encode('utf-8') for s in datatable['header']] + writer.writerow(encoded_row) for datarow in datatable['data']: + # 's' here may be an integer, float (eg score) or string (eg student name) encoded_row = [unicode(s).encode('utf-8') for s in datarow] writer.writerow(encoded_row) return response @@ -170,17 +175,19 @@ def get_student_from_identifier(unique_student_identifier): student = User.objects.get(email=unique_student_identifier) else: student = User.objects.get(username=unique_student_identifier) - msg += "Found a single student. " + msg += _u("Found a single student. ") except User.DoesNotExist: student = None - msg += "Couldn't find student with that email or username. " + msg += "{text}".format( + text=_u("Couldn't find student with that email or username.") + ) return msg, student # process actions from form POST action = request.POST.get('action', '') use_offline = request.POST.get('use_offline_grades', False) - if settings.MITX_FEATURES['ENABLE_MANUAL_GIT_RELOAD']: + if settings.FEATURES['ENABLE_MANUAL_GIT_RELOAD']: if 'GIT pull' in action: data_dir = course.data_dir log.debug('git pull {0}'.format(data_dir)) @@ -211,20 +218,20 @@ def get_student_from_identifier(unique_student_identifier): if action == 'Dump list of enrolled students' or action == 'List enrolled students': log.debug(action) datatable = get_student_grade_summary_data(request, course, course_id, get_grades=False, use_offline=use_offline) - datatable['title'] = 'List of students enrolled in {0}'.format(course_id) + datatable['title'] = _u('List of students enrolled in {0}').format(course_id) track.views.server_track(request, "list-students", {}, page="idashboard") elif 'Dump Grades' in action: log.debug(action) datatable = get_student_grade_summary_data(request, course, course_id, get_grades=True, use_offline=use_offline) - datatable['title'] = 'Summary Grades of students enrolled in {0}'.format(course_id) + datatable['title'] = _u('Summary Grades of students enrolled in {0}').format(course_id) track.views.server_track(request, "dump-grades", {}, page="idashboard") elif 'Dump all RAW grades' in action: log.debug(action) datatable = get_student_grade_summary_data(request, course, course_id, get_grades=True, get_raw_scores=True, use_offline=use_offline) - datatable['title'] = 'Raw Grades of students enrolled in {0}'.format(course_id) + datatable['title'] = _u('Raw Grades of students enrolled in {0}').format(course_id) track.views.server_track(request, "dump-grades-raw", {}, page="idashboard") elif 'Download CSV of all student grades' in action: @@ -252,14 +259,22 @@ def get_student_from_identifier(unique_student_identifier): try: instructor_task = submit_rescore_problem_for_all_students(request, course_id, problem_url) if instructor_task is None: - msg += 'Failed to create a background task for rescoring "{0}".'.format(problem_url) + msg += '{text}'.format( + text=_u('Failed to create a background task for rescoring "{0}".').format(problem_url) + ) else: track.views.server_track(request, "rescore-all-submissions", {"problem": problem_url, "course": course_id}, page="idashboard") except ItemNotFoundError as err: - msg += 'Failed to create a background task for rescoring "{0}": problem not found.'.format(problem_url) + msg += '{text}'.format( + text=_u('Failed to create a background task for rescoring "{0}": problem not found.').format(problem_url) + ) except Exception as err: log.error("Encountered exception from rescore: {0}".format(err)) - msg += 'Failed to create a background task for rescoring "{0}": {1}.'.format(problem_url, err.message) + msg += '{text}'.format( + text=_u('Failed to create a background task for rescoring "{url}": {message}.').format( + url=problem_url, message=err.message + ) + ) elif "Reset ALL students' attempts" in action: problem_urlname = request.POST.get('problem_for_all_students', '') @@ -267,15 +282,23 @@ def get_student_from_identifier(unique_student_identifier): try: instructor_task = submit_reset_problem_attempts_for_all_students(request, course_id, problem_url) if instructor_task is None: - msg += 'Failed to create a background task for resetting "{0}".'.format(problem_url) + msg += '{text}'.format( + text=_u('Failed to create a background task for resetting "{0}".').format(problem_url) + ) else: track.views.server_track(request, "reset-all-attempts", {"problem": problem_url, "course": course_id}, page="idashboard") except ItemNotFoundError as err: log.error('Failure to reset: unknown problem "{0}"'.format(err)) - msg += 'Failed to create a background task for resetting "{0}": problem not found.'.format(problem_url) + msg += '{text}'.format( + text=_u('Failed to create a background task for resetting "{0}": problem not found.').format(problem_url) + ) except Exception as err: log.error("Encountered exception from reset: {0}".format(err)) - msg += 'Failed to create a background task for resetting "{0}": {1}.'.format(problem_url, err.message) + msg += '{text}'.format( + text=_u('Failed to create a background task for resetting "{url}": {message}.').format( + url=problem_url, message=err.message + ) + ) elif "Show Background Task History for Student" in action: # put this before the non-student case, since the use of "in" will cause this to be missed @@ -316,12 +339,10 @@ def get_student_from_identifier(unique_student_identifier): course_id=course_id, module_state_key=module_state_key ) - msg += "Found module. " + msg += _u("Found module. ") except StudentModule.DoesNotExist as err: - error_msg = "Couldn't find module with that urlname: {0}. ".format( - problem_urlname - ) - msg += "" + error_msg + "({0}) ".format(err) + "" + error_msg = _u("Couldn't find module with that urlname: {url}. ").format(url=problem_urlname) + msg += "{err_msg} ({err})".format(err_msg=error_msg, err=err) log.debug(error_msg) if student_module is not None: @@ -329,7 +350,9 @@ def get_student_from_identifier(unique_student_identifier): # delete the state try: student_module.delete() - msg += "Deleted student module state for {0}!".format(module_state_key) + msg += "{text}".format( + text=_u("Deleted student module state for {state}!").format(state=module_state_key) + ) event = { "problem": module_state_key, "student": unique_student_identifier, @@ -342,10 +365,10 @@ def get_student_from_identifier(unique_student_identifier): page="idashboard" ) except Exception as err: - error_msg = "Failed to delete module state for {0}/{1}. ".format( - unique_student_identifier, problem_urlname + error_msg = _u("Failed to delete module state for {id}/{url}. ").format( + id=unique_student_identifier, url=problem_urlname ) - msg += "" + error_msg + "({0}) ".format(err) + "" + msg += "{err_msg} ({err})".format(err_msg=error_msg, err=err) log.exception(error_msg) elif "Reset student's attempts" in action: # modify the problem's state @@ -365,24 +388,32 @@ def get_student_from_identifier(unique_student_identifier): "course": course_id } track.views.server_track(request, "reset-student-attempts", event, page="idashboard") - msg += "Module state successfully reset!" + msg += "{text}".format( + text=_u("Module state successfully reset!") + ) except Exception as err: - error_msg = "Couldn't reset module state for {0}/{1}. ".format( - unique_student_identifier, problem_urlname + error_msg = _u("Couldn't reset module state for {id}/{url}. ").format( + id=unique_student_identifier, url=problem_urlname ) - msg += "" + error_msg + "({0}) ".format(err) + "" + msg += "{err_msg} ({err})".format(err_msg=error_msg, err=err) log.exception(error_msg) else: # "Rescore student's problem submission" case try: instructor_task = submit_rescore_problem_for_student(request, course_id, module_state_key, student) if instructor_task is None: - msg += 'Failed to create a background task for rescoring "{0}" for student {1}.'.format(module_state_key, unique_student_identifier) + msg += '{text}'.format( + text=_u('Failed to create a background task for rescoring "{key}" for student {id}.').format( + key=module_state_key, id=unique_student_identifier + ) + ) else: track.views.server_track(request, "rescore-student-submission", {"problem": module_state_key, "student": unique_student_identifier, "course": course_id}, page="idashboard") except Exception as err: - msg += 'Failed to create a background task for rescoring "{0}": {1}.'.format( - module_state_key, err.message + msg += '{text}'.format( + text=_u('Failed to create a background task for rescoring "{key}": {id}.').format( + key=module_state_key, id=err.message + ) ) log.exception("Encountered exception from rescore: student '{0}' problem '{1}'".format( unique_student_identifier, module_state_key @@ -397,7 +428,12 @@ def get_student_from_identifier(unique_student_identifier): if student is not None: progress_url = reverse('student_progress', kwargs={'course_id': course_id, 'student_id': student.id}) track.views.server_track(request, "get-student-progress-page", {"student": unicode(student), "instructor": unicode(request.user), "course": course_id}, page="idashboard") - msg += " Progress page for username: {1} with email address: {2}.".format(progress_url, student.username, student.email) + msg += "{text}.".format( + url=progress_url, + text=_u("Progress page for username: {username} with email address: {email}").format( + username=student.username, email=student.email + ) + ) #---------------------------------------- # export grades to remote gradebook @@ -411,7 +447,7 @@ def get_student_from_identifier(unique_student_identifier): allgrades = get_student_grade_summary_data(request, course, course_id, get_grades=True, use_offline=use_offline) assignments = [[x] for x in allgrades['assignments']] - datatable = {'header': ['Assignment Name']} + datatable = {'header': [_u('Assignment Name')]} datatable['data'] = assignments datatable['title'] = action @@ -435,27 +471,31 @@ def domatch(x): datatable = {} aname = request.POST.get('assignment_name', '') if not aname: - msg += "Please enter an assignment name" + msg += "{text}".format(text=_u("Please enter an assignment name")) else: allgrades = get_student_grade_summary_data(request, course, course_id, get_grades=True, use_offline=use_offline) if aname not in allgrades['assignments']: - msg += "Invalid assignment name '%s'" % aname + msg += "{text}".format( + text=_u("Invalid assignment name '{name}'").format(name=aname) + ) else: aidx = allgrades['assignments'].index(aname) - datatable = {'header': ['External email', aname]} + datatable = {'header': [_u('External email'), aname]} ddata = [] for x in allgrades['students']: # do one by one in case there is a student who has only partial grades try: ddata.append([x.email, x.grades[aidx]]) except IndexError: - log.debug('No grade for assignment %s (%s) for student %s', aidx, aname, x.email) + log.debug('No grade for assignment {idx} ({name}) for student {email}'.format( + idx=aidx, name=aname, email=x.email) + ) datatable['data'] = ddata - datatable['title'] = 'Grades for assignment "%s"' % aname + datatable['title'] = _u('Grades for assignment "{name}"').format(name=aname) if 'Export CSV' in action: # generate and return CSV file - return return_csv('grades %s.csv' % aname, datatable) + return return_csv('grades {name}.csv'.format(name=aname), datatable) elif 'remote gradebook' in action: file_pointer = StringIO() @@ -470,12 +510,12 @@ def domatch(x): elif 'List course staff' in action: role = CourseStaffRole(course.location) - datatable = _role_members_table(role, "List of Staff", course_id) + datatable = _role_members_table(role, _u("List of Staff"), course_id) track.views.server_track(request, "list-staff", {}, page="idashboard") elif 'List course instructors' in action and GlobalStaff().has_user(request.user): role = CourseInstructorRole(course.location) - datatable = _role_members_table(role, "List of Instructors", course_id) + datatable = _role_members_table(role, _u("List of Instructors"), course_id) track.views.server_track(request, "list-instructors", {}, page="idashboard") elif action == 'Add course staff': @@ -515,8 +555,8 @@ def getdat(u): return [u.username, u.email] + [getattr(p, x, '') for x in profkeys] datatable['data'] = [getdat(u) for u in enrolled_students] - datatable['title'] = 'Student profile data for course %s' % course_id - return return_csv('profiledata_%s.csv' % course_id, datatable) + datatable['title'] = _u('Student profile data for course {couse_id}').format(course_id = course_id) + return return_csv('profiledata_{course_id}.csv'.format(course_id = course_id), datatable) elif 'Download CSV of all responses to problem' in action: problem_to_dump = request.POST.get('problem_to_dump', '') @@ -529,17 +569,19 @@ def getdat(u): smdat = StudentModule.objects.filter(course_id=course_id, module_state_key=module_state_key) smdat = smdat.order_by('student') - msg += "Found %d records to dump " % len(smdat) + msg += _u("Found {num} records to dump.").format(num=smdat) except Exception as err: - msg += "Couldn't find module with that urlname. " - msg += "
    %s
    " % escape(err) + msg += "{text}
    {err}
    ".format( + text=_u("Couldn't find module with that urlname."), + err=escape(err) + ) smdat = [] if smdat: datatable = {'header': ['username', 'state']} datatable['data'] = [[x.student.username, x.state] for x in smdat] - datatable['title'] = 'Student state for problem %s' % problem_to_dump - return return_csv('student_state_from_%s.csv' % problem_to_dump, datatable) + datatable['title'] = _u('Student state for problem {problem}').format(problem = problem_to_dump) + return return_csv('student_state_from_{problem}.csv'.format(problem = problem_to_dump), datatable) elif 'Download CSV of all student anonymized IDs' in action: students = User.objects.filter( @@ -555,7 +597,7 @@ def getdat(u): elif 'List beta testers' in action: role = CourseBetaTesterRole(course.location) - datatable = _role_members_table(role, "List of Beta Testers", course_id) + datatable = _role_members_table(role, _u("List of Beta Testers"), course_id) track.views.server_track(request, "list-beta-testers", {}, page="idashboard") elif action == 'Add beta testers': @@ -694,9 +736,15 @@ def getdat(u): else: # If sending the task succeeds, deliver a success message to the user. if email_to_option == "all": - email_msg = '

    Your email was successfully queued for sending. Please note that for large classes, it may take up to an hour (or more, if other courses are simultaneously sending email) to send all emails.

    ' + text = _u( + "Your email was successfully queued for sending. " + "Please note that for large classes, it may take up to an hour " + "(or more, if other courses are simultaneously sending email) " + "to send all emails." + ) else: - email_msg = '

    Your email was successfully queued for sending.

    ' + text = _u('Your email was successfully queued for sending.') + email_msg = '

    {text}

    '.format(text=text) elif "Show Background Email Task History" in action: message, datatable = get_background_task_table(course_id, task_type='bulk_course_email') @@ -763,10 +811,14 @@ def get_analytics_result(analytics_name): # offline grades? if use_offline: - msg += "
    Grades from %s" % offline_grades_available(course_id) + msg += "
    {text}".format( + text=_u("Grades from {course_id}").format( + course_id=offline_grades_available(course_id) + ) + ) # generate list of pending background tasks - if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): + if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): instructor_tasks = get_running_instructor_tasks(course_id) else: instructor_tasks = None @@ -794,7 +846,7 @@ def get_analytics_result(analytics_name): # 1. Feature flag is on # 2. We have explicitly enabled email for the given course via django-admin # 3. It is NOT an XML course - if settings.MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] and \ + if settings.FEATURES['ENABLE_INSTRUCTOR_EMAIL'] and \ CourseAuthorization.instructor_email_enabled(course_id) and is_studio_course: show_email_tab = True @@ -805,7 +857,7 @@ def get_analytics_result(analytics_name): # disable buttons for large courses disable_buttons = False - max_enrollment_for_buttons = settings.MITX_FEATURES.get("MAX_ENROLLMENT_INSTR_BUTTONS") + max_enrollment_for_buttons = settings.FEATURES.get("MAX_ENROLLMENT_INSTR_BUTTONS") if max_enrollment_for_buttons is not None: disable_buttons = enrollment_number > max_enrollment_for_buttons @@ -841,7 +893,7 @@ def get_analytics_result(analytics_name): 'disable_buttons': disable_buttons } - if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BETA_DASHBOARD'): + if settings.FEATURES.get('ENABLE_INSTRUCTOR_BETA_DASHBOARD'): context['beta_dashboard_url'] = reverse('instructor_dashboard_2', kwargs={'course_id': course_id}) return render_to_response('courseware/instructor_dashboard.html', context) @@ -853,17 +905,17 @@ def _do_remote_gradebook(user, course, action, args=None, files=None): ''' rg = course.remote_gradebook if not rg: - msg = "No remote gradebook defined in course metadata" + msg = _u("No remote gradebook defined in course metadata") return msg, {} - rgurl = settings.MITX_FEATURES.get('REMOTE_GRADEBOOK_URL', '') + rgurl = settings.FEATURES.get('REMOTE_GRADEBOOK_URL', '') if not rgurl: - msg = "No remote gradebook url defined in settings.MITX_FEATURES" + msg = _u("No remote gradebook url defined in settings.FEATURES") return msg, {} rgname = rg.get('name', '') if not rgname: - msg = "No gradebook name defined in course remote_gradebook metadata" + msg = _u("No gradebook name defined in course remote_gradebook metadata") return msg, {} if args is None: @@ -875,19 +927,19 @@ def _do_remote_gradebook(user, course, action, args=None, files=None): resp = requests.post(rgurl, data=data, verify=False, files=files) retdict = json.loads(resp.content) except Exception as err: - msg = "Failed to communicate with gradebook server at %s
    " % rgurl - msg += "Error: %s" % err - msg += "
    resp=%s" % resp.content - msg += "
    data=%s" % data + msg = _u("Failed to communicate with gradebook server at {url}").format(url = rgurl) + "
    " + msg += _u("Error: {err}").format(err = err) + msg += "
    resp={resp}".format(resp = resp.content) + msg += "
    data={data}".format(data = data) return msg, {} - msg = '
    %s
    ' % retdict['msg'].replace('\n', '
    ') + msg = '
    {msg}
    '.format(msg = retdict['msg'].replace('\n', '
    ')) retdata = retdict['data'] # a list of dicts if retdata: datatable = {'header': retdata[0].keys()} datatable['data'] = [x.values() for x in retdata] - datatable['title'] = 'Remote gradebook response for %s' % action + datatable['title'] = _u('Remote gradebook response for {action}').format(action = action) datatable['retdata'] = retdata else: datatable = {} @@ -906,13 +958,13 @@ def _list_course_forum_members(course_id, rolename, datatable): Returns message status string to append to displayed message, if role is unknown. """ # make sure datatable is set up properly for display first, before checking for errors - datatable['header'] = ['Username', 'Full name', 'Roles'] - datatable['title'] = 'List of Forum {0}s in course {1}'.format(rolename, course_id) + datatable['header'] = [_u('Username'), _u('Full name'), _u('Roles')] + datatable['title'] = _u('List of Forum {name}s in course {id}').format(name = rolename, id = course_id) datatable['data'] = [] try: role = Role.objects.get(name=rolename, course_id=course_id) except Role.DoesNotExist: - return 'Error: unknown rolename "{0}"'.format(rolename) + return '' + _u('Error: unknown rolename "{0}"').format(rolename) + '' uset = role.users.all().order_by('username') msg = 'Role = {0}'.format(rolename) log.debug('role={0}'.format(rolename)) @@ -936,11 +988,11 @@ def _update_forum_role_membership(uname, course, rolename, add_or_remove): try: user = User.objects.get(username=uname) except User.DoesNotExist: - return 'Error: unknown username "{0}"'.format(uname) + return '' + _u('Error: unknown username "{0}"').format(uname) + '' try: role = Role.objects.get(name=rolename, course_id=course.id) except Role.DoesNotExist: - return 'Error: unknown rolename "{0}"'.format(rolename) + return '' + _u('Error: unknown rolename "{0}"').format(rolename) + '' # check whether role already has the specified user: alreadyexists = role.users.filter(username=uname).exists() @@ -948,19 +1000,19 @@ def _update_forum_role_membership(uname, course, rolename, add_or_remove): log.debug('rolename={0}'.format(rolename)) if add_or_remove == FORUM_ROLE_REMOVE: if not alreadyexists: - msg = 'Error: user "{0}" does not have rolename "{1}", cannot remove'.format(uname, rolename) + msg = '' + _u('Error: user "{0}" does not have rolename "{1}", cannot remove').format(uname, rolename) + '' else: user.roles.remove(role) - msg = 'Removed "{0}" from "{1}" forum role = "{2}"'.format(user, course.id, rolename) + msg = '' + _u('Removed "{0}" from "{1}" forum role = "{2}"').format(user, course.id, rolename) + '' else: if alreadyexists: - msg = 'Error: user "{0}" already has rolename "{1}", cannot add'.format(uname, rolename) + msg = '' + _u('Error: user "{0}" already has rolename "{1}", cannot add').format(uname, rolename) + '' else: if (rolename == FORUM_ROLE_ADMINISTRATOR and not has_access(user, course, 'staff')): - msg = 'Error: user "{0}" should first be added as staff before adding as a forum administrator, cannot add'.format(uname) + msg = '' + _u('Error: user "{0}" should first be added as staff before adding as a forum administrator, cannot add').format(uname) + '' else: user.roles.add(role) - msg = 'Added "{0}" to "{1}" forum role = "{2}"'.format(user, course.id, rolename) + msg = '' + _u('Added "{0}" to "{1}" forum role = "{2}"').format(user, course.id, rolename) + '' return msg @@ -980,9 +1032,9 @@ def _role_members_table(role, title, course_id): 'title': "{title} in course {course}" """ uset = role.users_with_role() - datatable = {'header': ['Username', 'Full name']} + datatable = {'header': [_u('Username'), _u('Full name')]} datatable['data'] = [[x.username, x.profile.name] for x in uset] - datatable['title'] = '{0} in course {1}'.format(title, course_id) + datatable['title'] = _u('{0} in course {1}').format(title, course_id) return datatable @@ -1105,7 +1157,7 @@ def get_student_grade_summary_data(request, course, course_id, get_grades=True, courseenrollment__is_active=1, ).prefetch_related("groups").order_by('username') - header = ['ID', 'Username', 'Full Name', 'edX email', 'External email'] + header = [_u('ID'), _u('Username'), _u('Full Name'), _u('edX email'), _u('External email')] assignments = [] if get_grades and enrolled_students.count() > 0: # just to construct the header @@ -1290,7 +1342,7 @@ def _do_enroll_students(course, course_id, students, overload=False, auto_enroll datatable = {'header': ['StudentEmail', 'action']} datatable['data'] = [[x, status[x]] for x in sorted(status)] - datatable['title'] = 'Enrollment of students' + datatable['title'] = _u('Enrollment of students') def sf(stat): return [x for x in status if status[x] == stat] @@ -1363,7 +1415,7 @@ def _do_unenroll_students(course_id, students, email_students=False): datatable = {'header': ['StudentEmail', 'action']} datatable['data'] = [[x, status[x]] for x in sorted(status)] - datatable['title'] = 'Un-enrollment of students' + datatable['title'] = _u('Un-enrollment of students') data = dict(datatable=datatable) return data @@ -1546,10 +1598,10 @@ def get_background_task_table(course_id, problem_url=None, student=None, task_ty if problem_url is None: msg += 'Failed to find any background tasks for course "{course}".'.format(course=course_id) elif student is not None: - template = 'Failed to find any background tasks for course "{course}", module "{problem}" and student "{student}".' + template = '' + _u('Failed to find any background tasks for course "{course}", module "{problem}" and student "{student}".') + '' msg += template.format(course=course_id, problem=problem_url, student=student.username) else: - msg += 'Failed to find any background tasks for course "{course}" and module "{problem}".'.format(course=course_id, problem=problem_url) + msg += '' + _u('Failed to find any background tasks for course "{course}" and module "{problem}".').format(course=course_id, problem=problem_url) + '' else: datatable['header'] = ["Task Type", "Task Id", diff --git a/lms/djangoapps/instructor_task/tasks_helper.py b/lms/djangoapps/instructor_task/tasks_helper.py index 06941e7fdf7e..23d51a9ad7bc 100644 --- a/lms/djangoapps/instructor_task/tasks_helper.py +++ b/lms/djangoapps/instructor_task/tasks_helper.py @@ -523,7 +523,8 @@ def update_task_progress(): # We were able to successfully grade this student for this course. num_succeeded += 1 if not header: - header = [section['label'] for section in gradeset[u'section_breakdown']] + # Encode the header row in utf-8 encoding in case there are unicode characters + header = [section['label'].encode('utf-8') for section in gradeset[u'section_breakdown']] rows.append(["id", "email", "username", "grade"] + header) percents = { diff --git a/lms/djangoapps/instructor_task/tests/factories.py b/lms/djangoapps/instructor_task/tests/factories.py index e54c007a817a..8cb982560dff 100644 --- a/lms/djangoapps/instructor_task/tests/factories.py +++ b/lms/djangoapps/instructor_task/tests/factories.py @@ -1,6 +1,7 @@ import json -from factory import DjangoModelFactory, SubFactory +import factory +from factory.django import DjangoModelFactory from student.tests.factories import UserFactory as StudentUserFactory from instructor_task.models import InstructorTask from celery.states import PENDING @@ -16,4 +17,4 @@ class InstructorTaskFactory(DjangoModelFactory): task_id = None task_state = PENDING task_output = None - requester = SubFactory(StudentUserFactory) + requester = factory.SubFactory(StudentUserFactory) diff --git a/lms/djangoapps/licenses/models.py b/lms/djangoapps/licenses/models.py index db24126a8e25..f91048d269e2 100644 --- a/lms/djangoapps/licenses/models.py +++ b/lms/djangoapps/licenses/models.py @@ -4,7 +4,7 @@ from student.models import User -log = logging.getLogger("mitx.licenses") +log = logging.getLogger("edx.licenses") class CourseSoftware(models.Model): diff --git a/lms/djangoapps/licenses/tests.py b/lms/djangoapps/licenses/tests.py index 4298bec81bda..a416c5945509 100644 --- a/lms/djangoapps/licenses/tests.py +++ b/lms/djangoapps/licenses/tests.py @@ -5,7 +5,8 @@ from uuid import uuid4 from random import shuffle from tempfile import NamedTemporaryFile -from factory import DjangoModelFactory, SubFactory +import factory +from factory.django import DjangoModelFactory from django.test import TestCase from django.test.client import Client @@ -51,7 +52,7 @@ class UserLicenseFactory(DjangoModelFactory): FACTORY_FOR = UserLicense user = None - software = SubFactory(CourseSoftwareFactory) + software = factory.SubFactory(CourseSoftwareFactory) serial = SERIAL_1 diff --git a/lms/djangoapps/licenses/views.py b/lms/djangoapps/licenses/views.py index 1c1a80ed3182..657d6cd0c7ee 100644 --- a/lms/djangoapps/licenses/views.py +++ b/lms/djangoapps/licenses/views.py @@ -5,7 +5,7 @@ from collections import namedtuple, defaultdict -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from django.contrib.auth.decorators import login_required from django.contrib.auth.models import User @@ -16,7 +16,7 @@ from licenses.models import get_courses_licenses, get_or_create_license, get_license -log = logging.getLogger("mitx.licenses") +log = logging.getLogger("edx.licenses") License = namedtuple('License', 'software serial') diff --git a/lms/djangoapps/lms_migration/migrate.py b/lms/djangoapps/lms_migration/migrate.py index d028ce8e5a83..d00030bd43c8 100644 --- a/lms/djangoapps/lms_migration/migrate.py +++ b/lms/djangoapps/lms_migration/migrate.py @@ -17,7 +17,7 @@ except ImportError: from django.contrib.csrf.middleware import csrf_exempt -log = logging.getLogger("mitx.lms_migrate") +log = logging.getLogger("edx.lms_migrate") LOCAL_DEBUG = True ALLOWED_IPS = settings.LMS_MIGRATION_ALLOWED_IPS @@ -118,7 +118,7 @@ def manage_modulestores(request, reload_dir=None, commit_id=None): html += '
      ' for cdir, course in def_ms.courses.items(): html += '
    1. %s (%s)
      2. ' % ( - settings.MITX_ROOT_URL, + settings.EDX_ROOT_URL, escape(cdir), escape(cdir), course.location.url() diff --git a/lms/djangoapps/multicourse/views.py b/lms/djangoapps/multicourse/views.py index da9ccb77a665..7f313373a813 100644 --- a/lms/djangoapps/multicourse/views.py +++ b/lms/djangoapps/multicourse/views.py @@ -1,14 +1,14 @@ from django.conf import settings -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from multicourse import multicourse_settings -def mitxhome(request): +def edxhome(request): ''' Home page (link from main header). List of courses. ''' if settings.DEBUG: - print "[djangoapps.multicourse.mitxhome] MITX_ROOT_URL = " + settings.MITX_ROOT_URL + print "[djangoapps.multicourse.edxhome] EDX_ROOT_URL = " + settings.EDX_ROOT_URL if settings.ENABLE_MULTICOURSE: context = {'courseinfo': multicourse_settings.COURSE_SETTINGS} - return render_to_response("mitxhome.html", context) + return render_to_response("edXhome.html", context) return info(request) diff --git a/lms/djangoapps/notes/utils.py b/lms/djangoapps/notes/utils.py index e6e784ce4966..c34020694564 100644 --- a/lms/djangoapps/notes/utils.py +++ b/lms/djangoapps/notes/utils.py @@ -7,11 +7,11 @@ def notes_enabled_for_course(course): Returns True if the notes app is enabled for the course, False otherwise. In order for the app to be enabled it must be: - 1) enabled globally via MITX_FEATURES. + 1) enabled globally via FEATURES. 2) present in the course tab configuration. ''' tab_found = next((True for t in course.tabs if t['type'] == 'notes'), False) - feature_enabled = settings.MITX_FEATURES.get('ENABLE_STUDENT_NOTES') + feature_enabled = settings.FEATURES.get('ENABLE_STUDENT_NOTES') return feature_enabled and tab_found diff --git a/lms/djangoapps/notes/views.py b/lms/djangoapps/notes/views.py index 01671b7ccdab..bf57f80c3d48 100644 --- a/lms/djangoapps/notes/views.py +++ b/lms/djangoapps/notes/views.py @@ -1,6 +1,6 @@ from django.contrib.auth.decorators import login_required from django.http import Http404 -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from courseware.courses import get_course_with_access from notes.models import Note from notes.utils import notes_enabled_for_course diff --git a/lms/djangoapps/notification_prefs/views.py b/lms/djangoapps/notification_prefs/views.py index 6be5b8f76647..68e8c875daf2 100644 --- a/lms/djangoapps/notification_prefs/views.py +++ b/lms/djangoapps/notification_prefs/views.py @@ -10,7 +10,7 @@ from django.http import Http404, HttpResponse from django.views.decorators.http import require_GET, require_POST -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from notification_prefs import NOTIFICATION_PREF_KEY from user_api.models import UserPreference diff --git a/lms/djangoapps/open_ended_grading/open_ended_notifications.py b/lms/djangoapps/open_ended_grading/open_ended_notifications.py index c4580dd30436..e99f51283c78 100644 --- a/lms/djangoapps/open_ended_grading/open_ended_notifications.py +++ b/lms/djangoapps/open_ended_grading/open_ended_notifications.py @@ -9,7 +9,7 @@ from courseware.access import has_access from lms.lib.xblock.runtime import LmsModuleSystem -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from student.models import unique_id_for_user from util.cache import cache diff --git a/lms/djangoapps/open_ended_grading/staff_grading_service.py b/lms/djangoapps/open_ended_grading/staff_grading_service.py index 1322f3f06933..ba8009ece3c3 100644 --- a/lms/djangoapps/open_ended_grading/staff_grading_service.py +++ b/lms/djangoapps/open_ended_grading/staff_grading_service.py @@ -13,7 +13,7 @@ from courseware.access import has_access from lms.lib.xblock.runtime import LmsModuleSystem -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from student.models import unique_id_for_user from util.json_request import expect_json diff --git a/lms/djangoapps/open_ended_grading/tests.py b/lms/djangoapps/open_ended_grading/tests.py index ad6298d71a9f..7e4a805fc9e4 100644 --- a/lms/djangoapps/open_ended_grading/tests.py +++ b/lms/djangoapps/open_ended_grading/tests.py @@ -27,7 +27,7 @@ from courseware.tests.modulestore_config import TEST_DATA_MIXED_MODULESTORE from lms.lib.xblock.runtime import LmsModuleSystem from courseware.roles import CourseStaffRole -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from student.models import unique_id_for_user from open_ended_grading import staff_grading_service, views, utils diff --git a/lms/djangoapps/open_ended_grading/utils.py b/lms/djangoapps/open_ended_grading/utils.py index bfde229e9c85..01d58fb479d4 100644 --- a/lms/djangoapps/open_ended_grading/utils.py +++ b/lms/djangoapps/open_ended_grading/utils.py @@ -11,7 +11,7 @@ from django.conf import settings from lms.lib.xblock.runtime import LmsModuleSystem -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string log = logging.getLogger(__name__) diff --git a/lms/djangoapps/open_ended_grading/views.py b/lms/djangoapps/open_ended_grading/views.py index e8002e0883f7..02fb28790544 100644 --- a/lms/djangoapps/open_ended_grading/views.py +++ b/lms/djangoapps/open_ended_grading/views.py @@ -2,7 +2,7 @@ from django.conf import settings from django.views.decorators.cache import cache_control -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from django.core.urlresolvers import reverse from student.models import unique_id_for_user @@ -16,10 +16,11 @@ from xmodule.modulestore.django import modulestore from xmodule.modulestore import search -from xmodule.modulestore.exceptions import ItemNotFoundError, NoPathToItem +from xmodule.modulestore import Location +from xmodule.modulestore.exceptions import NoPathToItem from django.http import HttpResponse, Http404, HttpResponseRedirect -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from django.utils.translation import ugettext as _ from open_ended_grading.utils import (STAFF_ERROR_MESSAGE, STUDENT_ERROR_MESSAGE, @@ -92,7 +93,7 @@ def find_peer_grading_module(course): # Get the course id and split it. course_id_parts = course.id.split("/") # Get the peer grading modules currently in the course. Explicitly specify the course id to avoid issues with different runs. - items = modulestore().get_items(['i4x', course_id_parts[0], course_id_parts[1], 'peergrading', None], + items = modulestore().get_items(Location('i4x', course_id_parts[0], course_id_parts[1], 'peergrading', None), course_id=course.id) #See if any of the modules are centralized modules (ie display info from multiple problems) items = [i for i in items if not getattr(i, "use_for_single_location", True)] diff --git a/lms/djangoapps/psychometrics/psychoanalyze.py b/lms/djangoapps/psychometrics/psychoanalyze.py index c6e66445a48d..dac10e0b070c 100644 --- a/lms/djangoapps/psychometrics/psychoanalyze.py +++ b/lms/djangoapps/psychometrics/psychoanalyze.py @@ -18,7 +18,7 @@ from courseware.models import StudentModule from pytz import UTC -log = logging.getLogger("mitx.psychometrics") +log = logging.getLogger("edx.psychometrics") #db = "ocwtutor" # for debugging #db = "default" diff --git a/lms/djangoapps/shoppingcart/context_processor.py b/lms/djangoapps/shoppingcart/context_processor.py index b94f1cac2a39..95beb106d3d5 100644 --- a/lms/djangoapps/shoppingcart/context_processor.py +++ b/lms/djangoapps/shoppingcart/context_processor.py @@ -17,7 +17,7 @@ def user_has_cart_context_processor(request): """ return {'display_shopping_cart': ( request.user.is_authenticated() and # user is logged in and - settings.MITX_FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION') and # settings enable paid course reg and - settings.MITX_FEATURES.get('ENABLE_SHOPPING_CART') and # settings enable shopping cart and + settings.FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION') and # settings enable paid course reg and + settings.FEATURES.get('ENABLE_SHOPPING_CART') and # settings enable shopping cart and shoppingcart.models.Order.user_cart_has_items(request.user) # user's cart has items )} diff --git a/lms/djangoapps/shoppingcart/models.py b/lms/djangoapps/shoppingcart/models.py index fa77efb50f93..7647b2c48708 100644 --- a/lms/djangoapps/shoppingcart/models.py +++ b/lms/djangoapps/shoppingcart/models.py @@ -23,7 +23,7 @@ from xmodule.modulestore.exceptions import ItemNotFoundError from course_modes.models import CourseMode -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from student.views import course_from_id from student.models import CourseEnrollment, unenroll_done @@ -143,7 +143,7 @@ def purchase(self, first='', last='', street1='', street2='', city='', state='', self.bill_to_state = state self.bill_to_country = country self.bill_to_postalcode = postalcode - if settings.MITX_FEATURES['STORE_BILLING_INFO']: + if settings.FEATURES['STORE_BILLING_INFO']: self.bill_to_street1 = street1 self.bill_to_street2 = street2 self.bill_to_ccnum = ccnum @@ -164,7 +164,7 @@ def purchase(self, first='', last='', street1='', street2='', city='', state='', message = render_to_string('emails/order_confirmation_email.txt', { 'order': self, 'order_items': orderitems, - 'has_billing_info': settings.MITX_FEATURES['STORE_BILLING_INFO'] + 'has_billing_info': settings.FEATURES['STORE_BILLING_INFO'] }) try: send_mail(subject, message, @@ -557,6 +557,7 @@ def add_to_order(cls, order, course_id, cost, mode, currency='usd'): """ super(CertificateItem, cls).add_to_order(order, course_id, cost, currency=currency) + course_enrollment = CourseEnrollment.get_or_create_enrollment(order.user, course_id) # do some validation on the enrollment mode @@ -570,7 +571,7 @@ def add_to_order(cls, order, course_id, cost, mode, currency='usd'): user=order.user, course_id=course_id, course_enrollment=course_enrollment, - mode=mode + mode=mode, ) item.status = order.status item.qty = 1 @@ -595,7 +596,6 @@ def purchased_callback(self): log.exception( "Could not submit verification attempt for enrollment {}".format(self.course_enrollment) ) - self.course_enrollment.change_mode(self.mode) self.course_enrollment.activate() diff --git a/lms/djangoapps/shoppingcart/processors/CyberSource.py b/lms/djangoapps/shoppingcart/processors/CyberSource.py index 5d43482bd4c3..d6811303a1f7 100644 --- a/lms/djangoapps/shoppingcart/processors/CyberSource.py +++ b/lms/djangoapps/shoppingcart/processors/CyberSource.py @@ -13,7 +13,7 @@ from textwrap import dedent from django.conf import settings from django.utils.translation import ugettext as _ -from mitxmako.shortcuts import render_to_string +from edxmako.shortcuts import render_to_string from shoppingcart.models import Order from shoppingcart.processors.exceptions import * diff --git a/lms/djangoapps/shoppingcart/tests/payment_fake.py b/lms/djangoapps/shoppingcart/tests/payment_fake.py index fa6f40190415..0de87410ef03 100644 --- a/lms/djangoapps/shoppingcart/tests/payment_fake.py +++ b/lms/djangoapps/shoppingcart/tests/payment_fake.py @@ -15,7 +15,7 @@ from django.views.generic.base import View from django.views.decorators.csrf import csrf_exempt from django.http import HttpResponse, HttpResponseBadRequest -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response # We use the same hashing function as the software under test, diff --git a/lms/djangoapps/shoppingcart/tests/test_context_processor.py b/lms/djangoapps/shoppingcart/tests/test_context_processor.py index 4cedca8d1473..c7be12d86e51 100644 --- a/lms/djangoapps/shoppingcart/tests/test_context_processor.py +++ b/lms/djangoapps/shoppingcart/tests/test_context_processor.py @@ -33,27 +33,27 @@ def add_to_cart(self): cart = Order.get_cart_for_user(self.user) PaidCourseRegistration.add_to_order(cart, course.id) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_SHOPPING_CART': False, 'ENABLE_PAID_COURSE_REGISTRATION': True}) + @patch.dict(settings.FEATURES, {'ENABLE_SHOPPING_CART': False, 'ENABLE_PAID_COURSE_REGISTRATION': True}) def test_no_enable_shoppingcart(self): """ - Tests when MITX_FEATURES['ENABLE_SHOPPING_CART'] is not set + Tests when FEATURES['ENABLE_SHOPPING_CART'] is not set """ self.add_to_cart() self.request.user = self.user context = user_has_cart_context_processor(self.request) self.assertFalse(context['display_shopping_cart']) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': False}) + @patch.dict(settings.FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': False}) def test_no_enable_paid_course_registration(self): """ - Tests when MITX_FEATURES['ENABLE_PAID_COURSE_REGISTRATION'] is not set + Tests when FEATURES['ENABLE_PAID_COURSE_REGISTRATION'] is not set """ self.add_to_cart() self.request.user = self.user context = user_has_cart_context_processor(self.request) self.assertFalse(context['display_shopping_cart']) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': True}) + @patch.dict(settings.FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': True}) def test_anonymous_user(self): """ Tests when request.user is anonymous @@ -62,7 +62,7 @@ def test_anonymous_user(self): context = user_has_cart_context_processor(self.request) self.assertFalse(context['display_shopping_cart']) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': True}) + @patch.dict(settings.FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': True}) def test_no_items_in_cart(self): """ Tests when request.user doesn't have a cart with items @@ -71,7 +71,7 @@ def test_no_items_in_cart(self): context = user_has_cart_context_processor(self.request) self.assertFalse(context['display_shopping_cart']) - @patch.dict(settings.MITX_FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': True}) + @patch.dict(settings.FEATURES, {'ENABLE_SHOPPING_CART': True, 'ENABLE_PAID_COURSE_REGISTRATION': True}) def test_items_in_cart(self): """ Tests when request.user has a cart with items diff --git a/lms/djangoapps/shoppingcart/tests/test_models.py b/lms/djangoapps/shoppingcart/tests/test_models.py index a0161cbe0f41..5a52ca0680df 100644 --- a/lms/djangoapps/shoppingcart/tests/test_models.py +++ b/lms/djangoapps/shoppingcart/tests/test_models.py @@ -6,7 +6,7 @@ from textwrap import dedent from boto.exception import BotoServerError # this is a super-class of SESError and catches connection errors -from mock import patch, MagicMock +from mock import patch, MagicMock, sentinel from django.core import mail from django.conf import settings from django.db import DatabaseError @@ -161,7 +161,7 @@ def purchase_with_data(self, cart): ) @patch('shoppingcart.models.render_to_string') - @patch.dict(settings.MITX_FEATURES, {'STORE_BILLING_INFO': True}) + @patch.dict(settings.FEATURES, {'STORE_BILLING_INFO': True}) def test_billing_info_storage_on(self, render): cart = Order.get_cart_for_user(self.user) self.purchase_with_data(cart) @@ -179,7 +179,7 @@ def test_billing_info_storage_on(self, render): self.assertTrue(context['has_billing_info']) @patch('shoppingcart.models.render_to_string') - @patch.dict(settings.MITX_FEATURES, {'STORE_BILLING_INFO': False}) + @patch.dict(settings.FEATURES, {'STORE_BILLING_INFO': False}) def test_billing_info_storage_off(self, render): cart = Order.get_cart_for_user(self.user) self.purchase_with_data(cart) @@ -425,12 +425,21 @@ def setUp(self): min_price=self.cost) course_mode.save() + patcher = patch('student.models.server_track') + self.mock_server_track = patcher.start() + self.addCleanup(patcher.stop) + crum_patcher = patch('student.models.crum.get_current_request') + self.mock_get_current_request = crum_patcher.start() + self.addCleanup(crum_patcher.stop) + self.mock_get_current_request.return_value = sentinel.request + def test_existing_enrollment(self): CourseEnrollment.enroll(self.user, self.course_id) cart = Order.get_cart_for_user(user=self.user) CertificateItem.add_to_order(cart, self.course_id, self.cost, 'verified') # verify that we are still enrolled self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course_id)) + self.mock_server_track.reset_mock() cart.purchase() enrollment = CourseEnrollment.objects.get(user=self.user, course_id=self.course_id) self.assertEquals(enrollment.mode, u'verified') diff --git a/lms/djangoapps/shoppingcart/tests/test_views.py b/lms/djangoapps/shoppingcart/tests/test_views.py index 0451277ce235..d1ab9ab24fee 100644 --- a/lms/djangoapps/shoppingcart/tests/test_views.py +++ b/lms/djangoapps/shoppingcart/tests/test_views.py @@ -18,9 +18,9 @@ from student.tests.factories import UserFactory from student.models import CourseEnrollment from course_modes.models import CourseMode -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from shoppingcart.processors import render_purchase_form_html -from mock import patch, Mock +from mock import patch, Mock, sentinel def mock_render_purchase_form_html(*args, **kwargs): @@ -39,6 +39,8 @@ def mock_render_to_response(*args, **kwargs): @override_settings(MODULESTORE=TEST_DATA_MONGO_MODULESTORE) class ShoppingCartViewsTests(ModuleStoreTestCase): def setUp(self): + patcher = patch('student.models.server_track') + self.mock_server_track = patcher.start() self.user = UserFactory.create() self.user.set_password('password') self.user.save() @@ -53,6 +55,7 @@ def setUp(self): self.verified_course_id = 'org/test/Test_Course' CourseFactory.create(org='org', number='test', run='course1', display_name='Test Course') self.cart = Order.get_cart_for_user(self.user) + self.addCleanup(patcher.stop) def login_user(self): self.client.login(username=self.user.username, password="password") @@ -83,6 +86,7 @@ def test_add_nonexistent_course_to_cart(self): def test_add_course_to_cart_success(self): self.login_user() + reverse('shoppingcart.views.add_course_to_cart', args=[self.course_id]) resp = self.client.post(reverse('shoppingcart.views.add_course_to_cart', args=[self.course_id])) self.assertEqual(resp.status_code, 200) self.assertTrue(PaidCourseRegistration.contained_in_order(self.cart, self.course_id)) @@ -202,6 +206,55 @@ def test_show_receipt_success(self): self.assertIn(cert_item, context['order_items']) self.assertFalse(context['any_refunds']) + @patch('shoppingcart.views.render_to_response', render_mock) + def test_show_receipt_success_with_upgrade(self): + + reg_item = PaidCourseRegistration.add_to_order(self.cart, self.course_id) + cert_item = CertificateItem.add_to_order(self.cart, self.verified_course_id, self.cost, 'honor') + self.cart.purchase(first='FirstNameTesting123', street1='StreetTesting123') + + self.login_user() + + # When we come from the upgrade flow, we'll have a session variable showing that + s = self.client.session + s['attempting_upgrade'] = True + s.save() + + self.mock_server_track.reset_mock() + resp = self.client.get(reverse('shoppingcart.views.show_receipt', args=[self.cart.id])) + + # Once they've upgraded, they're no longer *attempting* to upgrade + attempting_upgrade = self.client.session.get('attempting_upgrade', False) + self.assertFalse(attempting_upgrade) + + self.assertEqual(resp.status_code, 200) + self.assertIn('FirstNameTesting123', resp.content) + self.assertIn('80.00', resp.content) + + + ((template, context), _) = render_mock.call_args + + # When we come from the upgrade flow, we get these context variables + + + self.assertEqual(template, 'shoppingcart/receipt.html') + self.assertEqual(context['order'], self.cart) + self.assertIn(reg_item, context['order_items']) + self.assertIn(cert_item, context['order_items']) + self.assertFalse(context['any_refunds']) + + course_enrollment = CourseEnrollment.get_or_create_enrollment(self.user, self.course_id) + course_enrollment.emit_event('edx.course.enrollment.upgrade.succeeded') + self.mock_server_track.assert_any_call( + None, + 'edx.course.enrollment.upgrade.succeeded', + { + 'user_id': course_enrollment.user.id, + 'course_id': course_enrollment.course_id, + 'mode': course_enrollment.mode + } + ) + @patch('shoppingcart.views.render_to_response', render_mock) def test_show_receipt_success_refund(self): reg_item = PaidCourseRegistration.add_to_order(self.cart, self.course_id) diff --git a/lms/djangoapps/shoppingcart/urls.py b/lms/djangoapps/shoppingcart/urls.py index 3653c9152469..b9797e9a5b37 100644 --- a/lms/djangoapps/shoppingcart/urls.py +++ b/lms/djangoapps/shoppingcart/urls.py @@ -5,7 +5,7 @@ url(r'^postpay_callback/$', 'postpay_callback'), # Both the ~accept and ~reject callback pages are handled here url(r'^receipt/(?P[0-9]*)/$', 'show_receipt'), ) -if settings.MITX_FEATURES['ENABLE_SHOPPING_CART']: +if settings.FEATURES['ENABLE_SHOPPING_CART']: urlpatterns += patterns( 'shoppingcart.views', url(r'^$', 'show_cart'), @@ -15,7 +15,7 @@ url(r'^csv_report/$', 'csv_report', name='payment_csv_report'), ) -if settings.MITX_FEATURES.get('ENABLE_PAYMENT_FAKE'): +if settings.FEATURES.get('ENABLE_PAYMENT_FAKE'): from shoppingcart.tests.payment_fake import PaymentFakeView urlpatterns += patterns( 'shoppingcart.tests.payment_fake', diff --git a/lms/djangoapps/shoppingcart/views.py b/lms/djangoapps/shoppingcart/views.py index ad7ef6b0800a..22bccbf28cf4 100644 --- a/lms/djangoapps/shoppingcart/views.py +++ b/lms/djangoapps/shoppingcart/views.py @@ -10,13 +10,16 @@ from django.core.urlresolvers import reverse from django.views.decorators.csrf import csrf_exempt from django.contrib.auth.decorators import login_required -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from .models import Order, PaidCourseRegistration, OrderItem +from student.models import CourseEnrollment from .processors import process_postpay_callback, render_purchase_form_html from .exceptions import ItemAlreadyInCartException, AlreadyEnrolledInCourseException, CourseDoesNotExistException log = logging.getLogger("shoppingcart") +EVENT_NAME_USER_UPGRADED = 'edx.course.enrollment.upgrade.succeeded' + @require_POST def add_course_to_cart(request, course_id): @@ -124,6 +127,13 @@ def show_receipt(request, ordernum): receipt_template = order_items[0].single_item_receipt_template context.update(order_items[0].single_item_receipt_context) + # Only orders where order_items.count() == 1 might be attempting to upgrade + attempting_upgrade = request.session.get('attempting_upgrade', False) + if attempting_upgrade: + course_enrollment = CourseEnrollment.get_or_create_enrollment(request.user, order_items[0].course_id) + course_enrollment.emit_event(EVENT_NAME_USER_UPGRADED) + request.session['attempting_upgrade'] = False + return render_to_response(receipt_template, context) diff --git a/lms/djangoapps/static_template_view/views.py b/lms/djangoapps/static_template_view/views.py index e5a8c43ca86a..4cff3c77ac71 100644 --- a/lms/djangoapps/static_template_view/views.py +++ b/lms/djangoapps/static_template_view/views.py @@ -3,7 +3,7 @@ # List of valid templates is explicitly managed for (short-term) # security reasons. -from mitxmako.shortcuts import render_to_response, render_to_string +from edxmako.shortcuts import render_to_response, render_to_string from mako.exceptions import TopLevelLookupException from django.shortcuts import redirect from django.conf import settings diff --git a/lms/djangoapps/staticbook/views.py b/lms/djangoapps/staticbook/views.py index f73cfb6e5bb3..db9dce87dd16 100644 --- a/lms/djangoapps/staticbook/views.py +++ b/lms/djangoapps/staticbook/views.py @@ -4,7 +4,7 @@ from django.contrib.auth.decorators import login_required from django.http import Http404 -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from courseware.access import has_access from courseware.courses import get_course_with_access diff --git a/lms/djangoapps/user_api/tests/factories.py b/lms/djangoapps/user_api/tests/factories.py index 97cc12df1268..ee2609cb5beb 100644 --- a/lms/djangoapps/user_api/tests/factories.py +++ b/lms/djangoapps/user_api/tests/factories.py @@ -1,4 +1,4 @@ -from factory import DjangoModelFactory +from factory.django import DjangoModelFactory from user_api.models import UserPreference diff --git a/lms/djangoapps/verify_student/models.py b/lms/djangoapps/verify_student/models.py index 523e8393a40b..dccbdb430aeb 100644 --- a/lms/djangoapps/verify_student/models.py +++ b/lms/djangoapps/verify_student/models.py @@ -477,7 +477,7 @@ def upload_face_image(self, img_data): # developing and aren't interested in working on student identity # verification functionality. If you do want to work on it, you have to # explicitly enable these in your private settings. - if settings.MITX_FEATURES.get('AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'): + if settings.FEATURES.get('AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'): return aes_key_str = settings.VERIFY_STUDENT["SOFTWARE_SECURE"]["FACE_IMAGE_AES_KEY"] @@ -502,7 +502,7 @@ def upload_photo_id_image(self, img_data): # developing and aren't interested in working on student identity # verification functionality. If you do want to work on it, you have to # explicitly enable these in your private settings. - if settings.MITX_FEATURES.get('AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'): + if settings.FEATURES.get('AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'): return aes_key = random_aes_key() @@ -670,7 +670,7 @@ def send_request(self): # create the message because that would require encryption and message # signing that rely on settings.VERIFY_STUDENT values that aren't set # in dev. So we just pretend like we successfully posted - if settings.MITX_FEATURES.get('AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'): + if settings.FEATURES.get('AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'): fake_response = requests.Response() fake_response.status_code = 200 return fake_response diff --git a/lms/djangoapps/verify_student/tests/test_views.py b/lms/djangoapps/verify_student/tests/test_views.py index 43cbff15bd3b..c14f41d87b1b 100644 --- a/lms/djangoapps/verify_student/tests/test_views.py +++ b/lms/djangoapps/verify_student/tests/test_views.py @@ -99,7 +99,7 @@ def test_reverify_post_failure(self): self.assertIn('photo_reverification', template) self.assertTrue(context['error']) - @patch.dict(settings.MITX_FEATURES, {'AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING': True}) + @patch.dict(settings.FEATURES, {'AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING': True}) def test_reverify_post_success(self): url = reverse('verify_student_reverify') response = self.client.post(url, {'face_image': ',', diff --git a/lms/djangoapps/verify_student/views.py b/lms/djangoapps/verify_student/views.py index 673564e72c06..2ac798bbf203 100644 --- a/lms/djangoapps/verify_student/views.py +++ b/lms/djangoapps/verify_student/views.py @@ -6,7 +6,7 @@ import logging import decimal -from mitxmako.shortcuts import render_to_response +from edxmako.shortcuts import render_to_response from django.conf import settings from django.core.urlresolvers import reverse diff --git a/lms/envs/acceptance.py b/lms/envs/acceptance.py index 8236303161e7..6b4b5f7665c0 100644 --- a/lms/envs/acceptance.py +++ b/lms/envs/acceptance.py @@ -36,7 +36,7 @@ def seed(): modulestore_options = { 'default_class': 'xmodule.raw_module.RawDescriptor', 'fs_root': TEST_ROOT / "data", - 'render_template': 'mitxmako.shortcuts.render_to_string', + 'render_template': 'edxmako.shortcuts.render_to_string', } MODULESTORE = { @@ -93,21 +93,21 @@ def seed(): # Forums are disabled in test.py to speed up unit tests, but we do not have # per-test control for acceptance tests -MITX_FEATURES['ENABLE_DISCUSSION_SERVICE'] = True +FEATURES['ENABLE_DISCUSSION_SERVICE'] = True # Use the auto_auth workflow for creating users and logging them in -MITX_FEATURES['AUTOMATIC_AUTH_FOR_TESTING'] = True +FEATURES['AUTOMATIC_AUTH_FOR_TESTING'] = True # Enable fake payment processing page -MITX_FEATURES['ENABLE_PAYMENT_FAKE'] = True +FEATURES['ENABLE_PAYMENT_FAKE'] = True # Enable email on the instructor dash -MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] = True -MITX_FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] = False +FEATURES['ENABLE_INSTRUCTOR_EMAIL'] = True +FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] = False # Don't actually send any requests to Software Secure for student identity # verification. -MITX_FEATURES['AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'] = True +FEATURES['AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'] = True # Configure the payment processor to use the fake processing page # Since both the fake payment page and the shoppingcart app are using @@ -128,7 +128,7 @@ def seed(): # We do not yet understand why this occurs. Setting this to true is a stopgap measure USE_I18N = True -MITX_FEATURES['ENABLE_FEEDBACK_SUBMISSION'] = True +FEATURES['ENABLE_FEEDBACK_SUBMISSION'] = True FEEDBACK_SUBMISSION_EMAIL = 'dummy@example.com' # Include the lettuce app for acceptance testing, including the 'harvest' django-admin command diff --git a/lms/envs/aws.py b/lms/envs/aws.py index 2e19887bf9c0..8f39618fcb45 100644 --- a/lms/envs/aws.py +++ b/lms/envs/aws.py @@ -44,7 +44,7 @@ DEFAULT_FILE_STORAGE = 'storages.backends.s3boto.S3BotoStorage' # Enable Berkeley forums -MITX_FEATURES['ENABLE_DISCUSSION_SERVICE'] = True +FEATURES['ENABLE_DISCUSSION_SERVICE'] = True # IMPORTANT: With this enabled, the server must always be behind a proxy that # strips the header HTTP_X_FORWARDED_PROTO from client requests. Otherwise, @@ -124,7 +124,9 @@ STATIC_URL_BASE = ENV_TOKENS.get('STATIC_URL_BASE', None) if STATIC_URL_BASE: # collectstatic will fail if STATIC_URL is a unicode string - STATIC_URL = STATIC_URL_BASE.encode('ascii') + "/" + STATIC_URL = STATIC_URL_BASE.encode('ascii') + if not STATIC_URL.endswith("/"): + STATIC_URL += "/" PLATFORM_NAME = ENV_TOKENS.get('PLATFORM_NAME', PLATFORM_NAME) # For displaying on the receipt. At Stanford PLATFORM_NAME != MERCHANT_NAME, but PLATFORM_NAME is a fine default @@ -210,8 +212,9 @@ for app in ENV_TOKENS.get('ADDL_INSTALLED_APPS', []): INSTALLED_APPS += (app,) -for feature, value in ENV_TOKENS.get('MITX_FEATURES', {}).items(): - MITX_FEATURES[feature] = value +ENV_FEATURES = ENV_TOKENS.get('FEATURES', ENV_TOKENS.get('MITX_FEATURES', {})) +for feature, value in ENV_FEATURES.items(): + FEATURES[feature] = value WIKI_ENABLED = ENV_TOKENS.get('WIKI_ENABLED', WIKI_ENABLED) local_loglevel = ENV_TOKENS.get('LOCAL_LOGLEVEL', 'INFO') @@ -234,6 +237,10 @@ FEEDBACK_SUBMISSION_EMAIL = ENV_TOKENS.get("FEEDBACK_SUBMISSION_EMAIL") MKTG_URLS = ENV_TOKENS.get('MKTG_URLS', MKTG_URLS) +# git repo loading environment +GIT_REPO_DIR = ENV_TOKENS.get('GIT_REPO_DIR', '/edx/var/edxapp/course_repos') +GIT_IMPORT_STATIC = ENV_TOKENS.get('GIT_IMPORT_STATIC', True) + for name, value in ENV_TOKENS.get("CODE_JAIL", {}).items(): oldvalue = CODE_JAIL.get(name) if isinstance(oldvalue, dict): @@ -248,6 +255,11 @@ if "TRACKING_IGNORE_URL_PATTERNS" in ENV_TOKENS: TRACKING_IGNORE_URL_PATTERNS = ENV_TOKENS.get("TRACKING_IGNORE_URL_PATTERNS") +# SSL external authentication settings +SSL_AUTH_EMAIL_DOMAIN = ENV_TOKENS.get("SSL_AUTH_EMAIL_DOMAIN", "MIT.EDU") +SSL_AUTH_DN_FORMAT_STRING = ENV_TOKENS.get("SSL_AUTH_DN_FORMAT_STRING", + "/C=US/ST=Massachusetts/O=Massachusetts Institute of Technology/OU=Client CA v1/CN={0}/emailAddress={1}") + ############################## SECURE AUTH ITEMS ############### # Secret things: passwords, access keys, etc. @@ -258,7 +270,7 @@ # If Segment.io key specified, load it and enable Segment.io if the feature flag is set SEGMENT_IO_LMS_KEY = AUTH_TOKENS.get('SEGMENT_IO_LMS_KEY') if SEGMENT_IO_LMS_KEY: - MITX_FEATURES['SEGMENT_IO_LMS'] = ENV_TOKENS.get('SEGMENT_IO_LMS', False) + FEATURES['SEGMENT_IO_LMS'] = ENV_TOKENS.get('SEGMENT_IO_LMS', False) CC_PROCESSOR = AUTH_TOKENS.get('CC_PROCESSOR', CC_PROCESSOR) @@ -283,6 +295,7 @@ MODULESTORE = AUTH_TOKENS.get('MODULESTORE', MODULESTORE) CONTENTSTORE = AUTH_TOKENS.get('CONTENTSTORE', CONTENTSTORE) DOC_STORE_CONFIG = AUTH_TOKENS.get('DOC_STORE_CONFIG',DOC_STORE_CONFIG) +MONGODB_LOG = AUTH_TOKENS.get('MONGODB_LOG', {}) OPEN_ENDED_GRADING_INTERFACE = AUTH_TOKENS.get('OPEN_ENDED_GRADING_INTERFACE', OPEN_ENDED_GRADING_INTERFACE) diff --git a/lms/envs/cms/acceptance.py b/lms/envs/cms/acceptance.py index 0b638dca8ae0..c1ba93f46fc5 100644 --- a/lms/envs/cms/acceptance.py +++ b/lms/envs/cms/acceptance.py @@ -20,7 +20,7 @@ ########################### LETTUCE TESTING ########################## -MITX_FEATURES['DISPLAY_TOY_COURSES'] = True +FEATURES['DISPLAY_TOY_COURSES'] = True INSTALLED_APPS += ('lettuce.django',) # INSTALLED_APPS += ('portal',) diff --git a/lms/envs/cms/dev.py b/lms/envs/cms/dev.py index 0978d88d173b..427b7a78d2dd 100644 --- a/lms/envs/cms/dev.py +++ b/lms/envs/cms/dev.py @@ -8,7 +8,7 @@ from ..dev import * -MITX_FEATURES['AUTH_USE_MIT_CERTIFICATES'] = False +FEATURES['AUTH_USE_MIT_CERTIFICATES'] = False SUBDOMAIN_BRANDING['edge'] = 'edge' SUBDOMAIN_BRANDING['preview.edge'] = 'edge' @@ -18,7 +18,7 @@ # modules. Since - for now - those links point to github (for XML based authoring), it seems broken # to people using it. Once we can update those links to properly link back to Studio, # then we can turn this flag back on, as well as enabling in aws.py configurations. -MITX_FEATURES['ENABLE_LMS_MIGRATION'] = False +FEATURES['ENABLE_LMS_MIGRATION'] = False META_UNIVERSITIES = {} @@ -31,7 +31,7 @@ modulestore_options = { 'default_class': 'xmodule.raw_module.RawDescriptor', 'fs_root': DATA_DIR, - 'render_template': 'mitxmako.shortcuts.render_to_string', + 'render_template': 'edxmako.shortcuts.render_to_string', } MODULESTORE = { diff --git a/lms/envs/cms/mixed_dev.py b/lms/envs/cms/mixed_dev.py index ba45d7e747cc..f636566558cf 100644 --- a/lms/envs/cms/mixed_dev.py +++ b/lms/envs/cms/mixed_dev.py @@ -33,7 +33,7 @@ 'OPTIONS': { 'default_class': 'xmodule.raw_module.RawDescriptor', 'fs_root': DATA_DIR, - 'render_template': 'mitxmako.shortcuts.render_to_string', + 'render_template': 'edxmako.shortcuts.render_to_string', } } }, diff --git a/lms/envs/common.py b/lms/envs/common.py index 46c9df1a6ecb..3e7841833af3 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -2,7 +2,7 @@ This is the common settings file, intended to set sane defaults. If you have a piece of configuration that's dependent on a set of feature flags being set, then create a function that returns the calculated value based on the value of -MITX_FEATURES[...]. Modules that extend this one can change the feature +FEATURES[...]. Modules that extend this one can change the feature configuration in an environment specific config file and re-calculate those values. @@ -14,7 +14,7 @@ 1. Right now our treatment of static content in general and in particular course-specific static content is haphazard. 2. We should have a more disciplined approach to feature flagging, even if it - just means that we stick them in a dict called MITX_FEATURES. + just means that we stick them in a dict called FEATURES. 3. We need to handle configuration for multiple courses. This could be as multiple sites, but we do need a way to map their data assets. """ @@ -50,7 +50,7 @@ # Features -MITX_FEATURES = { +FEATURES = { 'SAMPLE': False, 'USE_DJANGO_PIPELINE': True, 'DISPLAY_HISTOGRAMS_TO_STAFF': True, @@ -89,6 +89,8 @@ 'ENABLE_MASQUERADE': True, # allow course staff to change to student view of courseware + 'ENABLE_SYSADMIN_DASHBOARD': False, # sysadmin dashboard, to see what courses are loaded, to delete & load courses + 'DISABLE_LOGIN_BUTTON': False, # used in systems where login is automatic, eg MIT SSL # extrernal access methods @@ -216,7 +218,7 @@ PROJECT_ROOT = path(__file__).abspath().dirname().dirname() # /edx-platform/lms REPO_ROOT = PROJECT_ROOT.dirname() COMMON_ROOT = REPO_ROOT / "common" -ENV_ROOT = REPO_ROOT.dirname() # virtualenv dir /mitx is in +ENV_ROOT = REPO_ROOT.dirname() # virtualenv dir /edx-platform is in COURSES_ROOT = ENV_ROOT / "data" DATA_DIR = COURSES_ROOT @@ -245,7 +247,7 @@ ############################ OpenID Provider ################################## OPENID_PROVIDER_TRUSTED_ROOTS = ['cs50.net', '*.cs50.net'] -################################## MITXWEB ##################################### +################################## EDX WEB ##################################### # This is where we stick our compiled template files. Most of the app uses Mako # templates from tempdir import mkdtemp_clean @@ -281,7 +283,7 @@ 'course_wiki.course_nav.context_processor', # Hack to get required link URLs to password reset templates - 'mitxmako.shortcuts.marketing_link_context_processor', + 'edxmako.shortcuts.marketing_link_context_processor', # Shoppingcart processor (detects if request.user has a cart) 'shoppingcart.context_processor.user_has_cart_context_processor', @@ -310,10 +312,10 @@ STATIC_GRAB = False DEV_CONTENT = True -MITX_ROOT_URL = '' +EDX_ROOT_URL = '' -LOGIN_REDIRECT_URL = MITX_ROOT_URL + '/accounts/login' -LOGIN_URL = MITX_ROOT_URL + '/accounts/login' +LOGIN_REDIRECT_URL = EDX_ROOT_URL + '/accounts/login' +LOGIN_URL = EDX_ROOT_URL + '/accounts/login' COURSE_NAME = "6.002_Spring_2012" COURSE_NUMBER = "6.002x" @@ -321,7 +323,7 @@ ### Dark code. Should be enabled in local settings for devel. -ENABLE_MULTICOURSE = False # set to False to disable multicourse display (see lib.util.views.mitxhome) +ENABLE_MULTICOURSE = False # set to False to disable multicourse display (see lib.util.views.edXhome) WIKI_ENABLED = False @@ -360,7 +362,7 @@ # Backwards compatibility with ENABLE_SQL_TRACKING_LOGS feature flag. # In the future, adding the backend to TRACKING_BACKENDS enough. -if MITX_FEATURES.get('ENABLE_SQL_TRACKING_LOGS'): +if FEATURES.get('ENABLE_SQL_TRACKING_LOGS'): TRACKING_BACKENDS.update({ 'sql': { 'ENGINE': 'track.backends.django.DjangoBackend' @@ -490,7 +492,7 @@ # gitreload is used in LMS-workflow to pull content from github # gitreload requests are only allowed from these IP addresses, which are # the advertised public IPs of the github WebHook servers. -# These are listed, eg at https://github.com/MITx/mitx/admin/hooks +# These are listed, eg at https://github.com/edx/edx-platform/admin/hooks ALLOWED_GITRELOAD_IPS = ['207.97.227.253', '50.57.128.197', '108.171.174.178'] @@ -592,8 +594,8 @@ # List of callables that know how to import templates from various sources. TEMPLATE_LOADERS = ( - 'mitxmako.makoloader.MakoFilesystemLoader', - 'mitxmako.makoloader.MakoAppDirectoriesLoader', + 'edxmako.makoloader.MakoFilesystemLoader', + 'edxmako.makoloader.MakoAppDirectoriesLoader', # 'django.template.loaders.filesystem.Loader', # 'django.template.loaders.app_directories.Loader', @@ -615,7 +617,7 @@ 'django.contrib.messages.middleware.MessageMiddleware', 'track.middleware.TrackMiddleware', - 'mitxmako.middleware.MakoMiddleware', + 'edxmako.middleware.MakoMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'course_wiki.course_nav.Middleware', @@ -817,11 +819,15 @@ STATICFILES_IGNORE_PATTERNS = ( "sass/*", "coffee/*", + + # Symlinks used by js-test-tool + "xmodule_js", + "common_static", ) PIPELINE_YUI_BINARY = 'yui-compressor' -# Setting that will only affect the MITx version of django-pipeline until our changes are merged upstream +# Setting that will only affect the edX version of django-pipeline until our changes are merged upstream PIPELINE_COMPILE_INPLACE = True ################################# CELERY ###################################### @@ -928,7 +934,7 @@ 'service_status', # For asset pipelining - 'mitxmako', + 'edxmako', 'pipeline', 'staticfiles', 'static_replace', @@ -944,6 +950,7 @@ 'eventtracking.django', 'util', 'certificates', + 'dashboard', 'instructor', 'instructor_task', 'open_ended_grading', @@ -1034,7 +1041,7 @@ def enable_theme(theme_name): THEME_NAME = "stanford" enable_theme(THEME_NAME) """ - MITX_FEATURES['USE_CUSTOM_THEME'] = True + FEATURES['USE_CUSTOM_THEME'] = True # Calculate the location of the theme's files theme_root = ENV_ROOT / "themes" / theme_name @@ -1055,7 +1062,7 @@ def enable_theme(theme_name): ######################## CAS authentication ########################### -if MITX_FEATURES.get('AUTH_USE_CAS'): +if FEATURES.get('AUTH_USE_CAS'): CAS_SERVER_URL = 'https://provide_your_cas_url_here' AUTHENTICATION_BACKENDS = ( 'django.contrib.auth.backends.ModelBackend', diff --git a/lms/envs/dev.py b/lms/envs/dev.py index 7ab58b008f04..30053d3da3e5 100644 --- a/lms/envs/dev.py +++ b/lms/envs/dev.py @@ -4,7 +4,7 @@ /envroot/ /db # This is where it'll write the database file - /mitx # The location of this repo + /edx-platform # The location of this repo /log # Where we're going to write log files """ @@ -24,23 +24,23 @@ TEMPLATE_DEBUG = True -MITX_FEATURES['DISABLE_START_DATES'] = False -MITX_FEATURES['ENABLE_SQL_TRACKING_LOGS'] = True -MITX_FEATURES['SUBDOMAIN_COURSE_LISTINGS'] = False # Enable to test subdomains--otherwise, want all courses to show up -MITX_FEATURES['SUBDOMAIN_BRANDING'] = True -MITX_FEATURES['FORCE_UNIVERSITY_DOMAIN'] = None # show all university courses if in dev (ie don't use HTTP_HOST) -MITX_FEATURES['ENABLE_MANUAL_GIT_RELOAD'] = True -MITX_FEATURES['ENABLE_PSYCHOMETRICS'] = False # real-time psychometrics (eg item response theory analysis in instructor dashboard) -MITX_FEATURES['ENABLE_INSTRUCTOR_ANALYTICS'] = True -MITX_FEATURES['ENABLE_SERVICE_STATUS'] = True -MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] = True # Enable email for all Studio courses -MITX_FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] = False # Give all courses email (don't require django-admin perms) -MITX_FEATURES['ENABLE_HINTER_INSTRUCTOR_VIEW'] = True -MITX_FEATURES['ENABLE_INSTRUCTOR_BETA_DASHBOARD'] = True -MITX_FEATURES['MULTIPLE_ENROLLMENT_ROLES'] = True -MITX_FEATURES['ENABLE_SHOPPING_CART'] = True -MITX_FEATURES['AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'] = True -MITX_FEATURES['ENABLE_S3_GRADE_DOWNLOADS'] = True +FEATURES['DISABLE_START_DATES'] = False +FEATURES['ENABLE_SQL_TRACKING_LOGS'] = True +FEATURES['SUBDOMAIN_COURSE_LISTINGS'] = False # Enable to test subdomains--otherwise, want all courses to show up +FEATURES['SUBDOMAIN_BRANDING'] = True +FEATURES['FORCE_UNIVERSITY_DOMAIN'] = None # show all university courses if in dev (ie don't use HTTP_HOST) +FEATURES['ENABLE_MANUAL_GIT_RELOAD'] = True +FEATURES['ENABLE_PSYCHOMETRICS'] = False # real-time psychometrics (eg item response theory analysis in instructor dashboard) +FEATURES['ENABLE_INSTRUCTOR_ANALYTICS'] = True +FEATURES['ENABLE_SERVICE_STATUS'] = True +FEATURES['ENABLE_INSTRUCTOR_EMAIL'] = True # Enable email for all Studio courses +FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] = False # Give all courses email (don't require django-admin perms) +FEATURES['ENABLE_HINTER_INSTRUCTOR_VIEW'] = True +FEATURES['ENABLE_INSTRUCTOR_BETA_DASHBOARD'] = True +FEATURES['MULTIPLE_ENROLLMENT_ROLES'] = True +FEATURES['ENABLE_SHOPPING_CART'] = True +FEATURES['AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'] = True +FEATURES['ENABLE_S3_GRADE_DOWNLOADS'] = True FEEDBACK_SUBMISSION_EMAIL = "dummy@example.com" @@ -55,7 +55,7 @@ DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': ENV_ROOT / "db" / "mitx.db", + 'NAME': ENV_ROOT / "db" / "edx.db", } } @@ -64,7 +64,7 @@ # In staging/prod envs, the sessions also live here. 'default': { 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', - 'LOCATION': 'mitx_loc_mem_cache', + 'LOCATION': 'edx_loc_mem_cache', 'KEY_FUNCTION': 'util.memcache.safe_key', }, @@ -85,7 +85,11 @@ 'LOCATION': '/var/tmp/mongo_metadata_inheritance', 'TIMEOUT': 300, 'KEY_FUNCTION': 'util.memcache.safe_key', - } + }, + 'loc_cache': { + 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', + 'LOCATION': 'edx_location_mem_cache', + }, } @@ -158,9 +162,9 @@ ] -################################# mitx revision string ##################### +################################# edx-platform revision string ##################### -MITX_VERSION_STRING = os.popen('cd %s; git describe' % REPO_ROOT).read().strip() +EDX_PLATFORM_VERSION_STRING = os.popen('cd %s; git describe' % REPO_ROOT).read().strip() ############################ Open ended grading config ##################### @@ -174,9 +178,9 @@ } ############################## LMS Migration ################################## -MITX_FEATURES['ENABLE_LMS_MIGRATION'] = True -MITX_FEATURES['ACCESS_REQUIRE_STAFF_FOR_COURSE'] = False # require that user be in the staff_* group to be able to enroll -MITX_FEATURES['USE_XQA_SERVER'] = 'http://xqa:server@content-qa.mitx.mit.edu/xqa' +FEATURES['ENABLE_LMS_MIGRATION'] = True +FEATURES['ACCESS_REQUIRE_STAFF_FOR_COURSE'] = False # require that user be in the staff_* group to be able to enroll +FEATURES['USE_XQA_SERVER'] = 'http://xqa:server@content-qa.edX.mit.edu/xqa' INSTALLED_APPS += ('lms_migration',) @@ -184,9 +188,9 @@ ################################ OpenID Auth ################################# -MITX_FEATURES['AUTH_USE_OPENID'] = True -MITX_FEATURES['AUTH_USE_OPENID_PROVIDER'] = True -MITX_FEATURES['BYPASS_ACTIVATION_EMAIL_FOR_EXTAUTH'] = True +FEATURES['AUTH_USE_OPENID'] = True +FEATURES['AUTH_USE_OPENID_PROVIDER'] = True +FEATURES['BYPASS_ACTIVATION_EMAIL_FOR_EXTAUTH'] = True INSTALLED_APPS += ('external_auth',) INSTALLED_APPS += ('django_openid_auth',) @@ -200,7 +204,7 @@ ######################## MIT Certificates SSL Auth ############################ -MITX_FEATURES['AUTH_USE_MIT_CERTIFICATES'] = True +FEATURES['AUTH_USE_MIT_CERTIFICATES'] = False ################################# CELERY ###################################### @@ -247,8 +251,8 @@ 'django.core.files.uploadhandler.TemporaryFileUploadHandler', ) -MITX_FEATURES['AUTH_USE_SHIB'] = True -MITX_FEATURES['RESTRICT_ENROLL_BY_REG_METHOD'] = True +FEATURES['AUTH_USE_SHIB'] = True +FEATURES['RESTRICT_ENROLL_BY_REG_METHOD'] = True ########################### PIPELINE ################################# @@ -264,7 +268,7 @@ # If there's an environment variable set, grab it and turn on Segment.io SEGMENT_IO_LMS_KEY = os.environ.get('SEGMENT_IO_LMS_KEY') if SEGMENT_IO_LMS_KEY: - MITX_FEATURES['SEGMENT_IO_LMS'] = True + FEATURES['SEGMENT_IO_LMS'] = True ###################### Payment ##############################3 @@ -279,7 +283,7 @@ ####################### Shoppingcart ########################### -MITX_FEATURES['ENABLE_SHOPPING_CART'] = True +FEATURES['ENABLE_SHOPPING_CART'] = True ##################################################################### # Lastly, see if the developer has any local overrides. diff --git a/lms/envs/dev_ike.py b/lms/envs/dev_ike.py index 50bbfff0968d..92dac61765cd 100644 --- a/lms/envs/dev_ike.py +++ b/lms/envs/dev_ike.py @@ -4,7 +4,7 @@ /envroot/ /db # This is where it'll write the database file - /mitx # The location of this repo + /edx-platform # The location of this repo /log # Where we're going to write log files """ @@ -17,28 +17,28 @@ import socket WIKI_ENABLED = False -MITX_FEATURES['ENABLE_TEXTBOOK'] = False -MITX_FEATURES['ACCESS_REQUIRE_STAFF_FOR_COURSE'] = True # require that user be in the staff_* group to be able to enroll -MITX_FEATURES['SUBDOMAIN_COURSE_LISTINGS'] = False -MITX_FEATURES['SUBDOMAIN_BRANDING'] = False -MITX_FEATURES['FORCE_UNIVERSITY_DOMAIN'] = None # show all university courses if in dev (ie don't use HTTP_HOST) +FEATURES['ENABLE_TEXTBOOK'] = False +FEATURES['ACCESS_REQUIRE_STAFF_FOR_COURSE'] = True # require that user be in the staff_* group to be able to enroll +FEATURES['SUBDOMAIN_COURSE_LISTINGS'] = False +FEATURES['SUBDOMAIN_BRANDING'] = False +FEATURES['FORCE_UNIVERSITY_DOMAIN'] = None # show all university courses if in dev (ie don't use HTTP_HOST) -MITX_FEATURES['DISABLE_START_DATES'] = True -# MITX_FEATURES['USE_DJANGO_PIPELINE']=False # don't recompile scss +FEATURES['DISABLE_START_DATES'] = True +# FEATURES['USE_DJANGO_PIPELINE']=False # don't recompile scss myhost = socket.gethostname() if ('edxvm' in myhost) or ('ocw' in myhost): - MITX_FEATURES['DISABLE_LOGIN_BUTTON'] = True # auto-login with MIT certificate - MITX_FEATURES['USE_XQA_SERVER'] = 'https://qisx.mit.edu/xqa' # needs to be ssl or browser blocks it - MITX_FEATURES['USE_DJANGO_PIPELINE'] = False # don't recompile scss + FEATURES['DISABLE_LOGIN_BUTTON'] = True # auto-login with MIT certificate + FEATURES['USE_XQA_SERVER'] = 'https://qisx.mit.edu/xqa' # needs to be ssl or browser blocks it + FEATURES['USE_DJANGO_PIPELINE'] = False # don't recompile scss if ('ocw' in myhost): - MITX_FEATURES['ACCESS_REQUIRE_STAFF_FOR_COURSE'] = False + FEATURES['ACCESS_REQUIRE_STAFF_FOR_COURSE'] = False if ('domU' in myhost): EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend' - MITX_FEATURES['REROUTE_ACTIVATION_EMAIL'] = 'ichuang@mitx.mit.edu' # nonempty string = address for all activation emails - MITX_FEATURES['USE_DJANGO_PIPELINE'] = False # don't recompile scss + FEATURES['REROUTE_ACTIVATION_EMAIL'] = 'ichuang@edX.mit.edu' # nonempty string = address for all activation emails + FEATURES['USE_DJANGO_PIPELINE'] = False # don't recompile scss SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTOCOL', 'https') # django 1.4 for nginx ssl proxy @@ -47,8 +47,8 @@ INSTALLED_APPS = tuple([app for app in INSTALLED_APPS if not app.startswith('debug_toolbar')]) MIDDLEWARE_CLASSES = tuple([mcl for mcl in MIDDLEWARE_CLASSES if not mcl.startswith('debug_toolbar')]) -#TEMPLATE_LOADERS = tuple([ app for app in TEMPLATE_LOADERS if not app.startswith('mitxmako') ]) +#TEMPLATE_LOADERS = tuple([ app for app in TEMPLATE_LOADERS if not app.startswith('edxmako') ]) TEMPLATE_LOADERS = ( 'django.template.loaders.filesystem.Loader', 'django.template.loaders.app_directories.Loader', - ) +) diff --git a/lms/envs/dev_int.py b/lms/envs/dev_int.py index 34921205a6de..f5636a51294e 100644 --- a/lms/envs/dev_int.py +++ b/lms/envs/dev_int.py @@ -16,7 +16,7 @@ from .dev import * -MITX_FEATURES['SUBDOMAIN_COURSE_LISTINGS'] = True +FEATURES['SUBDOMAIN_COURSE_LISTINGS'] = True COURSE_LISTINGS = { 'default': ['BerkeleyX/CS169.1x/2012_Fall', diff --git a/lms/envs/dev_mongo.py b/lms/envs/dev_mongo.py index bd7a8b20aa95..3a99f4465551 100644 --- a/lms/envs/dev_mongo.py +++ b/lms/envs/dev_mongo.py @@ -21,7 +21,7 @@ 'OPTIONS': { 'default_class': 'xmodule.raw_module.RawDescriptor', 'fs_root': GITHUB_REPO_ROOT, - 'render_template': 'mitxmako.shortcuts.render_to_string', + 'render_template': 'edxmako.shortcuts.render_to_string', } } } diff --git a/lms/envs/devplus.py b/lms/envs/devplus.py index bfd0788165d0..adda94ff083f 100644 --- a/lms/envs/devplus.py +++ b/lms/envs/devplus.py @@ -9,7 +9,7 @@ Dir structure: /envroot/ - /mitx # The location of this repo + /edx-platform # The location of this repo /log # Where we're going to write log files """ diff --git a/lms/envs/devstack.py b/lms/envs/devstack.py index 0b1c8feeaad2..adec04ba3ff4 100644 --- a/lms/envs/devstack.py +++ b/lms/envs/devstack.py @@ -23,8 +23,8 @@ ################################ EMAIL ######################################## EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' -MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] = True # Enable email for all Studio courses -MITX_FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] = False # Give all courses email (don't require django-admin perms) +FEATURES['ENABLE_INSTRUCTOR_EMAIL'] = True # Enable email for all Studio courses +FEATURES['REQUIRE_COURSE_EMAIL_AUTH'] = False # Give all courses email (don't require django-admin perms) ################################ DEBUG TOOLBAR ################################ @@ -53,6 +53,11 @@ PIPELINE_SASS_ARGUMENTS = '--debug-info --require {proj_dir}/static/sass/bourbon/lib/bourbon.rb'.format(proj_dir=PROJECT_ROOT) +########################### VERIFIED CERTIFICATES ################################# + +FEATURES['AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING'] = True +FEATURES['ENABLE_PAYMENT_FAKE'] = True +CC_PROCESSOR['CyberSource']['PURCHASE_ENDPOINT'] = '/shoppingcart/payment_fake/' ##################################################################### # Lastly, see if the developer has any local overrides. diff --git a/lms/envs/edx4edx_aws.py b/lms/envs/edx4edx_aws.py index 247fa866bc7e..a78c47779737 100644 --- a/lms/envs/edx4edx_aws.py +++ b/lms/envs/edx4edx_aws.py @@ -10,7 +10,7 @@ EDX4EDX_ROOT = ENV_ROOT / "data/edx4edx" ### Dark code. Should be enabled in local settings for devel. -ENABLE_MULTICOURSE = True # set to False to disable multicourse display (see lib.util.views.mitxhome) +ENABLE_MULTICOURSE = True # set to False to disable multicourse display (see lib.util.views.edxhome) ### PIPELINE_CSS_COMPRESSOR = None PIPELINE_JS_COMPRESSOR = None diff --git a/lms/envs/static.py b/lms/envs/static.py index 260153e62314..ce3d8d610f9d 100644 --- a/lms/envs/static.py +++ b/lms/envs/static.py @@ -4,7 +4,7 @@ /envroot/ /db # This is where it'll write the database file - /mitx # The location of this repo + /edx-platform # The location of this repo /log # Where we're going to write log files """ @@ -25,7 +25,7 @@ DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': ENV_ROOT / "db" / "mitx.db", + 'NAME': ENV_ROOT / "db" / "edx.db", } } @@ -34,7 +34,7 @@ # In staging/prod envs, the sessions also live here. 'default': { 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', - 'LOCATION': 'mitx_loc_mem_cache', + 'LOCATION': 'edx_loc_mem_cache', 'KEY_FUNCTION': 'util.memcache.safe_key', }, diff --git a/lms/envs/test.py b/lms/envs/test.py index 49f8d29aa2e8..2dbfca0bd655 100644 --- a/lms/envs/test.py +++ b/lms/envs/test.py @@ -4,7 +4,7 @@ /envroot/ /db # This is where it'll write the database file - /mitx # The location of this repo + /edx-platform # The location of this repo /log # Where we're going to write log files """ @@ -21,20 +21,24 @@ # can't test start dates with this True, but on the other hand, # can test everything else :) -MITX_FEATURES['DISABLE_START_DATES'] = True +FEATURES['DISABLE_START_DATES'] = True # Most tests don't use the discussion service, so we turn it off to speed them up. # Tests that do can enable this flag, but must use the UrlResetMixin class to force urls.py # to reload -MITX_FEATURES['ENABLE_DISCUSSION_SERVICE'] = False +FEATURES['ENABLE_DISCUSSION_SERVICE'] = False -MITX_FEATURES['ENABLE_SERVICE_STATUS'] = True +FEATURES['ENABLE_SERVICE_STATUS'] = True -MITX_FEATURES['ENABLE_HINTER_INSTRUCTOR_VIEW'] = True +FEATURES['ENABLE_HINTER_INSTRUCTOR_VIEW'] = True -MITX_FEATURES['ENABLE_INSTRUCTOR_BETA_DASHBOARD'] = True +FEATURES['ENABLE_INSTRUCTOR_BETA_DASHBOARD'] = True -MITX_FEATURES['ENABLE_SHOPPING_CART'] = True +FEATURES['ENABLE_SHOPPING_CART'] = True + +# Enable this feature for course staff grade downloads, to enable acceptance tests +FEATURES['ENABLE_S3_GRADE_DOWNLOADS'] = True +FEATURES['ALLOW_COURSE_STAFF_GRADE_DOWNLOADS'] = True # Need wiki for courseware views to work. TODO (vshnayder): shouldn't need it. WIKI_ENABLED = True @@ -130,7 +134,7 @@ DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': TEST_ROOT / 'db' / 'mitx.db' + 'NAME': TEST_ROOT / 'db' / 'edx.db' }, } @@ -140,7 +144,7 @@ # In staging/prod envs, the sessions also live here. 'default': { 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', - 'LOCATION': 'mitx_loc_mem_cache', + 'LOCATION': 'edx_loc_mem_cache', 'KEY_FUNCTION': 'util.memcache.safe_key', }, @@ -161,7 +165,12 @@ 'LOCATION': '/var/tmp/mongo_metadata_inheritance', 'TIMEOUT': 300, 'KEY_FUNCTION': 'util.memcache.safe_key', - } + }, + 'loc_cache': { + 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', + 'LOCATION': 'edx_location_mem_cache', + }, + } # Dummy secret key for dev @@ -171,13 +180,13 @@ filterwarnings('ignore', message='No request passed to the backend, unable to rate-limit') ################################## OPENID ##################################### -MITX_FEATURES['AUTH_USE_OPENID'] = True -MITX_FEATURES['AUTH_USE_OPENID_PROVIDER'] = True +FEATURES['AUTH_USE_OPENID'] = True +FEATURES['AUTH_USE_OPENID_PROVIDER'] = True ################################## SHIB ####################################### -MITX_FEATURES['AUTH_USE_SHIB'] = True -MITX_FEATURES['SHIB_DISABLE_TOS'] = True -MITX_FEATURES['RESTRICT_ENROLL_BY_REG_METHOD'] = True +FEATURES['AUTH_USE_SHIB'] = True +FEATURES['SHIB_DISABLE_TOS'] = True +FEATURES['RESTRICT_ENROLL_BY_REG_METHOD'] = True OPENID_CREATE_USERS = False OPENID_UPDATE_DETAILS_FROM_SREG = True @@ -186,7 +195,7 @@ ###################### Payment ##############################3 # Enable fake payment processing page -MITX_FEATURES['ENABLE_PAYMENT_FAKE'] = True +FEATURES['ENABLE_PAYMENT_FAKE'] = True # Configure the payment processor to use the fake processing page # Since both the fake payment page and the shoppingcart app are using # the same settings, we can generate this randomly and guarantee @@ -203,6 +212,10 @@ CC_PROCESSOR['CyberSource']['SERIAL_NUMBER'] = "0123456789012345678901" CC_PROCESSOR['CyberSource']['PURCHASE_ENDPOINT'] = "/shoppingcart/payment_fake" +########################### SYSADMIN DASHBOARD ################################ +FEATURES['ENABLE_SYSADMIN_DASHBOARD'] = True +GIT_REPO_DIR = TEST_ROOT / "course_repos" + ################################# CELERY ###################################### CELERY_ALWAYS_EAGER = True @@ -217,7 +230,7 @@ new_staticfiles_dirs = [] # Strip out any static files that aren't in the repository root -# so that the tests can run with only the mitx directory checked out +# so that the tests can run with only the edx-platform directory checked out for static_dir in STATICFILES_DIRS: # Handle both tuples and non-tuple directory definitions try: diff --git a/lms/lib/xblock/runtime.py b/lms/lib/xblock/runtime.py index 4fa48be83a83..cb2c0330251b 100644 --- a/lms/lib/xblock/runtime.py +++ b/lms/lib/xblock/runtime.py @@ -82,12 +82,22 @@ def handler_url(course_id, block, handler, suffix='', query='', thirdparty=False if thirdparty: view_name = 'xblock_handler_noauth' - return reverse(view_name, kwargs={ + url = reverse(view_name, kwargs={ 'course_id': course_id, 'usage_id': quote_slashes(str(block.scope_ids.usage_id)), 'handler': handler, 'suffix': suffix, - }) + '?' + query + }) + + # If suffix is an empty string, remove the trailing '/' + if not suffix: + url = url.rstrip('/') + + # If there is a query string, append it + if query: + url += '?' + query + + return url def handler_prefix(course_id, block): @@ -96,9 +106,13 @@ def handler_prefix(course_id, block): The prefix is a valid handler url after the handler name is slash-appended to it. - """ - return handler_url(course_id, block, '').rstrip('/') + # This depends on handler url having the handler_name as the final piece of the url + # so that leaving an empty handler_name really does leave the opportunity to append + # the handler_name on the frontend + + # This is relied on by the xblock/runtime.v1.coffee frontend handlerUrl function + return handler_url(course_id, block, '').rstrip('/?') class LmsHandlerUrls(object): diff --git a/lms/lib/xblock/test/test_runtime.py b/lms/lib/xblock/test/test_runtime.py index c8c4d006f791..5b3efc171c05 100644 --- a/lms/lib/xblock/test/test_runtime.py +++ b/lms/lib/xblock/test/test_runtime.py @@ -3,8 +3,10 @@ """ from ddt import ddt, data +from mock import Mock from unittest import TestCase -from lms.lib.xblock.runtime import quote_slashes, unquote_slashes +from urlparse import urlparse +from lms.lib.xblock.runtime import quote_slashes, unquote_slashes, handler_url TEST_STRINGS = [ '', @@ -31,3 +33,46 @@ def test_inverse(self, test_string): @data(*TEST_STRINGS) def test_escaped(self, test_string): self.assertNotIn('/', quote_slashes(test_string)) + + +class TestHandlerUrl(TestCase): + """Test the LMS handler_url""" + + def setUp(self): + self.block = Mock() + self.course_id = "org/course/run" + + def test_trailing_characters(self): + self.assertFalse(handler_url(self.course_id, self.block, 'handler').endswith('?')) + self.assertFalse(handler_url(self.course_id, self.block, 'handler').endswith('/')) + + self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix').endswith('?')) + self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix').endswith('/')) + + self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix', 'query').endswith('?')) + self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix', 'query').endswith('/')) + + self.assertFalse(handler_url(self.course_id, self.block, 'handler', query='query').endswith('?')) + self.assertFalse(handler_url(self.course_id, self.block, 'handler', query='query').endswith('/')) + + def _parsed_query(self, query_string): + """Return the parsed query string from a handler_url generated with the supplied query_string""" + return urlparse(handler_url(self.course_id, self.block, 'handler', query=query_string)).query + + def test_query_string(self): + self.assertIn('foo=bar', self._parsed_query('foo=bar')) + self.assertIn('foo=bar&baz=true', self._parsed_query('foo=bar&baz=true')) + self.assertIn('foo&bar&baz', self._parsed_query('foo&bar&baz')) + + def _parsed_path(self, handler_name='handler', suffix=''): + """Return the parsed path from a handler_url with the supplied handler_name and suffix""" + return urlparse(handler_url(self.course_id, self.block, handler_name, suffix=suffix)).path + + def test_suffix(self): + self.assertTrue(self._parsed_path(suffix="foo").endswith('foo')) + self.assertTrue(self._parsed_path(suffix="foo/bar").endswith('foo/bar')) + self.assertTrue(self._parsed_path(suffix="/foo/bar").endswith('/foo/bar')) + + def test_handler_name(self): + self.assertIn('handler1', self._parsed_path('handler1')) + self.assertIn('handler_a', self._parsed_path('handler_a')) diff --git a/lms/static/coffee/src/staff_grading/staff_grading.coffee b/lms/static/coffee/src/staff_grading/staff_grading.coffee index 80487f24ee34..1035eadb3d1d 100644 --- a/lms/static/coffee/src/staff_grading/staff_grading.coffee +++ b/lms/static/coffee/src/staff_grading/staff_grading.coffee @@ -47,36 +47,36 @@ The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for t ''' rubric: ''' - + - + - + - + - + - + - + - + @@ -98,9 +98,9 @@ The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for t max_score: 2 + @mock_cnt % 3 ml_error_info : 'ML accuracy info: ' + @mock_cnt else - response = + response = success: false - + else if cmd == 'save_grade' response = @@ -109,7 +109,7 @@ The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for t # should get back a list of problem_ids, problem_names, num_graded, min_for_ml else if cmd == 'get_problem_list' @mock_cnt = 1 - response = + response = success: true problem_list: [ {location: 'i4x://MITx/3.091x/problem/open_ended_demo1', \ @@ -123,7 +123,7 @@ The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for t error: 'Unknown command ' + cmd if @mock_cnt % 5 == 0 - response = + response = success: true message: 'No more submissions' @@ -132,7 +132,7 @@ The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for t response = success: false error: 'An error for testing' - + return response @@ -190,7 +190,7 @@ class @StaffGrading @question_header = $('.question-header') @question_header.click @collapse_question @collapse_question() - + # model state @state = state_no_data @submission_id = null @@ -266,7 +266,7 @@ class @StaffGrading @render_view() @scroll_to_top() - + get_next_submission: (location) -> @location = location @list_view = false @@ -296,7 +296,7 @@ class @StaffGrading submission_id: @submission_id location: @location submission_flagged: @flag_submission_checkbox.is(':checked') - @gentle_alert "Grades saved. Fetching the next submission to grade." + @gentle_alert gettext("Grades saved. Fetching the next submission to grade.") @backend.post('save_grade', data, @ajax_callback) gentle_alert: (msg) => @@ -344,13 +344,13 @@ class @StaffGrading # clear the problem list and breadcrumbs @problem_list.html(''' - - - - - + + + + + - ''') + ''') @breadcrumbs.html('') @problem_list_container.toggle(@list_view) if @backend.mock_backend @@ -364,14 +364,14 @@ class @StaffGrading # only show the grading elements when we are not in list view or the state # is invalid - show_grading_elements = !(@list_view || @state == state_error || + show_grading_elements = !(@list_view || @state == state_error || @state == state_no_data) @prompt_wrapper.toggle(show_grading_elements) @submission_wrapper.toggle(show_grading_elements) @grading_wrapper.toggle(show_grading_elements) @meta_info_wrapper.toggle(show_grading_elements) @action_button.hide() - + if @list_view @render_list() else @@ -410,23 +410,27 @@ class @StaffGrading show_action_button = true problem_list_link = $('').attr('href', 'javascript:void(0);') - .append("< Back to problem list") + .append("< " + gettext("Back to problem list")) .click => @get_problem_list() # set up the breadcrumbing @breadcrumbs.append(problem_list_link) - + if @state == state_error - @set_button_text('Try loading again') + @set_button_text(gettext('Try loading again')) show_action_button = true else if @state == state_grading @ml_error_info_container.html(@ml_error_info) + available = _.template(gettext("<%= num %> available"), {num: @num_pending}) + graded = _.template(gettext("<%= num %> graded"), {num: @num_graded}) + needed = _.template(gettext("<%= num %> more needed to start ML"), + {num: Math.max(@min_for_ml - @num_graded, 0)}) meta_list = $("
      ") - meta_list.append("
      #{@num_pending} available |
      ") - meta_list.append("
      #{@num_graded} graded |
      ") - meta_list.append("
      #{Math.max(@min_for_ml - @num_graded, 0)} more needed to start ML

      ") + .append("
      #{available}
      ") + .append("
      #{graded}
      ") + .append("
      #{needed}
      ") @problem_meta_info.html(meta_list) @prompt_container.html(@prompt) @@ -437,24 +441,24 @@ class @StaffGrading show_action_button = false @setup_score_selection() - + else if @state == state_graded - @set_button_text('Submit') + @set_button_text(gettext('Submit')) show_action_button = false else if @state == state_no_data @message_container.html(@message) - @set_button_text('Re-check for submissions') + @set_button_text(gettext('Re-check for submissions')) else - @error('System got into invalid state ' + @state) + @error(_.template(gettext('System got into invalid state: <%= state %>'), {state: @state})) @submit_button.toggle(show_submit_button) @action_button.toggle(show_action_button) submit: (event) => event.preventDefault() - + if @state == state_error @get_next_submission(@location) else if @state == state_graded @@ -462,17 +466,17 @@ class @StaffGrading else if @state == state_no_data @get_next_submission(@location) else - @error('System got into invalid state for submission: ' + @state) + @error(gettext('System got into invalid state for submission: ') + @state) collapse_question: () => @prompt_container.slideToggle() @prompt_container.toggleClass('open') - if @question_header.text() == "(Hide)" + if @question_header.text() == gettext("(Hide)") Logger.log 'staff_grading_hide_question', {location: @location} - new_text = "(Show)" + new_text = gettext("(Show)") else Logger.log 'staff_grading_show_question', {location: @location} - new_text = "(Hide)" + new_text = gettext("(Hide)") @question_header.text(new_text) scroll_to_top: () => diff --git a/lms/static/js/Markdown.Editor.js b/lms/static/js/Markdown.Editor.js index 5728a5b52fe4..3a2fb24f8b4e 100644 --- a/lms/static/js/Markdown.Editor.js +++ b/lms/static/js/Markdown.Editor.js @@ -1377,6 +1377,18 @@ doClick(this); return false; } + util.addEvent(button, "keydown", function(event) { + var keyCode = event.charCode || event.keyCode; + if (keyCode == 32 || keyCode == 13) { + if (event.preventDefault) { + event.preventDefault(); + } + if (window.event) { + window.event.returnValue = false; + } + doClick(button); + } + }) } } else { diff --git a/lms/static/js/wiki/CodeMirror.init.js b/lms/static/js/wiki/CodeMirror.init.js index 2ef21aa4be94..76bfbfdd9f38 100644 --- a/lms/static/js/wiki/CodeMirror.init.js +++ b/lms/static/js/wiki/CodeMirror.init.js @@ -1,24 +1,24 @@ $(document).ready(function() { var editor = CodeMirror.fromTextArea(document.getElementById("id_content"), { - mode: 'mitx_markdown', + mode: 'edx_markdown', matchBrackets: true, theme: "default", lineWrapping: true, keyMap: "accessible" }); - + //Store the inital contents so we can compare for unsaved changes var initial_contents = editor.getValue(); - + window.onbeforeunload = function askConfirm() { //Warn the user before they navigate away if ( editor.getValue() != initial_contents ) { return "You have made changes to the article that have not been saved yet."; } }; - + $(".btn-primary").click(function() { initial_contents = editor.getValue(); }); - -}); \ No newline at end of file + +}); diff --git a/lms/static/sass/_discussion.scss b/lms/static/sass/_discussion.scss index 8f55f6c5fd0d..5fa86f922534 100644 --- a/lms/static/sass/_discussion.scss +++ b/lms/static/sass/_discussion.scss @@ -519,12 +519,6 @@ body.discussion { .sidebar-comments-count span { font-weight: 700; } - - .sidebar-toggle-moderator-button { - @include blue-button; - margin-top: $baseline; - text-align: center; - } } diff --git a/lms/templates/combinedopenended/combined_open_ended.html b/lms/templates/combinedopenended/combined_open_ended.html index c8f4c029dc7f..5b0f94f6bb09 100644 --- a/lms/templates/combinedopenended/combined_open_ended.html +++ b/lms/templates/combinedopenended/combined_open_ended.html @@ -58,7 +58,7 @@

      ${display_name}

      % if is_staff:
      - Staff Warning: Please note that if you submit a duplicate of text that has already been submitted for grading, it will not show up in the staff grading view. It will be given the same grade that the original received automatically, and will be returned within 30 minutes if the original is already graded, or when the original is graded if not. + ${_("Staff Warning: Please note that if you submit a duplicate of text that has already been submitted for grading, it will not show up in the staff grading view. It will be given the same grade that the original received automatically, and will be returned within 30 minutes if the original is already graded, or when the original is graded if not.")}
      % endif diff --git a/lms/templates/combinedopenended/openended/open_ended_rubric.html b/lms/templates/combinedopenended/openended/open_ended_rubric.html index 1d73647ec761..199f19924526 100644 --- a/lms/templates/combinedopenended/openended/open_ended_rubric.html +++ b/lms/templates/combinedopenended/openended/open_ended_rubric.html @@ -1,4 +1,5 @@ <%! from django.utils.translation import ugettext as _ %> +<%! from django.utils.translation import ungettext%> <% from random import randint %>
      @@ -6,7 +7,7 @@
      ${_("Rubric")} -

      Select the criteria you feel best represents this submission in each category.

      +

      ${_("Select the criteria you feel best represents this submission in each category.")}

      % for i in range(len(categories)): <% category = categories[i] %> @@ -22,7 +23,14 @@ % endif % endfor diff --git a/lms/templates/courseware/course_about.html b/lms/templates/courseware/course_about.html index 0afce2859570..81e9e2507f2e 100644 --- a/lms/templates/courseware/course_about.html +++ b/lms/templates/courseware/course_about.html @@ -5,7 +5,7 @@ from courseware.access import has_access from django.conf import settings - if settings.MITX_FEATURES.get('ENABLE_SHOPPING_CART'): + if settings.FEATURES.get('ENABLE_SHOPPING_CART'): cart_link = reverse('shoppingcart.views.show_cart') else: cart_link = "" @@ -31,7 +31,7 @@ event.preventDefault(); }); - % if settings.MITX_FEATURES.get('ENABLE_SHOPPING_CART') and settings.MITX_FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION'): + % if settings.FEATURES.get('ENABLE_SHOPPING_CART') and settings.FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION'): add_course_complete_handler = function(jqXHR, textStatus) { if (jqXHR.status == 200) { location.href = "${cart_link}"; @@ -57,7 +57,7 @@ % endif ## making the conditional around this entire JS block for sanity - %if settings.MITX_FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: + %if settings.FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: $('#class_enroll_form').on('ajax:complete', function(event, xhr) { if(xhr.status == 200) { location.href = "${reverse('dashboard')}"; @@ -135,7 +135,7 @@

      ${_('This course is in your cart.').format(cart_link=cart_link)} - %elif settings.MITX_FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION') and registration_price: + %elif settings.FEATURES.get('ENABLE_PAID_COURSE_REGISTRATION') and registration_price: <% if user.is_authenticated(): reg_href = "#" diff --git a/lms/templates/courseware/course_navigation.html b/lms/templates/courseware/course_navigation.html index 0be247ed899c..05189edfd15a 100644 --- a/lms/templates/courseware/course_navigation.html +++ b/lms/templates/courseware/course_navigation.html @@ -1,4 +1,5 @@ ## mako +<%! from django.utils.translation import ugettext as _ %> <%page args="active_page=None" /> <% diff --git a/lms/templates/courseware/gradebook.html b/lms/templates/courseware/gradebook.html index 8828721555de..4b1175590b90 100644 --- a/lms/templates/courseware/gradebook.html +++ b/lms/templates/courseware/gradebook.html @@ -45,7 +45,7 @@

      ${_("Gradebook")}

      diff --git a/lms/templates/courseware/instructor_dashboard.html b/lms/templates/courseware/instructor_dashboard.html index c2488694225c..cd78ef0c6ca9 100644 --- a/lms/templates/courseware/instructor_dashboard.html +++ b/lms/templates/courseware/instructor_dashboard.html @@ -113,7 +113,7 @@
      - %if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BETA_DASHBOARD'): + %if settings.FEATURES.get('ENABLE_INSTRUCTOR_BETA_DASHBOARD'):
      ${_("Try New Beta Dashboard")}
      %endif %if studio_url: @@ -126,7 +126,7 @@

      ${_("Instructor Dashboard")}

      [ Grades | - %if settings.MITX_FEATURES.get('ENABLE_PSYCHOMETRICS'): + %if settings.FEATURES.get('ENABLE_PSYCHOMETRICS'): ${_("Psychometrics")} | %endif ${_("Admin")} | @@ -137,7 +137,7 @@

      [ ${_("Email")} %endif - %if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_ANALYTICS'): + %if settings.FEATURES.get('ENABLE_INSTRUCTOR_ANALYTICS'): | ${_("Analytics")} %endif ] @@ -172,7 +172,7 @@

      ${_("Grade Downloads")}

      "with more than {max_enrollment} students. We are urgently working on " "fixing this issue. Thank you for your patience as we continue " "working to improve the platform!").format( - max_enrollment=settings.MITX_FEATURES['MAX_ENROLLMENT_INSTR_BUTTONS'] + max_enrollment=settings.FEATURES['MAX_ENROLLMENT_INSTR_BUTTONS'] )}

      @@ -207,7 +207,7 @@

      ${_("Grade Downloads")}

      - %if settings.MITX_FEATURES.get('REMOTE_GRADEBOOK_URL','') and instructor_access: + %if settings.FEATURES.get('REMOTE_GRADEBOOK_URL','') and instructor_access: <% rg = course.remote_gradebook @@ -240,7 +240,7 @@

      ${_("Export grades to remote gradebook")}

      %endif - %if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): + %if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'):

      ${_("Course-specific grade adjustment")}

      @@ -292,7 +292,7 @@

      ${_("Student-specific grade inspection and adjustment")}

      ${_("Then select an action:")} - %if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): + %if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): %endif

      @@ -303,7 +303,7 @@

      ${_("Student-specific grade inspection and adjustment")}

      %endif - %if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): + %if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'):

      ${_("Rescoring runs in the background, and status for active tasks will appear in a table below. " "To see status for all tasks submitted for this problem and student, click on this button:")}

      @@ -359,7 +359,7 @@

      ${_("Student-specific grade inspection and adjustment")}

      %endif - %if settings.MITX_FEATURES['ENABLE_MANUAL_GIT_RELOAD'] and admin_access: + %if settings.FEATURES['ENABLE_MANUAL_GIT_RELOAD'] and admin_access:

      @@ -409,7 +409,7 @@

      ${_("Enrollment Data")}

      "with more than {max_enrollment} students. We are urgently working on " "fixing this issue. Thank you for your patience as we continue " "working to improve the platform!").format( - max_enrollment=settings.MITX_FEATURES['MAX_ENROLLMENT_INSTR_BUTTONS'] + max_enrollment=settings.FEATURES['MAX_ENROLLMENT_INSTR_BUTTONS'] )}

      @@ -420,7 +420,7 @@

      ${_("Enrollment Data")}

      - %if settings.MITX_FEATURES.get('REMOTE_GRADEBOOK_URL','') and instructor_access: + %if settings.FEATURES.get('REMOTE_GRADEBOOK_URL','') and instructor_access: <% rg = course.remote_gradebook diff --git a/lms/templates/courseware/progress.html b/lms/templates/courseware/progress.html index 1c099119c0cd..6cb80e43e228 100644 --- a/lms/templates/courseware/progress.html +++ b/lms/templates/courseware/progress.html @@ -59,7 +59,7 @@

      - ${"{0:.3n} of {1:.3n} possible points".format( float(earned), float(total) )} + ${_("{earned:.3n} of {total:.3n} possible points").format( earned = float(earned), total = float(total) )} %endif %if total > 0 or earned > 0: @@ -72,7 +72,7 @@

      %if len(section['scores']) > 0: -

      ${ "Problem Scores: " if section['graded'] else "Practice Scores: "}

      +

      ${ _("Problem Scores: ") if section['graded'] else _("Practice Scores: ")}

        %for score in section['scores']:
      1. ${"{0:.3n}/{1:.3n}".format(float(score.earned),float(score.possible))}
        2. diff --git a/lms/templates/dashboard.html b/lms/templates/dashboard.html index 9d9600475cba..523eecfe9698 100644 --- a/lms/templates/dashboard.html +++ b/lms/templates/dashboard.html @@ -2,6 +2,7 @@ <%! from django.core.urlresolvers import reverse + import waffle %> <%inherit file="main.html" /> @@ -22,6 +23,21 @@ $(this).closest('.message.is-expandable').toggleClass('is-expanded'); } + $("#upgrade-to-verified").click(function(event) { + user = $(event.target).data("user"); + course = $(event.target).data("course-id"); + Logger.log('edx.course.enrollment.upgrade.clicked', [user, course], null); + % if waffle.flag_is_active(request, 'alternate_upsell_copy'): + analytics.track("Clicked on Alternate Upsell Copy", { + course: course + }); + % else: + analytics.track("Clicked on Regular Upsell Copy", { + course: course + }); + % endif + }); + $(".email-settings").click(function(event) { $("#email_settings_course_id").val( $(event.target).data("course-id") ); $("#email_settings_course_number").text( $(event.target).data("course-number") ); @@ -197,7 +213,7 @@

        ${_("Current Courses")}

        % else:
        - % if settings.MITX_FEATURES.get('COURSES_ARE_BROWSABLE'): + % if settings.FEATURES.get('COURSES_ARE_BROWSABLE'):

        ${_("Looks like you haven't registered for any courses yet.")}

         ${_("Find courses now!")} @@ -329,7 +345,6 @@

        ${_("Change your name")}, ${_("modal

        ${_(' {course_number}? ').format(course_number='')}, ${_("modal open")}

        - refund
        @@ -341,4 +356,4 @@

        ${_(' {course_num -

        \ No newline at end of file +

      diff --git a/lms/templates/dashboard/_dashboard_course_listing.html b/lms/templates/dashboard/_dashboard_course_listing.html index aa7b1b84b05e..3569e365ee94 100644 --- a/lms/templates/dashboard/_dashboard_course_listing.html +++ b/lms/templates/dashboard/_dashboard_course_listing.html @@ -61,13 +61,17 @@

      <%include file='_dashboard_certificate_information.html' args='cert_status=cert_status,course=course, enrollment=enrollment'/> % endif - %if course_mode_info['show_upsell']: + % if course_mode_info['show_upsell']:
      ${profiled_user['threads_count'] | h} ${pluralize('discussion', profiled_user['threads_count']) | h} started
      ${profiled_user['comments_count'] | h} ${pluralize('comment', profiled_user['comments_count']) | h}
      - % if check_permissions_by_view(user, course.id, content=None, name='update_moderator_status'): - % if "Moderator" in role_names: - ${_("Revoke Moderator rights")} - % else: - ${_("Promote to Moderator")} - % endif - % endif diff --git a/lms/templates/discussion/ajax_user_profile.html b/lms/templates/discussion/ajax_user_profile.html deleted file mode 100644 index c24081845f7b..000000000000 --- a/lms/templates/discussion/ajax_user_profile.html +++ /dev/null @@ -1 +0,0 @@ -<%include file="_user_profile.html" /> diff --git a/lms/templates/footer.html b/lms/templates/footer.html index 394c679b6f85..3e8e993891bd 100644 --- a/lms/templates/footer.html +++ b/lms/templates/footer.html @@ -48,27 +48,27 @@ diff --git a/lms/templates/help_modal.html b/lms/templates/help_modal.html index dea4b7e8b9d4..7568af9c755b 100644 --- a/lms/templates/help_modal.html +++ b/lms/templates/help_modal.html @@ -6,7 +6,7 @@ <%! from django.conf import settings %> <%! from courseware.tabs import get_discussion_link %> -% if settings.MITX_FEATURES.get('ENABLE_FEEDBACK_SUBMISSION', False): +% if settings.FEATURES.get('ENABLE_FEEDBACK_SUBMISSION', False):
      ${_("Help")} diff --git a/lms/templates/index.html b/lms/templates/index.html index 83024e01aa7b..56d08ce1108f 100644 --- a/lms/templates/index.html +++ b/lms/templates/index.html @@ -165,7 +165,7 @@

      ${_('Explore free courses from {span_start}{platform_name}{span_end} univers % endif - % if settings.MITX_FEATURES.get('COURSES_ARE_BROWSABLE'): + % if settings.FEATURES.get('COURSES_ARE_BROWSABLE'):
        %for course in courses: diff --git a/lms/templates/instructor/instructor_dashboard_2/course_info.html b/lms/templates/instructor/instructor_dashboard_2/course_info.html index 7362014b0998..3569251e790e 100644 --- a/lms/templates/instructor/instructor_dashboard_2/course_info.html +++ b/lms/templates/instructor/instructor_dashboard_2/course_info.html @@ -58,7 +58,7 @@

        ${_("Basic Course Information")}

      -%if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): +%if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'):

      ${_("Pending Instructor Tasks")}

      diff --git a/lms/templates/instructor/instructor_dashboard_2/data_download.html b/lms/templates/instructor/instructor_dashboard_2/data_download.html index cbbc2a871bba..9d3fda61d0ce 100644 --- a/lms/templates/instructor/instructor_dashboard_2/data_download.html +++ b/lms/templates/instructor/instructor_dashboard_2/data_download.html @@ -4,37 +4,37 @@

      ${_("Data Download")}

      -
      +

      ${_("The following button displays a list of all students enrolled in this course, along with profile information such as email address and username. The data can also be downloaded as a CSV file.")}

      -
      +

      ${_("Displays the grading configuration for the course. The grading configuration is the breakdown of graded subsections of the course (such as exams and problem sets), and can be changed on the 'Grading' page (under 'Settings') in Studio.")}

      -
      +

      ${_("Download a CSV of anonymized student IDs by clicking this button.")}

      -%if settings.MITX_FEATURES.get('ENABLE_S3_GRADE_DOWNLOADS'): +%if settings.FEATURES.get('ENABLE_S3_GRADE_DOWNLOADS'):

      ${_("Grade Reports")}

      - %if settings.MITX_FEATURES.get('ALLOW_COURSE_STAFF_GRADE_DOWNLOADS') or section_data['access']['admin']: + %if settings.FEATURES.get('ALLOW_COURSE_STAFF_GRADE_DOWNLOADS') or section_data['access']['admin']:

      ${_("The following button will generate a CSV grade report for all currently enrolled students. For large courses, generating this report may take a few hours.")}

      ${_("The report is generated in the background, meaning it is OK to navigate away from this page while your report is generating. Generated reports appear in a table below and can be downloaded.")}

      -
      -
      +
      +

      @@ -42,11 +42,11 @@

      ${_("Grade Reports")}

      ${_("Reports Available for Download")}

      ${_("File links are generated on demand and expire within 5 minutes due to the sensitive nature of student grade information. Please note that the report filename contains a timestamp that represents when your file was generated; this timestamp is UTC, not your local timezone.")}


      -
      +
      %endif -%if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): +%if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'):

      ${_("Pending Instructor Tasks")}

      diff --git a/lms/templates/instructor/instructor_dashboard_2/send_email.html b/lms/templates/instructor/instructor_dashboard_2/send_email.html index 4d49530b5c68..cb8afb88a130 100644 --- a/lms/templates/instructor/instructor_dashboard_2/send_email.html +++ b/lms/templates/instructor/instructor_dashboard_2/send_email.html @@ -33,8 +33,8 @@

      ${_("Send Email")}

    2. -
      3. @@ -55,7 +55,7 @@

      ${_("Send Email")}

      -%if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): +%if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'):

      ${_("Pending Instructor Tasks")}

      diff --git a/lms/templates/instructor/instructor_dashboard_2/student_admin.html b/lms/templates/instructor/instructor_dashboard_2/student_admin.html index 2762ba489903..1ff3e2727c75 100644 --- a/lms/templates/instructor/instructor_dashboard_2/student_admin.html +++ b/lms/templates/instructor/instructor_dashboard_2/student_admin.html @@ -30,7 +30,7 @@

      ${_("Student-specific grade adjustment")}


      -

      ${_('Specify a particular problem in the course here by its url:')} +

      ${_('Specify a particular problem in the course here by its url:')}

      @@ -50,7 +50,7 @@

      ${_("Student-specific grade adjustment")}

      - %if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS') and section_data['access']['instructor']: + %if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS') and section_data['access']['instructor']: %endif

      @@ -63,7 +63,7 @@

      ${_("Student-specific grade adjustment")}

      - %if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS') and section_data['access']['instructor']: + %if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS') and section_data['access']['instructor']:

      ${_("Rescoring runs in the background, and status for active tasks will appear in the 'Pending Instructor Tasks' table. " "To see status for all tasks submitted for this problem and student, click on this button:")} @@ -75,7 +75,7 @@

      ${_("Student-specific grade adjustment")}

      -%if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS') and section_data['access']['instructor']: +%if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS') and section_data['access']['instructor']:

      ${_('Course-specific grade adjustment')}

      @@ -108,7 +108,7 @@

      ${_('Course-specific grade adjustment')}

      %endif -%if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): +%if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'):

      ${_("Pending Instructor Tasks")}

      diff --git a/lms/templates/instructor/staff_grading.html b/lms/templates/instructor/staff_grading.html index ae6485ec364f..0c591c1fb266 100644 --- a/lms/templates/instructor/staff_grading.html +++ b/lms/templates/instructor/staff_grading.html @@ -6,6 +6,7 @@ <%block name="headextra"> <%static:css group='style-course-vendor'/> <%static:css group='style-course'/> + <%block name="title">${_("{course_number} Staff Grading").format(course_number=course.display_number_with_default) | h} diff --git a/lms/templates/login.html b/lms/templates/login.html index 56a04d628397..72d903eed2ce 100644 --- a/lms/templates/login.html +++ b/lms/templates/login.html @@ -170,7 +170,7 @@

      ${_('Account Preferences')}

      ${_("Helpful Information")}

      - % if settings.MITX_FEATURES.get('AUTH_USE_OPENID'): + % if settings.FEATURES.get('AUTH_USE_OPENID'): - + % if not course: diff --git a/lms/templates/main_django.html b/lms/templates/main_django.html index a20d489d8bbd..9190ddab928f 100644 --- a/lms/templates/main_django.html +++ b/lms/templates/main_django.html @@ -25,7 +25,7 @@ - + diff --git a/lms/templates/mktg_iframe.html b/lms/templates/mktg_iframe.html index 338f49240cbe..ea1b00f1ad61 100644 --- a/lms/templates/mktg_iframe.html +++ b/lms/templates/mktg_iframe.html @@ -8,7 +8,7 @@ <%block name="title"> - + <%static:css group='style-vendor'/> diff --git a/lms/templates/navigation.html b/lms/templates/navigation.html index 2dc571c24700..bb847ed09a36 100644 --- a/lms/templates/navigation.html +++ b/lms/templates/navigation.html @@ -57,11 +57,11 @@

      ${course.display_org_with_default | h}: ${cour
        <%block name="navigation_global_links_authenticated"> - % if settings.MITX_FEATURES.get('COURSES_ARE_BROWSABLE'): + % if settings.FEATURES.get('COURSES_ARE_BROWSABLE'):
      1. ${_('Find Courses')}
        2. - % endif + % endif
        @@ -93,7 +93,7 @@

        ${course.display_org_with_default | h}: ${cour % else:
          <%block name="navigation_global_links"> - % if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE'): + % if settings.FEATURES.get('ENABLE_MKTG_SITE'):
        1. ${_("How it Works")}
          2. @@ -105,8 +105,8 @@

          ${course.display_org_with_default | h}: ${cour % endif - % if not settings.MITX_FEATURES['DISABLE_LOGIN_BUTTON']: - % if course and settings.MITX_FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: + % if not settings.FEATURES['DISABLE_LOGIN_BUTTON']: + % if course and settings.FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain:
        2. ${_("Register Now")}
          3. @@ -120,8 +120,8 @@

          ${course.display_org_with_default | h}: ${cour
          1. - % if not settings.MITX_FEATURES['DISABLE_LOGIN_BUTTON']: - % if course and settings.MITX_FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: + % if not settings.FEATURES['DISABLE_LOGIN_BUTTON']: + % if course and settings.FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD') and course.enrollment_domain: % else: diff --git a/lms/templates/peer_grading/peer_grading.html b/lms/templates/peer_grading/peer_grading.html index 1b212bcc0f43..57df316683cf 100644 --- a/lms/templates/peer_grading/peer_grading.html +++ b/lms/templates/peer_grading/peer_grading.html @@ -2,7 +2,7 @@ <% nothing_to_grade_message = _( """ -{p_tag}You currently do not having any peer grading to do. In order to have peer grading to do: +{p_tag}You currently do not have any peer grading to do. In order to have peer grading to do: {ul_tag} {li_tag}You need to have submitted a response to a peer grading problem.{end_li_tag} {li_tag}The instructor needs to score the essays that are used to help you better understand the grading diff --git a/lms/templates/press.json b/lms/templates/press.json index 43c295b63ecc..794a0803f674 100644 --- a/lms/templates/press.json +++ b/lms/templates/press.json @@ -18,7 +18,7 @@ "publication": "The New York Times", "publish_date": "April 29, 2013" }, - + { "title": "Online Education Lifts Pass Rates at University", "url": "http://online.wsj.com/article/SB10001424127887323741004578414861572832182.html?mod=googlenews_wsj", @@ -80,7 +80,7 @@ "publish_date": "February 20, 2013" }, - + { "title": "Georgetown to offer free online courses", "url": "http://www.washingtonpost.com/local/education/georgetown-to-offer-free-online-courses/2012/12/09/365c4612-3fd3-11e2-bca3-aadc9b7e29c5_story.html", @@ -90,7 +90,7 @@ "publication": "The Washington Post", "publish_date": "December 9, 2012" }, - + { "title": "Wellesley College teams up with online provider edX", "url": "http://bostonglobe.com/2012/12/04/edx/AqnQ808q4IEcaUa8KuZuBO/story.html", @@ -136,7 +136,7 @@ "deck": null, "publication": "BBC", "publish_date": "October 31, 2012" - }, + }, { "title": "VMware to provide software for HarvardX CS50x", "url": "http://tech.mit.edu/V132/N48/edxvmware.html", diff --git a/lms/templates/provider_login.html b/lms/templates/provider_login.html index 3bcd22fafd7e..b7f7067bef5a 100644 --- a/lms/templates/provider_login.html +++ b/lms/templates/provider_login.html @@ -41,6 +41,7 @@

            ${_("Log In")}

            %if error: %endif +

            ${_("Please note that we will be sending your user name, email, and full name to this third party site.")}

            diff --git a/lms/templates/staff_problem_info.html b/lms/templates/staff_problem_info.html index 7f876740474b..7e5561203499 100644 --- a/lms/templates/staff_problem_info.html +++ b/lms/templates/staff_problem_info.html @@ -18,7 +18,7 @@ % endif -% if settings.MITX_FEATURES.get('ENABLE_STUDENT_HISTORY_VIEW') and \ +% if settings.FEATURES.get('ENABLE_STUDENT_HISTORY_VIEW') and \ location.category == 'problem': % endif diff --git a/lms/templates/static_templates/faq.html b/lms/templates/static_templates/faq.html index 9b90fd5c6ca6..4621b30323c1 100644 --- a/lms/templates/static_templates/faq.html +++ b/lms/templates/static_templates/faq.html @@ -62,7 +62,7 @@

            ${_("Will {edX} be adding additional X Universities?").format(edX="edX")}

            ${_("{EdX} will actively explore the addition of other institutions from around the world to the {edX} platform, and looks forward to adding more \"{X_Universities}\".").format(EdX="EdX", edX="edX", X_Universities="X Universities")}

            diff --git a/lms/templates/stripped-main.html b/lms/templates/stripped-main.html index 28166dbd972f..f2e8545e968f 100644 --- a/lms/templates/stripped-main.html +++ b/lms/templates/stripped-main.html @@ -24,7 +24,7 @@ - + diff --git a/lms/templates/sysadmin_dashboard.html b/lms/templates/sysadmin_dashboard.html new file mode 100644 index 000000000000..21dcf4c869dc --- /dev/null +++ b/lms/templates/sysadmin_dashboard.html @@ -0,0 +1,206 @@ +<%inherit file="/main.html" /> +<%! from django.core.urlresolvers import reverse %> +<%! from django.utils.translation import ugettext as _ %> +<%namespace name='static' file='/static_content.html'/> + +<%block name="headextra"> + <%static:css group='style-course'/> + + + + + + +
            +
            + +
            +

            ${_('Sysadmin Dashboard')}

            +
            +

            + ${_('Users')} + ${_('Courses')} + ${_('Staffing and Enrollment')} + ${_('Git Logs')} +

            +
            +%if modeflag.get('users'): +

            ${_('User Management')}

            + +
            + + +
              +
            • + + +
              • + +
            • + + +
              • +
            • + + +
              • +
            + +
            +

            + + +

            +
            + +
            +

            + +

            + +

            + +

            + +
            + + %endif + +%if modeflag.get('staffing'): + +

            ${_("Go to each individual course's Instructor dashboard to manage course enrollment.")}

            +
            + +

            ${_('Manage course staff and instructors')}


            +
            + + + + +%endif + +%if modeflag.get('courses'): +

            ${_('Administer Courses')}


            + +
            + +
              +
            • + + +
              • +
            +
            + +
            +
            +
              +
            • + + +
              • +
            +
            + +
            + +
            +%endif + +%if msg: +

            ${msg}

            +%endif + +%if datatable: + +
            +
            +

            +

            +

            ${datatable['title']}

            +

      Purpose
      Organization
      Problem NameGradedAvailable to GradeRequiredProgress''' + gettext("Problem Name") + '''''' + gettext("Graded") + '''''' + gettext("Available to Grade") + '''''' + gettext("Required") + '''''' + gettext("Progress") + '''
      - +
      + + %for hname in datatable['header']: + + %endfor + + %for row in datatable['data']: + + %for value in row: + + %endfor + + %endfor +
      ${hname}
      ${value}
      +

      +%endif + +%if plots: + + %for plot in plots: +
      +

      ${plot['title']}

      +
      +

      ${plot['info']}

      +
      +
      + +
      +
      + %endfor + +%endif + +
    +
    ${_('Django PID')}: ${djangopid} + | ${_('Platform Version')}: ${mitx_version}
    +
    +
    diff --git a/lms/templates/sysadmin_dashboard_gitlogs.html b/lms/templates/sysadmin_dashboard_gitlogs.html new file mode 100644 index 000000000000..d7709c675d73 --- /dev/null +++ b/lms/templates/sysadmin_dashboard_gitlogs.html @@ -0,0 +1,125 @@ +<%inherit file="/main.html" /> +<%! from django.core.urlresolvers import reverse %> +<%! from django.utils.translation import ugettext as _ %> +<%namespace name='static' file='/static_content.html'/> + +<%block name="headextra"> + <%static:css group='style-course'/> + + + + + +
    +
    + +
    +

    ${_('Sysadmin Dashboard')}

    +
    +

    + ${_('Users')} + ${_('Courses')} + ${_('Staffing and Enrollment')} + ${_('Git Logs')} +

    +
    + +
    + + + +

    ${_('Git Logs')}

    + +%if course_id is None: + + + + + + + + + + %for cil in cilset[:10]: + + + + + + %endfor + +
    ${_('Date')}${_('Course ID')}${_('Git Action')}
    ${cil.created}${cil.course_id}${cil.git_log}
    + +%else: + +

    ${_('Recent git load activity for')} ${course_id}

    + %if error_msg: +

    ${_('Error')}:

    +

    ${error_msg}

    + %endif + + + + + + + + + + + % for cil in cilset[:2]: + + + + + + + + + + % endfor + +
    ${_('Date')}${_('Course ID')}${_('git action')}
    ${cil.created}${cil.course_id}${cil.git_log}
    + 
    ${cil.import_log | h}
    +
    + +% endif + +
    +
    +
    diff --git a/lms/templates/widgets/segment-io.html b/lms/templates/widgets/segment-io.html index 87dc0eebe074..3c6728bb16b6 100644 --- a/lms/templates/widgets/segment-io.html +++ b/lms/templates/widgets/segment-io.html @@ -1,4 +1,4 @@ -% if settings.MITX_FEATURES.get('SEGMENT_IO_LMS'): +% if settings.FEATURES.get('SEGMENT_IO_LMS'): <%! from django.core.urlresolvers import reverse %> <%! import waffle %> @@ -29,4 +29,4 @@ }; -% endif \ No newline at end of file +% endif diff --git a/lms/urls.py b/lms/urls.py index 913c686f1bea..ca154c21c541 100644 --- a/lms/urls.py +++ b/lms/urls.py @@ -6,7 +6,7 @@ import django.contrib.auth.views # Uncomment the next two lines to enable the admin: -if settings.DEBUG or settings.MITX_FEATURES.get('ENABLE_DJANGO_ADMIN_SITE'): +if settings.DEBUG or settings.FEATURES.get('ENABLE_DJANGO_ADMIN_SITE'): admin.autodiscover() urlpatterns = ('', # nopep8 @@ -63,7 +63,7 @@ url(r'^', include('waffle.urls')), ) -# if settings.MITX_FEATURES.get("MULTIPLE_ENROLLMENT_ROLES"): +# if settings.FEATURES.get("MULTIPLE_ENROLLMENT_ROLES"): urlpatterns += ( url(r'^verify_student/', include('verify_student.urls')), url(r'^course_modes/', include('course_modes.urls')), @@ -80,6 +80,12 @@ url(r'^jsi18n/$', 'django.views.i18n.javascript_catalog', js_info_dict), ) +# sysadmin dashboard, to see what courses are loaded, to delete & load courses +if settings.FEATURES["ENABLE_SYSADMIN_DASHBOARD"]: + urlpatterns += ( + url(r'^sysadmin/', include('dashboard.sysadmin_urls')), + ) + #Semi-static views (these need to be rendered and have the login bar, but don't change) urlpatterns += ( url(r'^404$', 'static_template_view.views.render', @@ -87,7 +93,7 @@ ) # Semi-static views only used by edX, not by themes -if not settings.MITX_FEATURES["USE_CUSTOM_THEME"]: +if not settings.FEATURES["USE_CUSTOM_THEME"]: urlpatterns += ( url(r'^jobs$', 'static_template_view.views.render', {'template': 'jobs.html'}, name="jobs"), @@ -130,7 +136,7 @@ # To allow theme templates to inherit from default templates, # prepend a standard prefix - if settings.MITX_FEATURES["USE_CUSTOM_THEME"]: + if settings.FEATURES["USE_CUSTOM_THEME"]: template = "theme-" + template # Make the assumption that the URL we want is the lowercased @@ -318,13 +324,13 @@ ) # allow course staff to change to student view of courseware - if settings.MITX_FEATURES.get('ENABLE_MASQUERADE'): + if settings.FEATURES.get('ENABLE_MASQUERADE'): urlpatterns += ( url(r'^masquerade/(?P.*)$', 'courseware.masquerade.handle_ajax', name="masquerade-switch"), ) # discussion forums live within courseware, so courseware must be enabled first - if settings.MITX_FEATURES.get('ENABLE_DISCUSSION_SERVICE'): + if settings.FEATURES.get('ENABLE_DISCUSSION_SERVICE'): urlpatterns += ( url(r'^courses/(?P[^/]+/[^/]+/[^/]+)/discussion/', include('django_comment_client.urls')), @@ -339,7 +345,7 @@ 'courseware.views.static_tab', name="static_tab"), ) - if settings.MITX_FEATURES.get('ENABLE_STUDENT_HISTORY_VIEW'): + if settings.FEATURES.get('ENABLE_STUDENT_HISTORY_VIEW'): urlpatterns += ( url(r'^courses/(?P[^/]+/[^/]+/[^/]+)/submission_history/(?P[^/]*)/(?P.*?)$', 'courseware.views.submission_history', @@ -347,7 +353,7 @@ ) -if settings.COURSEWARE_ENABLED and settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BETA_DASHBOARD'): +if settings.COURSEWARE_ENABLED and settings.FEATURES.get('ENABLE_INSTRUCTOR_BETA_DASHBOARD'): urlpatterns += ( url(r'^courses/(?P[^/]+/[^/]+/[^/]+)/instructor_dashboard$', 'instructor.views.instructor_dashboard.instructor_dashboard_2', name="instructor_dashboard_2"), @@ -356,29 +362,29 @@ include('instructor.views.api_urls')) ) -if settings.DEBUG or settings.MITX_FEATURES.get('ENABLE_DJANGO_ADMIN_SITE'): +if settings.DEBUG or settings.FEATURES.get('ENABLE_DJANGO_ADMIN_SITE'): ## Jasmine and admin urlpatterns += (url(r'^admin/', include(admin.site.urls)),) -if settings.MITX_FEATURES.get('AUTH_USE_OPENID'): +if settings.FEATURES.get('AUTH_USE_OPENID'): urlpatterns += ( url(r'^openid/login/$', 'django_openid_auth.views.login_begin', name='openid-login'), url(r'^openid/complete/$', 'external_auth.views.openid_login_complete', name='openid-complete'), url(r'^openid/logo.gif$', 'django_openid_auth.views.logo', name='openid-logo'), ) -if settings.MITX_FEATURES.get('AUTH_USE_SHIB'): +if settings.FEATURES.get('AUTH_USE_SHIB'): urlpatterns += ( url(r'^shib-login/$', 'external_auth.views.shib_login', name='shib-login'), ) -if settings.MITX_FEATURES.get('AUTH_USE_CAS'): +if settings.FEATURES.get('AUTH_USE_CAS'): urlpatterns += ( url(r'^cas-auth/login/$', 'external_auth.views.cas_login', name="cas-login"), url(r'^cas-auth/logout/$', 'django_cas.views.logout', {'next_page': '/'}, name="cas-logout"), ) -if settings.MITX_FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD'): +if settings.FEATURES.get('RESTRICT_ENROLL_BY_REG_METHOD'): urlpatterns += ( url(r'^course_specific_login/(?P[^/]+/[^/]+/[^/]+)/$', 'external_auth.views.course_specific_login', name='course-specific-login'), @@ -393,7 +399,7 @@ ) -if settings.MITX_FEATURES.get('AUTH_USE_OPENID_PROVIDER'): +if settings.FEATURES.get('AUTH_USE_OPENID_PROVIDER'): urlpatterns += ( url(r'^openid/provider/login/$', 'external_auth.views.provider_login', name='openid-provider-login'), url(r'^openid/provider/login/(?:.+)$', 'external_auth.views.provider_identity', name='openid-provider-login-identity'), @@ -401,7 +407,7 @@ url(r'^openid/provider/xrds/$', 'external_auth.views.provider_xrds', name='openid-provider-xrds') ) -if settings.MITX_FEATURES.get('ENABLE_LMS_MIGRATION'): +if settings.FEATURES.get('ENABLE_LMS_MIGRATION'): urlpatterns += ( url(r'^migrate/modules$', 'lms_migration.migrate.manage_modulestores'), url(r'^migrate/reload/(?P[^/]+)$', 'lms_migration.migrate.manage_modulestores'), @@ -410,23 +416,23 @@ url(r'^gitreload/(?P[^/]+)$', 'lms_migration.migrate.gitreload'), ) -if settings.MITX_FEATURES.get('ENABLE_SQL_TRACKING_LOGS'): +if settings.FEATURES.get('ENABLE_SQL_TRACKING_LOGS'): urlpatterns += ( url(r'^event_logs$', 'track.views.view_tracking_log'), url(r'^event_logs/(?P.+)$', 'track.views.view_tracking_log'), ) -if settings.MITX_FEATURES.get('ENABLE_SERVICE_STATUS'): +if settings.FEATURES.get('ENABLE_SERVICE_STATUS'): urlpatterns += ( url(r'^status/', include('service_status.urls')), ) -if settings.MITX_FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): +if settings.FEATURES.get('ENABLE_INSTRUCTOR_BACKGROUND_TASKS'): urlpatterns += ( url(r'^instructor_task_status/$', 'instructor_task.views.instructor_task_status', name='instructor_task_status'), ) -if settings.MITX_FEATURES.get('RUN_AS_ANALYTICS_SERVER_ENABLED'): +if settings.FEATURES.get('RUN_AS_ANALYTICS_SERVER_ENABLED'): urlpatterns += ( url(r'^edinsights_service/', include('edinsights.core.urls')), ) @@ -438,20 +444,20 @@ url(r'^comm/foldit_ops', 'foldit.views.foldit_ops', name="foldit_ops"), ) -if settings.MITX_FEATURES.get('ENABLE_DEBUG_RUN_PYTHON'): +if settings.FEATURES.get('ENABLE_DEBUG_RUN_PYTHON'): urlpatterns += ( url(r'^debug/run_python', 'debug.views.run_python'), ) # Crowdsourced hinting instructor manager. -if settings.MITX_FEATURES.get('ENABLE_HINTER_INSTRUCTOR_VIEW'): +if settings.FEATURES.get('ENABLE_HINTER_INSTRUCTOR_VIEW'): urlpatterns += ( url(r'^courses/(?P[^/]+/[^/]+/[^/]+)/hint_manager$', 'instructor.hint_manager.hint_manager', name="hint_manager"), ) # enable automatic login -if settings.MITX_FEATURES.get('AUTOMATIC_AUTH_FOR_TESTING'): +if settings.FEATURES.get('AUTOMATIC_AUTH_FOR_TESTING'): urlpatterns += ( url(r'^auto_auth$', 'student.views.auto_auth'), ) diff --git a/mongo_indexes.md b/mongo_indexes.md index 513367473772..f42aed9a58d4 100644 --- a/mongo_indexes.md +++ b/mongo_indexes.md @@ -16,6 +16,6 @@ location_map: ============= ``` -ensureIndex({​'_id.org': 1, '_id.course': 1}) -ensureIndex({​'course_id': 1}) +ensureIndex({'_id.org': 1, '_id.course': 1}) +ensureIndex({'course_id': 1}) ``` diff --git a/package.json b/package.json index 2213d41f8d3f..31876d5a321a 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "mitx", + "name": "edx", "version": "0.1.0", "dependencies": { "coffee-script": "1.6.X" diff --git a/proxy/nginx.conf b/proxy/nginx.conf index 2b48e17d0377..77d5a6eb8d8e 100644 --- a/proxy/nginx.conf +++ b/proxy/nginx.conf @@ -1,6 +1,6 @@ -# Mapping of +# Mapping of # -# From the /mitx directory: +# From the /edx-platform directory: # /usr/local/Cellar/nginx/1.2.2/sbin/nginx -p `pwd`/ -c nginx.conf worker_processes 1; @@ -49,7 +49,7 @@ http { rewrite ^(.*)/favicon.ico$ /static/images/favicon.ico last; - # Our catchall + # Our catchall location / { proxy_pass http://portal; } diff --git a/rakelib/deploy.rake b/rakelib/deploy.rake deleted file mode 100644 index 1d0a1b2c4f71..000000000000 --- a/rakelib/deploy.rake +++ /dev/null @@ -1,15 +0,0 @@ - -# Packaging constants -COMMIT = (ENV["GIT_COMMIT"] || `git rev-parse HEAD`).chomp()[0, 10] -PACKAGE_NAME = "mitx" -BRANCH = (ENV["GIT_BRANCH"] || `git symbolic-ref -q HEAD`).chomp().gsub('refs/heads/', '').gsub('origin/', '') - -desc "Build a properties file used to trigger autodeploy builds" -task :autodeploy_properties do - File.open("autodeploy.properties", "w") do |file| - file.puts("UPSTREAM_NOOP=false") - file.puts("UPSTREAM_BRANCH=#{BRANCH}") - file.puts("UPSTREAM_JOB=#{PACKAGE_NAME}") - file.puts("UPSTREAM_REVISION=#{COMMIT}") - end -end \ No newline at end of file diff --git a/rakelib/tests.rake b/rakelib/tests.rake index 130ff3d9fd8d..fb324c080722 100644 --- a/rakelib/tests.rake +++ b/rakelib/tests.rake @@ -21,13 +21,20 @@ def run_tests(system, report_dir, test_id=nil, stop_on_failure=true) # If no test id is provided, we need to limit the test runner # to the Djangoapps we want to test. Otherwise, it will # run tests on all installed packages. + + default_test_id = "#{system}/djangoapps common/djangoapps" + + if system == :lms + default_test_id += " #{system}/lib" + end + if test_id.nil? - test_id = "#{system}/djangoapps common/djangoapps" + test_id = default_test_id # Handle "--failed" as a special case: we want to re-run only # the tests that failed within our Django apps elsif test_id == '--failed' - test_id = "#{system}/djangoapps common/djangoapps --failed" + test_id = "#{default_test_id} --failed" end cmd = django_admin(system, :test, 'test', test_id) diff --git a/requirements/edx/base.txt b/requirements/edx/base.txt index 3bcfe9abe0ea..e8dcb9191b28 100644 --- a/requirements/edx/base.txt +++ b/requirements/edx/base.txt @@ -42,6 +42,7 @@ lazy==1.1 lxml==3.0.1 mako==0.7.3 Markdown==2.2.1 +mongoengine==0.7.10 networkx==1.7 nltk==2.0.4 oauthlib==0.5.1 @@ -92,7 +93,7 @@ transifex-client==0.9.1 # Used for testing coverage==3.7 ddt==0.4.0 -factory_boy==2.0.2 +factory_boy==2.2.1 mock==1.0.1 nosexcover==1.0.7 pep8==1.4.5 diff --git a/requirements/edx/github.txt b/requirements/edx/github.txt index 798c40f6bd3c..c779abedf3b8 100644 --- a/requirements/edx/github.txt +++ b/requirements/edx/github.txt @@ -7,7 +7,7 @@ # Python libraries to install directly from github # Third-party: --e git+https://github.com/edx/django-staticfiles.git@6d2504e5c8#egg=django-staticfiles +-e git+https://github.com/edx/django-staticfiles.git@d89aae2a82f2b#egg=django-staticfiles -e git+https://github.com/edx/django-pipeline.git@88ec8a011e481918fdc9d2682d4017c835acd8be#egg=django-pipeline -e git+https://github.com/edx/django-wiki.git@41815e2ef1b0323f92900f8e60711b0f0c37766b#egg=django-wiki -e git+https://github.com/edx/lettuce.git@503fe2d2599290c45b021d6c424ab5ea899e42be#egg=lettuce diff --git a/requirements/edx/local.txt b/requirements/edx/local.txt index 7941f9fa5e03..8a9568fdd55e 100644 --- a/requirements/edx/local.txt +++ b/requirements/edx/local.txt @@ -1,4 +1,4 @@ -# Python libraries to install that are local to the mitx repo +# Python libraries to install that are local to the edx-platform repo -e common/lib/calc -e common/lib/capa -e common/lib/chem diff --git a/scripts/runone.py b/scripts/runone.py index 19b5f7195b68..e4dcce8dea55 100755 --- a/scripts/runone.py +++ b/scripts/runone.py @@ -5,7 +5,7 @@ import sys # I want this: -# ERROR: test_update_and_fetch (mitx.cms.djangoapps.contentstore.tests.test_course_settings.CourseDetailsViewTest) +# ERROR: test_update_and_fetch (edx-platform.cms.djangoapps.contentstore.tests.test_course_settings.CourseDetailsViewTest) # to become: # test --settings=cms.envs.test --pythonpath=. -s cms/djangoapps/contentstore/tests/test_course_settings.py:CourseDetailsViewTest.test_update_and_fetch @@ -32,9 +32,13 @@ def main(argv): if words[0].endswith(':'): del words[0] - test_method = words[0] - test_path = words[1].split('.') - if test_path[0] == 'mitx': + if len(words) == 1: + test_path, test_method = words[0].rsplit('.', 1) + test_path = test_path.split('.') + else: + test_method = words[0] + test_path = words[1].split('.') + if test_path[0] == 'edx-platform': del test_path[0] test_class = test_path[-1] del test_path[-1] diff --git a/scripts/setup-test-dirs.sh b/scripts/setup-test-dirs.sh index c4db61ec161d..efd18fa493dd 100755 --- a/scripts/setup-test-dirs.sh +++ b/scripts/setup-test-dirs.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash -# Create symlinks from ~/mitx_all/data or $ROOT/data, with root passed as first arg -# to all the test courses in mitx/common/test/data/ +# Create symlinks from ~/edx_all/data or $ROOT/data, with root passed as first arg +# to all the test courses in edx-platform/common/test/data/ # posix compliant sanity check if [ -z $BASH ] || [ $BASH = "/bin/sh" ]; then @@ -9,20 +9,20 @@ echo "Please use the bash interpreter to run this script" exit 1 fi -ROOT="${1:-$HOME/mitx_all}" +ROOT="${1:-$HOME/edx_all}" if [[ ! -d "$ROOT" ]]; then echo "'$ROOT' is not a directory" exit 1 fi -if [[ ! -d "$ROOT/mitx" ]]; then - echo "'$ROOT' is not the root mitx_all directory" +if [[ ! -d "$ROOT/edx-platform" ]]; then + echo "'$ROOT' is not the root edx_all directory" exit 1 fi if [[ ! -d "$ROOT/data" ]]; then - echo "'$ROOT' is not the root mitx_all directory" + echo "'$ROOT' is not the root edx_all directory" exit 1 fi @@ -30,7 +30,7 @@ echo "ROOT is $ROOT" cd $ROOT/data -for course in $(/bin/ls ../mitx/common/test/data/) +for course in $(/bin/ls ../edx-platform/common/test/data/) do # Get rid of the symlink if it already exists if [[ -L "$course" ]]; then @@ -39,7 +39,7 @@ do fi echo "Make link to '$course'" # Create it - ln -s "../mitx/common/test/data/$course" + ln -s "../edx-platform/common/test/data/$course" done # go back to where we came from