인용 가능한 문서 만들기

문서의 YAML 프런트매터에 추가 메타데이터를 제공하면 다른 사람이 작업을 인용하기 훨씬 쉬워집니다. 인용 정보는 웹에 배포된 글과 저널(doi 유무와 관계없이)에 게재된 글 모두에 대해 제공할 수 있습니다.

웹 문서

웹에 배포된 글에 인용 정보를 제공하려면 작성자와 날짜 메타데이터, 그리고 인용 URL을 포함합니다. 예를 들어 다음과 같습니다.

---
title: "재현 가능한 문서 출력을 요약하기"
description: | 
  재현 가능한 과학 문서의 출력 요약 모범 사례를 정리한 글입니다.
date: 5/4/2018
author:
  - name: Norah Jones 
    url: https://example.com/norahjones
    affiliation: Spacely Sprockets
    affiliation-url: https://example.com/spacelysprockets
citation:
  url: https://example.com/summarizing-output
bibliography: biblio.bib
---

이름에 붙는 파티클은 Citation Style Language(CSL)의 파티클 명명 규격을 따라 name 키 안에서 더 자세히 지정할 수 있습니다. 인용 URL을 생략하면 Quarto가 site-url 값과 현재 페이지 위치를 사용해 인용 URL을 생성하려 시도합니다. Quarto가 인용 URL을 생성하도록 하려면 인용 URL을 빼고 페이지에서 인용 출력을 활성화하기만 하면 됩니다. 예를 들어 다음과 같습니다.

---
title: "재현 가능한 문서 출력을 요약하기"
description: | 
  재현 가능한 과학 문서의 출력 요약 모범 사례를 정리한 글입니다.
date: 5/4/2018
author:
  - name: Norah Jones 
    url: https://example.com/norahjones
    affiliation: Spacely Sprockets
    affiliation-url: https://example.com/spacelysprokets
citation: true
bibliography: biblio.bib
---

이 메타데이터가 준비되면 인용 부록이 자동으로 글에 추가됩니다. 부록에는 문서를 그대로 복사해 붙여 넣을 수 있는 bibtex 표현과 서식이 적용된 인용문이 함께 표시됩니다(CSL 파일을 지정했다면 해당 파일을 기반으로 합니다). 예시는 다음과 같습니다.

BibTeX 및 일반 텍스트 인용문이 함께 표시된 인용 부록의 모양

기본적으로 bibtex 표현과 서식이 적용된 표현이 모두 표시됩니다. 이 동작은 appendix-cite-as 옵션으로 조정할 수 있습니다.

appendix-cite-as: false 부록에 인용문을 포함하지 않습니다. |
appendix-cite-as: bibtex BibTeX 버전 인용문만 표시합니다. |
appendix-cite-as: display 서식이 적용된 인용문만 표시합니다. |

학술지 문서

글이 학술지에 배포되어 있다면 다음 추가 필드를 입력해 해당 인용 정보를 생성할 수 있습니다.

---
title: "재현 가능한 문서 출력을 요약하기"
description: | 
  재현 가능한 과학 문서의 출력 요약 모범 사례를 정리한 글입니다.
date: 5/4/2018
author:
  - name: Norah Jones 
    url: https://example.com/norahjones
    affiliation: Spacely Sprockets
    affiliation-url: https://example.com/spacelysprokets
citation:
  type: article-journal
  container-title: "Journal of Data Science Software"
  doi: "10.23915/reprodocs.00010"
  url: https://example.com/summarizing-output
bibliography: biblio.bib
---

이 경우 부록에서 인용 정보가 다음과 같이 표시됩니다.

BibTeX 및 일반 텍스트 인용문이 함께 표시된 학술지 인용 부록의 예시

기타 문서 유형

문서에 표시되는 BibTeX 및 서식이 적용된 인용 정보는 citation 키에 입력된 내용(즉 Citation Style Language(CSL) 항목 규격을 따르는 정보)을 바탕으로 생성됩니다. 사용 가능한 옵션은 Citation Metadata Reference에서 자세히 확인할 수 있습니다.

Google Scholar

Quarto 문서에는 Google Scholar가 색인화하는 형식에 호환되는 메타데이터를 포함할 수 있습니다. 이를 사용하면 색인 엔진(Google Scholar 또는 기타 엔진)이 글에 대한 인용뿐 아니라 글에서 인용한 다른 정보도 쉽게 추출할 수 있습니다. 이를 활성화하려면 google-scholar 옵션을 사용하세요.

title: "재현 가능한 문서 출력을 요약하기"
description: | 
  재현 가능한 과학 문서의 출력 요약 모범 사례를 정리한 글입니다.
date: 5/4/2018
author:
  - name: Norah Jones 
    url: https://example.com/norahjones
    affiliation: Spacely Sprockets
    affiliation-url: https://example.com/spacelysprokets
citation:
  type: article-journal
  container-title: "Journal of Data Science Software"
  doi: "10.23915/reprodocs.00010"
  url: https://example.com/summarizing-output
bibliography: biblio.bib 
google-scholar: true

위와 같은 메타데이터로 작성된 문서에는 다음과 같은 Google Scholar 메타데이터가 자동으로 포함됩니다.

<meta name="citation_title" content="Summarizing Output for Reproducible Documents">
<meta name="citation_author" content="Norah Jones">
<meta name="citation_online_date" content="2018-05-04">
<meta name="citation_fulltext_html_url" content="https://example.com/summarizing-output">
<meta name="citation_publication_date" content="2018-05-04">
<meta name="citation_journal_title" content="Journal of Data Science Software">
<meta name="citation_reference" content="citation_title=Donald knuth;,citation_fulltext_html_url=http://dx.doi.org/10.7551/mitpress/
5485.003.0041;,citation_publication_date=1989;,citation_journal_title
=undefined;">

앞에서 설명한 인용 메타데이터 외에도, Quarto는 문서의 참고문헌에 포함된 각 항목에 대해 citatation_reference 항목을 자동으로 생성합니다.

인용 필드

Quarto는 기본 CSL 필드를 받아 알맞은 Google Scholar / Zotero / Highwire 메타데이터 태그로 변환합니다. 다음 필드를 문서 메타데이터의 citation 키 아래에 지정하면 HTML 문서에 학술 메타 태그가 생성됩니다. 이 필드에는 Google Scholar가 요구하는 필드와 선택적으로 포함할 수 있는 필드가 모두 포함되어 있습니다.

문서 Yaml

메타데이터 태그

title
지정하지 않으면 문서의 title 값이 사용됩니다.
citation_title
author
한 명 이상의 작성자1. citation 서브키가 없으면 문서의 author 값이 사용됩니다.
citation_author
editor
한 명 이상의 편집자2.
citation_editor
abstract
지정하지 않으면 문서의 abstract 값이 사용됩니다.
citation_abstract
keyword3
지정하지 않으면 문서의 keywords 값이 사용됩니다.
citation_keywords
issued
지정하지 않으면 문서의 date 값이 사용됩니다.

citation_publication_date

추가로 발행일은 다음 필드도 채웁니다:

citation_cover_date
citation_year

available-date
지정하지 않으면 문서의 date 값이 사용됩니다.
citation_online_date
url  | citation_fulltext_html_url | site-url 이 지정되어 있으면 현재 문서 기준으로url 이 생성됩니다 |
pdf-url citation_pdf_url
language
지정하지 않으면 문서의 lang 값이 사용됩니다.
citation_language
type
유효한 CSL 유형. https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types 참조.
<none>
doi
지정하지 않으면 문서의 doi 값이 사용됩니다.
citation_doi
isbn citation_isbn
issn citation_issn
eissn citation_eissn
pmid citation_pmid
issue citation_issue
volume citation_volume
page
- 기호를 기준으로 나눠 필요한 페이지 메타데이터를 생성합니다.

citation_firstpage

citation_lastpage

page-first citation_firstpage
page-last citation_lastpage
abstract-url citation_abstract_html_url
container-title

citation_journal_title

특정 유형일 경우 추가 메타 태그가 생성됩니다:

  • type: paper-conference
    citation_conference_title

  • type: book
    citation_book_title

  • type: chapter
    citation_inbook_title

number

citation_technical_report_number

type이 report이면 citation_technical_report_number 가 생성됩니다.

publisher

citation_publisher

특정 유형일 경우 추가 메타 태그가 생성됩니다:

  • type: paper-conference
    citation_conference

  • type: thesis
    citation_dissertation_institution

  • type:report
    citation_technical_report_institution

container-title-short citation_journal_abbrev
collection-title citation_series_title

다음은 문서 프런트매터에 정의한 학술대회 논문 인용 정보 예시입니다.

title: A Published Conference Paper
author:
  - name: Norah Jones
    affiliation: School of Hard Knocks
    orcid: 0000-0001-8715-9476
citation:
  type: paper-conference
  container-title: "Proceedings of the annual conference of the Society for Research"
  publisher: "Society for Research"
  issued: 2020/09/23
  volume: 2
  doi: "10.23915/reprodocs.00010"
  url: https://example.com/summarizing-output
  page-first: 46
  page-last: 53
  editor:
  - Don Draper
  - Nick Fury
google-scholar: true  

HTML 메타데이터는 다음과 같이 생성됩니다.

<meta name="citation_title" content="A Published Conference Paper">
<meta name="citation_author" content="Norah Jones">
<meta name="citation_editor" content="Nick Cage">
<meta name="citation_editor" content="Don Draper">
<meta name="citation_publication_date" content="2020-09-23">
<meta name="citation_cover_date" content="2020-09-23">
<meta name="citation_year" content="2020">
<meta name="citation_fulltext_html_url" content="https://example.com/summarizing-output">
<meta name="citation_doi" content="10.23915/reprodocs.00010">
<meta name="citation_volume" content="2">
<meta name="citation_language" content="en">
<meta name="citation_conference_title" content="Proceedings of the annual conference of the Society for Research">
<meta name="citation_conference" content="Society for Research">

Footnotes

  1. 다음 중 한 가지 방식으로 한 명 이상의 작성자를 지정하세요.

    author: Norah Jones

    또는 여러 명을 다음과 같이 지정합니다.

    author:
    -   Norah Jones
    -   Nick Fury

    HTML 메타데이터를 생성할 때는 citation 키 아래에 지정한 작성자 목록이 문서 작성자 대신 사용됩니다.↩︎

  2. 다음 중 한 가지 방식으로 한 명 이상의 편집자를 지정하세요.

    editors: Norah Jones

    또는 여러 명을 다음과 같이 지정합니다.

    editors:
    -   Norah Jones
    -   Nick Fury
    ↩︎
  3. keyword 인용 필드는 CSL과 동일하게 쉼표로 구분한 문자열입니다.↩︎