Git Product home page Git Product logo

uwex-learning-tech / sbplus-v3 Goto Github PK

View Code? Open in Web Editor NEW
2.0 5.0 1.0 50.2 MB

Storybook Plus is a web application for delivering multimedia presentations.

Home Page: https://media.uwex.edu/our-work/application-showcase/the-storybook-player

License: GNU General Public License v3.0

CSS 0.06% JavaScript 95.88% Smarty 0.46% HTML 0.07% PHP 0.07% SCSS 3.46%
webapp multimedia-storytelling multimedia education video-player audio-player presentation-tools

sbplus-v3's People

Contributors

lin87 avatar owlboy avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

iambillweber

sbplus-v3's Issues

Author Profile - Use the Name from the Author Profile Globally

The author profile is intended to be the canonical, or exact spelling/formatting of both the Author Name and the Author Bio/Profile. This allows us to update both the name and the Bio once and have it cascade to all Storybook Projects keyed to that Profile.

Currently, the name in the profile is not being used in all places that the name appears. It is only being used in the profile box.

We need the author profile Name sting to be used anywhere the Author Name appears in the Storybook Presentation. When the profile cannot be loaded, fall back to the string in the sbplus.xml.

Author Profile Photo Formatting

Hello,

This is something we discussed at one point, and I just wanted to get it in a formal ticket so it's not lost in the shuffle and so you can get to it when you have time.

The author profile photo needs some formatting set so that it can be a higher resolution image ready for high DPI screens, and not get gigantic.

I have attached an example screenshot that is at about the standard embed size of 900x630.

The specifications / Requirements:

  • Max height of 300px
  • Grey background gets wider to fill in empty space as the viewport gets bigger
  • Grey background does not get taller
  • Photo is centered in the grey background
  • Photo can be any aspect ratio, a really wide photo would be cutoff on the sides at smaller viewport sizes. A super tall photo would scale to fit it's full height in the fixed height photo area, leaving a large amount of grey background showing.

Standard Viewport/iFrame Embed:
profile_photo

Huge Viewport:
profile_photo-huge-viewport

Let me know if you have more questions!

Author Profile - Show What is Available to Show

When loading the author profile, it would be preferable to have it load what it does have instead of completely failing.

This is in addition to continuing to attempt to fallback to centralized assets once it knows local versions of the Author Photo and Author Profile don't exist. Including supporting a mix/match of all possibilities. (Local Profile & Central Picture; Central Profile & Local Picture; Local Picture, Completely Missing Profile; etc.)

Should We Display a Single Tab when there is Only one?

I would like input on this issue from @Lin87 @patrick-wirth @mwolfensteinuwex.

It was brought up at a meeting that maybe we should consider hiding the tab when only one Note or Widget is being displayed.

In Support of Hiding the Single Tab:
• Allows for the space to be used for content
• If it's just one tab, and there is no possibility of more appearing dynamically, there is no reason for it to be there.
• We never labeled the notes section "Notes" before now
• They are useful mainly for differentiation between Notes and Widgets

In Support of Displaying the Single Tab:
• It is visually consistent with other slides with notes/widgets
• It labels the Notes / Widget (But this could be done via text inside of the note / widget)
• It's simpler to implement on Ethan's end

Author Profile - Center Heading Vertically

Please center the Author Profile heading text vertically in the bar. Currently it changes depending on the size of the viewport. The larger the size, the more uncentered it gets.

screen shot 2016-08-31 at 5 55 51 pm

Author Profile - Error Reporting

Please update the Author Profile loading errors to be more granular and clearly communicated.

Report when a JSON file exists, but it failed to read in properly (Syntax errors in the JSON):

  • Message: "Author profile failed to load. Syntax error."
  • Formatting: Plain text, red. (As it is now)

Report when an author profile is missing:

  • Message: "Author profile not available."
  • Formatting: Bold, black, same size as the author name. (Same formatting as the author name) – We do not want this to be red because a missing profile might be intentional expected behavior for that presentation.

When the author photo is missing, please make Storybook do the following:

  • Make the Photo background exactly twice the height of the "Author Profile" heading bar above it.
  • Load the included profile icon centered in the space (Both vertically and Horizontally)

Mockup:
profile_photo-missing

The Profile Icon:
profile_photo.svg.zip

This icon is from Icomoon, it's "0501 user" and I have colored it #656b70, please use that color.

Invalid XML Error - Minor Convenience update

Hello!

Minor update request:

When you have an incorrect XML file, you helpfully link to where I could get it validated to sort out the issue. Lets take this a step further by making it load the XML in question too!

So, all we need to do is replace the link to the validator site with one with a query string for the URL to the sbplus.xml file of the presentation.

Original:
Validate the XML at <a href="https://validator.w3.org/">https://validator.w3.org/</a>.

Proposed Change:
<a href="https://validator.w3.org/check?uri=$$SBPLUS.XML$$&charset=%28detect+automatically%29&doctype=Inline&group=0">Validate the XML at the WC3 Markup Validation Service</a>
($$SBPLUS.XML$$ is where the URL to the sbplus.xml of the project goes)

All other text and formatting choices that are currently on the page are great.

Images Jump / Scale During Page Change When in Zoomed Mode

Hello,

I am working on a presentation that will be used at the Faculty Symposium and we plan to present using Storybook in Zoomed mode in a Fullscreen Browser.

Transitions seem fast without flicker or loading spinners. But when in zoomed mode they jump around as they are scaled to fit into the content area.

Example: https://youtu.be/yDdjYd51jH0
Presentation: faculty_symposium_2017-infomercial

If this could be fixed it would be fantastic. The jumps are very distracting/Ugly as they are now, especially for a presentation to a crowd of Faculty.

The Symposium is on Monday May 22nd. So we have time, but if this could be tweaked as soon as possible that would be fantastic.

Thank you!

Bulleted Lists in Author Profiles

I am having trouble getting bullets in lists to display in author profiles. When I edit things in the inspector in Safari to add the CSS to make them display again they are aligned poorly. Please check that ordered lists work too.

Quiz - Feedback Formatting - Do Not Display the Feedback Heading if no Feedback Exists

When the quiz renders feedback, and finds there is none provided for the answers given, don't display the Feedback heading.

In other words, if the applicable <Feedback /> tag is empty, don't render a heading. This will prevent Storybook from showing something to the user that the user might interpret as an error or incomplete.

Further, keep in mind that this situation needs to work too:
Answer A - Has Feedback
Answer B - NO FEEDBACK
Answer C - Has Feedback

If the user picks answer B, the feedback heading should not be shown. If they pick A or C it should be shown, along with the feedback.

Sadly I have to make lots of quiz questions where the author did no provide feedback for one or more of the answers.

Quiz - Question Formatting - Indents

To make things cleaner, and easer to read, we need to have the Radio buttons and Checkboxes of quiz question answers be separate and to the left of the blocks of text that are associated with them.

Current Appearance:
screen shot 2016-08-26 at 4 02 15 pm

Mockup of Requested Appearance:
screen shot 2016-08-26 at 4 00 03 pm

Playback Rate Not Applied

For some reason playback rate/speed is not applied to the video when set in settings and not carry over to the next video when changed in the playback control. Everything is correct, but VideoJS is not recognizing the rate change event. This happens on desktop. On mobile, it may be another story.

FYI, @owlboy .

Captions are Not Displaying

Captions are not displaying.

Example Project:
https://media.uwex.edu/content/himt/himt300_r16/himt300_unit1/

If Matt resizes the viewport, he can manage to make it appear. It seems like it is displaying both too low, and on a layer/z-depth that is below the slide image. Or it is just too low and under the notes div.

Here is a video of that:
https://youtu.be/LrX87aMqNVU

In Safari I don't have captions, but can't make the graphical artifact/error happen. Matt can make it happen in Chrome and Firefox. (I think Safari is just good at keeping the rendering up-to-date and clean.)

Math - Impliment MathJax

So, this is the ultimate solution to getting Math working once and for all in a consistent way in Storybook. We probally should have implimented it last year, but I was working hard trying to avoid loading another Javascript library every time a Storybook presentation is used.

So, I feel we should impliment MathJax in the current version of Storybook v3.

If you feel loading this library for every presentation would be a bad practice, then I would request that we do it in a way so it can load optionally based on a sbplus.xml tag.

Something like <storybook mathjax="yes">

https://www.mathjax.org/

Media Loading Error Display / Text

Some changes to make the errors displayed more useful/clear/readable:

1. Add a background box that is similar the one used on the Splash Screen

  • Same Transparent White Background
  • Rounded Corners
  • Black Text

Currently the white text is not readable on top of white slides.

2. Update the Error Text

  • Error describes the "media" that did not load
  • Error provides help for students

image-audio

The audio for this Storybook Page could not be loaded. Please try refreshing your browser. Contact support if you continue to have issues.
Expected audio: assets/pages/slide17.mp3

The image for this Storybook Page could not be loaded. Please try refreshing your browser. Contact support if you continue to have issues.
Expected image: assets/pages/slide17.svg

The audio and image for this Storybook Page could not be loaded. Please try refreshing your browser. Contact support if you continue to have issues.
Expected audio: assets/pages/slide17.mp3
Expected image: assets/pages/slide17.svg

Video

The video for this Storybook Page could not be loaded. Please try refreshing your browser. Contact support if you continue to have issues.
Expected video: assets/pages/slide17.mp4


I understand what the intent of the original error was, but we have to recognize these errors will occur for end users too. We can figure out what's going on while developing, and don't need to be told that our file format is wrong.

I also understand that you might not have anything in place to differentiate between audio and images. Please look into adding that functionality. It would go a long way to making sure a student knows that the error displaying is not intact an error in-itself. They might link "oh, I see the slide, the error must be wrong… and it's in the way of the slide text!" When in fact they should know the audio that goes on that Storybook Page is not loaded.

Remember how Crystal didn't understand the Table of Contents? We are thinking of users like that.

Kaltura Videos - Handle Videos that are Processing in a more Understandable Way

When a video on Kaltura has been recently uploaded, it exhibits some weird behavior in Storybook until it is done processing.

Two examples of it behaving weirdly:

  • Displaying an error saying that the audio for that Storybook Page could not be found, and then saying the expected audio file is the Kaltura ID.
  • Say we have a 4 Page presentation. Page one has a fully functioning Kaltura video. The next three are still processing. If I view Page 1, and then Page 2, 3, and 4, they all display the video from Page 1, no indication it could not load the intended video, no errors. Just a functioning page playing the wrong video. This is confusing for people who don't understand Kaltura and how it processes videos. It could lead a project creator to think their XML is wrong. But if they check their XML they will find it is correct. So they try again and it's still showing the wrong video. Minutes later, from their point of view, it just "magically" starts working. They don't know or care about the processing necessarily.

There is another situation where I struggle with this, even though I fully understand the reasons behind the weirdness. That situation occurs when I send one of these presentations to ID. I tell them videos are still processing. But they still sometimes report to me that the pages that are processing are broken, or displaying the wrong content. My response sadly up until now is some messaged version of "yeah, it's acting weird because of that processing I mentioned…"

I feel strongly that the solution is not: Tell people that while a Kaltura video is still processing that Storybook will act erratically.

The solution is to support this situation properly with proper error messages. I am assuming the Kaltura API returns a code/message when a video is still processing. This needs to be caught and used to display the more useful message, and end the confusing erratic behavior.

Also, I totally understand why this was not considered before now. You never encountered such a situation when creating the Kaltura feature. Test videos were always all finished and ready to play.

When you are ready to tackle this, I can help you with the Kaltura side of making the "still processing" situations.

Add Storybook Information/Version to the Help Screen

It would be fantastic if the Help Pane could have a section that displays that this presentation is powered by StoryBook Plus v3, and list it's version number.

This way if a person uses this route to report issues, they can know what to call the type of "video" they are using, and the version number to pass on to us.

Color Contrast in Menu

The contrast between the blue active menu selection and the grey background is too low in the hamburger menu.

I'd consider making the blue brighter.

Feature Request: preventAutoPlay="yes" Flag

Hello,

Nick came to Ethan and I today with a feature request for Storybook that would add a flag to pages that would prevent them from autoplaying when arriving at the page.

The use case he has in mind is a mostly silent text commentary presentation that ends with a video. He would like students to be able to control when the video starts as to not be surprised by audio in the video after spending awhile in silence.

I think that adding a optional preventAutoPlay="yes" flag to the <page> tag would be ideal for this. And the flag title would make it very clear what it is for. The intent would be for it to work on all slide types that use the built in VideoJS player. And we would work to make sure it is not confusable with a feature that autoplays the whole presentation page after page.

Rework notes area into widget components.

Previously notes area will be restructured to contain multiple components such as live transcript (if available) and any custom information specified in the XML. Notes will be one of the components as well and displayed if available.

Update Labels

To make what settings do more clear to end users, please make the following updates:

In Settings

General

  • Hide Notes/Widgets area by default
  • Hide Table of Contents by default
  • Disable Interactive Transcript (alpha)

Video and Audio Player

  • Autoplay audio and video
  • Default Volume Level (%)
  • Default playback rate
  • Always display subtitles

Elsewhere

  • Update "Hide Widget" button to be "Toggle Notes/Widgets Area"

Make Quiz correct attributes case insensitive.

Hello,

Just a minor tweak request if it's not a big deal to implement:

When writing quiz question XML it would be nice if the correct="Yes" attribute would be case insensitive so that "Yes" works along with "yes".

If this is acceptable, then please also apply the change to any other attributes where case insensitivity makes sense.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.