shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-27 07:22:07 +03:00
Code Releases Activity
1bbcc79e0e
libvirt/docs/devguide.html.in

43 lines
1.8 KiB
HTML
Raw Normal View History

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 18:25:37 +04: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 20:01:25 +03:00
<!DOCTYPE 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 18:25:37 +04:00
<html xmlns="http://www.w3.org/1999/xhtml">
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
<body>
docs: Update devguide.html to point to the new Python dev guide We have a new libvirt-appdev-guide-python which we need to promote to users. Rewrite the existing page to mention it too. Also use the new URL location which is automatically refreshed once a day. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2015-09-10 14:15:45 +03:00
<h1>libvirt Application Development Guides</h1>
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
<p>
docs: Update devguide.html to point to the new Python dev guide We have a new libvirt-appdev-guide-python which we need to promote to users. Rewrite the existing page to mention it too. Also use the new URL location which is automatically refreshed once a day. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2015-09-10 14:15:45 +03:00
The libvirt API is accessible from a number of programming languages.
At this time, there are application development guides available
which cover the C API and the Python API. Of the two, the Python guide
is currently the more comprehensive document.
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
</p>
<ul>
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-10-13 18:30:41 +03:00
<li><a href="https://libvirt.org/docs/libvirt-appdev-guide/en-US/html/">Application Development Guide (C language) HTML</a></li>
<li><a href="https://libvirt.org/docs/libvirt-appdev-guide/en-US/pdf/">Application Development Guide (C language) PDF</a></li>
<li><a href="https://libvirt.org/docs/libvirt-appdev-guide-python/en-US/html/">Application Development Guide (Python language) HTML</a></li>
<li><a href="https://libvirt.org/docs/libvirt-appdev-guide-python/en-US/pdf/">Application Development Guide (Python language) PDF</a></li>
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
</ul>
docs: Update devguide.html to point to the new Python dev guide We have a new libvirt-appdev-guide-python which we need to promote to users. Rewrite the existing page to mention it too. Also use the new URL location which is automatically refreshed once a day. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2015-09-10 14:15:45 +03:00
<h2>Contributing content</h2>
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
<p>
docs: Update devguide.html to point to the new Python dev guide We have a new libvirt-appdev-guide-python which we need to promote to users. Rewrite the existing page to mention it too. Also use the new URL location which is automatically refreshed once a day. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2015-09-10 14:15:45 +03:00
These guides are written in DocBook and published with the
publican tool, which is also used for Fedora and Red Hat
documentation. The original content is provided in GIT and
any contributions to the guide are welcome.
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
</p>
<pre>
devguide.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-12 01:40:27 +03:00
# C language
docs: update all GIT repo examples to use https:// protocol The https:// protocol is much more reliably usable than git:// when faced with unreasonably strict firewalls. The libvirt.org web server is now setup to support the smart https:// protocol, which is just as fast as git://, so change all the docs to use https:// Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2018-03-20 15:35:00 +03:00
$ git clone <a href="https://libvirt.org/git/?p=libvirt-appdev-guide.git">https://libvirt.org/git/libvirt-appdev-guide.git</a>
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
devguide.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-12 01:40:27 +03:00
# Python language
docs: update all GIT repo examples to use https:// protocol The https:// protocol is much more reliably usable than git:// when faced with unreasonably strict firewalls. The libvirt.org web server is now setup to support the smart https:// protocol, which is just as fast as git://, so change all the docs to use https:// Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2018-03-20 15:35:00 +03:00
$ git clone <a href="https://libvirt.org/git/?p=libvirt-appdev-guide-python.git">https://libvirt.org/git/libvirt-appdev-guide-python.git</a>
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
devguide.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-12 01:40:27 +03:00
# Publican Style/Theme
docs: update all GIT repo examples to use https:// protocol The https:// protocol is much more reliably usable than git:// when faced with unreasonably strict firewalls. The libvirt.org web server is now setup to support the smart https:// protocol, which is just as fast as git://, so change all the docs to use https:// Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2018-03-20 15:35:00 +03:00
$ git clone <a href="https://libvirt.org/git/?p=libvirt-publican.git">https://libvirt.org/git/libvirt-publican.git</a>
docs: Update devguide.html to point to the new Python dev guide We have a new libvirt-appdev-guide-python which we need to promote to users. Rewrite the existing page to mention it too. Also use the new URL location which is automatically refreshed once a day. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2015-09-10 14:15:45 +03:00
</pre>
docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake.
2010-09-10 13:26:05 +04:00
</body>
</html>
Copy Permalink