Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Be more Wizardly in ebook-builder.rb #18

Open
ccoupe opened this issue Jan 10, 2017 · 7 comments
Open

Be more Wizardly in ebook-builder.rb #18

ccoupe opened this issue Jan 10, 2017 · 7 comments
Milestone

Comments

@ccoupe
Copy link
Member

ccoupe commented Jan 10, 2017

ebook-builder doesn't keep any state about what phase has been completed nor anyway to backup to a previous phase and change something. If we wrote mulitpe yamls file ebook-1.yaml, ebook2.yaml we could detect the current state (and for debugging purposes compare the two yamls) clicking save or next would create it's ebook-{n}.yaml and delete yaml greater than n. It would also allow a nicer GUI experience and the ability the add panels if needed and could also be a way to move some of the code into separate files, per #17

@ccoupe ccoupe added this to the 1.0.0 milestone Jan 10, 2017
@IanTrudel
Copy link
Collaborator

How about a multi page UI with next button? If the process was stopped or interrupted, it would give the user the choice to either resume or start over.

@ccoupe
Copy link
Member Author

ccoupe commented Jan 11, 2017

I call it multiple panels (like Cobbler) - is that mult ipage ? If so, then it would be easier to work ones way through the steps with some back and next buttons.

@IanTrudel
Copy link
Collaborator

shoesebookbuilder

ccoupe pushed a commit that referenced this issue Jan 11, 2017
* image hash is not section specific, it's for the whole document
  -- thats a github rule.
* navigation documents can have images.
* start moving some duplicate code into methods.
* create interim yaml-n files. Not wizardy yet - good for debugging though.
@IanTrudel
Copy link
Collaborator

IanTrudel commented Jan 11, 2017

It might be possible to bootstrap the Shoes eBook builder.

  • Write the builder content using Markdown
  • Generate an eBook
  • Manually add Ruby code to perform builder tasks

It would be otherwise possible to consider adding a feature that would allow us, or even authors, to run code (not the run this button!), create widgets and forms in the eBook.

@ccoupe
Copy link
Member Author

ccoupe commented Jan 11, 2017

Many things are possible. Github doesn't support svg's in certain places that ebook could handle.

README.md is already a test case for ebook with a private note to myself that there could be a 'help' button on the builder that would display it in new Shoes Window.

Per your image above, what do you think should happen sidebar wise, if there are two or three md in that directory with the README.md ?

@IanTrudel
Copy link
Collaborator

IanTrudel commented Jan 11, 2017

The main text in the image above is just a filler. The idea is to provide something like NSIS installer as far as workflow goes.

The main page is displayed, the author moves to initializing, fill up the form, click on next at the bottom of the page to get to the next step and so on.

@IanTrudel
Copy link
Collaborator

The side menu is kinda like a progress bar. We may grey out steps until the author has properly fill the current section. Look at the image... Each section is equivalent to your buttons in the eBook-builder.rb.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants