Qt 5.11 - Text Markup

पाठ मार्कअप




qt

पाठ मार्कअप

टेक्स्ट फॉर्मेटिंग कमांड यह बताता है कि टेक्स्ट को कैसे रेंडर किया जाना है।

\ a (पैरामीटर मार्कर)

\ कमांड एक आदेश QDoc बताता है कि अगला शब्द एक औपचारिक पैरामीटर नाम है।

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

/ *!
   Constructs a line edit containing the text
   \a contents. The \a parent parameter is sent
   to the QWidget constructor.
* /

QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)
{
   ...
}

QDoc इसे प्रस्तुत करता है:

QLineEdit::QLineEdit (const QWidget और सामग्री, QWidget * जनक)

पाठ सामग्री युक्त एक पंक्ति संपादित करता है। मूल पैरामीटर QWidget कंस्ट्रक्टर को भेजा जाता है।

औपचारिक पैरामीटर नाम घुंघराले कोष्ठक के बीच संलग्न किया जा सकता है, लेकिन इसकी आवश्यकता नहीं है।

\ c (कोड फ़ॉन्ट)

कोड फ़ॉन्ट में चर नामों, उपयोगकर्ता-परिभाषित वर्ग नामों और C ++ कीवर्ड (उदाहरण के लिए, int और for ) के प्रतिपादन के लिए \ c कमांड का उपयोग किया जाता है।

आदेश एक मोनोस्पेस फ़ॉन्ट का उपयोग करके अपने तर्क प्रस्तुत करता है। उदाहरण के लिए:

/ *!
  The \c AnalogClock class provides a clock widget with hour
  and minute hands that is automatically updated every
  few seconds.
* /

QDoc इसे प्रस्तुत करता है:

AnalogClock क्लास घंटे और मिनट के हाथों के साथ एक घड़ी विजेट प्रदान करता है, जो हर कुछ सेकंड में स्वचालित रूप से अपडेट किया जाता है।

यदि कोड फ़ॉन्ट में दिए जाने वाले पाठ में रिक्त स्थान हैं, तो पूरे पाठ को घुंघराले कोष्ठक में संलग्न करें।

\c {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}

QDoc इसे प्रस्तुत करता है:

QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)

\ C कमांड अपने तर्क के भीतर विशेष वर्ण को स्वीकार करता है, जो इसे एक सामान्य चरित्र के रूप में प्रस्तुत करता है। इसलिए यदि आप नेस्टेड कमांड का उपयोग करना चाहते हैं, तो आपको इसके बजाय टेलेटाइप (\ tt) कमांड का उपयोग करना होगा।

\ Tt और \code भी देखें।

\ div

\ Div और \ enddiv कमांड पाठ के एक बड़े या छोटे ब्लॉक को परिसीमित करते हैं (जिसमें अन्य QDoc कमांड शामिल हो सकते हैं) जिसमें विशेष स्वरूपण विशेषताएँ लागू की जानी चाहिए।

एक तर्क घुंघराले ब्रेसिज़ में प्रदान किया जाना चाहिए, जैसा कि नीचे दी गई qdoc टिप्पणी में है। तर्क की व्याख्या नहीं की जाती है लेकिन इसका उपयोग उस टैग के गुण (गुण) के रूप में किया जाता है जो कि qdoc द्वारा आउटपुट होता है।

उदाहरण के लिए, हम एक इनलाइन छवि को प्रस्तुत करना चाहते हैं ताकि यह पाठ के वर्तमान ब्लॉक के दाईं ओर तैर सके:

/ *!
   \div {class="float-right"}
     \inlineimage qml-column.png
   \enddiv

* /

यदि qdoc HTML उत्पन्न कर रहा है, तो यह इन आदेशों का अनुवाद करेगा:

<div class="float-right"><p><img src="images/qml-column.png" /></p></div>

HTML के लिए, विशेषता मान फ्लोट-राइट तब style.css फ़ाइल में एक क्लॉज़ को संदर्भित करेगा, जो इस मामले में हो सकता है:

div.float-right
{
   float: right; margin-left: 2em
}

यदि qdoc DITA XML उत्पन्न कर रहा है, तो यह कमांडों का अनुवाद करेगा:

<sectiondiv outputclass="float-right">
    <p>
        <fig>
            <image href="images/qml-column.png" placement="inline"/>
        </fig>
    </p>
</sectiondiv>

तब आपका DITA XML प्रकाशन प्रोग्राम को आउटपुटक्लास विशेषता मान को पहचानना चाहिए।

नोट: ध्यान दें कि \ div कमांड को नेस्ट किया जा सकता है।

नीचे आप Qt 4.7 के लिए index.html उत्पन्न करने के लिए index.qdoc फ़ाइल से लिया गया एक उदाहरण पा सकते हैं:

\div {class="indexbox guide"}
    \div {class="heading"}
        Qt Developer Guide
\enddiv
    \div {class="indexboxcont indexboxbar"}
        \div {class="section indexIcon"} \emptyspan
        \enddiv
        \div {class="section"}
            Qt is a cross-platform application and UI
            framework. Using Qt, you can write web-enabled
            applications once and deploy them across desktop,
            mobile and embedded operating systems without
            rewriting the source code.
        \enddiv
        \div {class="section sectionlist"}
            \list
               \li \l{Getting Started}
               \li \l{Installation} {Installation}
               \li \l{how-to-learn-qt.html} {How to learn Qt}
               \li \l{tutorials.html} {Tutorials}
               \li \l{Qt Examples} {Examples}
               \li \l{qt4-7-intro.html} {What's new in Qt 4.7}
            \endlist
        \enddiv
    \enddiv
\enddiv

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

क्यूटी डेवलपर गाइड

Qt एक क्रॉस-प्लेटफॉर्म एप्लिकेशन और UI फ्रेमवर्क है। Qt का उपयोग करते हुए, आप एक बार वेब-सक्षम अनुप्रयोगों को लिख सकते हैं और उन्हें स्रोत कोड को फिर से लिखे बिना डेस्कटॉप, मोबाइल और एम्बेडेड ऑपरेटिंग सिस्टम पर तैनात कर सकते हैं।

  • शुरू करना
  • स्थापना
  • Qt कैसे सीखें
  • ट्यूटोरियल
  • उदाहरण
  • Qt 4.7 में क्या नया है

DITA XML बनाते समय, qdoc नेस्टेड डिव कमांड को निम्नानुसार आउटपुट करता है:

<sectiondiv outputclass="indexbox guide">
    <sectiondiv outputclass="heading">
        <p>Qt Developer Guide</p>
    </sectiondiv>
    <sectiondiv outputclass="indexboxcont indexboxbar">
        <sectiondiv outputclass="section indexIcon"/>
        <sectiondiv outputclass="section">
            <p>Qt is a cross-platform application and UI
               framework. Using Qt, you can write
               web-enabled applications once and deploy
               them across desktop, mobile and embedded
               operating systems without rewriting the
               source code.
            </p>
        </sectiondiv>
        <sectiondiv outputclass="section sectionlist">
            <ul>
                <li>
                    <xref href="gettingstarted.xml#id-606ee7a8-219b-47b7-8f94-91bc8c76e54c">Getting started</xref>
                </li>
                <li>
                    <xref href="installation.xml#id-075c20e2-aa1e-4f88-a316-a46517e50443">Installation</xref>
                </li>
                <li>
                    <xref href="how-to-learn-qt.xml#id-49f509b5-52f9-4cd9-9921-74217b9a5182">How to learn Qt</xref>
                </li>
                <li>
                    <xref href="tutorials.xml#id-a737f955-a904-455f-b4aa-0dc69ed5a64f">Tutorials</xref>
                </li>
                <li>
                    <xref href="all-examples.xml#id-98d95159-d65b-4706-b08f-13d80080448d">Examples</xref>
                </li>
                <li>
                    <xref href="qt4-7-intro.xml#id-519ae0e3-4242-4c2a-b2be-e05d1e95f177">What's new in Qt 4.7</xref>
                </li>
            </ul>
        </sectiondiv>
    </sectiondiv>
</sectiondiv>

आपके DITA XML प्रकाशन प्रोग्राम को आउटपुटक्लास विशेषता के मूल्यों को पहचानना चाहिए।

यह भी देखें

\ अवधि

\ Span कमांड पाठ के एक छोटे से ब्लॉक में विशेष स्वरूपण लागू करता है।

दो तर्क दिए जाने चाहिए, प्रत्येक तर्क घुंघराले ब्रेसिज़ में, जैसा कि नीचे QDoc टिप्पणी में दिखाया गया है। पहले तर्क की व्याख्या नहीं की जाती है, लेकिन QDoc द्वारा टैग आउटपुट के स्वरूपण विशेषता (एस) को निर्दिष्ट करता है। दूसरा तर्क विशेष स्वरूपण विशेषताओं के साथ प्रस्तुत किया जाने वाला पाठ है।

उदाहरण के लिए, हम नीले रंग की संख्यात्मक सूची में प्रत्येक तत्व के पहले शब्द को प्रस्तुत करना चाहते हैं।

/ *!
    Global variables with complex types:
\list 1
        \li \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
        \li \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
        \li \span {class="variableName"} {constComplex1} in globals.cpp at line 16
        \li \span {class="variableName"} {constComplex2} in globals.cpp at line 17
    \endlist
* /

वर्ग चर नाम आपकी शैली में एक खंड को संदर्भित करता है।

.variableName
{
    font-family: courier;
color: blue
}

ऊपर दिखाए गए चर नाम का उपयोग करके, उदाहरण के रूप में प्रस्तुत किया गया है:

जटिल प्रकार के साथ वैश्विक चर:

  1. 14 में globals.cpp में mutableComplex1
  2. 15 में globals.cpp पर mutableComplex2
  3. constComplex1 globals.cpp में लाइन 16 पर
  4. 17 में globals.cpp पर constComplex2

नोट: स्पैन कमांड शुरू होने के लिए एक नया पैराग्राफ नहीं बनाता है।

यह भी देखें

\ tt (टेलेटाइप फ़ॉन्ट)

\ Tt कमांड एक मोनोस्पेस फ़ॉन्ट में अपने तर्क प्रस्तुत करता है। यह कमांड सिर्फ \c कमांड की तरह व्यवहार करता है, सिवाय इसके कि \ tt आपको तर्क के भीतर QDoc कमांड को घोंसला बनाने की अनुमति देता है (जैसे \e , \b और \underline )।

/ *!
    After having populated the main container with
    child widgets, \c setupUi() scans the main container's list of
    slots for names with the form
    \tt{on_\e{objectName}_\e{signalName}().}
* /

QDoc इसे प्रस्तुत करता है:

चाइल्ड विजेट्स के साथ मुख्य कंटेनर को पॉप्युलेट करने के बाद, setupUi() on_ objectName _ signalName (). साथ नामों के लिए स्लॉट्स के मुख्य कंटेनर की सूची को स्कैन करता है on_ objectName _ signalName ().

यदि कोड फ़ॉन्ट में दिए जाने वाले पाठ में रिक्त स्थान हैं, तो पूरे पाठ को घुंघराले कोष्ठक में संलग्न करें।

\tt {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}

QDoc इसे प्रस्तुत करता है:

QLineEdit::QLineEdit (const QString &contents, QWidget *parent) : QWidget (parent)

यह भी देखें

\ b

\ B कमांड बोल्ड फ़ॉन्ट में अपने तर्क प्रस्तुत करती है। इस कमांड को \ _ बोल्ड कहा जाता था।

/ *!
    This is regular text; \b {this text is
    rendered using the \\b command}.
* /

QDoc इसे प्रस्तुत करता है:

यह नियमित पाठ है; यह पाठ \ b कमांड का उपयोग करके प्रदान किया गया है

\ e (जोर, इटैलिक)

\ E कमांड एक विशेष फ़ॉन्ट, सामान्य रूप से इटैलिक में अपने तर्क प्रस्तुत करता है। इस कमांड को \ i कहा जाता था, जिसे अब हटा दिया गया है।

यदि तर्क में रिक्त स्थान या अन्य विराम चिह्न हैं, तो तर्क को घुंघराले कोष्ठक में संलग्न करें।

/ *!
    Here, we render \e {a few words} in italics.
* /

QDoc इसे प्रस्तुत करता है:

यहाँ, हम कुछ शब्दों को इटैलिक में प्रस्तुत करते हैं।

यदि आप एक तर्क के भीतर अन्य QDoc कमांड का उपयोग करना चाहते हैं जिसमें रिक्त स्थान शामिल हैं, तो आपको हमेशा तर्क को ब्रेसिज़ में संलग्न करने की आवश्यकता होती है। लेकिन QDoc कोष्ठक [3] को गिनने में काफी स्मार्ट है, इसलिए आपको इस तरह के मामलों में ब्रेसिज़ की आवश्यकता नहीं है:

/ *!
    An argument can sometimes contain whitespaces,
    for example: \e QPushButton(tr("A Brand New Button"))
* /

QDoc इसे प्रस्तुत करता है:

एक तर्क में कभी-कभी व्हाट्सएप हो सकता है, उदाहरण के लिए: QPushButton (tr ("A Brand New Button")

अंत में, अनुगामी विराम चिह्न एक तर्क [4] में शामिल नहीं है, और न ही "s" [5] है।

QDoc सिंटेक्स उत्पन्न दस्तावेज
1 एक कमांड बटन का एक बदलाव \ ई मेनू बटन है। कमांड बटन की एक भिन्नता एक मेनू बटन है।
2 QPushButton विजेट एक \ e {कमांड बटन} प्रदान करता है। QPushButton विजेट एक कमांड बटन प्रदान करता है।
3 बटन का एक और वर्ग विकल्प बटन \ e (QRadioButton देखें) हैं। बटन का एक अन्य वर्ग विकल्प बटन हैं (QRadioButton देखें)
4 एक पुश बटन सिग्नल \ e पर क्लिक करता है ()। एक पुश बटन क्लिक किए गए सिग्नल का उत्सर्जन करता है ()।
5 \ E QPushButton की जाँच की गई संपत्ति डिफ़ॉल्ट रूप से गलत है। QPushButton की जाँच की गई संपत्ति डिफ़ॉल्ट रूप से गलत है।

\ उप

एक छोटे फ़ॉन्ट का उपयोग करके, नियमित पाठ की आधार रेखा की तुलना में \ sub कमांड अपने तर्क को कम करती है।

/ *!
    Definition (Range): Consider the sequence
    {x\sub n}\sub {n > 1} . The set

    {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}

    is called the range of the sequence.
* /

QDoc इसे प्रस्तुत करता है:

परिभाषा (श्रेणी): अनुक्रम {x n } n> 1 पर विचार करें। सेट

{x 2 , x 3 , x 4 , ...} = {x n ; n = 2, 3, 4, ...}

अनुक्रम की सीमा कहा जाता है।

यदि तर्क में रिक्त स्थान या अन्य विराम चिह्न हैं, तो तर्क को घुंघराले कोष्ठक में संलग्न करें।

\ sup

\ Sup कमांड एक छोटे फ़ॉन्ट का उपयोग करके, नियमित पाठ की आधार रेखा से अधिक अपने तर्क का प्रतिपादन करता है।

/ *!
    The series

    1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...

    is called the \i {geometric series}.
* /

QDoc इसे प्रस्तुत करता है:

श्रृंखला

1 + a + a 2 + a 3 + a 4 + ...

को ज्यामितीय श्रृंखला कहा जाता है।

यदि तर्क में रिक्त स्थान या अन्य विराम चिह्न हैं, तो तर्क को घुंघराले कोष्ठक में संलग्न करें।

\ uicontrol

UI नियंत्रण तत्वों के लिए उपयोग की जाने वाली सामग्री को चिह्नित करने के लिए \ uicontrol कमांड का उपयोग किया जाता है। HTML का उपयोग करते समय, आउटपुट बोल्ड में प्रस्तुत किया जाता है। डीआईटीए एक्सएमएल का उपयोग करते समय सामग्री को एक uicontrol टैग में संलग्न किया गया है।

\ रेखांकन

\ Underline कमांड अपने तर्क को रेखांकित करता है।

/ *!
    The \underline {F}ile menu gives the users the possibility
    to edit an existing file, or save a new or modified
    file, and exit the application.
* /

QDoc इसे प्रस्तुत करता है:

F ile मेनू उपयोगकर्ताओं को किसी मौजूदा फ़ाइल को संपादित करने, या एक नई या संशोधित फ़ाइल सहेजने, और एप्लिकेशन से बाहर निकलने की संभावना देता है।

यदि तर्क में रिक्त स्थान या अन्य विराम चिह्न हैं, तो तर्क को घुंघराले कोष्ठक में संलग्न करें।

\\ (डबल बैकस्लैश)

\\ कमांड एक डबल बैकस्लैश तक फैलता है।

QDoc कमांड हमेशा एक बैकस्लैश के साथ शुरू होती हैं। पाठ में एक एकल बैकस्लैश प्रदर्शित करने के लिए आपको दो बैकस्लैश टाइप करने होंगे। यदि आप दो बैकस्लैश प्रदर्शित करना चाहते हैं, तो आपको चार टाइप करने होंगे।

/ *!
    The \\\\ command is useful if you want a
    backslash to appear verbatim, for example,
    writing C:\\windows\\home\\.
* /

QDoc इसे प्रस्तुत करता है:

यदि आप एक बैकस्लैश को शब्दशः प्रदर्शित करना चाहते हैं, तो उदाहरण के लिए, C: \ windows \ home \ लिखना उपयोगी है।

हालाँकि, यदि आप चाहते हैं कि आपका पाठ एक मोनोस्पेस फ़ॉन्ट में भी दिखाई दे, तो आप इसके बजाय \c कमांड का उपयोग कर सकते हैं, जो बैकस्लैश को किसी अन्य वर्ण के रूप में स्वीकार और प्रस्तुत करता है। उदाहरण के लिए:

/ *!
    The \\c command is useful if you want a
    backslash to appear verbatim, and the word
    that contains it written in a monospace font,
    like this: \c {C:\windows\home\}.
* /

QDoc इसे प्रस्तुत करता है:

यदि आप शब्दशः प्रकट करने के लिए बैकस्लैश चाहते हैं तो \ c कमांड उपयोगी है, और इसमें जो शब्द है वह मोनोपॉज़ फ़ॉन्ट में लिखा है, जैसे: C:\windows\home\

यह भी देखें