External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-23 14:15:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
f143e4e7b6
libvirt/docs/page.xsl

235 lines
11 KiB
XML
Raw Normal View History

docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<?xml version="1.0"?>
<xsl:stylesheet
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
xmlns="http://www.w3.org/1999/xhtml"
xmlns:html="http://www.w3.org/1999/xhtml"
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:exsl="http://exslt.org/common"
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
exclude-result-prefixes="xsl exsl html"
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
version="1.0">
docs: fix include of ACL permissions files The XSL generator loads included HTML files relative to the source dir but we need to tell it to load them from the build dir instead. Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-11-20 15:24:18 +00:00
<xsl:param name="builddir" select="'..'"/>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<xsl:template match="node() | @*" mode="content">
<xsl:copy>
<xsl:apply-templates select="node() | @*" mode="content"/>
</xsl:copy>
</xsl:template>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:template match="html:ul[@id='toc']" mode="content">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<xsl:call-template name="toc"/>
</xsl:template>
Add documentation for access control system This adds two new pages to the website, acl.html describing the general access control framework and permissions models, and aclpolkit.html describing the use of polkit as an access control driver. page.xsl is modified to support a new syntax <div id="include" filename="somefile.htmlinc"/> which will cause the XSL transform to replace that <div> with the contents of 'somefile.htmlinc'. We use this in the acl.html.in file, to pull the table of permissions for each libvirt object. This table is autogenerated from the enums in src/access/viraccessperms.h by the genaclperms.pl script. newapi.xsl is modified so that the list of permissions checks shown against each API will link to the description of the permissions in acl.html Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-08-08 10:51:01 +00:00
<xsl:template match="html:div[@id='include']" mode="content">
<xsl:call-template name="include"/>
</xsl:template>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<xsl:template name="toc">
<ul>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:for-each select="/html:html/html:body/html:h2[count(html:a) = 1]">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<xsl:variable name="thish2" select="."/>
<li>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<a href="#{html:a/@id}"><xsl:value-of select="html:a/text()"/></a>
Fix a few more docs XSL bugs related to the TOC Add missing 'html:' namespace prefix to a few more XSL rules for generating the table of contents links Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 19:56:04 +00:00
<xsl:if test="count(./following-sibling::html:h3[preceding-sibling::html:h2[1] = $thish2 and count(html:a) = 1]) > 0">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<ul>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:for-each select="./following-sibling::html:h3[preceding-sibling::html:h2[1] = $thish2 and count(html:a) = 1]">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<xsl:variable name="thish3" select="."/>
<li>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<a href="#{html:a/@id}"><xsl:value-of select="html:a/text()"/></a>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:if test="count(./following-sibling::html:h4[preceding-sibling::html:h3[1] = $thish3 and count(html:a) = 1]) > 0">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<ul>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:for-each select="./following-sibling::html:h4[preceding-sibling::html:h3[1] = $thish3 and count(html:a) = 1]">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<xsl:variable name="thish4" select="."/>
<li>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<a href="#{html:a/@id}"><xsl:value-of select="html:a/text()"/></a>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:if test="count(./following-sibling::html:h5[preceding-sibling::html:h4[1] = $thish4 and count(html:a) = 1]) > 0">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<ul>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:for-each select="./following-sibling::html:h5[preceding-sibling::html:h4[1] = $thish4 and count(html:a) = 1]">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<xsl:variable name="thish5" select="."/>
<li>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<a href="#{html:a/@id}"><xsl:value-of select="html:a/text()"/></a>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:if test="count(./following-sibling::html:h6[preceding-sibling::html:h5[1] = $thish5 and count(html:a) = 1]) > 0">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<ul>
Fix docs generator regression in previous commit The previous commit failed to update the XSL to take account of fact that in XHTML mode the elements need namespace prefixes. This caused every web page to be blank!
2013-05-03 15:57:05 +00:00
<xsl:for-each select="./following-sibling::html:h6[preceding-sibling::html:h5[1] = $thish5 and count(html:a) = 1]">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<li>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<a href="#{html:a/@id}"><xsl:value-of select="html:a/text()"/></a>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
</li>
</xsl:for-each>
</ul>
</xsl:if>
</li>
</xsl:for-each>
</ul>
</xsl:if>
</li>
</xsl:for-each>
</ul>
</xsl:if>
</li>
</xsl:for-each>
</ul>
</xsl:if>
</li>
</xsl:for-each>
</ul>
</xsl:template>
<!-- This is the master page structure -->
<xsl:template match="/" mode="page">
docs: add 'edit this page' link to footer of every page To encourage contributors to make changes to the main website, add a footer link to every page which links to the corresponding source file in git. With gitlab, they are able to edit content directly in the web browser and then submit a merge request. This gives a way to contribute content that is arguably easier than our wiki which requires manual account creation, while this will also benefit from maintainer review. Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-08 15:18:58 +00:00
<xsl:param name="pagesrc"/>
docs: Add build timestamps to generated html/php pages In order not to make the build even less reproducible, honour SOURCE_DATE_EPOCH environment variable as specified: https://reproducible-builds.org/specs/source-date-epoch/ Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2017-07-26 15:04:37 +00:00
<xsl:param name="timestamp"/>
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
<xsl:text disable-output-escaping="yes">&lt;!DOCTYPE html&gt;
</xsl:text>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<html>
<xsl:comment>
docs: fix libvirt go-import metadata in pages and links in 404 page The meson conversion lost the <meta> tags providing the go-import, because the "$pagename" variable lost the .html suffix. Rather than fix that, just change to using "$pagesrc" instead, as it is a better fit. The 404 page also needs to use absolute links to work correctly for pages in sub-folders. Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-08-04 13:33:15 +00:00
This file is autogenerated from <xsl:value-of select="$pagesrc"/>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
Do not edit this file. Changes will be lost.
</xsl:comment>
docs: Add build timestamps to generated html/php pages In order not to make the build even less reproducible, honour SOURCE_DATE_EPOCH environment variable as specified: https://reproducible-builds.org/specs/source-date-epoch/ Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2017-07-26 15:04:37 +00:00
<xsl:comment>
This page was generated at <xsl:value-of select="$timestamp"/>.
</xsl:comment>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<head>
docs: explicitly declare pages as being UTF-8 format Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 17:20:26 +00:00
<meta charset="UTF-8"/>
docs: make website responsive for mobile devices The website does not look good in a mobile device as the text is far too small and the layout assumes a wide screen. Make the style dynamically adapt based on viewport size, so a mobile device gets a layout more suited to its dimensions, also changing "Learn" to "Docs" Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-08-04 12:29:43 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
docs: Move all CSS files to a subdirectory This unclutters the top-level docs directory. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2021-12-21 15:10:13 +00:00
<link rel="stylesheet" type="text/css" href="{$href_base}css/main.css"/>
docs: add full set of "favicon" files to support modern clients Use of the relation "shortcut" for a favicon was an Internet Explorer only feature. Other browsers just require "icon". The new icons & metadata are generated using https://realfavicongenerator.net/ which is user tested to work well across all modern clients Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 17:22:11 +00:00
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/>
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/>
<link rel="manifest" href="/manifest.json"/>
<meta name="theme-color" content="#ffffff"/>
docs: adapt filling of <head> section for rst2html output The HTML from rst2html doesn't have <h1> immediately under the <body> tag, instead there is at least one <div> in between. There are also many things added in the <head> section that we don't want to have copied over, since our templating system already adds suitable <head> elements. We only need to copy the <script> to make index.html work. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:58:56 +00:00
<title>libvirt: <xsl:value-of select="html:html/html:body//html:h1"/></title>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<meta name="description" content="libvirt, virtualization, virtualization API"/>
docs: fix libvirt go-import metadata in pages and links in 404 page The meson conversion lost the <meta> tags providing the go-import, because the "$pagename" variable lost the .html suffix. Rather than fix that, just change to using "$pagesrc" instead, as it is a better fit. The 404 page also needs to use absolute links to work correctly for pages in sub-folders. Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-08-04 13:33:15 +00:00
<xsl:if test="$pagesrc = 'docs/libvirt-go.rst'">
docs: point go imports to gitlab.com repos The gitlab.com repos are the primary source, with libvirt.org just a read-only mirror. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2021-07-02 10:50:20 +00:00
<meta name="go-import" content="libvirt.org/libvirt-go git https://gitlab.com/libvirt/libvirt-go.git"/>
docs: add pages to support Go module package resolution Currently the libvirt Go modules are accessed by applications using their github repository URLs. This is undesirable as we don't want applications to have a direct dependancy on a specific source repo location. We want to enable applications to use the Go packages via the libvirt.org namespace. When you do "go get libvirt.org/libvirt-go", the Go client will do an HTTPS request to that URL, and parse the HTML content to look for a <meta> tag which tells it where to the find the GIT repository. https://golang.org/cmd/go/#hdr-Remote_import_paths This adds two pages to support this Go module resolution. They are not linked from anywhere as we don't expect users to actually look at them. If someone does happen upon them, there's some boilerplate text to send them off to godoc.org for API documentation. Since the pages we're adding have a .html extension, we will also use a small apache config tweak on the server RewriteEngine on RewriteRule ^/libvirt-go$ /libvirt-go.html [L] RewriteRule ^/libvirt-go-xml$ /libvirt-go-xml.html [L] Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-12-16 10:06:50 +00:00
</xsl:if>
docs: fix libvirt go-import metadata in pages and links in 404 page The meson conversion lost the <meta> tags providing the go-import, because the "$pagename" variable lost the .html suffix. Rather than fix that, just change to using "$pagesrc" instead, as it is a better fit. The 404 page also needs to use absolute links to work correctly for pages in sub-folders. Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-08-04 13:33:15 +00:00
<xsl:if test="$pagesrc = 'docs/libvirt-go-xml.rst'">
docs: point go imports to gitlab.com repos The gitlab.com repos are the primary source, with libvirt.org just a read-only mirror. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2021-07-02 10:50:20 +00:00
<meta name="go-import" content="libvirt.org/libvirt-go-xml git https://gitlab.com/libvirt/libvirt-go-xml.git"/>
docs: add pages to support Go module package resolution Currently the libvirt Go modules are accessed by applications using their github repository URLs. This is undesirable as we don't want applications to have a direct dependancy on a specific source repo location. We want to enable applications to use the Go packages via the libvirt.org namespace. When you do "go get libvirt.org/libvirt-go", the Go client will do an HTTPS request to that URL, and parse the HTML content to look for a <meta> tag which tells it where to the find the GIT repository. https://golang.org/cmd/go/#hdr-Remote_import_paths This adds two pages to support this Go module resolution. They are not linked from anywhere as we don't expect users to actually look at them. If someone does happen upon them, there's some boilerplate text to send them off to godoc.org for API documentation. Since the pages we're adding have a .html extension, we will also use a small apache config tweak on the server RewriteEngine on RewriteRule ^/libvirt-go$ /libvirt-go.html [L] RewriteRule ^/libvirt-go-xml$ /libvirt-go-xml.html [L] Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-12-16 10:06:50 +00:00
</xsl:if>
docs: add go-import meta tags for new go modules Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2021-07-02 10:54:03 +00:00
<xsl:if test="$pagesrc = 'docs/go/libvirt.rst'">
<meta name="go-import" content="libvirt.org/go/libvirt git https://gitlab.com/libvirt/libvirt-go-module.git"/>
</xsl:if>
<xsl:if test="$pagesrc = 'docs/go/libvirtxml.rst'">
<meta name="go-import" content="libvirt.org/go/libvirtxml git https://gitlab.com/libvirt/libvirt-go-xml-module.git"/>
</xsl:if>
docs: adapt filling of <head> section for rst2html output The HTML from rst2html doesn't have <h1> immediately under the <body> tag, instead there is at least one <div> in between. There are also many things added in the <head> section that we don't want to have copied over, since our templating system already adds suitable <head> elements. We only need to copy the <script> to make index.html work. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 14:58:56 +00:00
<xsl:apply-templates select="/html:html/html:head/html:script" mode="content"/>
docs: make website responsive for mobile devices The website does not look good in a mobile device as the text is far too small and the layout assumes a wide screen. Make the style dynamically adapt based on viewport size, so a mobile device gets a layout more suited to its dimensions, also changing "Learn" to "Docs" Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-08-04 12:29:43 +00:00
docs: move javascript logic into a standalone file Instead of duplicating javascript in every single page, put it in a standalone file which can be cached by the browser. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-04-05 12:59:31 +00:00
<script type="text/javascript" src="{$href_base}js/main.js">
<xsl:comment>// forces non-empty element</xsl:comment>
docs: make website responsive for mobile devices The website does not look good in a mobile device as the text is far too small and the layout assumes a wide screen. Make the style dynamically adapt based on viewport size, so a mobile device gets a layout more suited to its dimensions, also changing "Learn" to "Docs" Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-08-04 12:29:43 +00:00
</script>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
</head>
docs: move javascript logic into a standalone file Instead of duplicating javascript in every single page, put it in a standalone file which can be cached by the browser. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-04-05 12:59:31 +00:00
<body onload="pageload()">
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
<div id="body">
docs: xsl: Unify stylability of main container element page.xsl was adding '<div id="content">' wrapper for the content picked up from the <body> element from the original input file. Optionally class="$DOCNAME" was added for some documents taken from <body>. Since docs generated from RST by docutils have a '<div class='document' id='$DOCNAME>' we actually don't need an extra wrapper for them. Additionally if we standardize on one of them we can use the same styles for both. I've picked the latter because it makes more sense to use the document name as 'id'. This patch: 1) Modifies the XSL trasformation to add the wrapper only if it's not present. 2) Modifies the XSL transformation to use 'id' for document name and class='document' for the wrapper element. 3) Changes docs.html/index.html/hvsupport.html to use 'id' instead of 'class' for document name. 4) Modifies the main stylesheet to keep styling the elements properly Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 15:27:32 +00:00
<xsl:choose>
docs: Adapt to semantic tag usage of docutils-0.17 and later Docutils-0.17 switched to using <main> instead of a <div class='document'> and <section> instead of <div class='section'>. To ensure that our pages still work we need to slightly adapt our XSL stylesheet to select the <main> tag properly and adapt the CSS to also select the 'section' element instead of a class and to apply to a <main> tag with the appropriate names. Docutils-0.17 also changed to use 'h2' for section heading instead of 'h1'. Note the styles applied to the 'main' element with certain id can't be made more universal by just applying to the id itself, as in certain cases (e.g. 'documentation') we also have sections with that name. This was previously ensured by also matching the 'document' class which would make it equal to the 'main' element. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Martin Kletzander <mkletzan@redhat.com> Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
2022-04-12 11:00:45 +00:00
<!-- docutils-0.16 and older use a div as container for contents -->
docs: xsl: Unify stylability of main container element page.xsl was adding '<div id="content">' wrapper for the content picked up from the <body> element from the original input file. Optionally class="$DOCNAME" was added for some documents taken from <body>. Since docs generated from RST by docutils have a '<div class='document' id='$DOCNAME>' we actually don't need an extra wrapper for them. Additionally if we standardize on one of them we can use the same styles for both. I've picked the latter because it makes more sense to use the document name as 'id'. This patch: 1) Modifies the XSL trasformation to add the wrapper only if it's not present. 2) Modifies the XSL transformation to use 'id' for document name and class='document' for the wrapper element. 3) Changes docs.html/index.html/hvsupport.html to use 'id' instead of 'class' for document name. 4) Modifies the main stylesheet to keep styling the elements properly Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 15:27:32 +00:00
<xsl:when test="html:html/html:body/html:div/@class='document'">
<xsl:apply-templates select="/html:html/html:body/*" mode="content"/>
</xsl:when>
docs: Adapt to semantic tag usage of docutils-0.17 and later Docutils-0.17 switched to using <main> instead of a <div class='document'> and <section> instead of <div class='section'>. To ensure that our pages still work we need to slightly adapt our XSL stylesheet to select the <main> tag properly and adapt the CSS to also select the 'section' element instead of a class and to apply to a <main> tag with the appropriate names. Docutils-0.17 also changed to use 'h2' for section heading instead of 'h1'. Note the styles applied to the 'main' element with certain id can't be made more universal by just applying to the id itself, as in certain cases (e.g. 'documentation') we also have sections with that name. This was previously ensured by also matching the 'document' class which would make it equal to the 'main' element. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Martin Kletzander <mkletzan@redhat.com> Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
2022-04-12 11:00:45 +00:00
<!-- docutils-0.17 adopted use of the 'main' semantic container -->
<xsl:when test="html:html/html:body/html:main">
<xsl:apply-templates select="/html:html/html:body/*" mode="content"/>
</xsl:when>
<!-- for our older html-only files -->
docs: xsl: Unify stylability of main container element page.xsl was adding '<div id="content">' wrapper for the content picked up from the <body> element from the original input file. Optionally class="$DOCNAME" was added for some documents taken from <body>. Since docs generated from RST by docutils have a '<div class='document' id='$DOCNAME>' we actually don't need an extra wrapper for them. Additionally if we standardize on one of them we can use the same styles for both. I've picked the latter because it makes more sense to use the document name as 'id'. This patch: 1) Modifies the XSL trasformation to add the wrapper only if it's not present. 2) Modifies the XSL transformation to use 'id' for document name and class='document' for the wrapper element. 3) Changes docs.html/index.html/hvsupport.html to use 'id' instead of 'class' for document name. 4) Modifies the main stylesheet to keep styling the elements properly Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 15:27:32 +00:00
<xsl:otherwise>
<div class="document">
<xsl:if test="html:html/html:body/@id">
<xsl:attribute name="id">
<xsl:value-of select="html:html/html:body/@id"/>
</xsl:attribute>
</xsl:if>
<xsl:apply-templates select="/html:html/html:body/*" mode="content"/>
</div>
</xsl:otherwise>
</xsl:choose>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
</div>
docs: switch to new website banner Use a dark banner whose color matches the dark green used in the logo. Introduce a newly rendered version of the header logo derived from new SVG file, instead of old one from (now lost) Adobe Illustrator file. The top banner logo now links to the front page as is common practice for most websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:16:29 +00:00
<div id="nav">
<div id="home">
<a href="{$href_base}index.html">Home</a>
</div>
docs: add three core links in the header bar Add links to download, communicate and learn in the header bar, as the main jumping off points for navigation. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 15:27:10 +00:00
<div id="jumplinks">
<ul>
docs: Use href_base in absolute links That way all links work even if you click them in a subdirectory. Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2016-12-14 10:24:40 +00:00
<li><a href="{$href_base}downloads.html">Download</a></li>
<li><a href="{$href_base}contribute.html">Contribute</a></li>
docs: make website responsive for mobile devices The website does not look good in a mobile device as the text is far too small and the layout assumes a wide screen. Make the style dynamically adapt based on viewport size, so a mobile device gets a layout more suited to its dimensions, also changing "Learn" to "Docs" Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-08-04 12:29:43 +00:00
<li><a href="{$href_base}docs.html">Docs</a></li>
docs: add three core links in the header bar Add links to download, communicate and learn in the header bar, as the main jumping off points for navigation. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 15:27:10 +00:00
</ul>
</div>
docs: switch to new website banner Use a dark banner whose color matches the dark green used in the logo. Introduce a newly rendered version of the header logo derived from new SVG file, instead of old one from (now lost) Adobe Illustrator file. The top banner logo now links to the front page as is common practice for most websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:16:29 +00:00
<div id="search">
docs: add advanced search capabilities Allow targetting the search scope to the website, wiki or mailing lists only. When javascript is disabled this should gracefully fallback to only searching the website. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-04-05 15:49:05 +00:00
<form id="simplesearch" action="https://www.google.com/search" enctype="application/x-www-form-urlencoded" method="get">
<div>
<input id="searchsite" name="sitesearch" type="hidden" value="libvirt.org"/>
<input id="searchq" name="q" type="text" size="12" value=""/>
<input name="submit" type="submit" value="Go"/>
</div>
docs: switch to new website banner Use a dark banner whose color matches the dark green used in the logo. Introduce a newly rendered version of the header logo derived from new SVG file, instead of old one from (now lost) Adobe Illustrator file. The top banner logo now links to the front page as is common practice for most websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:16:29 +00:00
</form>
docs: add advanced search capabilities Allow targetting the search scope to the website, wiki or mailing lists only. When javascript is disabled this should gracefully fallback to only searching the website. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-04-05 15:49:05 +00:00
<div id="advancedsearch">
<span><input type="radio" name="what" id="whatwebsite" checked="checked" value="website"/><label for="whatwebsite">Website</label></span>
<span><input type="radio" name="what" id="whatwiki" value="wiki"/><label for="whatwiki">Wiki</label></span>
<span><input type="radio" name="what" id="whatdevs" value="devs"/><label for="whatdevs">Developers list</label></span>
<span><input type="radio" name="what" id="whatusers" value="users"/><label for="whatusers">Users list</label></span>
</div>
docs: switch to new website banner Use a dark banner whose color matches the dark green used in the logo. Introduce a newly rendered version of the header logo derived from new SVG file, instead of old one from (now lost) Adobe Illustrator file. The top banner logo now links to the front page as is common practice for most websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:16:29 +00:00
</div>
</div>
docs: add footer to all pages Add a footer to all pages containing a blurb about the code of conduct, and links to various communication channels / social media / user self-help sites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:56:50 +00:00
<div id="footer">
<div id="contact">
<h3>Contact</h3>
<ul>
docs: page.xsl: Fix link to 'mailing-lists' section Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2022-05-31 12:52:53 +00:00
<li><a href="{$href_base}contact.html#mailing-lists">email</a></li>
docs: Use href_base in absolute links That way all links work even if you click them in a subdirectory. Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2016-12-14 10:24:40 +00:00
<li><a href="{$href_base}contact.html#irc">irc</a></li>
docs: add footer to all pages Add a footer to all pages containing a blurb about the code of conduct, and links to various communication channels / social media / user self-help sites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:56:50 +00:00
</ul>
</div>
<div id="community">
<h3>Community</h3>
<ul>
docs: replace footer link to the bird site with mastodon Since the takeover of the bird site, the bulk of tech people who want a more friendly and inclusive media site have jumped over to Mastodon. With its decentralized nature, there's no one replacement that captures everything, but the fosstodon.org site is a topic relevant choice. Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2022-12-12 11:44:14 +00:00
<li><a href="https://fosstodon.org/tags/libvirt">fosstodon</a></li>
Prefer https: everywhere where possible Use https: links for websites that support them. The URIs which are used as namespace identifiers are left alone. Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Erik Skultety <eskultet@redhat.com> Reviewed-by: Neal Gompa <ngompa13@gmail.com>
2020-08-25 22:44:00 +00:00
<li><a href="https://stackoverflow.com/questions/tagged/libvirt">stackoverflow</a></li>
<li><a href="https://serverfault.com/questions/tagged/libvirt">serverfault</a></li>
docs: add footer to all pages Add a footer to all pages containing a blurb about the code of conduct, and links to various communication channels / social media / user self-help sites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:56:50 +00:00
</ul>
</div>
docs: build: Use proper path to file in 'contribute' link NEWS.rst is based in the root of the repository and 'hvsupport.html' doesn't have a backing file which can be edited since it's fully generated. Our 'contribute -> edit this page' link on the bottom of the page is wrong in those cases. Fix it by adding the contribute section only when there's a source and base the 'source' of a html file in the root of the repository. Along with that we need to modify the scripts/meson-html-gen.py script to accept optional 'pagesrc' and the XSL template to skip the 'contribute' section when we don't have a source. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-08-03 14:38:31 +00:00
<xsl:if test="$pagesrc != ''">
<div id="contribute">
<h3>Contribute</h3>
<ul>
<li><a href="https://gitlab.com/libvirt/libvirt/-/blob/master/{$pagesrc}">edit this page</a></li>
</ul>
</div>
</xsl:if>
docs: add footer to all pages Add a footer to all pages containing a blurb about the code of conduct, and links to various communication channels / social media / user self-help sites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:56:50 +00:00
<div id="conduct">
docs: page.xsl: Update anchor to the 'Code of conduct' paragraph Use the anchor name as generated by rst2html. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2022-03-07 15:05:23 +00:00
Participants in the libvirt project agree to abide by <a href="{$href_base}governance.html#code-of-conduct">the project code of conduct</a>
docs: add footer to all pages Add a footer to all pages containing a blurb about the code of conduct, and links to various communication channels / social media / user self-help sites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2016-10-25 14:56:50 +00:00
</div>
<br class="clear"/>
</div>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
</body>
</html>
</xsl:template>
Add documentation for access control system This adds two new pages to the website, acl.html describing the general access control framework and permissions models, and aclpolkit.html describing the use of polkit as an access control driver. page.xsl is modified to support a new syntax <div id="include" filename="somefile.htmlinc"/> which will cause the XSL transform to replace that <div> with the contents of 'somefile.htmlinc'. We use this in the acl.html.in file, to pull the table of permissions for each libvirt object. This table is autogenerated from the enums in src/access/viraccessperms.h by the genaclperms.pl script. newapi.xsl is modified so that the list of permissions checks shown against each API will link to the description of the permissions in acl.html Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-08-08 10:51:01 +00:00
<xsl:template name="include">
<xsl:variable name="inchtml">
docs: fix include of ACL permissions files The XSL generator loads included HTML files relative to the source dir but we need to tell it to load them from the build dir instead. Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-11-20 15:24:18 +00:00
<xsl:copy-of select="document(concat($builddir, '/docs/', @filename))"/>
Add documentation for access control system This adds two new pages to the website, acl.html describing the general access control framework and permissions models, and aclpolkit.html describing the use of polkit as an access control driver. page.xsl is modified to support a new syntax <div id="include" filename="somefile.htmlinc"/> which will cause the XSL transform to replace that <div> with the contents of 'somefile.htmlinc'. We use this in the acl.html.in file, to pull the table of permissions for each libvirt object. This table is autogenerated from the enums in src/access/viraccessperms.h by the genaclperms.pl script. newapi.xsl is modified so that the list of permissions checks shown against each API will link to the description of the permissions in acl.html Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-08-08 10:51:01 +00:00
</xsl:variable>
<xsl:apply-templates select="exsl:node-set($inchtml)/html:html/html:body/*" mode="content"/>
</xsl:template>
docs: add a permalink to html headers Quite often, I need to cite URLs like http://libvirt.org/formatnetwork.html#elementQoS but it is annoying to copy them from the table of contents or the html source. This patch borrows from the Python documentation in order to make it easier to cite headers on libvirt's oneline documentation.
2013-12-08 14:05:46 +00:00
docs: generate permalinks correctly for rst2html output The rst2html output generates the links for headings in a slightly different way than we do for docs written in HTML, so we must match another scenario when generating back links. rst2html will also use <h1> tags for both the document title and the first level of section titles, so we must expand the matching to allow for this too. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-11-11 15:53:02 +00:00
<xsl:template match="html:h1 | html:h2 | html:h3 | html:h4 | html:h5 | html:h6" mode="content">
docs/page.xls: remove unnecessary namespace attribute It breaks the build on RHEL-5.10 and because it's only optional we could remove it from the code. The default namespace will be used. This hunk was introduced by commit 237a088ba44633b08e0528fe5103d99b1e213b71. Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
2014-01-30 14:37:38 +00:00
<xsl:element name="{name()}">
docs: add a permalink to html headers Quite often, I need to cite URLs like http://libvirt.org/formatnetwork.html#elementQoS but it is annoying to copy them from the table of contents or the html source. This patch borrows from the Python documentation in order to make it easier to cite headers on libvirt's oneline documentation.
2013-12-08 14:05:46 +00:00
<xsl:apply-templates mode="copy" />
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<xsl:if test="./html:a/@id">
docs: xslt: Use 'Link' rather than 'Permalink' in header links The anchors are based on the article or chapter headers, thus they are not 100% permanent. Especially with pages generated from RST. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-03 13:28:21 +00:00
<a class="headerlink" href="#{html:a/@id}" title="Link to this headline">&#xb6;</a>
docs: add a permalink to html headers Quite often, I need to cite URLs like http://libvirt.org/formatnetwork.html#elementQoS but it is annoying to copy them from the table of contents or the html source. This patch borrows from the Python documentation in order to make it easier to cite headers on libvirt's oneline documentation.
2013-12-08 14:05:46 +00:00
</xsl:if>
docs: page.xsl: Improve generation of paragraph anchor links Use the 'parent' axis to check whether the parent is a div with class='section' rather than looking for 'toc-backref' anchor to see whether to generate one of the headerlink alternatives. Both hare docutils-specific thus apply to docs generated from RST documents. This adds the links for pages generated from RST documents which don't have a table of contents (and thus lack the 'toc-backref' anchors) and thus fixes pages such as hacking.html and news.html to have reasonable links which can be shared. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-10-26 12:44:19 +00:00
<xsl:if test="parent::html:div[@class='section']">
docs: xslt: Use 'Link' rather than 'Permalink' in header links The anchors are based on the article or chapter headers, thus they are not 100% permanent. Especially with pages generated from RST. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-03 13:28:21 +00:00
<a class="headerlink" href="#{../@id}" title="Link to this headline">&#xb6;</a>
docs: generate permalinks correctly for rst2html output The rst2html output generates the links for headings in a slightly different way than we do for docs written in HTML, so we must match another scenario when generating back links. rst2html will also use <h1> tags for both the document title and the first level of section titles, so we must expand the matching to allow for this too. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-11-11 15:53:02 +00:00
</xsl:if>
docs: add a permalink to html headers Quite often, I need to cite URLs like http://libvirt.org/formatnetwork.html#elementQoS but it is annoying to copy them from the table of contents or the html source. This patch borrows from the Python documentation in order to make it easier to cite headers on libvirt's oneline documentation.
2013-12-08 14:05:46 +00:00
</xsl:element>
</xsl:template>
docs: Fix template matching in page.xsl Our last default template had a match of "node()" which incidentally matched everything, including text nodes. Since this has the same priority according to the XSLT spec, section 5.5: https://www.w3.org/TR/1999/REC-xslt-19991116#conflict this is an error. Also according to the same spec section, the XSLT processor may signal the error or pick the last rule. This was uncovered with libxslt 1.1.35 which contains the following commit: https://gitlab.gnome.org/GNOME/libxslt/-/commit/b0074eeca3c6b21b4da14fdf712b853900c51635 which makes the build fail with: runtime error: file ../docs/page.xsl line 223 element element xsl:element: The effective name '' is not a valid QName. because our last rule also matches text nodes and we are trying to extract the node name out of them. To fix this we change the match to "*" which only matches elements and not all the nodes, and to avoid any possible errors with different XSLT processors we also bump the priority of the match="text()" rule a little higher, just in case someone needs to use an XSLT processor that chooses signalling the error instead of the optional recovery. https://bugs.gentoo.org/833586 Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2022-02-21 08:26:13 +00:00
<xsl:template match="text()" mode="copy" priority="0">
docs: add a permalink to html headers Quite often, I need to cite URLs like http://libvirt.org/formatnetwork.html#elementQoS but it is annoying to copy them from the table of contents or the html source. This patch borrows from the Python documentation in order to make it easier to cite headers on libvirt's oneline documentation.
2013-12-08 14:05:46 +00:00
<xsl:value-of select="."/>
</xsl:template>
docs: Fix template matching in page.xsl Our last default template had a match of "node()" which incidentally matched everything, including text nodes. Since this has the same priority according to the XSLT spec, section 5.5: https://www.w3.org/TR/1999/REC-xslt-19991116#conflict this is an error. Also according to the same spec section, the XSLT processor may signal the error or pick the last rule. This was uncovered with libxslt 1.1.35 which contains the following commit: https://gitlab.gnome.org/GNOME/libxslt/-/commit/b0074eeca3c6b21b4da14fdf712b853900c51635 which makes the build fail with: runtime error: file ../docs/page.xsl line 223 element element xsl:element: The effective name '' is not a valid QName. because our last rule also matches text nodes and we are trying to extract the node name out of them. To fix this we change the match to "*" which only matches elements and not all the nodes, and to avoid any possible errors with different XSLT processors we also bump the priority of the match="text()" rule a little higher, just in case someone needs to use an XSLT processor that chooses signalling the error instead of the optional recovery. https://bugs.gentoo.org/833586 Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2022-02-21 08:26:13 +00:00
<xsl:template match="*" mode="copy">
docs/page.xls: remove unnecessary namespace attribute It breaks the build on RHEL-5.10 and because it's only optional we could remove it from the code. The default namespace will be used. This hunk was introduced by commit 237a088ba44633b08e0528fe5103d99b1e213b71. Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
2014-01-30 14:37:38 +00:00
<xsl:element name="{name()}">
docs: add a permalink to html headers Quite often, I need to cite URLs like http://libvirt.org/formatnetwork.html#elementQoS but it is annoying to copy them from the table of contents or the html source. This patch borrows from the Python documentation in order to make it easier to cite headers on libvirt's oneline documentation.
2013-12-08 14:05:46 +00:00
<xsl:copy-of select="./@*"/>
<xsl:apply-templates mode="copy" />
</xsl:element>
</xsl:template>
docs: replace CRLF with LF
2011-01-28 12:52:18 +00:00
</xsl:stylesheet>
Reference in New Issue Copy Permalink