Haddock 옵션

Haddock은 주석이 포함된 Haskell 소스 코드에서 문서를 자동으로 생성하는 도구입니다. 자세한 내용은 https://haskell-haddock.readthedocs.io/를 참고하세요.

format: haddock

제목 및 저자

title

문서 제목
date

문서 날짜
date-format

문서의 날짜 형식
author

문서의 저자
order

웹사이트 자동 사이드바 메뉴에 포함될 때 사용할 문서 순서입니다.

형식 옵션

brand

이 문서에 사용할 브랜딩 정보입니다. 문자열이면 브랜드 파일의 경로입니다. false이면 이 문서에 브랜딩을 사용하지 않습니다. 객체이면 인라인 브랜드 정의이거나, 밝은/어두운 브랜드 경로 또는 정의를 가진 객체입니다.
identifier-prefix

HTML 및 DocBook 출력의 모든 식별자와 내부 링크, Markdown 및 Haddock 출력의 각주 번호에 접두사를 추가합니다. 다른 페이지에 포함될 조각을 생성할 때 중복 식별자를 방지하는 데 유용합니다.
quarto-required

이 문서 또는 프로젝트에서 지원되는 quarto 버전을 설명하는 semver 범위입니다.

예시:

  • >= 1.1.0: quarto 버전 1.1 이상 필요
  • 1.*: 주요 버전 번호가 1인 모든 quarto 버전 필요

목차

toc

출력 문서에 자동 생성된 목차를 포함합니다(또는 latex, context, docx, odt, opendocument, rst, ms의 경우 목차를 생성하라는 지시를 포함합니다).

ms를 통해 PDF를 생성하는 경우 목차는 제목 앞의 문서 시작 부분에 나타납니다. 문서 끝에 두고 싶다면 pdf-engine-opt: --no-toc-relocation 옵션을 사용합니다.
toc-depth

목차에 포함할 섹션 레벨 수를 지정합니다. 기본값은 3입니다.

번호 매기기

number-sections

출력에 렌더링된 섹션 제목에 번호를 매깁니다. 기본적으로 섹션은 번호가 매겨지지 않습니다. 클래스가 .unnumbered인 섹션은 number-sections가 지정되어도 번호가 매겨지지 않습니다.
shift-heading-level-by

제목 레벨을 양수 또는 음수 정수만큼 이동합니다. 예를 들어 shift-heading-level-by: -1이면 레벨 2 제목이 레벨 1 제목이 되고, 레벨 3 제목이 레벨 2 제목이 됩니다. 제목 레벨은 1보다 낮을 수 없으므로 레벨 1 아래로 이동되는 제목은 일반 문단이 됩니다. 예외적으로 -N만큼 이동할 때, 문서 시작의 레벨 N 제목은 메타데이터 제목을 대체합니다.

레이아웃

grid

Quarto HTML 페이지를 레이아웃하는 데 사용하는 그리드 시스템의 속성입니다.

코드

code-annotations

코드 주석을 표시할 때 사용할 스타일입니다. 이 값을 false로 설정하면 코드 주석을 숨깁니다.

실행

실행 옵션은 execute 키 아래에 지정해야 합니다. 예:

execute:
  echo: false
  warning: false
eval

코드 셀을 실행합니다(false이면 코드만 출력에 에코합니다).

  • true (기본값): 코드 셀을 실행
  • false: 코드 셀을 실행하지 않음
  • [...]: 표현식을 선택적으로 포함 또는 제외하기 위한 양수 또는 음수 숫자 목록 (표현식의 명시적 포함/제외는 knitr 엔진을 사용할 때만 가능합니다)
echo

렌더링된 출력에 셀 소스 코드를 포함합니다.

  • true (대부분의 형식에서 기본값): 소스 코드를 출력에 포함
  • false (beamer, revealjs, pptx 같은 프레젠테이션 형식의 기본값): 소스 코드를 출력에 포함하지 않음
  • fenced: 에코 외에도 셀 구분자를 출력의 일부로 포함
  • [...]: 선택적으로 포함하거나 제외할 줄 번호의 양수 또는 음수 목록 (줄의 명시적 포함/제외는 knitr 엔진을 사용할 때만 가능합니다)
output

코드 실행 결과를 출력에 포함합니다. 가능한 값:

  • true: 결과를 포함합니다.
  • false: 결과를 포함하지 않습니다.
  • asis: 출력물을 원시 마크다운으로 처리하고 감싸는 컨테이너를 사용하지 않습니다.
warning

렌더링된 출력에 경고를 포함합니다.
error

출력에 오류를 포함합니다(이는 코드 실행 오류가 문서 처리를 중단하지 않음을 의미합니다).
include

어떤 출력(코드 또는 결과)도 출력에 포함되지 않도록 하는 포괄 옵션입니다.
cache

계산 결과를 캐시합니다(R 문서에는 knitr cache를, Jupyter 문서에는 Jupyter Cache를 사용).

캐시 무효화는 청크 소스 코드 변경 (또는 정의한 다른 캐시 속성 변경)으로 트리거됩니다.

  • true: 결과를 캐시
  • false: 결과를 캐시하지 않음
  • refresh: 다른 이유로 무효화되지 않았더라도 캐시를 강제로 새로 고침
freeze

렌더링 시 이전 계산 출력의 재사용을 제어합니다.

  • true: 전역 프로젝트 렌더 시 이전에 생성된 계산 출력은 재계산하지 않음
  • false (기본값): 이전에 생성된 계산 출력을 재계산
  • auto: 소스 파일이 변경된 경우에만 이전 계산 출력을 재계산

그림

fig-width

Matplotlib 또는 R 그래픽으로 생성된 그림의 기본 너비입니다.

Jupyter 엔진에서는 이 옵션이 셀 수준에서 제공될 때 효과가 없으며 문서 또는 프로젝트 메타데이터로만 제공할 수 있습니다.
fig-height

Matplotlib 또는 R 그래픽으로 생성된 그림의 기본 높이입니다.

Jupyter 엔진에서는 이 옵션이 셀 수준에서 제공될 때 효과가 없으며 문서 또는 프로젝트 메타데이터로만 제공할 수 있습니다.
fig-format

Matplotlib 또는 R 그래픽으로 생성된 그림의 기본 형식(retina, png, jpeg, svg, pdf)
fig-dpi

Matplotlib 또는 R 그래픽으로 생성된 그림의 기본 DPI입니다.

Jupyter 엔진에서는 이 옵션이 셀 수준에서 제공될 때 효과가 없으며 문서 또는 프로젝트 메타데이터로만 제공할 수 있습니다.
fig-asp

그림의 종횡비, 즉 높이/너비 비율입니다. fig-asp를 지정하면 그림의 높이(fig-height 옵션)는 fig-width * fig-asp에서 계산됩니다.

fig-asp 옵션은 knitr 엔진에서만 사용할 수 있습니다.

표

df-print

Knitr 엔진 문서에서 표를 출력하는 데 사용하는 방법입니다:

  • default: 데이터 프레임의 기본 S3 메서드를 사용
  • kable: knitr::kable() 함수를 사용하는 마크다운 표
  • tibble: tibble 패키지를 사용하는 일반 텍스트 표
  • paged: 행과 열 오버플로에 페이징을 적용한 HTML 표

기본 출력 방식은 kable입니다.

참고문헌

bibliography

문서 참고문헌(BibTeX 또는 CSL). 단일 파일 또는 파일 목록일 수 있습니다.
csl

참고문헌 서식에 사용할 Citation Style Language 파일입니다.
citeproc

내장 인용 처리를 활성화합니다. 이 기능을 사용하려면 인용이 포함된 문서와 서지 데이터 소스가 필요합니다. 외부 참고문헌 파일 또는 문서의 YAML 메타데이터에 있는 references 목록을 사용할 수 있습니다. 선택적으로 csl 인용 스타일 파일도 포함할 수 있습니다.
citation-abbreviations

form="short"가 지정된 경우 형식화된 참고문헌에서 사용할 저널 약어를 포함하는 JSON 파일입니다. 파일 형식은 다음 예시로 설명할 수 있습니다:

{ "default": {
    "container-title": {
      "Lloyd's Law Reports": "Lloyd's Rep",
      "Estates Gazette": "EG",
      "Scots Law Times": "SLT"
    }
  }
}

상호 참조

crossref

상호 참조 레이블과 접두사 설정입니다. 자세한 내용은 Cross-Reference Options을 참조하세요.

인용

citation

문서 자체에 대한 인용 정보를 문서 front matter의 CSL YAML로 지정합니다.

지원되는 옵션에 대한 자세한 내용은 Citation Metadata를 참조하세요.

언어

lang

IETF 언어 태그( BCP 47 표준 준수)를 사용해 문서의 기본 언어를 식별합니다. 예: en, en-GB. Language subtag lookup 도구로 태그를 조회하거나 검증할 수 있습니다.

이 설정은 대부분의 형식에 영향을 주며, LaTeX(PDF 출력의 경우 babel 및 polyglossia) 또는 ConTeXt를 사용할 때 줄바꿈(하이픈화)을 제어합니다.
language

사용자 정의 언어 번역이 포함된 YAML 파일입니다.
dir

문서의 기본 문자 방향입니다(rtl 또는 ltr).

양방향 문서의 경우 dir 속성이 있는 pandoc 기본 span과 div를 사용해 일부 출력 형식에서 기본 방향을 재정의할 수 있습니다. 최종 렌더러(예: HTML 생성 시 브라우저)가 [Unicode Bidirectional Algorithm]을 지원한다면 항상 필요하지는 않을 수 있습니다.

LaTeX에서 양방향 문서를 사용할 때는 xelatex 엔진만 완전히 지원됩니다 (--pdf-engine=xelatex 사용).

포함

include-before-body

문서 본문의 시작 부분(예: HTML의 <body> 태그 뒤, 또는 LaTeX의 \begin{document} 명령 뒤)에 내용을 포함합니다.

키가 “file”인 객체 또는 문자열 값은 포함할 내용이 들어 있는 파일 이름을 의미합니다.

키가 “text”인 객체는 포함할 텍스트 콘텐츠를 의미합니다.
include-after-body

마크다운 콘텐츠 바로 뒤, 문서 본문의 끝부분에 내용을 포함합니다. HTML의 닫는 </body> 태그와 LaTeX의 \end{document} 명령 앞에 포함되지만, 이 옵션은 마크다운 콘텐츠의 끝을 의미합니다.

키가 “file”인 객체 또는 문자열 값은 포함할 내용이 들어 있는 파일 이름을 의미합니다.

키가 “text”인 객체는 포함할 텍스트 콘텐츠를 의미합니다.
include-in-header

헤더의 끝에 내용을 포함합니다. 예를 들어 HTML 문서에 특수한 CSS 또는 JavaScript를 포함하는 데 사용할 수 있습니다.

키가 “file”인 객체 또는 문자열 값은 포함할 내용이 들어 있는 파일 이름을 의미합니다.

키가 “text”인 객체는 포함할 텍스트 콘텐츠를 의미합니다.
metadata-files

제공된 YAML(또는 JSON) 파일에서 메타데이터를 읽습니다. 이 옵션은 모든 입력 형식에서 사용할 수 있지만, YAML 파일의 문자열 스칼라는 항상 마크다운으로 파싱됩니다. 일반적으로 입력은 YAML 메타데이터 블록에서와 동일하게 처리됩니다. 목록에서 나중에 지정된 파일의 값이 앞서 지정된 파일의 값보다 우선합니다. 문서 내부에서 지정하거나 -M을 사용해 지정한 메타데이터 값은 이 옵션으로 지정된 값을 덮어씁니다.

렌더링

from

읽을 형식입니다. 형식 이름 뒤에 +EXTENSION 또는 -EXTENSION을 붙여 확장을 개별적으로 활성화하거나 비활성화할 수 있습니다(예: markdown+emoji).
output-file

작성할 출력 파일
output-ext

생성된 출력 파일에 사용할 확장자
template

생성된 문서에 사용할 사용자 정의 템플릿 파일을 지정합니다.
template-partials

생성된 콘텐츠에 대해 템플릿에서 접근 가능한 partial로 지정된 파일을 포함합니다.
filters

입력이 파싱된 뒤 출력이 작성되기 전에 pandoc AST를 변환하는 필터로 사용할 실행 파일 또는 Lua 스크립트를 지정합니다.
shortcodes

숏코드 처리기를 구현하는 Lua 스크립트를 지정합니다.
keep-md

코드 실행으로 생성된 markdown 파일을 유지합니다.
keep-ipynb

코드 실행으로 생성된 노트북 파일을 유지합니다.
ipynb-filters

ipynb 파일을 markdown으로 렌더링하기 전에 전처리하는 필터입니다.
ipynb-shell-interactivity

어떤 노드를 대화형으로 실행할지(표현식 출력 표시) 지정합니다.
plotly-connected

true이면 “notebook_connected” plotly 렌더러를 사용하며, 이 렌더러는 CDN에서 종속성을 다운로드하므로 보려면 인터넷 연결이 필요합니다.
extract-media

원본 문서에 포함되거나 연결된 이미지 및 기타 미디어를 DIR 경로로 추출합니다. 필요한 경우 디렉터리를 생성하고, 문서의 이미지 참조가 추출된 파일을 가리키도록 조정합니다. 미디어는 다운로드되거나 파일 시스템에서 읽히거나, 필요에 따라 바이너리 컨테이너(예: docx)에서 추출됩니다. 원래의 파일 경로가 상대 경로이면서 …을 포함하지 않는 경우 해당 경로를 사용합니다. 그 외에는 콘텐츠의 SHA1 해시를 기반으로 파일 이름이 생성됩니다.
resource-path

이미지 및 기타 리소스를 검색할 경로 목록입니다.
default-image-extension

이미지 경로/URL에 확장자가 없을 때 사용할 기본 확장자를 지정합니다. 이렇게 하면 서로 다른 종류의 이미지가 필요한 형식에서 동일한 소스를 사용할 수 있습니다. 현재 이 옵션은 Markdown 및 LaTeX 리더에만 영향을 줍니다.
abbreviations

한 줄에 하나씩 약어를 적은 사용자 정의 약어 파일을 지정합니다. 이 목록은 Markdown 입력을 읽을 때 사용됩니다. 목록에서 발견된 문자열 뒤에는 줄바꿈 방지 공백이 추가되며, 마침표는 LaTeX와 같은 형식에서 문장 끝 공백을 생성하지 않습니다. 문자열에는 공백을 포함할 수 없습니다.
dpi

픽셀을 인치/센티미터로 변환하거나 그 반대로 변환할 때 사용할 기본 dpi(인치당 도트) 값을 지정합니다(엄밀히는 ppi: inch당 픽셀). 기본값은 96입니다. 이미지에 dpi 정보가 내부적으로 포함되어 있으면 이 옵션에 지정된 기본값 대신 인코딩된 값을 사용합니다.
html-table-processing

none이면 HTML 입력의 표를 처리하지 않습니다.

텍스트 출력

wrap

출력에서 텍스트 줄바꿈 방식(렌더링된 결과가 아니라 소스 코드)을 결정합니다.

  • auto (기본값): Pandoc이 columns에 지정된 열 너비(기본값 72)에 맞춰 줄바꿈을 시도합니다.
  • none: Pandoc이 줄바꿈을 전혀 수행하지 않습니다.
  • preserve: Pandoc이 소스 문서의 줄바꿈을 유지하려고 합니다. 소스에 비의미적 개행이 있으면 출력에도 비의미적 개행이 생깁니다.
columns

행 길이를 문자 수로 지정합니다. 이 값은 생성된 소스 코드의 텍스트 줄바꿈에 영향을 줍니다(wrap 참조). 또한 일반 텍스트 표의 열 너비 계산에도 영향을 줍니다.

typst의 경우 본문 텍스트의 열 수를 지정합니다.
tab-stop

탭당 공백 수를 지정합니다(기본값 4). 일반 텍스트 입력의 탭은 항상 공백으로 변환됩니다. 코드 내 탭도 변환되지만, preserve-tabs: false로 이를 비활성화할 수 있습니다.
preserve-tabs

탭을 공백으로 변환하지 않고 코드 내 탭을 유지합니다. (기본적으로 pandoc은 입력을 파싱하기 전에 탭을 공백으로 변환합니다.) 이는 리터럴 코드 스팬과 코드 블록의 탭에만 영향을 줍니다. 일반 텍스트의 탭은 항상 공백으로 처리됩니다.
eol

줄 끝 문자를 수동으로 지정합니다:

  • crlf: Windows 줄 끝 문자 사용
  • lf: macOS/Linux/UNIX 줄 끝 문자 사용
  • native (기본값): pandoc을 실행하는 OS에 적합한 줄 끝 문자 사용).