Storybook Packager – Beta Release

The storybook packager is now available for beta testing! This is an early build that is not yet feature-complete and is likely to have bugs. Be sure to back up your work!

Download Storybook Packager Beta

Installing

  1. Download from the link above.
  2. Unzip the download (if your browser has not already done so for you) and drag the Storybook Packager app to your Applications folder.
  3. Right-click the Storybook Packager application and choose “Open”. This will present you with a dialog saying that the application is not signed by a trusted developer. Click open to continue. – From now on you should be able to open the application in the same way you open any application on your Mac.

Using Storybook Packager

Documentation is currently limited as the application is currently in beta, and things are likely to change. Please explore the app to discover how it all works. And feel free to ask Ethan or Bryan questions!

  1. Presentation Properties – Configure presentation properties like presenation title and author.
  2. Presentation Settings – Configure presentation settings like image format, analytics, and accent color.
  3. Downloadable Files – Configure what files are bundled with the presntation such as transcripts and downloadable audio.
  4. Import Presentation Assets – Select files one-by-one or in bulk to import into the presentation. This can also be done by drag and drop from the Finder.
  5. Table of Contents/Navigation – Navigate the presentation and change what Storybook Page you are currently editing. You can also delete slides and rearrange them.
  6. Storybook Page properties/settings – Configure settings sepectic to this Storybook Page such at Page Type, title, and Storybook Page contents
  7. Set Image/Audio/Video assets for the selected Storybook Page – Place image, audio and video files on this Storybook Page. Or set the Video ID for videos hosted by other services.
  8. Notes/Widgets Editor – Edit the notes area for this Storybook Page. The editor is plain text, all formatting should be done via basic HTML.
  9. Add a Section – Add a section to your presntation. New sections are placed after your current selection in the Table of Contents.
  10. Add a Storybook Page – Add a Storybook Page to your presntation. New pages are placed after your current selection in the Table of Contents.

Presentation Project Format

.sbproj – The Storybook Packager saves a Storybook Presentation in a special folder format called a “package.” This package has the file extension .sbproj and is a single file that you can double-click on macOS to open the presentation in Storybook Packager.

Manually Editing the Project – The .sbproj package file is actually a folder with the contents of a standard Storybook Presentation folder. It is structured the same way and can be uploaded and deployed in the same way. To view the contents of this package in the Finder you can right-click the presentation and select “Show Package Contents”. From here you can manually modify the contents/XML of the Storybook Presentation. Note: Do not manually edit the contents of a storybook presentation while you have it open with the Storybook Packager. This could lead to unexpected issues and the loss of work.

Publishing – Presentations created with the Storybook Packager can be uploaded and downloaded from a Web Server just like a normal folder full of files. The .sbproj file extension will not cause issues, and should be left intact. This will both indicate it is a presentation made with the Storybook Packager and allow it to be easily opened with the packager when downloaded from the Web Server.

Reporting Bugs and Making Feature Requests

Storybook Packager Public GitHub Repository

If you find any bugs, please report them in the issues section of the Public GitHub repository for the Storybook Packager. Please be as detailed as possible in your report. Screenshots and crash should be included in your report where possible.

Please feel free to make feature request issues too!

FAQs

How to revert .sbproj file back to default folder?
Remove file extension confirmation dialog
To revert .sbproj file back to default folder appearance and behavior, remove the .sbproj from the file name. A Finder dialog will be displayed to prompt for confirmation. Click “Remove” to continue, and .sbproj file should now appears and behave like a regular folder.

When and why to revert .sbproj file back to default folder?
Storybook Packager is currently in beta phase and not feature complete. If a Storybook presentation project requires the use of not-yet supported features (such as HTML page type, an image in a quiz item, etc.), the file can be reverted back to regular folder appearance and behaviors. Once a file has been reverted back to default folder behavior and not-yet supported features have been added, Storybook Packager will no longer be able to open this file until the added feature is supported.

Published on April 16, 2019 at 3:33:49 pm CDT. Last modified on August 26, 2019 at 12:14:31 pm CDT.