From a41df03c64f8727343e723475aaefb820f08e788 Mon Sep 17 00:00:00 2001 From: polesye Date: Tue, 21 Jan 2014 13:56:11 +0200 Subject: [PATCH] Move README to docs. --- .../lib/xmodule/xmodule/js/src/video/README.rst | 16 ---------------- docs/en_us/developers/source/video_player.rst | 10 ++++++++++ docs/en_us/developers/source/xmodule.rst | 2 +- 3 files changed, 11 insertions(+), 17 deletions(-) delete mode 100644 common/lib/xmodule/xmodule/js/src/video/README.rst create mode 100644 docs/en_us/developers/source/video_player.rst diff --git a/common/lib/xmodule/xmodule/js/src/video/README.rst b/common/lib/xmodule/xmodule/js/src/video/README.rst deleted file mode 100644 index d27ab86517..0000000000 --- a/common/lib/xmodule/xmodule/js/src/video/README.rst +++ /dev/null @@ -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. diff --git a/docs/en_us/developers/source/video_player.rst b/docs/en_us/developers/source/video_player.rst new file mode 100644 index 0000000000..ce0744cbb8 --- /dev/null +++ b/docs/en_us/developers/source/video_player.rst @@ -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. diff --git a/docs/en_us/developers/source/xmodule.rst b/docs/en_us/developers/source/xmodule.rst index 77ee2ea684..879eab485c 100644 --- a/docs/en_us/developers/source/xmodule.rst +++ b/docs/en_us/developers/source/xmodule.rst @@ -154,7 +154,7 @@ Vertical Video ===== - +.. include:: video_player.rst .. automodule:: xmodule.video_module :members: :show-inheritance: