XML फ़ॉर्मैट करें

XML को दोबारा इंडेंट करना जितना दिखता है, उससे ज़्यादा जोखिम भरा क्यों है

XML में व्हाइटस्पेस डिफ़ॉल्ट रूप से मायने रखता है, और यही बात लोगों को चौंकाती है। JSON में फ़ॉर्मैटिंग से कुछ नहीं बिगड़ता, लेकिन XML पार्सर को एलिमेंट के बीच के स्पेस और नई लाइनों को टेक्स्ट कंटेंट के रूप में बताना ही पड़ता है — उन्हें अनदेखा किया जा सकता है या नहीं, यह स्कीमा (अगर हो) तय करता है। इसलिए दोबारा इंडेंट करने से डॉक्यूमेंट सच में बदल जाता है। ज़्यादातर कॉन्फ़िगरेशन और डेटा फ़ाइलों पर इसका कोई असर नहीं पड़ता, लेकिन मिक्स्ड कंटेंट वाले डॉक्यूमेंट में — जहां टेक्स्ट और एलिमेंट साथ-साथ होते हैं, जैसे XHTML या DocBook — इससे डॉक्यूमेंट का कहा हुआ बदल सकता है।

इसलिए यहां की फ़ॉर्मैटिंग उन चीज़ों को नहीं छूती जिन्हें छूना नहीं चाहिए। जिस एलिमेंट पर xml:space="preserve" लगा है, उसका कंटेंट बिल्कुल वैसा ही रहता है जैसा लिखा गया, क्योंकि यह एट्रिब्यूट ठीक यही कहने के लिए बना है। CDATA सेक्शन बिना छेड़े आगे जाते हैं; वे ऐसे टेक्स्ट के लिए होते हैं जिसे इंटरप्रेट नहीं किया जाना चाहिए, और उनके अंदर फ़ॉर्मैटिंग करने से वह ख़राब हो जाएगा। एंटिटी रेफ़रेंस रेफ़रेंस ही रहते हैं, उन्हें उन कैरेक्टर में नहीं बदला जाता जिनके लिए वे हैं।

नेमस्पेस बिल्कुल वैसे ही रखे जाते हैं जैसे लिखे गए हैं — प्रीफ़िक्स, डिक्लेरेशन और वे एलिमेंट जिनसे वे जुड़े हैं। यह ज़ाहिर-सी बात लगती है, पर है नहीं: जो फ़ॉर्मैटर प्रीफ़िक्स को नॉर्मलाइज़ करता है या डिक्लेरेशन को वहां ले जाता है जहां उसे सही लगता है, वह ऐसा डॉक्यूमेंट बनाता है जो तकनीकी रूप से बराबर होता है, पर उन टूल्स में फ़ेल हो जाता है जो प्रीफ़िक्स को अक्षरशः मिलाते हैं। एट्रिब्यूट का क्रम भी वैसा ही रखा जाता है, हालांकि XML के लिए उसका कोई मतलब नहीं — इसी वजह से, क्योंकि पिछले वर्शन से diff करना साफ़-सुथरे क्रम से ज़्यादा काम का है।

फ़ॉर्मैटिंग के दौरान well-formedness की जांच होती है: हर टैग बंद हो, सही तरह नेस्ट हो, एक ही रूट एलिमेंट हो, कैरेक्टर मान्य हों, ऐम्परसैंड और ऐंगल ब्रैकेट ठीक से एस्केप हों। यह XML की दो कसौटियों में से निचली कसौटी है। कोई डॉक्यूमेंट पूरी तरह well-formed होकर भी अपने DTD या स्कीमा के हिसाब से अमान्य हो सकता है, और कितनी भी फ़ॉर्मैटिंग यह नहीं दिखाएगी।

जब आपको कुछ और चाहिए

xmllint --format in.xml यही काम कमांड लाइन पर करता है और ज़्यादातर Unix सिस्टम पर पहले से इंस्टॉल होता है; xmlstarlet fo --indent-tab इंडेंटेशन पर ज़्यादा कंट्रोल देता है। दोनों ही उतनी बड़ी फ़ाइलें संभाल लेते हैं जितनी कोई वेब पेज मेमोरी में रख ही नहीं सकता।

जब डॉक्यूमेंट की तुलना करनी हो, उसे साइन करना हो या कैनॉनिकल रूप में सेव करना हो, तो फ़ॉर्मैटिंग बिल्कुल ग़लत काम है। Canonical XML — xmllint --c14n — वह एक नॉर्मलाइज़्ड रूप बनाता है जिसमें दो बराबर डॉक्यूमेंट एक जैसे हो जाते हैं, और XML पर डिजिटल सिग्नेचर इसी पर टिके होते हैं। साइन किए गए डॉक्यूमेंट को pretty-print करने से उसका सिग्नेचर टूट जाता है, और यह सबक़ सीखने का सबसे महंगा तरीक़ा है।