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

Show UI macros in PDF output #313

Closed
jniggemann opened this issue Sep 1, 2015 · 16 comments
Closed

Show UI macros in PDF output #313

jniggemann opened this issue Sep 1, 2015 · 16 comments
Assignees
Milestone

Comments

@jniggemann
Copy link

I frequently write manuals and one of the features for which I prefer using asciidoctor over pandoc (i.e. asciidoc oder markdown) are the UI macros, especially kbd shortcuts.

Given that ATM they are still experimental, I understand that UI macros haven't yet made it to asciidoctor-pdf.

  • kbd shortcuts result in just the word being written
  • menu selections are displayed with a pipe symbol instead of a triangle.

I thought I open a ticket so this can be tracked...

@mojavelinux
Copy link
Member

Thanks for reporting @jniggemann. You are correct that we don't yet style these elements. However, we have all the raw material in place that we would need in order to do it, so let's just schedule it to happen.

Regardless of how the macros get enabled, Asciidoctor PDF will still need to style them, so I think we should proceed despite the experimental label.

@mojavelinux
Copy link
Member

menu selections are displayed with a pipe symbol instead of a triangle.

This part of the issue is now resolved and will be available in the 1.5.0.alpha.12 release.

@jniggemann
Copy link
Author

Great to hear, thank you! I'm looking forward to test this and I'll report back...

@jniggemann
Copy link
Author

I confirm menu selections working in 1.5.0 Alpha 12 :-)
Thank you very much!

@mojavelinux
Copy link
Member

👍

@mojavelinux
Copy link
Member

We still have the kbd macro remaining.

@jniggemann
Copy link
Author

jniggemann commented Aug 7, 2016

We still have the kbd macro remaining.

I'm ready for testing and waiting :-)

@CapitanPrimate
Copy link

Hello.

Any news about supporting the kbd macro?

Thanks in advance!

@elmajime
Copy link

Hi!

I'm really looking forward to this feature as it could enable my team to move all our documentation to Asciidoctor!

Do you have any news to share?

@n2o
Copy link

n2o commented Jan 9, 2019

We would also love to see this feature in asciidoctor-pdf 👍

@mojavelinux
Copy link
Member

Now that the background color and border is supported for a phrase, we can move forward with this. We just need to port the logic used for the button. See #451.

mojavelinux added a commit to mojavelinux/asciidoctor-pdf that referenced this issue Jul 13, 2019
mojavelinux added a commit to mojavelinux/asciidoctor-pdf that referenced this issue Jul 13, 2019
@mojavelinux
Copy link
Member

It's now possible to control the style of the menu, button, and key (kbd) elements in one form or another. There are still some limitations due to the capabilities of Prawn, but you should be able to get pretty close to the styling you'd use in HTML/CSS.

@mojavelinux
Copy link
Member

Refer to the theming guide for details.

@jniggemann
Copy link
Author

This is great, thank you very much for your hard work!
I'll try this ASAP, but in this case ASAP means after the summer holidays.

@edward-encoord
Copy link

I can confirm it works perfectly with Asciidoctor PDF 1.6.2 using Asciidoctor 2.0.17:

image

@mojavelinux
Copy link
Member

Thanks for confirming!

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

6 participants