Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Move README to docs.

Browse Source
This commit is contained in:
polesye
2014-01-21 13:56:11 +02:00
parent ee4178e7f5
commit a41df03c64
3 changed files with 11 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
common/lib/xmodule/xmodule/js/src/video/README.rst
View File

@@ -1,16 +0,0 @@
Video player persists some user preferences between videos and these
preferences are stored on server.
Content for sequential positions is loaded just once on page load and is not
updated when the user navigates between sequential positions. So, we doesn't
have an actual data from server.
To resolve this issue, cookies are used as temporary storage and are removed
on page unload.
How it works:
1) On page load: cookies are empty and player get an actual data from server.
2) When user change some preferences, new value is stored to cookie;
3) If we navigate to another sequential position, video player get an actual data
from cookies.
4) Close the page: `unload` event fires and we clear our cookies and send user
preferences to the server.

10
docs/en_us/developers/source/video_player.rst Normal file
View File

@@ -0,0 +1,10 @@
Video player persists some user preferences between videos and these preferences are stored on server.
Content for sequential positions is loaded just once on page load and is not updated when the user navigates between sequential positions. So, we doesn't have an actual data from server.
To resolve this issue, cookies are used as temporary storage and are removed on page unload.
How it works:
1) On page load: cookies are empty and player get an actual data from server.
2) When user change some preferences, new value is stored to cookie;
3) If we navigate to another sequential position, video player get an actual data from cookies.
4) Close the page: `unload` event fires and we clear our cookies and send user preferences to the server.

2
docs/en_us/developers/source/xmodule.rst
View File

@@ -154,7 +154,7 @@ Vertical
Video
=====
.. include:: video_player.rst
.. automodule:: xmodule.video_module
:members:
:show-inheritance: