XML फ़ॉर्मैटर
XML को पढ़ने योग्य indentation के साथ format करें और elements, attributes, text, comments तथा escaped values को सुरक्षित रखें।
XML structure को पढ़ना आसान बनाएं
Compact XML transmit करने के लिए सुविधाजनक हो सकता है, लेकिन निरीक्षण करना कठिन होता है। जब पूरा document एक ही line में हो तो element, attribute, closing tag या escaped character ढूंढना मुश्किल होता है। यह formatter readable layout दिखाता है ताकि build, request या configuration में उपयोग से पहले structure की समीक्षा की जा सके।
Formatting presentation बदलती है, XML data का आशय नहीं। Element names, attribute values, text nodes, comments और entity references सुरक्षित रहते हुए consistent indentation और line breaks जुड़ने चाहिए। Readable result समीक्षा में मदद करता है, पर यह schema validation result नहीं है।
Tool समझने के लिए छोटा representative sample इस्तेमाल करें। Source document, formatted copy और बाद के validation result अलग रखें, ताकि XML syntax, schema, encoding और application rules में अंतर समझ सकें।
यदि document में secrets या personal data हैं तो paste करने से पहले redacted copy बनाएं। Formatting data को anonymous नहीं बनाती और यह सिद्ध नहीं करती कि उसे किसी अन्य service के साथ साझा करना अनुमत है।
Formatting और validation अलग हैं
XML एक nested markup format है जिसमें elements, attributes, text, comments, declarations और character references होते हैं। Elements को matching opening और closing tags चाहिए, attributes opening tag से जुड़े होते हैं और ampersand जैसे reserved characters data होने पर escape होने चाहिए।
Formatter nodes और whitespace व्यवस्थित करने के लिए पर्याप्त structure पढ़ता है। यह साबित नहीं करता कि document XSD, DTD, namespace policy, application contract या business rule से मेल खाता है। ये checks अपने संबंधित workflow में रखें।
कुछ XML contexts में whitespace data हो सकता है, खासकर mixed content और text nodes में। Whitespace-sensitive consumer में document बदलने से पहले output को उसकी requirements से मिलाएं और original source सुरक्षित रखें।
XML format करने का तरीका
- Source field में पूरा XML document या documented fragment paste करें। Test copy से unrelated prose और programming-language wrapper निकालें।
- Formatter चलाकर nesting, attributes, comments और text values देखें। Formatting failure को किसी खास parser message का प्रमाण न मानें।
- Formatted document और original की तुलना करें। Element names, attribute values, entity references, namespace declarations और text data समान होने चाहिए।
- Formatting के बाद project का XML parser, schema validator या application test चलाएं। Formatting अकेले validity या compatibility सिद्ध नहीं करती।
- Production data के लिए sample से secrets और personal information हटाएं। Controlled diff और rollback के लिए original file रखें।
Formatting method
- XML structure पढ़ना
Tool markup को nested XML content की तरह पढ़ता है और elements, attributes, text, comments तथा declarations की boundaries पहचानता है।
- Indentation लगाना
Formatter parent और child relationships दिखाने के लिए line breaks और indentation जोड़ता है। यह whitespace presentation है, नई schema rule नहीं।
- Technical values बचाना
Attribute text, entity references, namespace prefixes और comment content source sample से जुड़े रहने चाहिए। Exact bytes महत्वपूर्ण हों तो diff देखें।
Public page XML formatting input document करती है। Exact parser recovery, whitespace policy और error wording को live engine में जांचे बिना fixed behavior न लिखें।
Formatted result पढ़ना
Successful result दिए गए XML का readable arrangement है। Tree, values, attributes, comments और declarations को source से मिलाएं।
Failure का अर्थ है कि documented path input को handle नहीं कर पाया। Matching runtime evidence के बिना exact parser rule या error location न मानें।
यदि document बाद में XSD या application check में fail हो, तो उस अलग contract की जांच करें। Formatting required elements, namespaces या types नहीं जोड़ती।
सामान्य गलतियां
Indentation को schema validation समझने से missing required elements या invalid attributes छिप सकते हैं।
Escaped entities को visible characters से replace करने पर XML data बदल सकता है या document invalid हो सकता है।
Attributes या children को केवल दृश्य पसंद से sort करने पर consumer का अपेक्षित order या mixed content बदल सकता है।
Required namespace declaration के बिना केवल fragment copy करने से test production document से अलग हो सकता है।
सीमाएं
Documented capability XML formatting है। इससे XSD या DTD validation, transformation, canonicalization, security scan या application compatibility सिद्ध नहीं होती।
Whitespace-sensitive mixed content, namespaces, बड़े documents और parser-specific recovery को target consumer के साथ test करें।
Confidential production documents तभी paste करें जब policy अनुमति दे। Formatted copy में वही sensitive values रह सकती हैं।
Examples
Simple element format करना
क्या compact element readable बनाया जा सकता है?
Compact XML भेजें।
Child elements note के नीचे अलग indented lines में दिखाई देते हैं।
Attributes दिखाना
Attribute वाले element की समीक्षा कैसे करें?
Element भेजें और opening tag देखें।
id attribute user पर रहता है और name child indented होता है।
Escaped text सुरक्षित रखना
क्या text के भीतर entity बनी रहती है?
Document format करके text node की तुलना करें।
Entity reference text representation का हिस्सा बनी रहती है।
Repeated children format करना
क्या repeated elements को साफ अलग दिखाया जा सकता है?
दो item children वाले parent को भेजें।
हर repeated child अपनी line में दिखता है, जिससे order देखना आसान होता है।
Comment रखना
XML comment के साथ क्या होना चाहिए?
Configuration sample format करें।
Comment parent और mode element के बीच document में रहता है।
Declaration रखना
XML declaration को कैसे handle किया जाता है?
Declaration और root element साथ भेजें।
Declaration शुरुआत में रहती है और root content नीचे indented होता है।
Frequently asked questions
क्या formatting XML schema validate करती है?
नहीं। यह XML structure व्यवस्थित करती है। Schema check के लिए project का XSD, DTD या application validator इस्तेमाल करें।
क्या formatting element values बदलती है?
इसे values और structure सुरक्षित रखकर केवल presentation whitespace जोड़ना चाहिए। Exact text महत्वपूर्ण हो तो original से तुलना करें।
क्या comments सुरक्षित रहते हैं?
Examples comments को formatted view में रहने वाला content मानते हैं। Pipeline में भरोसा करने से पहले अपनी exact input पर behavior जांचें।
क्या XML fragment format कर सकते हैं?
Complete document या documented fragment shape इस्तेमाल करें। Fragment किसी missing namespace या root पर निर्भर हो सकता है।
क्या formatting XML को छोटा करती है?
नहीं। Readability के लिए whitespace जुड़ता है। Compact output चाहिए तो अलग minifier या transport process इस्तेमाल करें।
Escaped ampersand के साथ क्या करें?
& जैसी references को XML data की तरह रखें। Context valid XML न रहे तो उन्हें raw ampersand से replace न करें।
क्या formatting malformed XML repair करती है?
Automatic repair मानकर न चलें। Source को सोच-समझकर ठीक करें और application के parser तथा schema checks चलाएं।
Formatting के बाद क्या करें?
Diff review करें, parser या schema checks चलाएं और spaces या namespaces महत्वपूर्ण हों तो real consumer के साथ formatted copy test करें।