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

Adding chapters causes errors #37

Open
slifty opened this issue Jun 2, 2021 · 2 comments
Open

Adding chapters causes errors #37

slifty opened this issue Jun 2, 2021 · 2 comments
Labels
bug Something isn't working

Comments

@slifty
Copy link
Contributor

slifty commented Jun 2, 2021

If you add a chapter to your book the book rendering fails.

The short term solution is to remove the UX for chapters, but the long term solution is to make sure chapter functionality work properly.

@slifty slifty added the bug Something isn't working label Jun 2, 2021
@slifty
Copy link
Contributor Author

slifty commented Jun 15, 2021

The ultimate issue here is that the renderer doesn't have the concept of a chapter -- its API takes a list of URLs (and has no concept of a chapter).

This is quite unfortunate, and trickles back through the python as well (which is where the issue lies -- the python assumes each item has a URL, but as we know, Chapters have no such thing).

As a first step, I'm going to disable chapters from the UX so that nothing is broken in the short term.

After that I believe we would like to keep the concept of chapters. This will mean updating the node to accept chapters in between urls. I think this can be done easily enough -- update the API so that it takes a list of "items" and if the item is a URL it is treated as such, and otherwise it is treated as a chapter.

Open question: how should chapters appear in the table of contents?

slifty added a commit that referenced this issue Jun 15, 2021
Chapters are not supported by the renderer at this moment, which means
that they break if a user attempts to create a book with chapters.  In
the long run we would like to support chapters, but in the mean time  we
will disable the UX to prevent a broken user experience.

Issue #37
@slifty slifty mentioned this issue Jun 15, 2021
@slifty
Copy link
Contributor Author

slifty commented Jun 23, 2021

This issue is no longer user-facing, but it will stay open for now because it would be good to add support for chapters back.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant