Plain @ in lua-filter for writing texinfo

Plain @ in lua-filter for writing texinfo

[Doron Behar]

Hey,

I'm trying to write a lua filter that will add certain text to texinfo
document and I'm having trouble adding it without it being quoted.

To be specific, The text I'm trying to add is:

@direntry
* NAME OF THE FILE (NAME OF THE FILE)
@end direntry

The problem is that the string `@` I'm using in the lua filter code is
inserted in the output as `@@`. I suppose that's because of the quoting
rules in texinfo but as you might imagine I need it unquoted. I couldn't
find anything related to specific document formats quoting or unquoting
in the documentation.

I've tried using `pandoc.Plain`, `pandoc.Str` and `pandoc.RawInline` and
all of them returned in a different way `@@` and not just `@`.

I'll be glad to get some help, thanks in advance.

Re: Plain @ in lua-filter for writing texinfo

[John MacFarlane]

pandoc.RawInline("texinfo", "@") should insert a @
without escaping.

% pandoc -t texinfo -f native
[RawInline (Format "texinfo") "@"]
^D
@node Top
@top Top

@

Does your pandoc give a different result for the above
test?


Doron Behar <doron.behar-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> writes:

> Hey,
>
> I'm trying to write a lua filter that will add certain text to texinfo
> document and I'm having trouble adding it without it being quoted.
>
> To be specific, The text I'm trying to add is:
>
> @direntry
> * NAME OF THE FILE (NAME OF THE FILE)
> @end direntry
>
> The problem is that the string `@` I'm using in the lua filter code is
> inserted in the output as `@@`. I suppose that's because of the quoting
> rules in texinfo but as you might imagine I need it unquoted. I couldn't
> find anything related to specific document formats quoting or unquoting
> in the documentation.
>
> I've tried using `pandoc.Plain`, `pandoc.Str` and `pandoc.RawInline` and
> all of them returned in a different way `@@` and not just `@`.
>
> I'll be glad to get some help, thanks in advance.
>
> -- 
> 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/20190130111350.i6vphdqmtvwmffkr%40NUC.doronbehar.com.
> For more options, visit https://groups.google.com/d/optout.

Re: Plain @ in lua-filter for writing texinfo

[Doron Behar]

Sorry for the late reply, I guess I haven't understood the documentation
so thanks, that helped me a lot.

On Wed, Jan 30, 2019 at 11:14:52AM -0800, John MacFarlane wrote:
> 
> pandoc.RawInline("texinfo", "@") should insert a @
> without escaping.
> 
> % pandoc -t texinfo -f native
> [RawInline (Format "texinfo") "@"]
> ^D
> @node Top
> @top Top
> 
> @
> 
> Does your pandoc give a different result for the above
> test?
> 
> 
> Doron Behar <doron.behar-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> writes:
> 
> > Hey,
> >
> > I'm trying to write a lua filter that will add certain text to texinfo
> > document and I'm having trouble adding it without it being quoted.
> >
> > To be specific, The text I'm trying to add is:
> >
> > @direntry
> > * NAME OF THE FILE (NAME OF THE FILE)
> > @end direntry
> >
> > The problem is that the string `@` I'm using in the lua filter code is
> > inserted in the output as `@@`. I suppose that's because of the quoting
> > rules in texinfo but as you might imagine I need it unquoted. I couldn't
> > find anything related to specific document formats quoting or unquoting
> > in the documentation.
> >
> > I've tried using `pandoc.Plain`, `pandoc.Str` and `pandoc.RawInline` and
> > all of them returned in a different way `@@` and not just `@`.
> >
> > I'll be glad to get some help, thanks in advance.
> >
> > -- 
> > 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> > To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/20190130111350.i6vphdqmtvwmffkr%40NUC.doronbehar.com.
> > For more options, visit https://groups.google.com/d/optout.

Re: Plain @ in lua-filter for writing texinfo

[Doron Behar]

Thanks again John for helping me out. I've been putting more of my time
to learn Pandoc Lua filters and I think now I understand most of it.

I've ended with this filter for the purpose I described in my initial
post:

```
function Pandoc(doc)
	if os.getenv("WINFO_TITLE") then
		local title = os.getenv("WINFO_TITLE")
		table.insert(doc.blocks, 1, pandoc.Para({
			pandoc.RawInline("texinfo", "@direntry"),
			pandoc.LineBreak(),
			pandoc.Str("* " .. title .. " (" .. title .. ")"),
			pandoc.LineBreak(),
			pandoc.RawInline("texinfo", "@end"),
			pandoc.Space(),
			pandoc.RawInline("texinfo", "direntry"),
			pandoc.LineBreak()
		}))
	end
	return pandoc.Pandoc(doc.blocks, doc.meta)
end
```

The weird thing is, that from some reason I get this output where
@direntry is inserted:

```
@direntry@*
* TITLE (TITLE)@*
@end direntry@*
```

As you can see, `@*` are inserted at the end of each of those lines. Do
you know the reason why? I tried substituting pandoc.Para with
pandoc.Plain but those `@*` were inserted as well.

Thanks,

Doron.

On Sun, Feb 03, 2019 at 01:04:15AM +0200, Doron Behar wrote:
> Sorry for the late reply, I guess I haven't understood the documentation
> so thanks, that helped me a lot.
> 
> On Wed, Jan 30, 2019 at 11:14:52AM -0800, John MacFarlane wrote:
> > 
> > pandoc.RawInline("texinfo", "@") should insert a @
> > without escaping.
> > 
> > % pandoc -t texinfo -f native
> > [RawInline (Format "texinfo") "@"]
> > ^D
> > @node Top
> > @top Top
> > 
> > @
> > 
> > Does your pandoc give a different result for the above
> > test?
> > 
> > 
> > Doron Behar <doron.behar-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> writes:
> > 
> > > Hey,
> > >
> > > I'm trying to write a lua filter that will add certain text to texinfo
> > > document and I'm having trouble adding it without it being quoted.
> > >
> > > To be specific, The text I'm trying to add is:
> > >
> > > @direntry
> > > * NAME OF THE FILE (NAME OF THE FILE)
> > > @end direntry
> > >
> > > The problem is that the string `@` I'm using in the lua filter code is
> > > inserted in the output as `@@`. I suppose that's because of the quoting
> > > rules in texinfo but as you might imagine I need it unquoted. I couldn't
> > > find anything related to specific document formats quoting or unquoting
> > > in the documentation.
> > >
> > > I've tried using `pandoc.Plain`, `pandoc.Str` and `pandoc.RawInline` and
> > > all of them returned in a different way `@@` and not just `@`.
> > >
> > > I'll be glad to get some help, thanks in advance.
> > >
> > > -- 
> > > 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> > > To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/20190130111350.i6vphdqmtvwmffkr%40NUC.doronbehar.com.
> > > For more options, visit https://groups.google.com/d/optout.

Re: Plain @ in lua-filter for writing texinfo

[BPJ]

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

Aren't those the hard line breaks? See <
http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Command-List.html>.
If you use a RawBlock instead of a RawInline inside a Para with hard
linebreaks around them you probably will get what you expect. Note the
distinction between block and inline elements in the Lua filter manual. It
is very important in Pandoc'a internal document model.

Den tis 12 feb. 2019 11:36 skrev Doron Behar <doron.behar-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>:

> Thanks again John for helping me out. I've been putting more of my time
> to learn Pandoc Lua filters and I think now I understand most of it.
>
> I've ended with this filter for the purpose I described in my initial
> post:
>
> ```
> function Pandoc(doc)
>         if os.getenv("WINFO_TITLE") then
>                 local title = os.getenv("WINFO_TITLE")
>                 table.insert(doc.blocks, 1, pandoc.Para({
>                         pandoc.RawInline("texinfo", "@direntry"),
>                         pandoc.LineBreak(),
>                         pandoc.Str("* " .. title .. " (" .. title .. ")"),
>                         pandoc.LineBreak(),
>                         pandoc.RawInline("texinfo", "@end"),
>                         pandoc.Space(),
>                         pandoc.RawInline("texinfo", "direntry"),
>                         pandoc.LineBreak()
>                 }))
>         end
>         return pandoc.Pandoc(doc.blocks, doc.meta)
> end
> ```
>
> The weird thing is, that from some reason I get this output where
> @direntry is inserted:
>
> ```
> @direntry@*
> * TITLE (TITLE)@*
> @end direntry@*
> ```
>
> As you can see, `@*` are inserted at the end of each of those lines. Do
> you know the reason why? I tried substituting pandoc.Para with
> pandoc.Plain but those `@*` were inserted as well.
>
> Thanks,
>
> Doron.
>
> On Sun, Feb 03, 2019 at 01:04:15AM +0200, Doron Behar wrote:
> > Sorry for the late reply, I guess I haven't understood the documentation
> > so thanks, that helped me a lot.
> >
> > On Wed, Jan 30, 2019 at 11:14:52AM -0800, John MacFarlane wrote:
> > >
> > > pandoc.RawInline("texinfo", "@") should insert a @
> > > without escaping.
> > >
> > > % pandoc -t texinfo -f native
> > > [RawInline (Format "texinfo") "@"]
> > > ^D
> > > @node Top
> > > @top Top
> > >
> > > @
> > >
> > > Does your pandoc give a different result for the above
> > > test?
> > >
> > >
> > > Doron Behar <doron.behar-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> writes:
> > >
> > > > Hey,
> > > >
> > > > I'm trying to write a lua filter that will add certain text to
> texinfo
> > > > document and I'm having trouble adding it without it being quoted.
> > > >
> > > > To be specific, The text I'm trying to add is:
> > > >
> > > > @direntry
> > > > * NAME OF THE FILE (NAME OF THE FILE)
> > > > @end direntry
> > > >
> > > > The problem is that the string `@` I'm using in the lua filter code
> is
> > > > inserted in the output as `@@`. I suppose that's because of the
> quoting
> > > > rules in texinfo but as you might imagine I need it unquoted. I
> couldn't
> > > > find anything related to specific document formats quoting or
> unquoting
> > > > in the documentation.
> > > >
> > > > I've tried using `pandoc.Plain`, `pandoc.Str` and `pandoc.RawInline`
> and
> > > > all of them returned in a different way `@@` and not just `@`.
> > > >
> > > > I'll be glad to get some help, thanks in advance.
> > > >
> > > > --
> > > > 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
> .
> > > > To view this discussion on the web visit
> https://groups.google.com/d/msgid/pandoc-discuss/20190130111350.i6vphdqmtvwmffkr%40NUC.doronbehar.com
> .
> > > > For more options, visit https://groups.google.com/d/optout.
>
> --
> 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/pandoc-discuss/20190212103518.mkb4epawqlqsluua%40NUC.doronbehar.com
> .
> For more options, visit https://groups.google.com/d/optout.
>

-- 
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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/CADAJKhCCW%2BFZsFq5TtQSM19O50a9WrP-SHOhphMBk8N7ynQctQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

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

Re: Plain @ in lua-filter for writing texinfo

[Doron Behar]

Thanks for clarifying this, I guess you are right about the line break.
I'm using RawBlock now and it works great.

On Tue, Feb 12, 2019 at 01:58:32PM +0100, BPJ wrote:
> Aren't those the hard line breaks? See <
> http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Command-List.html>.
> If you use a RawBlock instead of a RawInline inside a Para with hard
> linebreaks around them you probably will get what you expect. Note the
> distinction between block and inline elements in the Lua filter manual. It
> is very important in Pandoc'a internal document model.
> 
> Den tis 12 feb. 2019 11:36 skrev Doron Behar <doron.behar-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>:
> 
> > Thanks again John for helping me out. I've been putting more of my time
> > to learn Pandoc Lua filters and I think now I understand most of it.
> >
> > I've ended with this filter for the purpose I described in my initial
> > post:
> >
> > ```
> > function Pandoc(doc)
> >         if os.getenv("WINFO_TITLE") then
> >                 local title = os.getenv("WINFO_TITLE")
> >                 table.insert(doc.blocks, 1, pandoc.Para({
> >                         pandoc.RawInline("texinfo", "@direntry"),
> >                         pandoc.LineBreak(),
> >                         pandoc.Str("* " .. title .. " (" .. title .. ")"),
> >                         pandoc.LineBreak(),
> >                         pandoc.RawInline("texinfo", "@end"),
> >                         pandoc.Space(),
> >                         pandoc.RawInline("texinfo", "direntry"),
> >                         pandoc.LineBreak()
> >                 }))
> >         end
> >         return pandoc.Pandoc(doc.blocks, doc.meta)
> > end
> > ```
> >
> > The weird thing is, that from some reason I get this output where
> > @direntry is inserted:
> >
> > ```
> > @direntry@*
> > * TITLE (TITLE)@*
> > @end direntry@*
> > ```
> >
> > As you can see, `@*` are inserted at the end of each of those lines. Do
> > you know the reason why? I tried substituting pandoc.Para with
> > pandoc.Plain but those `@*` were inserted as well.
> >
> > Thanks,
> >
> > Doron.
> >
> > On Sun, Feb 03, 2019 at 01:04:15AM +0200, Doron Behar wrote:
> > > Sorry for the late reply, I guess I haven't understood the documentation
> > > so thanks, that helped me a lot.
> > >
> > > On Wed, Jan 30, 2019 at 11:14:52AM -0800, John MacFarlane wrote:
> > > >
> > > > pandoc.RawInline("texinfo", "@") should insert a @
> > > > without escaping.
> > > >
> > > > % pandoc -t texinfo -f native
> > > > [RawInline (Format "texinfo") "@"]
> > > > ^D
> > > > @node Top
> > > > @top Top
> > > >
> > > > @
> > > >
> > > > Does your pandoc give a different result for the above
> > > > test?
> > > >
> > > >
> > > > Doron Behar <doron.behar-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> writes:
> > > >
> > > > > Hey,
> > > > >
> > > > > I'm trying to write a lua filter that will add certain text to
> > texinfo
> > > > > document and I'm having trouble adding it without it being quoted.
> > > > >
> > > > > To be specific, The text I'm trying to add is:
> > > > >
> > > > > @direntry
> > > > > * NAME OF THE FILE (NAME OF THE FILE)
> > > > > @end direntry
> > > > >
> > > > > The problem is that the string `@` I'm using in the lua filter code
> > is
> > > > > inserted in the output as `@@`. I suppose that's because of the
> > quoting
> > > > > rules in texinfo but as you might imagine I need it unquoted. I
> > couldn't
> > > > > find anything related to specific document formats quoting or
> > unquoting
> > > > > in the documentation.
> > > > >
> > > > > I've tried using `pandoc.Plain`, `pandoc.Str` and `pandoc.RawInline`
> > and
> > > > > all of them returned in a different way `@@` and not just `@`.
> > > > >
> > > > > I'll be glad to get some help, thanks in advance.
> > > > >
> > > > > --
> > > > > 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
> > .
> > > > > To view this discussion on the web visit
> > https://groups.google.com/d/msgid/pandoc-discuss/20190130111350.i6vphdqmtvwmffkr%40NUC.doronbehar.com
> > .
> > > > > For more options, visit https://groups.google.com/d/optout.
> >
> > --
> > 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> > To view this discussion on the web visit
> > https://groups.google.com/d/msgid/pandoc-discuss/20190212103518.mkb4epawqlqsluua%40NUC.doronbehar.com
> > .
> > For more options, visit https://groups.google.com/d/optout.
> >
> 
> -- 
> 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 post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/CADAJKhCCW%2BFZsFq5TtQSM19O50a9WrP-SHOhphMBk8N7ynQctQ%40mail.gmail.com.
> For more options, visit https://groups.google.com/d/optout.