Insert COinS in index.html generated by bookdown

[KriHa]

Hello RStudio community,

I've published a book/manual with bookdown and hosted it on Github-pages.
My browser has the Zotero-connector which scans for bibliographic metadata and allows to directly ingest the bibliographic reference into my Zotero database.

However, when I visit my bookdwon-website it is currently recognized as a book and the authors (as listed in the yaml) are mixed up when using the Zotero connector. On this site it is explained how to integrate ContextObjects in Spans (COinS) in the index.html of a website. So when I create a correct bibliographic reference in Zotero, export it as COinS and paste the generated COinS-html into the index.html, the Zotero-connector detects this meta-data and ingests it correctly into Zotero.

Is it possible to embed bibliographic metadata (COinS) directly in the Rmarkdown files when building the book in Bookdown, so there would be no need to copy/paste this after every build and update?

That would, for instance, require to include the following html in the html-output generated by Bookdown:

<span class='Z3988' title='url_ver=Z39.88-2004&amp;ctx_ver=Z39.88-2004&amp;rfr_id=info%3Asid%2Fzotero.org%3A2&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&amp;rft.type=webpage&amp;rft.title=A%20manual%20published%20with%20bookdown&amp;rft.description=Brief%20content%20of%20the%20website%20or%20book&amp;rft.identifier=urlOfTheWebsite&amp;rft.aufirst=first&amp;rft.aulast=Author&amp;rft.au=first%20Author&amp;rft.au=Second%20Author'></span>

Thanks for your time!
Best wishes,
Kristof.

[jtbayly]

I don't see any HTML.

Make sure you put it between two lines of triple backticks like this, but without the quotes:

"```
html here
```"

[KriHa]

Sorry for that. I've updated my question.
K.

[cderv]

@KriHa

That would, for instance, require to include the following html in the html-output generated by Bookdown:

Where should this be inserted ?

And you should be able to put it already in your Rmd file and as it is already html string, it will be kept in the output. Did you try that already ?

[KriHa]

This line of html with the bibliographic meta data should be inserted anywhere in the body of the index.html.

When I copy this line of html directly in index.Rmd (<span class= ...), for instance right under the YAML and before the first heading, is doesn't become part of index.html when I build the book. with bookdown

K.

[jtbayly]

Two options:

1. If you want it to show up using this method you have to set an option in index.Rmd in the YAML at the top:

always_allow_html: yes

2. There's an even better solution, though, I suspect. You want this to appear on every page of the book that somebody browses to, probably. Which means the best way to accomplish this is by placing it in a separate HTML file and then including that in your book on every page. You do that by saving a file (let's call it COinS.html) into your project with just that span code inside it. Then you include it like so in the bookdown::gitbook section of your YAML, either in index.Rmd or _output.yml:

bookdown::gitbook:
  includes:
    before_body: COinS.html

Hope that helps!

[cderv]

@jtbayly

1. If you want it to show up using this method you have to set an option in index.Rmd in the YAML at the top:

always_allow_html: yes

I am not sure this is required. This need to be set mainly for htmlwidget or other HTML only content, that would need to appear in a non-HTML format.

Using before_body is indeed the solution to have this inserted on each page.

@KriHa

for instance right under the YAML and before the first heading,

Anything before One level headings won't be included in a gitbook output because of the splitting that happens in gitbook format. You need to put it after the first header or use the before_body insertion

[jtbayly]

@cderv

I am not sure this is required.

Pretty sure it is. The first thing I did was try inserting her span code into the demo book, and it didn't show up in the page source until I added the always_allow_html option.

Edit: After reading about that option, perhaps this is just a bug?

[cderv]

@jtbayly

Pretty sure it is. The first thing I did was try inserting her span code into the demo book, and it didn't show up in the page source until I added the always_allow_html option.

I did the same thing and this option does seem to change anything on my end. If I put the span before the first level header in the index.Rmd file, I don't get the span in the output, no matter that option.

@jtbayly

Edit: After reading about that option, perhaps this is just a bug?

Anyway, it is indeed not made for this use as you saw in the documentation

[jtbayly]

My apologies. I cannot reproduce my claim above. I know I didn't have it before the header, so I must have simply fumbled my initial search in the source code.

[cderv]

No worries! Thanks for having looked into it though ! It is nice to have Rmarkdown helpers around here!

[KriHa]

Wow! Thanks a lot, both of you. I'm going to use the

@jtbayly

before_body: COinS.html

workaround. Then the COinS is indeed on every page of the book/website.
Another step forward in my (still limited) Rmarkdown/bookdown skills.

Best wishes,
Kristof.

[cderv]

If your question's been answered (even by you!), would you mind choosing a solution? It helps other people see which questions still need help, or find solutions if they have similar problems. Here’s how to do it:

FAQ: How do I mark a solution?

If your question has been answered, don't forget to mark the solution! How do I mark a solution? Find the reply you want to mark as the solution and look for the row of small gray icons at the bottom of that reply. Click the one that looks like a box with a checkmark in it: [image] Hovering over the mark solution button shows the label, "Select if this reply solves the problem". If you don't see the mark solution button, try clicking the three dots button ( ••• ) to expand the full set of options. When a solution is chosen, the icon turns green and the hover label changes to: "Unselect if this reply no longer solves the problem". Success! [solution_reply_author] …