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

Wish: Create a single slide deck across multiple documentation pages #96

Open
bmmpxf opened this issue Apr 3, 2015 · 5 comments
Open
Assignees
Milestone

Comments

@bmmpxf
Copy link

bmmpxf commented Apr 3, 2015

The ability to interleave slide content with documentation content is a huge benefit to using Hieroglyph.

However, this breaks down a bit with large projects than span many pages, because Hieroglyph will create a slide deck for every page. The ability to create a single slide deck for an entire documentation project (akin to the SingleFileHTMLBuilder) would be a definite improvement.

@nyergler
Copy link
Owner

nyergler commented Apr 8, 2015

You should be able to test this out by installing the development version of Hieroglyph and building with the singlefile-slides builder.

I'm not sure how this will interact with things like the nextslide directory, so I'm curious to hear what your experience is like.

@bmmpxf
Copy link
Author

bmmpxf commented Apr 9, 2015

Thanks! I tried with a little test project containing an index file and two child pages, all having a few slides each.

Now, it's very possible that I've got incorrect syntax (as evidenced by content that's not supposed to be in a slide appearing in one). But the output I got is below. With the singlefile-slides builder, although a single index.html file is built, I only see slide content from the index.rst page, not any of the child pages. The content in the background is different, I note, but I don't understand what that's doing there in either case. So definitely willing to admit user error here.

With slides builder:

makeslides

With singlefile-slides builder:

makesingleslide

For reference, the entire content of my index.rst file is below:

Multipage Hieroglyph Test
=========================

This is the main page. There are two sub pages. This page has one slide on it. This is the main text on the page and should not appear in a slide.

.. slide:: Welcome
   :level: 3

   This is the first slide. All other slides will exist in other pages. This is text that should exist only in a slide.

   .. note:: This is a presenter's note.

.. toctree::
   :maxdepth: 2

   page1
   page2

If you have a project you've been testing with, I'd be happy to give it a try here.

@nyergler
Copy link
Owner

I haven't tried it with the slide directive yet, so that may be the issue. I'll have to look into it. I'm using the files in https://github.com/nyergler/hieroglyph/tree/master/src/hieroglyph/tests/singlefile for my unit tests, so I'll add a slide there and see if I can reproduce this.

@nyergler
Copy link
Owner

I've added a test, and fixed the behavior for running the single-file builder on documents using the slide directive; want to see if this looks better for your uses?

@exhuma
Copy link

exhuma commented Aug 9, 2017

I'm currently working on slides where I need to shift around topics between two slide-decks. I was wondering if it was possible to build up a toctree and let hieroglyph build the slides from there. That way I could organise my slides as topics, construct a nice toctree which would make the HTML output well structured, and could still easily shift different topics around as I see fit.

I'm not sure if this ticket is related to this, but it sounds similar. Is it? Or should I create a new ticket?

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

No branches or pull requests

3 participants