도움말 프로젝트 파일 만들기
개요
Qt Assistant 는 파일 인벤토리를 생성하기 위해 QDoc이 필요한 Qt 문서 관리 시스템을 사용합니다.
QDoc은 구성 변수를 사용하여 생성하는 각 문서 세트에서 사용할 페이지를 지정할 수 있습니다. 이러한 변수는 qhp 변수의 하위 변수로 지정되며, 각 세트는 고유 식별자를 하위 변수로 사용하여 선언됩니다.
예를 들어 Qt Quick 문서 집합의 구성 파일은 qhp.QtQuick 접두사가 붙은 하위 변수로 집합에 대한 정보를 지정합니다:
qhp.projects = QtQuick qhp.QtQuick.file = qtquick.qhp qhp.QtQuick.namespace = org.qt-project.qtquick.$QT_VERSION_TAG qhp.QtQuick.virtualFolder = qtquick qhp.QtQuick.indexTitle = Qt Quick qhp.QtQuick.indexRoot = qhp.QtQuick.subprojects = qmltypes classes examples qhp.QtQuick.subprojects.qmltypes.title = QML Types qhp.QtQuick.subprojects.qmltypes.indexTitle = Qt Quick QML Types qhp.QtQuick.subprojects.qmltypes.selectors = qmlclass qhp.QtQuick.subprojects.qmltypes.sortPages = true qhp.QtQuick.subprojects.classes.title = Classes qhp.QtQuick.subprojects.classes.title = C++ Classes qhp.QtQuick.subprojects.classes.indexTitle = Qt Quick C++ Classes qhp.QtQuick.subprojects.classes.selectors = class fake:headerfile qhp.QtQuick.subprojects.classes.sortPages = true qhp.QtQuick.subprojects.examples.title = Examples qhp.QtQuick.subprojects.examples.indexTitle = Qt Quick Examples and Tutorials qhp.QtQuick.subprojects.examples.selectors = fake:example
문서 집합에는 하나 이상의 하위 프로젝트가 포함될 수 있으며, 이 하위 프로젝트는 title 로 지정된 이름으로 목차에 추가됩니다. indexTitle 에 의해 참조되는 문서의 페이지는 하위 프로젝트의 색인 페이지 역할을 합니다. 하위 프로젝트 아래에 나열할 페이지 유형은 selectors 에 의해 지정됩니다. sortPages 이 true 으로 설정된 경우 항목은 알파벳순으로 정렬됩니다.
선택기 사용
selectors 속성은 하위 프로젝트의 목차 항목 아래에 나열할 페이지 유형을 지정합니다. 여러 선택기를 공백으로 구분하여 나열할 수 있습니다.
| 선택기 | 설명 |
|---|---|
namespace | 네임스페이스 |
class | 클래스 |
qmltype | QML 유형 |
qmlclass | qmltype 의 별칭 . |
module[:name] | C++ 모듈 또는 지정된 이름을 가진 모듈의 멤버. |
qmlmodule[:name] | QML 모듈 또는 지정된 이름을 가진 모듈의 멤버. |
doc[:subtype] | 지정된 subtype. 여러 하위 유형을 쉼표로 구분된 목록으로 나열할 수 있습니다. |
fake | doc 의 별칭. |
group[:groupname] | 그룹 그룹명 명령을 사용하여 추가한 지정된 그룹의 구성원에 대한 문서 페이지. 여러 그룹 이름을 쉼표로 구분된 목록으로 나열할 수 있습니다. (QDoc 5.6에 도입됨). |
doc 선택기에 사용 가능한 하위 유형:
| 하위 유형 | 설명 |
|---|---|
example | 예제 |
headerfile | 헤더 파일 |
page | 페이지 명령으로 정의된 문서 페이지입니다. |
예를 들어 다음 구성은 예제 페이지와 \ingroup tutorials 명령어가 포함된 페이지를 선택합니다:
qhp.QtQuickControls.subprojects = examples qhp.QtQuickControls.subprojects.examples.title = Examples and Tutorials qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples qhp.QtQuickControls.subprojects.examples.selectors = doc:example group:tutorials qhp.QtQuickControls.subprojects.examples.sortPages = true
목차 추가하기
매뉴얼의 목차를 만들려면 type 속성을 가진 하위 프로젝트를 만들고 manual 으로 설정합니다. indexTitle 속성에서 참조하는 문서의 페이지에는 전체 매뉴얼의 목차 역할을 하는 링크 목록이 포함되어 있어야 합니다. QDoc은 이 목록의 정보를 가져와 하위 프로젝트에 대한 목차를 만듭니다.
예를 들어 Qt Creator 의 구성 파일은 단일 매뉴얼의 모든 문서를 포함하여 해당 문서에 대해 하나의 하위 프로젝트만 정의합니다:
qhp.QtCreator.subprojects = manual qhp.QtCreator.subprojects.manual.title = Qt Creator Manual qhp.QtCreator.subprojects.manual.indexTitle = Qt Creator Manual qhp.QtCreator.subprojects.manual.type = manual
이 예에서 "Qt Creator 매뉴얼"이라는 제목의 페이지에는 Qt Assistant 의 목차 탭에 중복된 문서 페이지 링크가 중첩된 목록이 포함되어 있습니다.
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
