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

Add glossary/endnote functionality #651

Merged
merged 10 commits into from
Jan 23, 2017

Conversation

binford2k
Copy link
Member

This will allow the user to add glossary terms, either inline or in .callout notes. This is intentionally undocumented for now, as it's not considered to be production ready yet.

On a slide, use something like the following to add both an entry in the notes/handouts and to a page tagged with glossary.

[a phrase](glossary://term-with-no-spaces "The definition of the term.")

You can also add a term to the notes/handouts, in which case it will be listed on the glossary page, but not shown on slide:

.callout.glossary By hand, yo!|by-hand: I made this one by hand.

You can also add a term to a named glossary inline:

[a phrase](glossary://name/term-with-no-spaces "The definition of the term.")

Or as a note:

.callout.glossary.name By hand, yo!|by-hand: I made this one by hand.

The glossary page is simply tagged with glossary and an optional name.

<!SLIDE glossary>
# General Glossary

You can add any markdown you want up here. A list of glossary items will be added to the end.

A named glossary

<!SLIDE glossary name>
# This is a named glossary

You can add any markdown you want up here. A list of glossary items will be added to the end.

Fixes #227

Now you can go to a slide by `#name_of_slide+something_internal` and
Showoff will realize that you mean to go to the slide named
`name_of_slide+something_internal`.
TODO:

* parser syntax for manual descriptions in the notes
* fix crasher when showoff static print
@binford2k binford2k changed the title Add glossary/endnote functionality WIP: Add glossary/endnote functionality Jan 20, 2017
@binford2k
Copy link
Member Author

When printing to PDF, it looks like both notes and handouts appear. 😢

This makes sure they don't get re-added.
@binford2k binford2k changed the title WIP: Add glossary/endnote functionality Add glossary/endnote functionality Jan 23, 2017
@marrero984 marrero984 merged commit 6f3ce69 into puppetlabs:master Jan 23, 2017
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

Successfully merging this pull request may close these issues.

None yet

2 participants