libvirt/docs/format.html.in

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <body>
    <h1>XML Format</h1>


    <p>
      Objects in the libvirt API are configured using XML documents to allow
      for ease of extension in future releases. Each XML document has an
      associated Relax-NG schema that can be used to validate documents
      prior to usage.
    </p>


    <ul>
      <li><a href="formatdomain.html">Domains</a></li>
      <li><a href="formatnetwork.html">Networks</a></li>
      <li><a href="formatnwfilter.html">Network filtering</a></li>
      <li><a href="formatstorage.html">Storage</a></li>
      <li><a href="formatstorageencryption.html">Storage encryption</a></li>
      <li><a href="formatcaps.html">Capabilities</a></li>
      <li><a href="formatdomaincaps.html">Domain capabilities</a></li>
      <li><a href="formatnode.html">Node devices</a></li>
      <li><a href="formatsecret.html">Secrets</a></li>
      <li><a href="formatsnapshot.html">Snapshots</a></li>
    </ul>

    <h2>Command line validation</h2>

    <p>
      The <code>virt-xml-validate</code> tool provides a simple command line
      for validating XML documents prior to giving them to libvirt. It uses
      the locally instaled RNG schema documents. It will auto-detect which
      schema to use for validation based on the name of the top level element
      in the input document. Thus it merely requires the XML document filename
      to be passed on the command line
    </p>

    <pre>
$ virt-xml-validate /path/to/XML/file</pre>

  </body>
</html>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2013-05-03 14:25:37 +00:00			`<?xml version="1.0" encoding="UTF-8"?>`
docs: switch to using HTML5 doctype declaration The HTML5 doctype is simply <!DOCTYPE html> no DTD is present because HTML5 is no longer defined as an extension of SGML. XSL has no way to natively output a doctype without a public or system identifier, so we have to use an <xsl:text> hack instead. See also https://dev.w3.org/html5/html-author/#doctype-declaration Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-07-26 17:01:25 +00:00			`<!DOCTYPE html>`
Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00			`<html xmlns="http://www.w3.org/1999/xhtml">`
			`<body>`
docs: add some content to the XML format main page The XML format main page has never had any content in it, relying on the left navbar to provide links to the XML schema pages. Since the navbar is gone, the page needs to have some content created, otherwise it is useless. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2016-11-08 11:35:20 +00:00			`<h1>XML Format</h1>`
Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00

docs: add some content to the XML format main page The XML format main page has never had any content in it, relying on the left navbar to provide links to the XML schema pages. Since the navbar is gone, the page needs to have some content created, otherwise it is useless. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2016-11-08 11:35:20 +00:00			`<p>`
			`Objects in the libvirt API are configured using XML documents to allow`
			`for ease of extension in future releases. Each XML document has an`
			`associated Relax-NG schema that can be used to validate documents`
			`prior to usage.`
			`</p>`


			`<ul>`
docs: remove bogus 'shape' attribute on links The 'shape' attribute on <a> is used together with a 'coords' attribute to create hot-zones in image maps. We're not using image maps so our inclusion of a 'shape' attribute is bogus. Furthermore this is forbidden in HTML5. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-07-26 17:18:16 +00:00			`<li><a href="formatdomain.html">Domains</a></li>`
			`<li><a href="formatnetwork.html">Networks</a></li>`
			`<li><a href="formatnwfilter.html">Network filtering</a></li>`
			`<li><a href="formatstorage.html">Storage</a></li>`
			`<li><a href="formatstorageencryption.html">Storage encryption</a></li>`
			`<li><a href="formatcaps.html">Capabilities</a></li>`
			`<li><a href="formatdomaincaps.html">Domain capabilities</a></li>`
			`<li><a href="formatnode.html">Node devices</a></li>`
			`<li><a href="formatsecret.html">Secrets</a></li>`
			`<li><a href="formatsnapshot.html">Snapshots</a></li>`
docs: add some content to the XML format main page The XML format main page has never had any content in it, relying on the left navbar to provide links to the XML schema pages. Since the navbar is gone, the page needs to have some content created, otherwise it is useless. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2016-11-08 11:35:20 +00:00			`</ul>`

			`<h2>Command line validation</h2>`

			`<p>`
			`The <code>virt-xml-validate</code> tool provides a simple command line`
			`for validating XML documents prior to giving them to libvirt. It uses`
			`the locally instaled RNG schema documents. It will auto-detect which`
			`schema to use for validation based on the name of the top level element`
			`in the input document. Thus it merely requires the XML document filename`
			`to be passed on the command line`
			`</p>`

			`<pre>`
format.html.in: Kill useless spaces in <pre/> The <pre/> section is rendered as-is on the page. That is, if all the lines are prefixed with 4 spaces the rendered page will also have them. Problem is if we put a box around such <pre/> because the content might not fix into it. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> 2016-11-11 22:40:27 +00:00			`$ virt-xml-validate /path/to/XML/file</pre>`
Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00
			`</body>`
			`</html>`