How do I display custom front matter keywords in the title-block

[haxfn]

Description

I want to display my custom yml keywords on the rendered page, something like the jats format:

I am creating a resource database, and for that I want to define a new yml template:

---
title: Page Rank
description: Thoughts and References when Learning Page Rank.

categories: ["A-Computing","B-LinearAlgebra",]
contributors: ["Sergey Brin","Larry Page"]
status: done
urls: ["https://en.wikipedia.org/wiki/PageRank", "https://www.cis.upenn.edu/~mkearns/teaching/NetworkedLife/pagerank.pdf"]

# format:
#  html:
#    template: /_extensions/custom-template
---

# Problem

The Page Rank algorithm is..

I would use this template in a listing:

---
title: "Resources"
description: "Categorized Learning Resource Database"
title-block-banner: _assets/tree.jpeg

# page-layout: article
listing:
  contents: .
  fields: [status, title, categories, urls, contributors]
  sort: "date desc"
  type: table
  table-striped: true
  field-links: [title]
  sort-ui: [title, categories, status]
  filter-ui: [title, categories]
  # categories: true
  # date-format: DD MMM, YYYY
#  template: _assets/tgif.js
# css: /css/tgif.css
---

I want to display custom YAML frontmatter fields like status, contributors, and urls on my rendered pages, similar to how the JATS format displays metadata in academic papers.

With some digging I realized I need to hack somewhere around here:

quarto-cli/src/resources/formats/html/pandoc/title-block.html:

<header id="title-block-header">
$if(title)$<h1 class="title">$title$</h1>$endif$
$if(subtitle)$
<p class="subtitle">$subtitle$</p>
$endif$
$for(author)$
<p class="author">$author$</p>
$endfor$

$if(date)$
<p class="date">$date$</p>
$endif$
$if(abstract)$
<div class="abstract">
<div class="abstract-title">$abstract-title$</div>
$abstract$
</div>
$endif$
</header>

Could someone guide? How do I make the custom keywords in yml front matter show up on my page?

[mcanouil]

There are already multiple threads about modifying partials and templates, including the documentation: https://quarto.org/docs/journals/templates.html

Please try to spend some time to understand how things work in Quarto and go through all the documentation and existing threads. This will help you with all your customisation questions.

See also: https://quarto.org/docs/websites/website-listings-custom.html

[haxfn]

The categories and the description don't show up. I have:

---
title: Page Rank
description: Thoughts and References when Learning Page Rank.

# ...

format:
  html:
    template-partials:
      - title-block.html
---

title-block.html: is the default source code

I don't understand why, but when I do this, i.e when I overwrite the template-partial title-block with the default title-block.html, the categories and the description don't show up. Why is that?

[cderv]

With some digging I realized I need to hack somewhere around here:
(...)
Could someone guide? How do I make the custom keywords in yml front matter show up on my page?

This is the template used when there is a title-block:
https://github.com/quarto-dev/quarto-cli/blob/main/src/resources/formats/html/templates/title-block.html

There are categories in there.

The other one is the pandoc default one that is used when the html format opt-out some features.

However, I am not sure I fully comprehend what you are trying to do, as you are also mentioning listing, and listing have another template mechanism: https://quarto.org/docs/websites/website-listings-custom.html

So I am unsure which part of your document or website you wants to modify. I would help us help guide you to the right feature.

If you manage to build a simple example in a github repo this would probably help demonstrasting the exact tweak you want to do.

Showing what you tried from what you understand from the documentation is really helpful for us to be precise in our replies.

Thanks a lot!

[haxfn]

Thanks @cderv

This is the template used when there is a title-block

This is very helpful, I was struggling earlier to find this template through the docs. The docs on templating only linked to the default pandoc source code.

However, I am not sure I fully comprehend what you are trying to do, as you are also mentioning listing

I am sorry, actually I should have not asked about listing, that was only to give an Idea of why I am using custom urls (to use them in listings). As such, this discussion was to only discuss displaying the custom keywords in yml and therefore templates.

So I am unsure which part of your document or website you wants to modify. I would help us help guide you to the right feature.

Sorry, you are right. I was referring to the following section on HTML Partials on html templating in an effort to find the docs on where might I modify the title block.

If you manage to build a simple example in a github repo this would probably help demonstrasting the exact tweak you want to do.

Sure, I have hopefully figured out the tweak that works for me, I will update it in some time on the Resource section of my site.

Again, Thanks @cderv !