public inbox archive for pandoc-discuss@googlegroups.com
 help / color / mirror / Atom feed
From: "Bernardo C. D. A. Vasconcelos" <bernardovasconcelos-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
To: pandoc-discuss <pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
Subject: Re: Lua Filter for \citeauthor and \citetitle in HTML
Date: Wed, 8 Mar 2023 06:00:34 -0800 (PST)	[thread overview]
Message-ID: <4641cd0b-adb7-408f-b025-f56a0b293be5n@googlegroups.com> (raw)
In-Reply-To: <9786B5A5-9022-4E5B-85DE-39D4A2CAFD8F-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>


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

A filter that seems close enough is the bibexport filter at 
https://raw.githubusercontent.com/pandoc/lua-filters/master/bibexport/bibexport.lua 
which I reproduce below:

```
local utils = require 'pandoc.utils'
local List = require 'pandoc.List'

local citation_id_set = {}

local type = utils.type or type

-- Collect all citation IDs.
function Cite (c)
  local cs = c.citations
  for i = 1, #cs do
    citation_id_set[cs[i].id or cs[i].citationId] = true
  end
end

--- Return a list of citation IDs
function citation_ids ()
  local citations = {};
  for cid, _ in pairs(citation_id_set) do
    citations[#citations + 1] = cid
  end
  return citations
end

--- stringify meta inline elements. Pandoc prior to version 2.8
-- didn't properly tag MetaInline values, so making it necessary to use an
-- auxiliary Span.
local stringifyMetaInlines = function (el)
  return el.t
    and utils.stringify(el)
    or utils.stringify(pandoc.Span(el))
end

function bibdata (bibliography)
  function bibname (bibitem)
    return type(bibitem) == 'string'
      and bibitem:gsub('%.bib$', '')
      -- bibitem is assumed to be a list of inlines or MetaInlines element
      or stringifyMetaInlines(bibitem):gsub('%.bib$', '')
  end

  local bibs = (type(bibliography) == 'List' or bibliography.t == 
'MetaList')
    and List.map(bibliography, bibname)
    or {bibname(bibliography)}
  return table.concat(bibs, ',')
end

function aux_content(bibliography)
  local cites = citation_ids()
  table.sort(cites)
  local citations = table.concat(cites, ',')
  return table.concat(
    {
      '\\bibstyle{alpha}',
      '\\bibdata{' .. bibdata(bibliography) .. '}',
      '\\citation{' .. citations .. '}',
      '',
    },
    '\n'
  )
end

function write_dummy_aux (bibliography, auxfile)
  local filename
  if type(auxfile) == 'string' then
    filename = auxfile
  elseif type(auxfile) == 'table' or type(auxfile) == 'Inlines' then
    -- assume list of inlines
    filename = utils.stringify(pandoc.Span(auxfile))
  else
    filename = 'bibexport.aux'
  end
  local fh = io.open(filename, 'w')
  fh:write(aux_content(bibliography))
  fh:close()
  io.stdout:write('Aux written to ' .. filename .. '\n')
  return filename
end

function Pandoc (doc)
  local meta = doc.meta
  if not meta.bibliography then
    return nil
  else
    -- create a dummy .aux file
    local auxfile_name = write_dummy_aux(meta.bibliography, meta.auxfile)
    os.execute('bibexport ' .. auxfile_name)
    io.stdout:write('Output written to bibexport.bib\n')
    return nil
  end
end
```

We already have something that will collect the whole bibliography. How do 
we go from this to actually using this to replace Cites with special 
attributes? E.g. [@Citekey]{.title} or with a suffix [@Citekey-]? This last 
one (the suffix) I was able to dig down until I could locate it in the 
Pandoc AST using Paru for Ruby, but not using Lua. (At first, I thought Lua 
would be easier, but the underlying Haskell architecture and the AST model 
are still very foreign to me.)

Thanks,
B.

On Monday, January 30, 2023 at 2:41:35 PM UTC-3 John MacFarlane wrote:

> In a Lua filter you could probably just use pandoc.read with the format 
> "bibtex" or "biblatex".
>
>
> > On Jan 30, 2023, at 9:21 AM, Bastien DUMONT <bastien...-VwIFZPTo/vqsTnJN9+BGXg@public.gmane.org> 
> wrote:
> > 
> > Do you mean a function that parses the .bib file directly? I really 
> think that it would be easier to convert the .bib file to a CSL JSON file 
> and import it via a JSON parser.
> > 
> > Le Monday 30 January 2023 à 08:49:36AM, Bernardo C. D. A. Vasconcelos a 
> écrit :
> >> Thanks for the feedback, Bastien! 
> >> Can you think of a similar example script that contains the function to 
> parse
> >> the bib data? I searched for it online to no avail.
> >> On Saturday, January 28, 2023 at 7:35:40 PM UTC-3 Bastien Dumont wrote:
> >> 
> >> I think that it would be better to run it before citeproc, since you 
> don't
> >> want citeproc output (unless you want to still benefit from the "ibid./
> >> cited" feature). Citeproc would not help you so much here because it 
> does
> >> not tag the different parts of a formatted citation. On the other hand,
> >> parsing the bib file would be rather simple if it is in the CSL JSON
> >> format: then you would just have to use one of the JSON modules for Lua 
> to
> >> import your bibliographic references into a Lua table. If you use 
> Bib(La)
> >> TeX, you can convert a .bib file to a .json with `pandoc -f bibtex (or
> >> biblatex) -t csljson myfile.bib -o myfile.json`.
> >> 
> >> Le Saturday 28 January 2023 à 02:07:54PM, Bernardo C. D. A. Vasconcelos 
> a
> >> écrit :
> >>> An HTML equivalent of these commands was proposed in Github, but there
> >> was no
> >>> feasible way for it to be implemented as part of Citeproc. I suggested 
> a
> >> Lua
> >>> filter to achieve this and John said it sounded doable. 
> >>> 
> >>> I learned some Lua and experimented, but I didn't come close enough to
> >> have
> >>> something worth sharing. In short: I imagined something like `[@Ref]
> >>> {.citetitle}` and `[@Ref]{.citeauthor}`. So this would imply: parsing 
> the
> >> bib
> >>> data and saving it to a Lua table (stuck here); filtering spans; 
> checking
> >> the
> >>> type and performing the replacement (not clear to me either what the
> >> correct
> >>> way would be to replace the id with the data or if this would have to 
> run
> >>> before/after citeproc).
> >>> 
> >>> Any pointers would be much appreciated.
> >>> 
> >>> --
> >>> 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 [1]pandoc-discus...-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> >>> To view this discussion on the web visit [2][1]
> https://groups.google.com/
> >> d/msgid/
> >>> pandoc-discuss/51e71797-b029-4438-be64-6a8a15dd500an%[2]
> >> 40googlegroups.com.
> >>> 
> >>> References:
> >>> 
> >>> [1] mailto:pandoc-discus...-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
> >>> [2] [3]https://groups.google.com/d/msgid/pandoc-discuss/
> >> 51e71797-b029-4438-be64-6a8a15dd500an%
> 40googlegroups.com?utm_medium=email&
> >> utm_source=footer
> >> 
> >> 
> >> --
> >> 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 [4]pandoc-discus...-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> >> To view this discussion on the web visit [5]
> https://groups.google.com/d/msgid/
> >> pandoc-discuss/4865a325-42c0-4245-b992-b4fbdeab576en%40googlegroups.com
> .
> >> 
> >> References:
> >> 
> >> [1] https://groups.google.com/d/msgid/
> >> [2] http://40googlegroups.com/
> >> [3] 
> https://groups.google.com/d/msgid/pandoc-discuss/51e71797-b029-4438-be64-6a8a15dd500an%40googlegroups.com?utm_medium=email&utm_source=footer
> >> [4] mailto:pandoc-discus...-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
> >> [5] 
> https://groups.google.com/d/msgid/pandoc-discuss/4865a325-42c0-4245-b992-b4fbdeab576en%40googlegroups.com?utm_medium=email&utm_source=footer
> > 
> > -- 
> > 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-discus...-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> > To view this discussion on the web visit 
> https://groups.google.com/d/msgid/pandoc-discuss/Y9f8i/Jl%2BgDjNo/a%40localhost
> .
>
>

-- 
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/4641cd0b-adb7-408f-b025-f56a0b293be5n%40googlegroups.com.

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

  parent reply	other threads:[~2023-03-08 14:00 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-28 22:07 Bernardo C. D. A. Vasconcelos
     [not found] ` <51e71797-b029-4438-be64-6a8a15dd500an-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2023-01-28 22:35   ` Bastien DUMONT
2023-01-30 16:49     ` Bernardo C. D. A. Vasconcelos
     [not found]       ` <4865a325-42c0-4245-b992-b4fbdeab576en-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2023-01-30 17:21         ` Bastien DUMONT
2023-01-30 17:41           ` John MacFarlane
     [not found]             ` <9786B5A5-9022-4E5B-85DE-39D4A2CAFD8F-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2023-03-08 14:00               ` Bernardo C. D. A. Vasconcelos [this message]
     [not found]                 ` <4641cd0b-adb7-408f-b025-f56a0b293be5n-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2023-03-09 12:37                   ` Albert Krewinkel
     [not found]                     ` <87pm9i6qmx.fsf-9EawChwDxG8hFhg+JK9F0w@public.gmane.org>
2023-03-09 14:37                       ` Bernardo C. D. A. Vasconcelos
     [not found]                         ` <555cddba-b706-48f6-acb8-07465e5487a2n-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2023-03-09 18:56                           ` Bernardo C. D. A. Vasconcelos

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4641cd0b-adb7-408f-b025-f56a0b293be5n@googlegroups.com \
    --to=bernardovasconcelos-re5jqeeqqe8avxtiumwx3w@public.gmane.org \
    --cc=pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).