{
/**
* The container to load the comic reader into.
* Should be a jQuery selector
*
* @type {String}
* @default
*/
container: '.panelz-creator-container',
/**
* The method by which to load the interface.
* id: fetch comic book data
* data: load the comic via an object
* ui: allow them to create from scratch
* @type {String}
*/
method: 'ui',
/**
* ID of the book to load when fetching the data.
* This value is required if a <#comic> object
* has not been provided.
*
* @type {String}
* @default
*/
id: false,
/**
* Object of comic data to load into the creator. Must
* contain an id, title, and array of pages. Each page
* object must look like the following:
* id: "<stringID>",
* title: "<title>",
* pages = [
* {
* url: "<urlOfImage>",
* size: <size> //in bytes
* panels: [
* {
* x: xCoordinateOfPanel
* y: yCoordinateOfPanel
* width: widthOfPanel
* height: heightOfPanel
* }
* ...
* ]
* }
* ...
* ]
* The panels array within each page can be empty if the
* page contains to panels to zoom to for the Panel Zoom feature.
*
* @type {Object}
* @default
*/
comic: {},
/**
* Supply a custom list of endpoints. The Panelz reader
* requires a number of configured URLs.
*
* The {id} placeholder will be swapped for the supplied
* <#id> configuration parameter.
*
* @type {Object}
* @default
*/
endpoints: {
/**
* Link to view the comic
*
* @type {String}
*/
view: '/read/?id={id}',
/**
* Gets comic data
*
* Method: GET
* Request:
* {
* id: <id>
* }
* Response:
* {
* id: <id>,
* title: <title>,
* panels: [
* {
* x: <x>,
* y: <y>,
* width: <width>,
* height: <height>
* }
* ...
* ]
* }
*/
get: '/comic/{id}',
/**
* Creates a comic book and returns the new ID
*
* Method: POST
* Request:
* {
* title: <title>
* }
* Response:
* {
* id: <id>,
* title: <title>,
* panels: []
* }
*/
create: '/create',
/**
* Saves comic data wholesale
*
* Method: PUT
* Request:
* {
* id: <id>,
* title: <title>,
* panels: [
* {
* x: <x>,
* y: <y>,
* width: <width>,
* height: <height>
* }
* ...
* ]
* }
* Response:
* {
* id: <id>,
* title: <title>,
* panels: [
* {
* x: <x>,
* y: <y>,
* width: <width>,
* height: <height>
* }
* ...
* ]
* }
*/
save: '/save',
/**
* Uploads a page to a comic
*
* Method: POST
* Request:
* {
* page: <file>
* id: <id>
* }
* Response:
* {
* url: <url>
* size: <size>
* width: <width>
* height: <height>
* }
*/
upload: '/upload'
},
/**
* Callback for when a comic is created, for the user
* to hook into if they need to. Good for redirecting
* or changing the URL to include the ID.
*
* @type {Function}
* @default
*/
onCreateComicSuccess: function(){}
}
Below is a table with a list of feedback from previous group discussions and how they were addressed in this round of coding.
| Feedback | Action | Priority Estimation | Effort Estimation |
|---|---|---|---|
| Tool tips take a little bit to show up | Nature of tool tips on web, can do custom tooltips, but that will take more effort | Low | 2 hours (Custom tooltip) |
| Labels on panels to help distinguish them better | Add labels | Medium | 6-8 hours |
| Alt to previous: tooltips on panels | Add tooltip on hover | Medium | 1 hour |
| Change icon to list icon | Medium | 20 minutes | |
Double Click to Rename |
Add | Medium | 10 minutes |
| Add | Low | 6-8 hours | |
| Switch interface to stay in draw mode | Medium | 30 minutes | |
Rearrange icons by switching Select and Draw |
Keep to stay consistent with other interfaces | N/A | N/A |
View Comic even with no pages |
Disable button unless there are pages | High | 30 minutes |
| Save on blur | High | 30 minutes | |
Change copy to read File(s) |
Medium | 5 minutes | |
| Change to cursor icon | Really Low | 5 minutes | |
| Fix to either delete or size up if they don't drag | Medium | 30 minutes |
| Feedback | How it was Addressed |
|---|---|
| Renaming panels may help with identifying which panels are which | Renaming panels in the panel menu has been added. Double click to edit and enter to submit changes. |
| Multiple upload layout broken | Previously multiple uploads showed up side-by-side, they are now stacked and in a scrollable panel for overflow. |
| After creating a comic, editing it, then viewing comic, clicking back didn't take you to edit | The URL now updates with the ID of the comic after creation, so clicking the back button after leaving the page will take you back to editing the comic. |
| Button icons seemed ambiguous | Added tool tips to display button action |
| Progress bar for upload is great, but with no border it's hard to tell how much is left. | Added border to progress bar |
| Outer cancel button hides the upload screen, but doesn't actually cancel the upload | Clicking cancel upload link closes window and cancels upload |
| Improvement | Fully commented code |