Qt 5.11 - Creating DITA Maps

डीआईटीए मैप बनाना




qt

डीआईटीए मैप बनाना

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

DITA मैप क्या है?

DITA का पूरा विवरण OASIS डार्विन इंफॉर्मेशन टाइपिंग आर्किटेक्चर साइट पर पाया जा सकता है।

here उस साइट पर डीआईटीए मानचित्र का स्पष्टीकरण पाया गया है।

\ ditamap

\ Ditamap कमांड qdoc कमांड का उपयोग करके एक DITA मैप बनाने के लिए है। \ Ditamap कमांड एक तरह का \ Page कमांड होता है, जो .html या .xml फ़ाइल के बजाय .ditamap बनाता है । फ़ाइल जो वास्तव में बनाई जाती है उसमें XML पाठ होता है, लेकिन .Ditamap प्रत्यय को DITA MAP युक्त फ़ाइल की पहचान करने के लिए उपयोग किया जाता है।

फ़ाइल बनाने के लिए तर्क का नाम है। निम्नलिखित उदाहरण में, फ़ाइल creator.ditamap आउटपुट है:

\ditamap creator.ditamap

\ topicref \ endtopicref

Ditamap में एक विषय बनाने के लिए \ topicref \ endtopicref कमांड हैं। \ Endtopicref कमांड की आवश्यकता है क्योंकि \ topicref कमांड को नेस्ट किया जा सकता है।

\ topicref के दो तर्क हैं। पहला तर्क नेवीटल विशेषता का मान बन जाता है। आम तौर पर, आप संदर्भित किए जा रहे विषय के शीर्षक का उपयोग करते हैं। यह शीर्षक अक्सर वह होता है जो डिटमैप से निर्मित सामग्री की तालिका में दिखाई देगा।

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

\topicref {QML Module QtQuick 2} {qtquick-2.xml}
  \mapref {Creator Manual} {creator-manual.ditamap} \endmapref
  \topicref {QML Mouse Events} {qtquick2-mouseevents.xml} \endtopicref
  \topicref {Property Binding} {qtquick2-propertybinding.xml} \endtopicref
\endtopicref

\ mapref

Ditamap में एक mapref बनाने के लिए \ mapref कमांड है। एक Mapref एक अन्य डिटामाप को संदर्भित करता है, जिसे आप अपने डिटमैप में शामिल करना चाहते हैं। \ Topicref कमांड की तरह, \ mapref कमांड में दो तर्क हैं, लेकिन \ mapref कमांड के लिए, दोनों तर्क आवश्यक हैं। तर्क अनिवार्य रूप से \ topicref के लिए वर्णित के समान हैं, लेकिन \ mapref के लिए, दूसरा आदेश किसी अन्य डिटामाप का नाम होना चाहिए, अर्थात इसमें .ditamap प्रत्यय होना चाहिए आपको फ़ाइल नाम प्रदान करना होगा। qdoc आपके लिए फ़ाइल नाम नहीं देख सकता है।

\mapref {Creator Manual} {creator-manual.ditamap} \endmapref

एक उदाहरण Ditamap पेज

निम्न उदाहरण ऊपर वर्णित तीन qdoc ditamap कमांड का उपयोग करता है।

\ditamap creator.ditamap
\title The DITA Map for Creator

\topicref {QML Module QtQuick 1}
  \topicref {QML Mouse Events} \endtopicref
  \topicref {Property Binding} \endtopicref
\endtopicref

\topicref {QML Module QtQuick 2} {qtquick-2.xml}
  \mapref {Creator Manual} {creator-manual.ditamap} \endmapref
  \topicref {QML Mouse Events} {qtquick2-mouseevents.xml} \endtopicref
  \topicref {Property Binding} {qtquick2-propertybinding.xml} \endtopicref
\endtopicref

\topicref {QML Module QtQuick.Particles 2} {qtquick-particles-2.xml}
  \topicref {Age} {qml-qtquick-particles2-age.xml} \endtopicref
\endtopicref

परिणाम Ditamap फ़ाइल

यह .ditamap फ़ाइल है जो आपको तब मिलती है जब आप ऊपर दिखाए गए qdoc ditamap पेज को इनपुट करते हैं। ध्यान दें कि आप सीधे एक्सएमएल में डीटामैप फाइलें लिख सकते हैं जितनी आसानी से आप qdoc कमांड का उपयोग करके लिख सकते हैं। चुनना आपको है।

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
<map>
  <topicmeta>
    <shortdesc>The DITA Map for Creator</shortdesc>
  </topicmeta>
  <topicref navtitle="QML Module QtQuick 1" href="qtquick-1.xml">
    <topicref navtitle="QML Mouse Events" href="qtquick2-mouseevents.xml"/>
    <topicref navtitle="Property Binding" href="qtquick2-propertybinding.xml"/>
  </topicref>
  <topicref navtitle="QML Module QtQuick 2" href="qtquick-2.xml">
    <mapref navtitle="Creator Manual" href="creator-manual.ditamap"/>
    <topicref navtitle="QML Mouse Events" href="qtquick2-mouseevents.xml"/>
    <topicref navtitle="Property Binding" href="qtquick2-propertybinding.xml"/>
  </topicref>
  <topicref navtitle="QML Module QtQuick.Particles 2" href="qtquick-particles-2.xml">
    <topicref navtitle="Age" href="qml-qtquick-particles2-age.xml"/>
  </topicref>
</map>