Skip to content

Commit

Permalink
Add keywords to title block
Browse files Browse the repository at this point in the history
  • Loading branch information
dragonstyle committed Jul 18, 2023
1 parent 164c6e6 commit 32ead25
Show file tree
Hide file tree
Showing 31 changed files with 51 additions and 3 deletions.
1 change: 1 addition & 0 deletions news/changelog-1.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
- ([#5929](https://github.com/quarto-dev/quarto-cli/issues/5929)): Split border-bottom properties to avoid invalid `inherit` entry in resulting CSS.
- ([#5957](https://github.com/quarto-dev/quarto-cli/issues/5957)): Fix layout issues when margin footnotes are contained in headings or other formatted text.
- ([#6163](https://github.com/quarto-dev/quarto-cli/issues/6163)): Wrap `svg` output of `dot` cells in RawBlock `html` elements.
- Add support for displaying `keywords` in HTML page title block, when present.

## RevealJS Format

Expand Down
3 changes: 3 additions & 0 deletions src/config/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ export const kTitleBlockAffiliationSingle = "title-block-affiliation-single";
export const kTitleBlockAffiliationPlural = "title-block-affiliation-plural";
export const kTitleBlockPublished = "title-block-published";
export const kTitleBlockModified = "title-block-modified";
export const kTitleBlockKeywords = "title-block-keywords";
export const kCodeSummary = "code-summary";
export const kCodeLine = "code-line";
export const kCodeLines = "code-lines";
Expand Down Expand Up @@ -348,6 +349,7 @@ export const kLanguageDefaultsKeys = [
kTitleBlockAuthorSingle,
kTitleBlockPublished,
kTitleBlockModified,
kTitleBlockKeywords,
kCodeSummary,
kCodeLine,
kCodeLines,
Expand Down Expand Up @@ -433,6 +435,7 @@ export const kLanguageDefaultsKeys = [
kTitleBlockAffiliationPlural,
kTitleBlockPublished,
kTitleBlockModified,
kTitleBlockKeywords,
kNotebookPreviewDownload,
kNotebookPreviewDownloadSrc,
kNotebookPreviewBack,
Expand Down
2 changes: 2 additions & 0 deletions src/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ import {
kTitleBlockAffiliationSingle,
kTitleBlockAuthorPlural,
kTitleBlockAuthorSingle,
kTitleBlockKeywords,
kTitleBlockModified,
kTitleBlockPublished,
kTitlePrefix,
Expand Down Expand Up @@ -585,6 +586,7 @@ export interface FormatLanguage {
[kTitleBlockAuthorPlural]?: string;
[kTitleBlockPublished]?: string;
[kTitleBlockModified]?: string;
[kTitleBlockKeywords]?: string;
[kSectionTitleFootnotes]?: string;
[kSectionTitleReferences]?: string;
[kSectionTitleAppendices]?: string;
Expand Down
7 changes: 7 additions & 0 deletions src/resources/filters/modules/authors.lua
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ local kModifiedLbl = 'modified'
local kDoiLbl = 'doi'
local kDescriptionLbl = 'description'
local kAbstractLbl = 'abstract'
local kKeywordsLbl = 'keywords'

-- affiliation fields that might be parsed into other fields
-- (e.g. if we see affiliation-url with author, we make that affiliation/url)
Expand Down Expand Up @@ -810,6 +811,12 @@ local function computeLabels(authors, affiliations, meta)
if meta[kDescriptionTitle] then
meta[kLabels][kDescriptionLbl] = meta[kDescriptionTitle]
end

meta[kLabels][kKeywordsLbl] = {pandoc.Str(language["title-block-keywords"])}
if meta[kKeywordsTitle] then
meta[kLabels][kKeywordsLbl] = meta[kKeywordsTitle]
end

end

return meta
Expand Down
3 changes: 2 additions & 1 deletion src/resources/formats/html/templates/title-block.scss
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ main.quarto-banner-title-block > section:first-child > h4 {
margin-bottom: 0.1em;
}

.keywords,
.description,
.abstract {
margin-top: 0;
Expand All @@ -176,7 +177,7 @@ main.quarto-banner-title-block > section:first-child > h4 {
margin-bottom: 0;
}

.abstract-title {
.block-title {
margin-top: 1em;
text-transform: uppercase;
font-size: 0.8em;
Expand Down
11 changes: 10 additions & 1 deletion src/resources/formats/html/templates/title-metadata.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,17 @@
$if(abstract)$
<div>
<div class="abstract">
<div class="abstract-title">$labels.abstract$</div>
<div class="block-title">$labels.abstract$</div>
$abstract$
</div>
</div>
$endif$

$if(keywords)$
<div>
<div class="keywords">
<div class="block-title">$labels.keywords$</div>
<p>$for(keywords)$$it$$sep$, $endfor$</p>
</div>
</div>
$endif$
1 change: 1 addition & 0 deletions src/resources/language/_language-cs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Afiliace"
title-block-affiliation-plural: "Afiliace"
title-block-published: "Publikováno"
title-block-modified: "Upraveno"
title-block-keywords: "Klíčová slova"

callout-tip-title: "Tip"
callout-note-title: "Poznámka"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-da.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Tilknytning"
title-block-affiliation-plural: "Tilknytninger"
title-block-published: "Udgivet"
title-block-modified: "Ændret"
title-block-keywords: "Nøgleord"

callout-tip-title: "Tip"
callout-note-title: "Note"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-de.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Zugehörigkeit"
title-block-affiliation-plural: "Zugehörigkeiten"
title-block-published: "Veröffentlichungsdatum"
title-block-modified: "Geändert"
title-block-keywords: "Schlüsselwörter"

callout-tip-title: "Tipp"
callout-note-title: "Hinweis"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-el.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ section-title-references: "Αναφορές"
section-title-reuse: "Επαναχρησιμοποίηση"
section-title-copyright: "Πνευματικά δικαιώματα"
section-title-citation: "Αναφορά"
title-block-keywords: "Λέξεις-κλειδιά"

appendix-attribution-cite-as: "Για απόδοση ευγνωμοσύνης, παρακαλούμε αναφερθείτε σε αυτό το έργο ως:"
appendix-attribution-bibtex: "Αναφορά BibTeX:"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-es.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Afiliación"
title-block-affiliation-plural: "Afiliaciones"
title-block-published: "Fecha de publicación"
title-block-modified: "Fecha de modificación"
title-block-keywords: "Palabras clave"

callout-tip-title: "Tip"
callout-note-title: "Nota"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-fi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Affiliaatio"
title-block-affiliation-plural: "Affiliaatiot"
title-block-published: "Julkaistu"
title-block-modified: "Muokattu"
title-block-keywords: "Avainsanat"

callout-tip-title: "Vihje"
callout-note-title: "Huomautus"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-fr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Affiliation"
title-block-affiliation-plural: "Affiliations"
title-block-published: "Date de publication"
title-block-modified: "Modifié"
title-block-keywords: "Mots clés"

callout-tip-title: "Astuce"
callout-note-title: "Note"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Afiliasi"
title-block-affiliation-plural: "Afiliasi"
title-block-published: "Diterbitkan"
title-block-modified: "Diubah"
title-block-keywords: "Kata kunci"

callout-tip-title: "Tip"
callout-note-title: "Catatan"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-it.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Affiliazione"
title-block-affiliation-plural: "Affiliazioni"
title-block-published: "Data di Pubblicazione"
title-block-modified: "Data di modifica"
title-block-keywords: "Parole chiave"

callout-tip-title: "Consiglio"
callout-note-title: "Nota"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "所属"
title-block-affiliation-plural: "所属"
title-block-published: "公開"
title-block-modified: "更新日"
title-block-keywords: "キーワード"

callout-tip-title: "ヒント"
callout-note-title: "ノート"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-ko.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ title-block-author-plural: "저자"
title-block-affiliation-single: "소속"
title-block-affiliation-plural: "소속"
title-block-published: "공개"
title-block-keywords: "키워드"

callout-tip-title: "힌트"
callout-note-title: "노트"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-lt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Organizacija"
title-block-affiliation-plural: "Organizacijos"
title-block-published: "Paskelbta"
title-block-modified: "Atnaujinta"
title-block-keywords: "Raktiniai žodžiai"

callout-tip-title: "Patarimas"
callout-note-title: "Pastaba"
Expand Down
3 changes: 2 additions & 1 deletion src/resources/language/_language-nb.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ other-links-title: "Andre lenker"

article-notebook-label: "Artikkelskrivebok"
notebook-preview-download: "Last ned skrivebok"
notebook-preview-download-src: " Last ned kildekode"
notebook-preview-download-src: "Last ned kildekode"
notebook-preview-back: "Tilbake til artikkelen"
manuscript-meca-bundle: "MECA-arkiv"

Expand All @@ -29,6 +29,7 @@ title-block-affiliation-single: "Tilknytning"
title-block-affiliation-plural: "Tilknytninger"
title-block-published: "Utgitt"
title-block-modified: "Endret"
title-block-keywords: "Nøkkelord"

callout-tip-title: "Tips"
callout-note-title: "Note"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-nl.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Affiliatie"
title-block-affiliation-plural: "Affiliaties"
title-block-published: "Publicatiedatum"
title-block-modified: "Gewijzigd"
title-block-keywords: "Sleutelwoorden"

callout-tip-title: "Tip"
callout-note-title: "Opmerking"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-nn.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Tilknyting"
title-block-affiliation-plural: "Tilknytingar"
title-block-published: "Publisert"
title-block-modified: "Endra"
title-block-keywords: "Nøkkelord"

callout-tip-title: "Tips"
callout-note-title: "Obs"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-pl.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Afiliacja"
title-block-affiliation-plural: "Afiliacje"
title-block-published: "Opublikowano"
title-block-modified: "Zmodyfikowano"
title-block-keywords: "Słowa kluczowe"

callout-tip-title: "Wskazówka"
callout-note-title: "Adnotacja"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-pt-BR.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ title-block-author-plural: "Autores"
title-block-affiliation-single: "Afiliação"
title-block-affiliation-plural: "Afiliações"
title-block-published: "Data de Publicação"
title-block-keywords: "Palavras-chave"

callout-tip-title: "Dica"
callout-note-title: "Nota"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-pt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Afiliação"
title-block-affiliation-plural: "Afiliações"
title-block-published: "Data de Publicação"
title-block-modified: "Data de Modificação"
title-block-keywords: "Palavras-chave"

callout-tip-title: "Dica"
callout-note-title: "Nota"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-ru.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "принадлежность"
title-block-affiliation-plural: "Принадлежности"
title-block-published: "Дата публикации"
title-block-modified: "Файл изменен"
title-block-keywords: "Ключевые слова"

callout-tip-title: "Совет"
callout-note-title: "Уведомление"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-sk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Príslušnosť"
title-block-affiliation-plural: "Príslušnosť"
title-block-published: "Publikované"
title-block-modified: "Zmenené"
title-block-keywords: "Kľúčové slová"

callout-tip-title: "Tip"
callout-note-title: "Poznámka"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-sv.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Anknuten"
title-block-affiliation-plural: "Anknutna"
title-block-published: "Utgiven"
title-block-modified: "Ändrad"
title-block-keywords: "Nyckelord"

callout-tip-title: "Tips"
callout-note-title: "Notera"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-tr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "üyelik"
title-block-affiliation-plural: "Bağlantılar"
title-block-published: "Yayınlanma Tarihi"
title-block-modified: "Değiştirilmiş"
title-block-keywords: "Anahtar kelimeler"

callout-tip-title: "Tavsiye"
callout-note-title: "Not"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language-zh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "联系"
title-block-affiliation-plural: "隶属关系"
title-block-published: "发布日期"
title-block-modified: "修改的"
title-block-keywords: "关键词"

callout-tip-title: "提示"
callout-note-title: "注释"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Affiliation"
title-block-affiliation-plural: "Affiliations"
title-block-published: "Published"
title-block-modified: "Modified"
title-block-keywords: "Keywords"

callout-tip-title: "Tip"
callout-note-title: "Note"
Expand Down
1 change: 1 addition & 0 deletions src/resources/language/_language_nb.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ title-block-affiliation-single: "Tilknytning"
title-block-affiliation-plural: "Tilknytninger"
title-block-published: "Utgitt"
title-block-modified: "Endret"
title-block-keywords: "Nøkkelord"

callout-tip-title: "Tips"
callout-note-title: "Note"
Expand Down

0 comments on commit 32ead25

Please sign in to comment.