Qt 5.11 - Format-specific Configuration Variables

प्रारूप-विशिष्ट कॉन्फ़िगरेशन चर




qt

प्रारूप-विशिष्ट कॉन्फ़िगरेशन चर

प्रारूप-विशिष्ट कॉन्फ़िगरेशन चर जनरेट किए गए दस्तावेज़ की शैली को परिभाषित करते हैं, या दस्तावेज़ के पाद लेख या पोस्टहेडर की सामग्री को परिभाषित करते हैं।

कॉन्फ़िगरेशन मानों में से कुछ केवल HTML आउटपुट स्वरूप के लिए प्रासंगिक हैं और उनके मूल्यों में कच्चा HTML शामिल है।

HTML.footer चर उत्पन्न HTML प्रलेखन के पाद लेख की सामग्री को परिभाषित करता है।

पाद लेख उत्पन्न प्रलेखन पृष्ठ के नीचे प्रदान किया गया है।

चर के मान को उद्धरण चिह्नों द्वारा संलग्न कच्चे HTML कोड के रूप में दिया गया है। ध्यान दें कि यदि मान कई पंक्तियों तक फैला है, तो प्रत्येक पंक्ति को उद्धरण चिह्नों से घिरा होना चाहिए।

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

<स्वरूप> .nosubdirs

एक बूलियन मूल्य, जो true , एकल-निर्देशिका आउटपुट मोड को सक्षम करता है; सभी उत्पन्न फाइलें प्रलेखन परियोजना के नाम के आधार पर एक उपनिर्देशिका के बजाय FORMAT.outputsubdir निर्देशिका में जाती हैं।

<स्वरूप> .outputsubdir

outputdir तहत उपनिर्देशिका को परिभाषित करता है जहां प्रलेखन उत्पन्न होता है।

HTML.nosubdirs = true
HTML.outputsubdir = html

ऊपर के साथ, आउटपुट <outputdir>/html

HTML.postheader

HTML.postheader वैरिएबल जनरेट किए गए HTML डॉक्यूमेंट की HTML.postheader की सामग्री को परिभाषित करता है।

हेडर उत्पन्न प्रलेखन पृष्ठ के शीर्ष पर प्रदान किया गया है।

चर के मान को उद्धरण चिह्नों द्वारा संलग्न कच्चे HTML के रूप में दिया गया है। ध्यान दें कि यदि मान कई पंक्तियों तक फैला है, तो प्रत्येक पंक्ति को उद्धरण चिह्नों से घिरा होना चाहिए।

HTML.postheader = "<table border=\"0\"..." \
                  ...
                  "<img src=\"images/qt-logo.png\" \
                  "align=\"right\" width=\"203\" height=\"32\""\
                 "border=\"0\" />" \
                  "</td></tr>" \
                  "</table>"

qtgui.qdocconf में पूर्ण चर प्रविष्टि Qt GUI दस्तावेज़ीकरण के मानक शीर्षलेख प्रदान करता है।

<स्वरूप> .quotinginformation

एक बूलियन मूल्य, जो true , सीधे सामग्री को शामिल करने के बजाय उद्धृत सामग्री (उदाहरण के लिए, \quotefromfile और \snippet कमांड) को \quotefromfile करता है।

वर्तमान में 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 पृष्ठों के साथ आउटपुट निर्देशिका में निर्दिष्ट उन लोगों को कॉपी करेगा।

<स्वरूप> .tocdepth

<FORMAT>.tocdepth वैरिएबल परिभाषित करता है कि सामग्री की तालिका में कितने दस्तावेज़ अनुभाग मुद्रित हैं। सभी अद्यतन अनुभागों को अपरिभाषित प्रिंट करते समय, 0 सेट करना tocdepth सामग्री की तालिका को अक्षम करता है।

वर्तमान में केवल HTML प्रारूप के लिए एक प्रभाव है:

HTML.tocdepth = 3