형식별 구성 변수

형식별 구성 변수는 생성된 문서의 스타일을 정의하거나, 문서의 바닥글 또는 머리글 내용을 정의합니다.

일부 구성 값은 HTML 출력 형식에만 적용되며, 해당 값에는 원시 HTML이 포함됩니다.

HTML.footer

HTML.footer 변수는 생성된 HTML 문서의 푸터 내용을 정의합니다.

푸터는 생성된 문서 페이지의 하단에 표시됩니다.

이 변수의 값은 따옴표로 묶인 원시 HTML 코드로 지정됩니다. 값이 여러 줄에 걸쳐 있는 경우, 각 줄을 따옴표로 묶어야 한다는 점에 유의하십시오.

HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
              ...
              "</tr></table></div></address>"

<FORMAT>.nosubdirs

true 일 때 단일 디렉터리 출력 모드를 활성화하는 부울 값입니다. 이 경우 생성된 모든 파일은 문서 프로젝트 이름을 기반으로 한 하위 디렉터리가 아닌 FORMAT.outputsubdir 디렉터리에 저장됩니다.

<FORMAT>.outputsubdir

outputdir 아래에 문서화가 생성될 하위 디렉터리를 정의합니다.

HTML.nosubdirs = true
HTML.outputsubdir = html

이 설정에 따라 출력 파일은 <outputdir>/html 에 저장됩니다.

HTML.postheader

HTML.postheader 변수는 생성된 HTML 문서의 포스트헤더 내용을 정의합니다.

이 헤더는 생성된 문서 페이지의 맨 위, <body> 요소의 시작 태그 바로 뒤에 표시됩니다.

이 변수의 값은 따옴표로 묶인 원시 HTML로 지정됩니다. 값이 여러 줄에 걸쳐 있는 경우, 각 줄을 따옴표로 묶어야 한다는 점에 유의하십시오.

HTML.postheader 의 내용을 렌더링한 후, QDoc은 페이지의 브레드크럼 내비게이션을 <li> 요소 집합으로 출력합니다. 따라서 postheader는 <ul> 와 같이 <li> 의 유효한 상위 요소로 끝나야 합니다. HTML.postheader 의 기본값은

HTML.postheader = "<ul class=\"breadcrumb\">\n"

참조 HTML.postpostheader.

HTML.postpostheader

HTML.postpostheader 변수는 HTML 문서의 포스트 헤더와 그 안에 포함된 탐색용 브레드크럼 항목 목록을 닫는 내용을 정의합니다. 이 변수의 값에는 HTML.postheader에서 열린 목록 요소에 해당하는 닫는 태그를 포함해야 합니다.

HTML.postpostheader 의 기본값은

HTML.postpostheader = "</ul>\n"

<FORMAT>.quotinginformation

부울 값으로, true 가 설정된 경우 따옴표로 묶인 콘텐츠에 대한 참조를 생성합니다(예: \quotefromfile 및 \snippet 명령어)를 생성합니다.

현재 WebXML 출력 형식에 사용됩니다.

WebXML.quotinginformation = true

HTML.style

HTML.style 변수는 생성된 HTML 문서의 스타일을 정의합니다.

이 변수의 값은 따옴표로 묶인 원시 HTML로 지정됩니다. 값이 여러 줄에 걸쳐 있는 경우, 각 줄을 따옴표로 묶어야 한다는 점에 유의하십시오.

HTML.style = "h3.fn,span.fn" \
             "{ margin-left: 1cm; text-indent: -1cm; }\n" \
             "a:link { color: #004faf; text-decoration: none }\n" \
             "a:visited" \
             "{ color: #672967; text-decoration: none }\n" \
             "td.postheader { font-family: sans-serif }\n" \
             "tr.address { font-family: sans-serif }\n" \
             "body { background: #ffffff; color: black; }"

HTML.stylesheets

HTML.stylesheets 변수는 생성된 HTML 문서에 사용할 스타일시트 목록을 정의합니다.

문서에 별도의 스타일시트를 사용하면 콘텐츠가 생성된 후 스타일을 쉽게 사용자 정의하고 실험해 볼 수 있습니다. 일반적으로는 어떤 문서 세트에 대해서도 하나의 스타일시트만 정의하면 충분합니다. 예를 들어:

HTML.stylesheets = path/to/classic.css

QDoc은 qtgui.qdocconf 파일이 있는 디렉터리에서 스타일시트를 찾으며, 지정된 스타일시트를 HTML 페이지와 함께 출력 디렉터리로 복사합니다.

<FORMAT>.tocdepth

<FORMAT>.tocdepth 변수는 목차에 표시될 문서 섹션의 수를 정의합니다. tocdepth를 0 로 설정하면 목차가 비활성화되며, 값을 지정하지 않으면 모든 문서 섹션이 표시됩니다.

현재는 HTML 형식에서만 적용됩니다:

HTML.tocdepth = 3