docbook codeblock callouts > markdown

docbook codeblock callouts > markdown

[Aidan Reilly]

[-- Attachment #1.1: Type: text/plain, Size: 1276 bytes --]

H again,

A feature of docbook/asciidoc that is really useful is codeblock callouts. 
It seems that this is not currently supported in the latest pandoc. 

Is there a way to tell pandoc to passthrough codeblocks "untouched"? I 
think if this was the case a lua filter could apply the rest of the markup 
I need. 

Example: 
$ cat callout.adoc
[source,yaml]
----
bmc:
  address: <bmc_address>
  credentialsName: <secret_credentials_name>  <1>
  disableCertificateVerification: True
----
<1> `credentialsName` needs a callout>

Run through asciidoctor > pandoc:
 
$ asciidoctor -b docbook -o - callout.adoc | pandoc -t markdown -f docbook
``` yaml
bmc:
  address: <bmc_address>
  credentialsName: <secret_credentials_name>  
  disableCertificateVerification: True
```

-   `credentialsName` needs a callout

Any other suggestions or strategies welcome

Thanks,
Aidan

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/99430384-ef3a-4534-a9da-8dcbcf7f0f91n%40googlegroups.com.

[-- Attachment #1.2: Type: text/html, Size: 1796 bytes --]

Re: docbook codeblock callouts > markdown

[Albert Krewinkel]

Aidan Reilly <aireilly-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> writes:

> A feature of docbook/asciidoc that is really useful is codeblock
> callouts. It seems that this is not currently supported in the latest
> pandoc.

I didn't know about callouts, they seem like a nice and useful feature:
https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/

Could you post the DocBook code generated by asciidoctor? I suspect that
this feature would require changes to the docbook reader, but maybe once
could make do with a custom Lua reader.

> Is there a way to tell pandoc to passthrough codeblocks "untouched"?
> I think if this was the case a lua filter could apply the rest of the
> markup I need. 
>
> Example: 
> $ cat callout.adoc
> [source,yaml]
> ----
> bmc:
>   address: <bmc_address>
>   credentialsName: <secret_credentials_name>  <1>
>   disableCertificateVerification: True
> ----
> <1> `credentialsName` needs a callout>
>
> Run through asciidoctor > pandoc:
>  
> $ asciidoctor -b docbook -o - callout.adoc | pandoc -t markdown -f
> docbook
> ``` yaml
> bmc:
>   address: <bmc_address>
>   credentialsName: <secret_credentials_name>  
>   disableCertificateVerification: True
> ```
>
> -   `credentialsName` needs a callout
>
> Any other suggestions or strategies welcome


-- 
Albert Krewinkel
GPG: 8eed e3e2 e8c5 6f18 81fe  e836 388d c0b2 1f63 1124

Re: docbook codeblock callouts > markdown

[Aidan Reilly]

[-- Attachment #1.1: Type: text/plain, Size: 3127 bytes --]

Hi Albert!

So here is the complete example: 

$ cat callout.adoc
[source,yaml]
----
bmc:
  address: <bmc_address>
  credentialsName: <secret_credentials_name>  <1>
  disableCertificateVerification: True
----
<1> `credentialsName` needs a callout


$ cat callout.xml
<?xml version="1.0" encoding="UTF-8"?>
<?asciidoc-toc?>
<?asciidoc-numbered?>
<article xmlns="http://docbook.org/ns/docbook" xmlns:xl="
http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<info>
<title>Untitled</title>
<date>2022-11-25</date>
</info>
<programlisting language="yaml" linenumbering="unnumbered">bmc:
  address: &lt;bmc_address&gt;
  credentialsName: &lt;secret_credentials_name&gt;  <co xml:id="CO1-1"/>
  disableCertificateVerification: True</programlisting>
<calloutlist>
<callout arearefs="CO1-1">
<para><literal>credentialsName</literal> needs a callout</para>
</callout>
</calloutlist>
</article>


$ pandoc -t markdown -f docbook callout.xml
``` yaml
bmc:
  address: <bmc_address>
  credentialsName: <secret_credentials_name>  
  disableCertificateVerification: True
```

-   `credentialsName` needs a callout

I'm just not clear whether this can be handled with a lua filter or not.

Thanks,

Aidan

On Wednesday, November 23, 2022 at 5:39:22 PM UTC Albert Krewinkel wrote:

>
> Aidan Reilly <aire...-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> writes:
>
> > A feature of docbook/asciidoc that is really useful is codeblock
> > callouts. It seems that this is not currently supported in the latest
> > pandoc.
>
> I didn't know about callouts, they seem like a nice and useful feature:
> https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/
>
> Could you post the DocBook code generated by asciidoctor? I suspect that
> this feature would require changes to the docbook reader, but maybe once
> could make do with a custom Lua reader.
>
> > Is there a way to tell pandoc to passthrough codeblocks "untouched"?
> > I think if this was the case a lua filter could apply the rest of the
> > markup I need. 
> >
> > Example: 
> > $ cat callout.adoc
> > [source,yaml]
> > ----
> > bmc:
> > address: <bmc_address>
> > credentialsName: <secret_credentials_name> <1>
> > disableCertificateVerification: True
> > ----
> > <1> `credentialsName` needs a callout>
> >
> > Run through asciidoctor > pandoc:
> > 
> > $ asciidoctor -b docbook -o - callout.adoc | pandoc -t markdown -f
> > docbook
> > ``` yaml
> > bmc:
> > address: <bmc_address>
> > credentialsName: <secret_credentials_name> 
> > disableCertificateVerification: True
> > ```
> >
> > - `credentialsName` needs a callout
> >
> > Any other suggestions or strategies welcome
>
>
> -- 
> Albert Krewinkel
> GPG: 8eed e3e2 e8c5 6f18 81fe e836 388d c0b2 1f63 1124
>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/7925cbe1-1d0d-4b9f-abe4-9224472bd417n%40googlegroups.com.

[-- Attachment #1.2: Type: text/html, Size: 4807 bytes --]

Re: docbook codeblock callouts > markdown

[Aidan Reilly]

[-- Attachment #1.1: Type: text/plain, Size: 3619 bytes --]

Wondering about this again. Albert, are you suggesting something like a 
custom docbook reader might be useful 
here? https://pandoc.org/custom-readers.html Are thee examples of custom 
docbook readers you can point to? 

Thanks,

Aidan

On Friday, November 25, 2022 at 10:24:13 AM UTC Aidan Reilly wrote:

> Hi Albert!
>
> So here is the complete example: 
>
> $ cat callout.adoc
> [source,yaml]
> ----
> bmc:
>   address: <bmc_address>
>   credentialsName: <secret_credentials_name>  <1>
>   disableCertificateVerification: True
> ----
> <1> `credentialsName` needs a callout
>
>
> $ cat callout.xml
> <?xml version="1.0" encoding="UTF-8"?>
> <?asciidoc-toc?>
> <?asciidoc-numbered?>
> <article xmlns="http://docbook.org/ns/docbook" xmlns:xl="
> http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
> <info>
> <title>Untitled</title>
> <date>2022-11-25</date>
> </info>
> <programlisting language="yaml" linenumbering="unnumbered">bmc:
>   address: &lt;bmc_address&gt;
>   credentialsName: &lt;secret_credentials_name&gt;  <co xml:id="CO1-1"/>
>   disableCertificateVerification: True</programlisting>
> <calloutlist>
> <callout arearefs="CO1-1">
> <para><literal>credentialsName</literal> needs a callout</para>
> </callout>
> </calloutlist>
> </article>
>
>
> $ pandoc -t markdown -f docbook callout.xml
> ``` yaml
> bmc:
>   address: <bmc_address>
>   credentialsName: <secret_credentials_name>  
>   disableCertificateVerification: True
> ```
>
> -   `credentialsName` needs a callout
>
> I'm just not clear whether this can be handled with a lua filter or not.
>
> Thanks,
>
> Aidan
>
> On Wednesday, November 23, 2022 at 5:39:22 PM UTC Albert Krewinkel wrote:
>
>>
>> Aidan Reilly <aire...-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> writes: 
>>
>> > A feature of docbook/asciidoc that is really useful is codeblock 
>> > callouts. It seems that this is not currently supported in the latest 
>> > pandoc. 
>>
>> I didn't know about callouts, they seem like a nice and useful feature: 
>> https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/ 
>>
>> Could you post the DocBook code generated by asciidoctor? I suspect that 
>> this feature would require changes to the docbook reader, but maybe once 
>> could make do with a custom Lua reader. 
>>
>> > Is there a way to tell pandoc to passthrough codeblocks "untouched"? 
>> > I think if this was the case a lua filter could apply the rest of the 
>> > markup I need. 
>> > 
>> > Example: 
>> > $ cat callout.adoc 
>> > [source,yaml] 
>> > ---- 
>> > bmc: 
>> > address: <bmc_address> 
>> > credentialsName: <secret_credentials_name> <1> 
>> > disableCertificateVerification: True 
>> > ---- 
>> > <1> `credentialsName` needs a callout> 
>> > 
>> > Run through asciidoctor > pandoc: 
>> > 
>> > $ asciidoctor -b docbook -o - callout.adoc | pandoc -t markdown -f 
>> > docbook 
>> > ``` yaml 
>> > bmc: 
>> > address: <bmc_address> 
>> > credentialsName: <secret_credentials_name> 
>> > disableCertificateVerification: True 
>> > ``` 
>> > 
>> > - `credentialsName` needs a callout 
>> > 
>> > Any other suggestions or strategies welcome 
>>
>>
>> -- 
>> Albert Krewinkel 
>> GPG: 8eed e3e2 e8c5 6f18 81fe e836 388d c0b2 1f63 1124 
>>
>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/42d817a7-49f5-452a-a38c-d0764ec3e5cdn%40googlegroups.com.

[-- Attachment #1.2: Type: text/html, Size: 5816 bytes --]

Re: docbook codeblock callouts > markdown

[Albert Krewinkel]

Aidan Reilly <aireilly-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> writes:

> Wondering about this again. Albert, are you suggesting something like
> a custom docbook reader might be useful here? https://pandoc.org/
> custom-readers.html Are thee examples of custom docbook readers you
> can point to?

That was my thought, yes. But I can't offer any examples or even more
detailed ideas on how to approach this. Sorry. Fixing this in the reader
is probably the best approach.

-- 
Albert Krewinkel
GPG: 8eed e3e2 e8c5 6f18 81fe  e836 388d c0b2 1f63 1124

Re: docbook codeblock callouts > markdown

[Aidan Reilly]

[-- Attachment #1: Type: text/plain, Size: 1940 bytes --]

Ok thanks no problem. If I make any progress I’ll post here.

On Sat 3 Dec 2022 at 08:20, Albert Krewinkel <albert+pandoc-9EawChwDxG8hFhg+JK9F0w@public.gmane.org>
wrote:

>
> Aidan Reilly <aireilly-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> writes:
>
> > Wondering about this again. Albert, are you suggesting something like
> > a custom docbook reader might be useful here? https://pandoc.org/
> > custom-readers.html Are thee examples of custom docbook readers you
> > can point to?
>
> That was my thought, yes. But I can't offer any examples or even more
> detailed ideas on how to approach this. Sorry. Fixing this in the reader
> is probably the best approach.
>
> --
> Albert Krewinkel
> GPG: 8eed e3e2 e8c5 6f18 81fe  e836 388d c0b2 1f63 1124
>
> --
> You received this message because you are subscribed to a topic in the
> Google Groups "pandoc-discuss" group.
> To unsubscribe from this topic, visit
> https://groups.google.com/d/topic/pandoc-discuss/kWEdaeIzNRQ/unsubscribe.
> To unsubscribe from this group and all its topics, send an email to
> pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/pandoc-discuss/87tu2cx5k6.fsf%40zeitkraut.de
> .
>
> --

*Aidan Reilly*

He/Him/His

Senior Technical Writer, Telco (Cork, Ireland)

aireilly-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org

IM/GitHub: aireilly

TEL: +353851261126
<https://www.redhat.com/>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/CAM4RMsiNyrgSvhcmSh5EhjfyMVe54Eq%3Dod8JOE_pps-_TP5GRA%40mail.gmail.com.

[-- Attachment #2: Type: text/html, Size: 4430 bytes --]