사용자 정의 플로트 상호 참조 유형

개요

상호 참조가 가능한 그림, 표, 코드 목록은 모두 플로트 상호 참조 유형입니다. 플로트는 정의된 위치와 다른 위치에 표시될 수 있으며, 대부분 캡션을 갖습니다.

문서나 프로젝트 메타데이터의 crossref 옵션 아래에서 custom 키를 사용하면 플로트 상호 참조 유형을 새로 만들 수 있습니다. 사용자 정의 유형에는 최소한 다음 값이 필요합니다.

  • kind: 현재는 float만 지원합니다.
  • key: 참조 식별자에서 사용하는 축약어입니다(예: @fig-1의 fig).
  • reference-prefix: 출력물 참조에 쓰이는 접두사입니다(예: Figure 1).

다음 YAML은 비디오용 새 상호 참조 유형을 정의하는 예시입니다.

crossref:
  custom:
    - kind: float
      reference-prefix: Video
      key: vid

그다음 문서에서 상호 참조 Div 구문과 함께 이 유형을 사용할 수 있습니다.

::: {#vid-cern}

{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}

"CERN: The Journey of Discovery"

:::

In @vid-cern...

렌더링하면 다음과 같습니다.

Video 1: “CERN: The Journey of Discovery”

In Video 1…

추가 옵션을 사용하면 상호 참조의 모양을 더 세밀하게 제어할 수 있습니다.

  • caption-prefix: 플로트 아래에 표시되는 캡션 제목(“Figure 1: …”)을 구성하는 데 사용하는 접두사입니다. 생략하면 reference-prefix 값을 사용합니다.
  • caption-location: 캡션 위치입니다. top, bottom(기본값), margin 중에서 고를 수 있습니다.
  • space-before-numbering: 접두사와 번호 사이에 공백을 둘지 여부입니다. false로 설정하면 공백이 생략됩니다(예: “Figure1”).

custom 키에서 사용할 수 있는 전체 옵션은 Cross-Reference Options 레퍼런스 페이지에서 확인할 수 있습니다.

PDF 출력

출력 형식이 pdf라면 latex-env도 지정해야 합니다. 이 값은 요소를 감싸는 TeX 플로트 환경 이름으로 사용됩니다. 예를 들어 사용자 정의 비디오 상호 참조 유형을 사용하려면 latex-env: video를 추가합니다.

format: pdf
crossref:
  custom:
    - kind: float
      reference-prefix: Video
      key: vid
      latex-env: video

또한 \listof LaTeX 명령을 문서에 포함해 사용자 정의 상호 참조 목록을 만들 수 있습니다. 명령 이름은 listof + latex-env 값 + s입니다. 위 예시에서 latex-env는 video이므로 명령은 \listofvideos{}가 됩니다.

---
format: pdf
crossref:
  custom:
    - kind: float
      reference-prefix: Video
      key: vid
      latex-env: video
---

\listofvideos{}

기본적으로 목록 제목(예: “List of Videos”)은 reference-prefix 값으로 구성됩니다. latex-list-of-description 값을 지정하면 원하는 제목을 사용할 수 있습니다.

예시: 보충 그림

사용자 정의 상호 참조 유형의 또 다른 예로 보충 그림을 생각해 봅시다. 다음 요구 사항이 있다고 가정합니다.

  • 보충 그림에는 일반 그림과 다른 번호가 매겨진다.
  • 보충 그림 레이블은 “Figure S1”, “Figure S2”처럼 표시된다.
  • 보충 그림은 “List of Supplementary Figures” 목록에 따로 나열된다.

다음과 같이 보충 그림 유형을 정의할 수 있습니다.

crossref:
  custom:
    - kind: float
      key: suppfig
      latex-env: suppfig
      reference-prefix: Figure S
      space-before-numbering: false
      latex-list-of-description: Supplementary Figure

space-before-numbering: false 옵션 덕분에 접두사와 번호 사이에 공백이 없어져 “Figure S1”, “Figure S2”처럼 표시됩니다.