Asciidoctor :: Discussion

Problems getting wavedrom diagramming to work for asciidoctor-pdf

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

6 messages Options

Elisa

Problems getting wavedrom diagramming to work for asciidoctor-pdf

I've been putting together a full-featured pdf for a project that has numerous wavedrom diagrams as an important part of the documentation.

I've gotten other kinds of diagrams to work for both asciidoctor and the (old) ruby asciidoctor-pdf.

When I try to get asciidoctor-pdf to process the wavedrom scripts, it gives me an error message.

I am using ruby 2.7.2 because I understand that's what's needed for ascidoctor-pdf:
Using /Users/blahblah/.rvm/gems/ruby-2.7.2

Here is the version of asciidoctor-diagram that I have: asciidoctor-diagram-2.1.2

Here is the error:
asciidoctor: ERROR: tables_graphics.adoc: line 271: Failed to generate image: Could not find the 'WaveDromEditor.app', 'wavedrom-editor.app' executable in PATH; add it to the PATH or specify its location using the 'WaveDromEditorApp' document attribute

I have actually tried manually downloading wavedrom-editor and adding a path, however the downloadable app is not intended for that specific use. The wavedrom CLI is also downloadable and can be used to convert individually listed scripts, AFAIK.

I have gotten into editing some scripts but don't know quite how to handle this. With the volume of wavedrom diagrams that we need in our docs, we need to be able to get the wavedrom scripts processed jus like the other diagrams can be processed.

I can see that there is some information in asciidoctor-diagram about a WavedromBlockMacroProcessor

Can anyone help?

Thanks so much, in advance.

- Elisa

Elisa

Re: Problems getting asciidoctor-diagram to process wavedrom

Does anyone know how to communicate with those who implemented asciidoctor-diagram?

I'm working on a project in which must process numerous wavedrom scripts. The output is a custom pdf using asciidoctor-pdf with frontmatter, running headers and footers, footnotes, index, and other features.

We have asciidoctor-diagram working perfectly for other kinds of diagrams. However, pointing to the wavedrom-editor.app doesn't work. How was the integration implemented and tested?

abelsromero

Re: Problems getting asciidoctor-diagram to process wavedrom

Elisa wrote

Does anyone know how to communicate with those who implemented asciidoctor-diagram?

You can open an issue in the htts://github.com/asciidoctor/asciidoctor-diagram, or drop by the zulip #users channel https://asciidoctor.zulipchat.com/.

mojavelinux

Re: Problems getting asciidoctor-diagram to process wavedrom

Administrator

In reply to this post by Elisa

You can interact with the maintainers of Asciidoctor projects either via this mailing list, the community chat (https://asciidoctor.zulipchat.com), or the issue tracker. If you want to report a bug or request a new feature, the issue tracker is the appropriate place. Otherwise, you may communicate via this list or the community chat. The community chat tends to generate the best engagement.

Please note that maintainers are under no obligation to reply to you. These are volunteer projects and the maintainers will choose to reply on their own accord. Sometimes, that is really quick. Other times, it may not be. Please respect the time and effort that maintainers put into these projects. Being polite is your best tool.

Best Regard,

-Dan

On Sun, Apr 25, 2021 at 6:09 PM Elisa [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Does anyone know how to communicate with those who implemented asciidoctor-diagram?

I'm working on a project in which must process numerous wavedrom scripts. The output is a custom pdf using asciidoctor-pdf with frontmatter, running headers and footers, footnotes, index, and other features.

We have asciidoctor-diagram working perfectly for other kinds of diagrams. However, pointing to the wavedrom-editor.app doesn't work. How was the integration implemented and tested?

If you reply to this email, your message will be added to the discussion below:
https://discuss.asciidoctor.org/Problems-getting-wavedrom-diagramming-to-work-for-asciidoctor-pdf-tp8592p8597.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen (he, him, his) | @mojavelinux | https://twitter.com/mojavelinux

Elisa

Re: Problems getting asciidoctor-diagram to process wavedrom

Thanks for pointing me to the Zulip discussion, problem solved.

Just a note, while the the links from https://docs.asciidoctor.org/diagram-extension/latest/ point to Wavedrom itself, I didn't find information on how to install the requirements that support the wavedrom plugin as follows (for mac):

```
brew install node
npm install -g wavedrom-cli
```

Check that wavedrom-cli is in the path (this should display the help):

```
wavedrom-cli
```
The error message that results when asciidoctor-diagram doesn't find the path for wavedrom-cli actually mentions wavedrom-editor.app, which does exist as a separate downloadable.

Perhaps the documentation could be tweaked so that new asciidoctor-diagram users that want to enable wavedrom, don't fall into the same rabbit hole that I did? :-)

If you have any questions please let me know.

mojavelinux

Re: Problems getting asciidoctor-diagram to process wavedrom

Administrator

Elisa,

I think that's a great idea!

I encourage you to click "Edit this Page" and propose those changes. I'd be happy to test and review.

Best Regards,

-Dan

On Tue, May 4, 2021 at 10:24 AM Elisa [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Just a note, while the the links from https://docs.asciidoctor.org/diagram-extension/latest/ point to Wavedrom itself, I didn't find information on how to install the requirements that support the wavedrom plugin as follows (for mac):

```
brew install node
npm install -g wavedrom-cli
```

Check that wavedrom-cli is in the path (this should display the help):

```
wavedrom-cli
```
The error message that results when asciidoctor-diagram doesn't find the path for wavedrom-cli actually mentions wavedrom-editor.app, which does exist as a separate downloadable.

Perhaps the documentation could be tweaked so that new asciidoctor-diagram users that want to enable wavedrom, don't fall into the same rabbit hole that I did? :-)

If you have any questions please let me know.

If you reply to this email, your message will be added to the discussion below:
https://discuss.asciidoctor.org/Problems-getting-wavedrom-diagramming-to-work-for-asciidoctor-pdf-tp8592p8618.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen (he, him, his) | @mojavelinux | https://twitter.com/mojavelinux