/
Table of Contents Macro

Table of Contents Macro

현재 Confluence 페이지의 제목을 검색하여 해당 제목을 기반으로 목차를 만든다.

이를 통해 독자는 콘텐츠 구조를 요약하고 제목에 대한 링크를 제공하여 긴 페이지를 중심으로 길을 찾을 수 있다.

실행중인 목차 매크로를보고 싶습니까? 통찰력있는 고객 인터뷰 페이지를 만드는데 사용된 방법을 확인하십시오.

 

Table of Contents Macro 사용

힌트 : 편집기 도구 모음에서 빠르게 액세스하려면 삽입 > 목차 선택

페이지에 Table of Contents Macro를 추가하려면 :

  1. Confluence 편집기에서 삽입 > 다른 매크로 선택
  2. 필요한 매크로 찾기 및 선택

자동 완성으로 매크로 항목 속도 향상 : 추천 매크로 목록을 보려면 {및 매크로 이름의 시작 부분을 입력.

기존 매크로 편집 : 매크로 자리 표시자를 클릭하고 편집 선택. 매크로 대화 상자 창이 열리고 매크로 매개변수를 편집할 수 있다.

 

매개변수

매크로 출력의 내용이나 형식을 제어하도록 설정할 수 있는 옵션. 

Confluence 스토리지 포맷 또는 wikimarkup에서 사용되는 매개변수 이름이 매크로 브라우저에서 사용된 레이블과 다른 경우, 아래에 대괄호 ( example) 로 표시된다 .

매개변수

기본값

설명

출력 유형(type)

list

  • list  - 일반적인 목록 유형 목차를 생성
  • flat  - 수평 메뉴 유형의 일련의 링크를 생성

섹션 번호 매기기 표시(outline) 

clear

머리글에 개요 번호 매기기를 적용하려면 확인란을 선택(예 : 1.1, 1.2, 1.3)

목록 스타일(style) 

disc

각 목록 항목의 글 머리표 스타일을 선택. 유효한 CSS 스타일을 사용할 수 있다. 예 :

  • none - 목록 스타일이 표시되지 않는다.
  • circle - 목록 스타일이 원이다.
  • disc- 목록 스타일이 채워진 원이다. 이것은 일반적인 글 머리 기호 목록이며 이 예제 목록에 사용된다.
  • square - 목록 스타일은 정사각형이다.
  • decimal - 목록의 번호가 매겨진다(1, 2, 3, 4, 5).
  • lower-alpha - 목록은 소문자이며 알파벳순으로 표시된다(a, b, c, d, e).
  • lower-roman - 목록 스타일은 낮은 로마 숫자(i, ii, iii, iv, v, vi)
  • upper-roman - 목록 스타일은 상위 로마 숫자(I, II, III, IV, V, VI)

제목 들여 쓰기(indent) 

 

CSS 수량에 따라 목록의 들여 쓰기를 설정. 10px 입력하면 제목 그룹이 10px만큼 들여 쓰기된다. 

예를 들어, 제목1은 들여 쓰기가 10px이고 제목2는 추가로 10px 들여 쓰기된다.

구분 기호(separator) 

brackets

이 매개 변수는 일반 목록에만 적용. 다음 값 중 하나를 입력 할 수 있다.

  • brackets - 각 항목은 대괄호로 묶는다 : ([])
  • braces - 각 항목은 중괄호로 묶는다 : {}.
  • parens - 각 항목은 괄호로 묶는다 : ().
  • pipe - 각 항목은 파이프로 구분된다.
  • anything - 각 항목은 입력한 값으로 구분된다. 구분 기호로 텍스트를 입력 할 수 있다(예 : " * **"). 
    사용자 정의 분리 문자를 사용하는 경우 문자가 정확하게 입력된대로 표시되며 추가 공백없이 문자를 더 구분할 수 있다.

최소 제목 수준
(minLevel)

1

가장 높은 제목 수준을 선택하여 목차 목록을 시작. 예를 들어, 2를 입력하면 레벨 2와 하위 제목이 포함되지만 레벨 1 제목은 포함되지 않는다.

최대 제목 수준
(maxLevel)

7

포함할 가장 낮은 제목 수준을 선택. 예를 들어, 2를 입력하면 레벨 1과 2가 포함되지만 레벨 3 제목은 포함되지 않는다.

제목 포함(include)

 

특정 기준에 따라 제목을 필터링. 와일드 카드 문자를 사용할 수 있다. 정규 표현식 문자열을 만드는 예제는 Sun의 Regex 설명서를 참조.

제목 제외(exclude) 

 

특정 기준에 따라 제외할 제목을 필터링. 예를 들어, (Date|Goals)를 입력하면 '날짜' 및 '목표' 제목이 목차 목록에서 제외된다. 

와일드 카드 사용을 포함하여 정규 표현식 문자열을 구성하는 예제는 Sun의 Regex 설명서를 참조.

인쇄 가능(printable)

checked

기본적으로 목차는 인쇄하도록 설정되어 있다. 확인란을 선택 취소하면 페이지를 인쇄할 때 목차가 표시되지 않는다.

CSS 클래스명(class) 

 

CSS 스타일 시트에 사용자 정의 TOC 스타일이 있는 경우, 이 매개변수를 사용하여 지정된 클래스 속성이있는 <div> 태그 안에 목차를 출력한다.

절대 URL (absoluteURL)

 

기본적으로 목차의 링크는 현재 페이지를 가리키는 상대 URL이다. 선택하면 목차의 링크가 전체 URL이 된다. 

이 설정은 다른 페이지에 목차가있는 페이지를 포함하고 링크가 사용자를 데려다 줄 위치를 제어하려는 경우에 유용하다.

 

예제들

아래 예제는이 목차를 기반으로 한다.

필터링된 목차

이 예제는 'Favorite'가 포함된 제목을 포함하도록 제목을 필터링하지만 'Things'로 끝나는 제목은 제외한다. 목록은 로마 숫자로 표시한다.

매개변수
목록 스타일upper-roman
제목 포함
Favourite.*
제목 제외
.*Things

결과 목차는 다음과 같다.

평면 목록

이 예제는 모든 표제를 필터링하여 대괄호 (기본 목록 스타일)로 묶인 'Unknowns'의 단순 목록을 렌더링한다.

매개 변수
출력 유형
flat
최대 표제 수준
2
제목 포함
Unknown.*

결과 목차는 다음과 같다.

위키 마크 업 예제

이 예제는 편집기 외부에 매크로를 추가하려는 경우 (예 : 스페이스의 세로 막대, 머리글 또는 바닥 글에 사용자 지정 내용으로) 유용

매크로 이름 : toc

매크로 본문 :  없음

이 예제는 목록 유형의 목차를 보여준다.

{toc:printable=true|style=square|maxLevel=2|indent=5px|minLevel=2|class=bigpink|exclude=[1//2]|type=list|outline=true|include=.*}

이 예제는 플랫 목차를 보여준다.

{toc:printable=true|maxLevel=2|minLevel=2|class=bigpink|exclude=[1//2]|type=flat|outline=true|separator=pipe|include=.*}
 

노트

  • 서식 파일에서 목차 매크로를 사용하면 서식 파일 자체를 미리 볼 때 오류가 표시된다. 그러나 목차 매크로는 사람들이 템플릿에서 생성한 페이지에서 작동한다. 
    목차는 페이지를 저장한 후에 나타난다. 서식 파일이 페이지로 정의되어 있지 않고 목차 매크로가 페이지에만 작동하기 때문일 수 있다.
  • 목차 매크로는 페이지 또는 블로그 게시물 내용만 표시한다. 예를 들어 주석에 제목의 목차를 추가하는데 사용할 수는 없다. 
  • 목차 매크로(CONF-10619) 의 미해결 문제로 인해 매크로 브라우저의 새로 고침 기능은 매개변수 수정을 렌더링하지 않는다. 
    현재 목차 매크로에 대한 매개변수값 수정 렌더링은 페이지를 저장한 후에만 발생한다.
  • 목차 매크로에 HTML 제목 마크 업 사용 
    목차 매크로는 HTML 제목 마크 업을 독자적으로 처리 할 수 없다.

    따라서, HTML 및 HTML Include 매크로를 사용하여 Confluence 페이지에서 HTML 제목 마크 업을 렌더링하면 Table of Contents 매크로는 이러한 제목에서 내용 목록을 생성하지 않는다.

    <h2><a name="pagename-headingname"></a>Heading Name</h2>

    앵커 이름의 구문은 하이픈으로 구분된 페이지 이름과 제목 이름이다. 모든 공백을 제거하고 모든 텍스트를 소문자로 변환한다. 

    모든 문장 부호를 URL로 인코딩된 해당 항목으로 변환한다. 그러나 HTML 앵커를 페이지의 각 HTML 제목에 삽입하면(목차에 따라 다름) 목차 매크로는 이러한 제목을 콘텐츠 목록에 통합한다.