Qt 5.11 - Creating Help Project Files

हेल्प प्रोजेक्ट फाइल्स बनाना




qt

हेल्प प्रोजेक्ट फाइल्स बनाना

अवलोकन

Qt असिस्टेंट Qt डॉक्यूमेंट को मैनेज करने के लिए एक सिस्टम का उपयोग करता है जिसके लिए QDoc को एक फॉर्मेट में फाइलों के इन्वेंट्री जेनरेट करने की आवश्यकता होती है जो पुराने स्टाइल DCF फॉर्मेट के समान है, लेकिन अतिरिक्त फीचर्स के साथ।

QDoc कॉन्फ़िगरेशन वेरिएबल्स को यह निर्दिष्ट करने के लिए उपयोग करने की अनुमति देता है कि कौन से पृष्ठों का उपयोग प्रत्येक दस्तावेज़ में सेट किया जाए जो इसे उत्पन्न करता है। ये एक विशिष्ट पहचानकर्ता के रूप में घोषित किए गए प्रत्येक सेट के साथ qhp चर के उप- qhp रूप में निर्दिष्ट किए जाते हैं।

उदाहरण के लिए, Qt क्विक डॉक्यूमेंटेशन सेट के लिए कॉन्फ़िगरेशन फ़ाइल qhp.QtQuick उपसर्ग के साथ उप- 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.filterAttributes    = qtquick $QT_VERSION qtrefdoc
qhp.QtQuick.customFilters.Qt.name = QtQuick $QT_VERSION
qhp.QtQuick.customFilters.Qt.filterAttributes = qtquick $QT_VERSION

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 सेट किया जाता है, तो प्रविष्टियाँ वर्णानुक्रम में क्रमबद्ध होती true

चयनकर्ताओं का उपयोग करना

selectors संपत्ति निर्दिष्ट करती है कि किस पृष्ठ प्रकार को उपप्रोजेक्ट के लिए सामग्री प्रविष्टि की तालिका के तहत सूचीबद्ध किया गया है। एकाधिक चयनकर्ताओं को व्हाट्सएप द्वारा अलग-अलग सूचीबद्ध किया जा सकता है।

चयनकर्ता विवरण
namespace नेमस्पेस
class कक्षाएं
qmltype क्यूएमएल प्रकार
qmlclass qmltype लिए उपनाम।
module[:name] सी ++ मॉड्यूल या एक निर्दिष्ट नाम के साथ मॉड्यूल के सदस्य।
qmlmodule[:name] QML मॉड्यूल या एक निर्दिष्ट नाम के साथ मॉड्यूल के सदस्य।
doc[:subtype] एक निर्दिष्ट subtype साथ प्रलेखन पृष्ठ। एकाधिक उपप्रकारों को अल्पविराम से अलग की गई सूची के रूप में सूचीबद्ध किया जा सकता है।
fake doc लिए उपनाम।
group[:groupname] एक निर्दिष्ट समूह के सदस्यों के लिए प्रलेखन पृष्ठ, जैसा कि \ingroup groupname कमांड का उपयोग करके जोड़ा गया है। एकाधिक समूह नामों को अल्पविराम से अलग की गई सूची के रूप में सूचीबद्ध किया जा सकता है। (QDoc 5.6 में पेश किया गया)।

doc चयनकर्ता के लिए उपलब्ध उपप्रकार:

उपप्रकार विवरण
example उदाहरण
headerfile हैडर फाइलें
page दस्तावेज़ पृष्ठ \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 इस सूची में जानकारी लेगा और सबप्रोजेक्ट के लिए सामग्री की एक तालिका बनाएगा।

उदाहरण के लिए, क्यूटी क्रिएटर के लिए कॉन्फ़िगरेशन फ़ाइल अपने प्रलेखन के लिए केवल एक उपप्रोजेक्ट को परिभाषित करती है, जिसमें एक ही मैनुअल में सभी दस्तावेज शामिल हैं:

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

इस उदाहरण में, "क्यूटी क्रिएटर मैनुअल" शीर्षक वाले पृष्ठ में प्रलेखन में पृष्ठों के लिंक की एक नेस्टेड सूची है जो क्यूटी सहायक की सामग्री टैब में डुप्लिकेट है।