CDSoft / panda

Panda is a Pandoc Lua filter that works on internal Pandoc's AST. Panda is heavily inspired by [abp](http:/cdelord.fr/abp) reimplemented as a Pandoc Lua filter.
https://cdelord.fr/panda
GNU General Public License v3.0
43 stars 5 forks source link

'title' parameter of 'render' block should be caption of included diagram #6

Open bandel65 opened 2 years ago

bandel65 commented 2 years ago

i.e., the following:

  @startuml
  Alice -> Bob: hello
  @enduml

...should result in this:

![Alice & Bob](.build/cache/0ec62f1568ac33e20ec8d430ae77a9cbe6c9cd46.svg "Alice & Bob")

...rather than this:

![](.build/cache/0ec62f1568ac33e20ec8d430ae77a9cbe6c9cd46.svg "Alice & Bob")
CDSoft commented 2 years ago

In fact there should be a parameter for the caption and another one for the alternative text. I'll add two parameters and use them in the right places.

CDSoft commented 2 years ago

fixed

bandel65 commented 2 years ago

For the following example, I would expect the figure caption "Figure 1: Repository Structure" to be displayed. But it isn't, at least not converting to PDF via LaTeX. Converting to markdown does yield expected syntax. Issue seems to be trailing "{.dot}" in resulting markdown. Removing manually and converting that markdown to PDF via LaTeX yields proper caption.

graph {
  fontsize=18.0
  splines="ortho"
  node [shape=folder fontname="Helvetica" width=2.0 fixedsize=true]
  sogs [root=true shape=box]
  sogs -- {
    lib
    scripts
    src
    system_test
    test
  }
}
bandel65 commented 2 years ago

Christophe, one lingering issue. See my latest comment on issue.

From: CDSoft @.> Sent: Thursday, November 4, 2021 12:28 PM To: CDSoft/panda @.> Cc: Bill Andel @.>; Author @.> Subject: [External] Re: [CDSoft/panda] 'title' parameter of 'render' block should be caption of included diagram (Issue #6)

fixed

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/CDSoft/panda/issues/6#issuecomment-961351640, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AWKXBGNDZ6BYCBSNDYIOZF3UKLNFZANCNFSM5HKFGBZQ. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

CDSoft commented 2 years ago

in

```{.dot render="{{dot}}" title="Repository Structure"}
graph {
...
}
```

.dot is not required. It's not even used to generate the diagram. I usually keep the .dot class to let my text editor colorize the source of the diagram using the appropriate syntax. You can remove it:

```{render="{{dot}}" title="Repository Structure"}
graph {
...
}
```
bandel65 commented 2 years ago

OK, so I tried removing the “.dot” class from my input line. It had no effect – i.e. no caption shown – when going straight from markdown to latex. If I went in two steps, i.e. markdown to (filtered) markdown and then to PDF, I got the caption. Not sure what is going on in the first case, which is my desired use case.

From: CDSoft @.> Sent: Friday, November 5, 2021 10:22 AM To: CDSoft/panda @.> Cc: Bill Andel @.>; Author @.> Subject: [External] Re: [CDSoft/panda] 'title' parameter of 'render' block should be caption of included diagram (Issue #6)

in


graph {

...

}

.dot is not required. It's not even used to generate the diagram. I usually keep the .dot class to let my text editor colorize the source of the diagram using the appropriate syntax. You can remove it:


graph {

...

}

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/CDSoft/panda/issues/6#issuecomment-962076988, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AWKXBGLDWY7NA7ZVJKAOZ6DUKQHD5ANCNFSM5HKFGBZQ. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.