Qt 5.11 - Creating QDoc Configuration Files

QDoc विन्यास फाइल बनाना




qt

QDoc विन्यास फाइल बनाना

प्रलेखन उत्पन्न करने के लिए, QDoc कॉन्फ़िगरेशन फ़ाइलों का उपयोग करता है, कॉन्फ़िगरेशन सेटिंग्स को संग्रहीत करने के लिए qdocconf एक्सटेंशन के साथ।

QDoc कॉन्फ़िगरेशन फ़ाइल आलेख विभिन्न कॉन्फ़िगरेशन चर को अधिक विवरण में शामिल करता है।

QDoc कॉन्फ़िगरेशन फ़ाइलें

QDoc की कॉन्फ़िगरेशन सेटिंग्स एक एकल qdocconf फ़ाइल में रह सकती हैं, लेकिन अन्य qdocconf फ़ाइलों में भी हो सकती हैं। include(<filepath>) कमांड कॉन्फ़िगरेशन फ़ाइलों को अन्य कॉन्फ़िगरेशन फ़ाइलों को शामिल करने की अनुमति देता है।

QDoc में DITA XML प्रारूप में दो आउटपुट, HTML प्रलेखन और प्रलेखन हैं। दो आउटपुट के बीच मुख्य अंतर यह है कि HTML डॉक्यूमेंट को कॉन्फ़िगरेशन की फाइलों में अपनी HTML स्टाइलिंग जानकारी की आवश्यकता होती है। DITA XML डॉक्यूमेंटेशन नहीं है और एक अलग प्रक्रिया बाद में DITA में डॉक्यूमेंटेशन को स्टाइल कर सकती है। इसलिए DITA XML विभिन्न शैलियों को एक ही जानकारी पर लागू करने की अनुमति देने में अधिक लचीला है।

Qdoc को चलाने के लिए, प्रोजेक्ट कॉन्फ़िगरेशन फ़ाइल को एक तर्क के रूप में आपूर्ति की जाती है।

qdoc project.qdocconf

प्रोजेक्ट कॉन्फ़िगरेशन में ऐसी जानकारी है जो प्रलेखन बनाने के लिए qdoc का उपयोग करती है।

परियोजना की जानकारी

QDoc प्रलेखन उत्पन्न करने के लिए project जानकारी का उपयोग करता है।

project = QDoc Project
description = Sample QDoc project

इनपुट और आउटपुट निर्देशिकाएँ

स्रोत निर्देशिकाओं के लिए पथ निर्दिष्ट करने से QDoc को स्रोत खोजने और प्रलेखन उत्पन्न करने की अनुमति मिलती है।

sourcedirs = <path to source code>
exampledirs = <path to examples directory>
imagedirs = <path to image directory>

sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"

QDoc हेडर और स्रोतों को fileextensions चर में निर्दिष्ट लोगों से प्रोसेस करेगा।

इसी तरह, QDoc को आउटपुट डायरेक्टरी के लिए रास्ता चाहिए। outputformats चर प्रलेखन के प्रकार को निर्धारित करता है। ये चर दस्तावेज़ निर्माण को संशोधित करने के लिए अलग-अलग कॉन्फ़िगरेशन फ़ाइलों में होने चाहिए।

outputdir  =    $SAMPLE_PROJECT/doc/html
outputformats = HTML

QDoc qdocconf फ़ाइल के साथ-साथ पर्यावरण चर के सापेक्ष पथों को हल कर सकता है।

नोट: प्रत्येक QDoc रन के दौरान, आउटपुट निर्देशिका हटा दी जाती है।

अतिरिक्त फाइलें

QDoc आउटपुट डायरेक्टरी में निर्दिष्ट डायरेक्टरी में आउटपुट जनरेट करेगा। अतिरिक्त फ़ाइलों को निर्दिष्ट करना भी संभव है जो QDoc को निर्यात करना चाहिए।

HTML.extraimages = extraImage.png \
                   extraImage2.png

extraImage.png और extraImage2.png फाइलें HTML आउटपुट डायरेक्टरी में कॉपी की जाएंगी।

Qt मदद फ्रेमवर्क कॉन्फ़िगरेशन

QDoc, qhp फ़ाइल में एक Qt हेल्प प्रोजेक्ट फ़ाइल भी निर्यात करेगा। Qhp फ़ाइल का उपयोग qhelpgenerator द्वारा qch फ़ाइल में प्रलेखन को पैकेज करने के लिए किया जाता है। Qt क्रिएटर और Qt असिस्टेंट डॉक्यूमेंट को प्रदर्शित करने के लिए qch फाइल को पढ़ता है।

मदद प्रोजेक्ट प्रोजेक्ट फ़ाइल बनाना कॉन्फ़िगरेशन विकल्पों को शामिल करता है।

HTML कॉन्फ़िगरेशन

QDoc में एक HTML जनरेटर है जो विभिन्न कॉन्फ़िगरेशन सेटिंग्स का उपयोग करके HTML फ़ाइलों में प्रलेखन का एक सेट निर्यात करेगा। QDoc outputdir चर द्वारा निर्दिष्ट निर्देशिका में उत्पन्न प्रलेखन को outputdir

outputformats = HTML
outputdir =  <path to output directory>

QDoc को यह जानने की आवश्यकता है कि HTML बनाने के लिए शैली और टेम्पलेट कहाँ स्थित हैं। आमतौर पर, टेम्प्लेट डायरेक्टरी में scripts , images और एक style डायरेक्टरी होती है, जिसमें स्क्रिप्ट और सीएसएस फाइलें होती हैं।

मुख्य विन्यास चर हैं:

HTML.postheader
HTML.postpostheader
HTML.postheader
HTML.footer

HTML.headerstyles
HTML.stylesheets = template/style/style.css \
                   template/style/style1.css

HTML.scripts = template/scripts/script.js

HTML.headerstyles वेरिएबल HTML फ़ाइल में शैली की जानकारी सम्मिलित करता है और HTML.stylesheets निर्दिष्ट करता है कि QDoc को कौन सी फ़ाइलों को आउटपुट निर्देशिका में कॉपी करना चाहिए। साथ ही, QDoc प्रत्येक HTML फ़ाइल में पोस्टहीडर, footer और संबंधित चर में स्ट्रिंग एम्बेड करेगा।

प्रारूप-विशिष्ट कॉन्फ़िगरेशन चर चर प्रत्येक चर के उपयोग को रेखांकित करता है।

Qt सूचकांक संदर्भ

प्रलेखन परियोजनाएं Qt एपीआई और अन्य लेखों को qt.index फ़ाइल के लिए पथ निर्दिष्ट करके लिंक कर सकती हैं। जब qdoc Qt रेफरेंस डॉक्यूमेंटेशन जेनरेट करता है, तो यह एक इंडेक्स फाइल भी जनरेट करेगा, जिसमें लेखों के URL होंगे। अन्य प्रोजेक्ट्स इंडेक्स फ़ाइल में लिंक का उपयोग कर सकते हैं ताकि वे अन्य लेखों और क्यूटी के भीतर एपीआई प्रलेखन से लिंक कर सकें।

indexes = $QT_INSTALL_DOCS/html/qt.index $OTHER_PROJECT/html/qt.index

कई परियोजनाओं से कई सूचकांक फ़ाइलों को निर्दिष्ट करना संभव है।

मैक्रोज़ और अन्य विन्यास

HTML वर्णों को प्रतिस्थापित करने के लिए मैक्रोज़ मौजूद हैं और विशिष्ट HTML-मान्य वर्ण बनाने के लिए सहायक हैं।

macro.pi.HTML         = "&Pi;"

स्निपेट कोड \\pi किसी भी उदाहरण को &Pi साथ बदल देगा; HTML फ़ाइल में, जो ब्राउज़रों में देखे जाने पर ग्रीक file प्रतीक के रूप में दिखाई देगा।

QML परिवर्धन

QDoc QDoc टिप्पणियों के लिए QML फ़ाइलों को पार्स करने में सक्षम है। QDoc QML एक्सटेंशन, .qml साथ फ़ाइलों को पार्स करेगा, यदि एक्सटेंशन प्रकार output चर में शामिल है।

इसके अलावा, जेनरेट की गई HTML फाइलों में QML मॉड्यूल नाम के बाद एक उपसर्ग और एक प्रत्यय हो सकता है, जो QDoc कॉन्फ़िगरेशन फाइल में निर्दिष्ट है।

outputprefixes = QML
outputprefixes.QML = uicomponents-
outputsuffixes = QML
outputsuffixes.QML = -tp

इन्हें भी देखें : outputprefixes , outputsuffixes