FIguring out pandoc AST and types

FIguring out pandoc AST and types

[Harsh Donga]

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


Okay, being new to Haskell some of the questions might seem vague and some 
straightforward to you, I apologize in advance for that.

1. How can I create pandoc type variables, where exactly do I look if I 
want to make a table object purely using Haskell then convert it to JSON 
AST/other formats
2. How can I convert my own JSON (storing elements analogous to HTML) to 
pandoc AST
3. is there any way possible to make pandoc type variables using other 
languages like JS, Python...


Few more questions as follow-ups to these, your help is appreciated a lot!

-- 
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/4bd5ecbc-bd1d-442a-9558-6724174f77fcn%40googlegroups.com.

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

Re: FIguring out pandoc AST and types

[John MacFarlane]

Harsh Donga <harsh-7+aFW328pE6p1wGUEcWPqti2O/JbrIOy@public.gmane.org> writes:

> Okay, being new to Haskell some of the questions might seem vague and some 
> straightforward to you, I apologize in advance for that.
>
> 1. How can I create pandoc type variables, where exactly do I look if I 
> want to make a table object purely using Haskell then convert it to JSON 
> AST/other formats

You want to look at

https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Builder.html

> 2. How can I convert my own JSON (storing elements analogous to HTML) to 
> pandoc AST

If it's a custom JSON format, then you'll need to parse it to a
pandoc AST using a Haskell JSON parsing library (like aeson).
Alternatively, you could convert your JSON format to the JSON
serialization pandoc uses (which you can inspect using
pandoc -t json).

> 3. is there any way possible to make pandoc type variables using other 
> languages like JS, Python...

As noted above, you can construct a JSON document that represents
the pandoc AST; pandoc can then read this (pandoc -f json).

To understand pandoc's JSON serialization, the best thing to use
is pandoc itself.

pandoc -t native

will give you a look at the pandoc AST

pandoc -f native -t json

will show you how pandoc represents AST elements in JSON.

Re: FIguring out pandoc AST and types

[Harsh Donga]

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

Thank you for your response,

It is getting really hard for me to parse and build pandoc using pandoc 
types, as I am Haskell beginner.

Please correct me if I am wrong, but the only way to see the JSON output is 
by trying out pandoc? I mean for covering all the pandoc-types, I will have 
to put everything in a document then parse using pandoc?
And the figure out by looking at output how actually all types are stored 
in JSON?

It would be really helpful if there can be another way around it!
On Thursday, 9 September 2021 at 22:50:45 UTC+5:30 John MacFarlane wrote:

> Harsh Donga <ha...-7+aFW328pE6p1wGUEcWPqti2O/JbrIOy@public.gmane.org> writes:
>
> > Okay, being new to Haskell some of the questions might seem vague and 
> some 
> > straightforward to you, I apologize in advance for that.
> >
> > 1. How can I create pandoc type variables, where exactly do I look if I 
> > want to make a table object purely using Haskell then convert it to JSON 
> > AST/other formats
>
> You want to look at
>
>
> https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Builder.html
>
> > 2. How can I convert my own JSON (storing elements analogous to HTML) to 
> > pandoc AST
>
> If it's a custom JSON format, then you'll need to parse it to a
> pandoc AST using a Haskell JSON parsing library (like aeson).
> Alternatively, you could convert your JSON format to the JSON
> serialization pandoc uses (which you can inspect using
> pandoc -t json).
>
> > 3. is there any way possible to make pandoc type variables using other 
> > languages like JS, Python...
>
> As noted above, you can construct a JSON document that represents
> the pandoc AST; pandoc can then read this (pandoc -f json).
>
> To understand pandoc's JSON serialization, the best thing to use
> is pandoc itself.
>
> pandoc -t native
>
> will give you a look at the pandoc AST
>
> pandoc -f native -t json
>
> will show you how pandoc represents AST elements in JSON.
>
>

-- 
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/f3dfb122-d074-45e4-887c-06dc47c72ff4n%40googlegroups.com.

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

Re: FIguring out pandoc AST and types

[Harsh Donga]

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

Thank you for your response,

It is getting really hard for me to parse and build pandoc using pandoc 
types, as I am Haskell beginner.

Please correct me if I am wrong, but the only way to see the JSON output is 
by trying out pandoc? I mean for covering all the pandoc-types, I will have 
to put everything in a document then parse using pandoc?
And then figure out by looking at output how actually all types are stored 
in JSON?

It would be really helpful if there can be another way around it!

On Thursday, 9 September 2021 at 22:50:45 UTC+5:30 John MacFarlane wrote:

> Harsh Donga <ha...-7+aFW328pE6p1wGUEcWPqti2O/JbrIOy@public.gmane.org> writes:
>
> > Okay, being new to Haskell some of the questions might seem vague and 
> some 
> > straightforward to you, I apologize in advance for that.
> >
> > 1. How can I create pandoc type variables, where exactly do I look if I 
> > want to make a table object purely using Haskell then convert it to JSON 
> > AST/other formats
>
> You want to look at
>
>
> https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Builder.html
>
> > 2. How can I convert my own JSON (storing elements analogous to HTML) to 
> > pandoc AST
>
> If it's a custom JSON format, then you'll need to parse it to a
> pandoc AST using a Haskell JSON parsing library (like aeson).
> Alternatively, you could convert your JSON format to the JSON
> serialization pandoc uses (which you can inspect using
> pandoc -t json).
>
> > 3. is there any way possible to make pandoc type variables using other 
> > languages like JS, Python...
>
> As noted above, you can construct a JSON document that represents
> the pandoc AST; pandoc can then read this (pandoc -f json).
>
> To understand pandoc's JSON serialization, the best thing to use
> is pandoc itself.
>
> pandoc -t native
>
> will give you a look at the pandoc AST
>
> pandoc -f native -t json
>
> will show you how pandoc represents AST elements in JSON.
>
>

-- 
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/3a59eb3c-352f-49f4-89f8-465aa7e86750n%40googlegroups.com.

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

Re: FIguring out pandoc AST and types

[John MacFarlane]

Harsh Donga <harsh-7+aFW328pE6p1wGUEcWPqti2O/JbrIOy@public.gmane.org> writes:

> Thank you for your response,
>
> It is getting really hard for me to parse and build pandoc using pandoc 
> types, as I am Haskell beginner.
>
> Please correct me if I am wrong, but the only way to see the JSON output is 
> by trying out pandoc? I mean for covering all the pandoc-types, I will have 
> to put everything in a document then parse using pandoc?
> And then figure out by looking at output how actually all types are stored 
> in JSON?

There isn't complete documentation of the JSON format we use,
but it's all very regular and can be predicted from the AST given
a few examples. Pandoc can be used to give you those examples.

Or, you can look at the ToJSON and FromJSON instance definitions
in the source code for Text.Pandoc.Definition and figure it out
from that.

However, if what you want to do is to use Haskell to create a
pandoc AST, then you don't need to worry about JSON at all. JSON
is just a serialization format we use for communicating with
non-Haskell programs. For building a document, what you want is
Text.Pandoc.Builder, as I said. The documentation contains an
example to get you started.

Re: FIguring out pandoc AST and types

[Harsh Donga]

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

Thanks for continued support sir,

I had few couple of doubts,

What does Attr 
<https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Definition.html#t:Attr>
 mean?

And can you explain type Meta 
<https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Definition.html#t:Meta>?, 
it's going a bit over my head

Thanks in advance!

On Wednesday, 15 September 2021 at 05:09:35 UTC+5:30 John MacFarlane wrote:

> Harsh Donga <ha...-7+aFW328pE6p1wGUEcWPqti2O/JbrIOy@public.gmane.org> writes:
>
> > Thank you for your response,
> >
> > It is getting really hard for me to parse and build pandoc using pandoc 
> > types, as I am Haskell beginner.
> >
> > Please correct me if I am wrong, but the only way to see the JSON output 
> is 
> > by trying out pandoc? I mean for covering all the pandoc-types, I will 
> have 
> > to put everything in a document then parse using pandoc?
> > And then figure out by looking at output how actually all types are 
> stored 
> > in JSON?
>
> There isn't complete documentation of the JSON format we use,
> but it's all very regular and can be predicted from the AST given
> a few examples. Pandoc can be used to give you those examples.
>
> Or, you can look at the ToJSON and FromJSON instance definitions
> in the source code for Text.Pandoc.Definition and figure it out
> from that.
>
> However, if what you want to do is to use Haskell to create a
> pandoc AST, then you don't need to worry about JSON at all. JSON
> is just a serialization format we use for communicating with
> non-Haskell programs. For building a document, what you want is
> Text.Pandoc.Builder, as I said. The documentation contains an
> example to get you started.
>

-- 
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/68431aed-736c-425d-8745-14ffdc5468a9n%40googlegroups.com.

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

Re: FIguring out pandoc AST and types

[John MacFarlane]

Harsh Donga <harsh-7+aFW328pE6p1wGUEcWPqti2O/JbrIOy@public.gmane.org> writes:

> Thanks for continued support sir,
>
> I had few couple of doubts,
>
> What does Attr 
> <https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Definition.html#t:Attr>
>  mean?

It's for attributes on elements.
(identifier, clasess, key-value pairs)

> And can you explain type Meta 
> <https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Definition.html#t:Meta>?, 
> it's going a bit over my head

It's a mapping of metadata values.

Re: FIguring out pandoc AST and types

[Harsh Donga]

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

Sorry to bother you, 

I could read in the documentation that Attr stores (identifier, classes, 
key-value pairs)
What do these actually mean? can you share an example?


Thanks in advance!

On Thursday, 16 September 2021 at 22:10:40 UTC+5:30 John MacFarlane wrote:

> Harsh Donga <ha...-7+aFW328pE6p1wGUEcWPqti2O/JbrIOy@public.gmane.org> writes:
>
> > Thanks for continued support sir,
> >
> > I had few couple of doubts,
> >
> > What does Attr 
> > <
> https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Definition.html#t:Attr
> >
> > mean?
>
> It's for attributes on elements.
> (identifier, clasess, key-value pairs)
>
> > And can you explain type Meta 
> > <
> https://hackage.haskell.org/package/pandoc-types-1.22/docs/Text-Pandoc-Definition.html#t:Meta>?, 
>
> > it's going a bit over my head
>
> It's a mapping of metadata values.
>

-- 
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/4b3e7960-d144-44e0-9b48-a044db45f885n%40googlegroups.com.

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

Re: FIguring out pandoc AST and types

['Daniel Gnoutcheff' via pandoc-discuss]

On 9/17/21 12:18 AM, Harsh Donga wrote:
> Sorry to bother you,
> 
> I could read in the documentation that Attr stores (identifier, classes, 
> key-value pairs)
> What do these actually mean? can you share an example?

The AST corresponds closely to Pandoc's Markdown dialect, so a good way 
to learn about an AST type is to study the User's Manual sections that 
document the corresponding Markdown features.  You may have noticed that 
the Attr type is used by the Header, CodeBlock, Div, Code, Link, Image, 
and Span data constructors.  In Pandoc's Markdown, headings, code 
blocks, div blocks, code inlines, links, images, and spans all can have 
"attributes".  The relevant manual sections discuss their syntax and how 
they are used (or ignored) by writers:

- <https://pandoc.org/MANUAL.html#extension-header_attributes>
- <https://pandoc.org/MANUAL.html#extension-fenced_code_attributes>
- <https://pandoc.org/MANUAL.html#extension-fenced_divs>
- <https://pandoc.org/MANUAL.html#extension-inline_code_attributes>
- <https://pandoc.org/MANUAL.html#extension-link_attributes>
- <https://pandoc.org/MANUAL.html#extension-bracketed_spans>

I would just add that Pandoc's HTML writer converts Attr values into 
HTML tag attributes, including those classes and key-value pairs that 
Pandoc does not itself recognize.  Attributes and classes that mean 
nothing to Pandoc can become meaningful if, for example, you provide a 
custom template with CSS or JavaScript that does something with them.

HTH!

Later,
Daniel G.

Re: FIguring out pandoc AST and types

[BPJ]

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

The OP might also want to look at the type reference for Lua filters which
if I am not mistaken corresponds closely to the Haskell types. (I don't
know Haskell but at least the names/tags correspond closely.)

https://pandoc.org/lua-filters.html#lua-type-reference

Den fre 17 sep. 2021 21:26'Daniel Gnoutcheff' via pandoc-discuss <
pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org> skrev:

> On 9/17/21 12:18 AM, Harsh Donga wrote:
> > Sorry to bother you,
> >
> > I could read in the documentation that Attr stores (identifier, classes,
> > key-value pairs)
> > What do these actually mean? can you share an example?
>
> The AST corresponds closely to Pandoc's Markdown dialect, so a good way
> to learn about an AST type is to study the User's Manual sections that
> document the corresponding Markdown features.  You may have noticed that
> the Attr type is used by the Header, CodeBlock, Div, Code, Link, Image,
> and Span data constructors.  In Pandoc's Markdown, headings, code
> blocks, div blocks, code inlines, links, images, and spans all can have
> "attributes".  The relevant manual sections discuss their syntax and how
> they are used (or ignored) by writers:
>
> - <https://pandoc.org/MANUAL.html#extension-header_attributes>
> - <https://pandoc.org/MANUAL.html#extension-fenced_code_attributes>
> - <https://pandoc.org/MANUAL.html#extension-fenced_divs>
> - <https://pandoc.org/MANUAL.html#extension-inline_code_attributes>
> - <https://pandoc.org/MANUAL.html#extension-link_attributes>
> - <https://pandoc.org/MANUAL.html#extension-bracketed_spans>
>
> I would just add that Pandoc's HTML writer converts Attr values into
> HTML tag attributes, including those classes and key-value pairs that
> Pandoc does not itself recognize.  Attributes and classes that mean
> nothing to Pandoc can become meaningful if, for example, you provide a
> custom template with CSS or JavaScript that does something with them.
>
> HTH!
>
> Later,
> Daniel G.
>
> --
> 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/b467908f-a4ce-35b9-ba30-ef55e9e70958%40softwarefreedom.org
> .
>

-- 
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/CADAJKhDN5x1AqBuEehnRVO4ju_fjdwmu6vVuimSXohbnFqmQgA%40mail.gmail.com.

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