Qt 5.11 - Document Navigation

दस्तावेज़ नेविगेशन




qt

दस्तावेज़ नेविगेशन

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

उदाहरण

 /*!
     \page basicqt.html
     \contentspage {Basic Qt} {Contents}
     \nextpage Getting Started

     \indexpage Index
     \startpage Basic Qt

     \title Basic Qt

     The Qt toolkit is a C++ class library and a set of tools for
     building multiplatform GUI programs using a "write once,
     compile anywhere approach".

     Table of contents:

     \list
     \li \l {Getting Started}
     \li \l {Creating Dialogs}
     \li \l {Creating Main Windows}
     \endlist
 */

 /*!
    \page gettingstarted.html
    \previouspage Basic Qt
    \contentspage {Basic Qt} {Contents}
    \nextpage Creating Dialogs

    \indexpage Index
    \startpage Basic Qt

    \title Getting Started

    This chapter shows how to combine basic C++ with the
    functionality provided by Qt to create a few small graphical
    interface (GUI) applications.
*/

/ *!
    \page creatingdialogs.html
    \previouspage Getting Started
    \contentspage {Basic Qt} {Contents}

    \indexpage Index
    \startpage Basic Qt

    \title Creating Dialogs

    This chapter will teach you how to create dialog boxes using Qt.
*/

/*!
    \page index.html

    \indexpage Index
    \startpage Basic Qt

    \title Index

    \list
        \li \l {Basic Qt}
        \li \l {Creating Dialogs}
        \li \l {Getting Started}
    \endlist
*/

QDoc ने creatingdialogs.html में "गेटिंग स्टार्ट" पृष्ठ का प्रतिपादन किया:

[पिछला: बेसिक क्यूटी ] [ सामग्री ] [अगला: संवाद बनाना ]

शुरू करना

यह अध्याय दर्शाता है कि कुछ छोटे ग्राफ़िकल इंटरफ़ेस (GUI) अनुप्रयोगों को बनाने के लिए Qt द्वारा प्रदान की गई कार्यक्षमता के साथ बुनियादी C ++ को कैसे संयोजित किया जाए।

[पिछला: बेसिक क्यूटी ] [ सामग्री ] [अगला: संवाद बनाना ]

\indexpage और \startpage कमांड पेज के इंडेक्स पेज और स्टार्ट पेज के लिंक बनाते हैं। इन लिंक्स का उपयोग ब्राउज़र और सर्च इंजन द्वारा किया जा सकता है।

इंडेक्स पेज आमतौर पर दस्तावेज़ के शीर्षक और विषयों की एक वर्णमाला सूची है, जबकि प्रारंभ पृष्ठ लेखक द्वारा बहुगुण दस्तावेज़ का शुरुआती बिंदु माना जाता है।

लिंक उत्पन्न HTML स्रोत कोड में शामिल हैं, लेकिन प्रलेखन पर कोई दृश्य प्रभाव नहीं है:

<head>
    ...
    <link rel="index" href="index.html" />
    <link rel="start" href="basicqt.html" />
    ...
</head>

आदेश

\पिछला पृष्ठ

\ पिछला पृष्ठ कमांड पिछले पृष्ठ को एक अनुक्रम में पिछले पृष्ठ से जोड़ता है। कमांड में दो तर्क हैं, प्रत्येक घुंघराले ब्रेसिज़ द्वारा संलग्न है: पहला लिंक लक्ष्य है (पिछले पृष्ठ का शीर्षक), दूसरा लिंक पाठ है । यदि पृष्ठ का शीर्षक लिंक पाठ के बराबर है, तो दूसरा तर्क छोड़ा जा सकता है।

कमांड को अपनी लाइन पर अकेले खड़ा होना चाहिए।

\अगला पृष्ठ

\ Nextpage कमांड वर्तमान पेज को अगले पेज पर एक क्रम में लिंक करता है। आदेश उसी सिंटैक्स और तर्क सम्मेलन का अनुसरण करता है जैसे कि \previouspage कमांड।

\पृष्ठ प्रारंभ करें

\ Startpage कमांड पृष्ठों के अनुक्रम के पहले पृष्ठ को निर्दिष्ट करता है। कमांड को अपनी लाइन पर अकेले खड़ा होना चाहिए, और इसका अनूठा तर्क पहले दस्तावेज़ का शीर्षक है।

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

\तालिका पृष्ट

\ Contentpage कमांड वर्तमान पृष्ठ को सामग्री पृष्ठ की तालिका से जोड़ता है। आदेश उसी सिंटैक्स और तर्क सम्मेलन का अनुसरण करता है जैसे कि \previouspage कमांड।

\सूचि पन्ना

\ Indexpage कमांड वर्तमान दस्तावेज़ के लिए एक इंडेक्स पेज निर्दिष्ट करता है। कमांड को अपनी लाइन पर अकेले खड़ा होना चाहिए, और इसका अनूठा तर्क सूचकांक दस्तावेज़ का शीर्षक है।

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