Commit Graph

46 Commits

Author SHA1 Message Date
Peter Krempa
e49b305c56 docs: site: Don't generate '<?xml' header for HTML documents
Skip the XML header as it's invalid with <!DOCTYPE HTML> both for the
RST-generated pages and for the API docs generated from the API XML.

Additionally remove the spurious xsl:output directive from newapi.xsl
which is ignored and thus misleading.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
2024-03-01 12:51:55 +01:00
Peter Krempa
c4e35af08c docs: page.xsl: Split up 'href_base' for assets and links
To allow reuse of this template as-is in libvirt-wiki, we need to be
able to specify a distinct asset_href_base and link_href_base. Adjust
the template to allow that.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
2024-02-08 16:48:47 +01:00
Peter Krempa
8c0e313339 docs: Move 'html including' from page.xsl to site.xsl
Strip down the main template as much as possible.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
2024-02-08 16:48:47 +01:00
Peter Krempa
98ffd82060 docs: Simplify passing of 'href_base' XSL variable
Historically we had two top level XSL files for top level and nested
documents which only differ in what they pass for 'href_base' to the
main 'page.xsl' file.

We can instead pass the variable as argument from the build system so
that we have just one XSL file and also allow for more nested document
trees in the future.

The '404' page is special even with the current XSL way so we add a
special case for it.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2022-04-12 12:53:32 +02:00
Daniel P. Berrangé
08376431b4 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 17:06:33 +01:00
Daniel P. Berrangé
10ae8eb59c 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-09 12:01:49 +01:00
Daniel P. Berrange
b1c81567c7 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-08-02 17:00:11 +01:00
Martin Kletzander
a54c962286 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 17:47:25 +02:00
Daniel P. Berrange
7ee85c9900 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 16:58:46 +01:00
Martin Kletzander
3924072e4e docs: fix 404 page when fetched from different location
Error 404 page had relative paths specified for both the image and
stylesheets which caused a problem when requested URL included a
subfolder (e.g. http://libvirt.org/asdf/asdf ). This patch corrects
this behaviour by modifying href_base to '/' (for style-sheets) and
changing the src of the image (to be '/' always).
2012-08-10 10:54:23 +02:00
Daniel Veillard
5362edd442 Change generated HTML to UTF-8 encoding
* docs/ChangeLog.xsl docs/newapi.xsl docs/site.xsl: change all
  stylesheets to output UTF-8 HTML instead of ISO Latin 1 which was
  breaking on some people names.
2009-12-08 16:09:33 +01:00
Matthias Bolte
dad6ecc6bf Change DTD references to use public instead of system identifier
Debian's /etc/xml/catalog doesn't contain system identifiers, so use
public identifiers instead.

* docs/Makefile.am: use public instead of system identifier
* docs/site.xsl: use matching public identifier
2009-11-15 15:13:03 +01:00
Daniel P. Berrange
d62a9f2390 Adapt layout to workaround IE6 bugs 2008-04-25 16:23:51 +00:00
Daniel P. Berrange
9092c3d491 Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00
Daniel Veillard
a528e97383 typos fixes
* docs//* src/conf.c src/hash.c src/libvirt.c src/proxy_internal.c
 src/remote_internal.c src/virsh.c src/xen_internal.c
 src/xend_internal.c src/xml.c: applied patch from Atsushi SAKAI
 fixing a lot of typos
Daniel
2008-04-04 07:58:29 +00:00
Daniel P. Berrange
8b6b21d41c Added docs on storage management capabilities 2008-02-20 15:58:06 +00:00
Jim Meyering
e04912a9f0 Remove all trailing blanks; turn on the rule to detect them.
* Makefile.cfg (local-checks-to-skip): Remove sc_trailing_blank.
* .x-sc_trailing_blank: New file, to exempt the few binary files.
2008-02-05 19:27:37 +00:00
Daniel Veillard
d3043afe5c Remove docs/API*.html
* docs/API* docs/api.xsl docs/site.xsl docs/Makefile.am: remove the
  generation of the API*.html files as it's not really useful here
Daniel
2008-01-21 08:08:33 +00:00
Daniel P. Berrange
0e5f5da3db Added docs on authentication setup 2007-12-05 19:16:13 +00:00
Daniel Veillard
b4438e5933 * docs/site.xsl docs/libvir.html *.html: add boilerplate for
a Windows support page
Daniel
2007-11-27 15:41:32 +00:00
Daniel Veillard
90da74aee9 fix links again, Daniel 2007-11-26 14:16:03 +00:00
Daniel Veillard
3e59effd03 * doc/*: modified the python page into a bindings page,
added the Ruby binding link to all pages
Daniel
2007-11-26 14:07:56 +00:00
Richard W.M. Jones
207962bb1a Wed Nov 21 11:59:00 UTC 2007 Richard W.M. Jones <rjones@redhat.com>
* docs/libvir.html, docs/site.xsl: Fix the link to OCaml
	  bindings.
2007-11-21 12:02:40 +00:00
Daniel Veillard
50804b725b * docs/libvir.html docs/site.xsl: small updates with references
to CIM and OpenVZ
* po/*: updated translations
Daniel
2007-11-07 13:40:19 +00:00
Richard W.M. Jones
4c0f24c10f Tue Jun 29 13:44:00 BST 2007 Richard W.M. Jones <rjones@redhat.com>
* docs/site.xsl, docs/libvir.html, docs/hvsupport.html:
	  Document which libvirt versions supported various
	  hypervisor calls.
2007-06-29 12:44:57 +00:00
Richard W.M. Jones
2670b9c80a Mon Jun 25 09:19:00 BST 2007 Richard W.M. Jones <rjones@redhat.com>
* docs/site.xsl: Added link to OCaml bindings.
2007-06-25 08:40:38 +00:00
Daniel Veillard
995235b13c * docs/site.xsl docs/libvirt.html docs/uri.html docs/*.html:
adding a placeholder for the new URIs page, update the
  stylesheet to generate a new page, rebuilt.
Daniel
2007-06-19 13:43:28 +00:00
Daniel Veillard
435ce72149 * docs/remote.html docs/site.html docs/*.html: added a stub for
the remote page, added it to stylesheet and regenerated
Daniel
2007-04-18 09:58:35 +00:00
Daniel Veillard
fab8e90e6d * docs/site.xsl docs/*.html: add links to virt-manager
Daniel
2006-08-25 23:16:21 +00:00
Daniel Veillard
aa13b2aa79 * docs//* : fixed perl binding URL to point to CPAN as provided by
Daniel P. Berrange.
Daniel
2006-04-26 06:43:42 +00:00
Daniel Veillard
7743c7a7b1 * doc/site.xsl doc/libvir.html doc/*: added informations about
the Perl bindings, regenerated
* python/libvirt_wrap.h: added a missing include.
Daniel
2006-03-28 09:50:17 +00:00
Daniel Veillard
72b838fffc * configure.in: applied patch for --with-xen-distdir option from
Ronald Aigner
* docs/site.xsl docs/*.html: added link to Bugzilla
Daniel
2006-03-10 10:21:41 +00:00
Daniel Veillard
6c5a225725 * docs/errors.html docs/libvir.html docs/*: added a page about
error handling and regenerated the docs
Daniel
2006-02-28 13:58:30 +00:00
Daniel Veillard
7d28bba98d Fixing link to search.php, Daniel 2006-02-24 22:42:27 +00:00
Daniel Veillard
d3a15eb303 * TODO: updated
* python/tests/Makefile.am: fix a small PYTHONPATH bug
* docs//*: fixed the xsl a bit for toc names, added doc for
  the python bindings, regenerated
Daniel
2006-02-21 13:23:16 +00:00
Daniel Veillard
9a2ec00a05 * src/libvirt.c src/xend_internal.c src/xend_internal.h: move the
XML dump function around to make sure all entry points are centralized
  in libvirt.c and also avoid doc generation troubles.
* docs/examples/Makefile.am docs/examples/index.py: fix the makefile
  a bit.
* TODO: updated
* docs/format.html: added a description of the XML used for the
  domains.
* docs//*: rebuilt
Daniel
2006-02-20 23:08:47 +00:00
Daniel Veillard
9c5111b9c9 * docs/examples/examples.xsl docs/examples/index.html
docs/site.xsl: integates the examples page in the web site
* docs//* : fixed generator and rebuilt the docs
* python/tests/basic.py python/tests/create.py: couple cleanups
Daniel
2006-02-20 20:50:48 +00:00
Daniel Veillard
8c423e6c83 * //* : renamed the project libvirt , this affects all makefiles,
the specs, the icons, the docs, etc ...
* configure.in: prepare for 0.0.3
Daniel
2006-02-09 17:45:11 +00:00
Daniel Veillard
eece06a14f * docs/site.xsl docs/*.html: credits to Diana Fong for graphics
and web site design
Daniel
2006-01-29 08:52:59 +00:00
Daniel Veillard
46202b3705 * docs/site.xsl docs/*.png docs/*.html: update the images from Diana,
added favicon to page.
* src/libvir.c: reorganized the include imports.
Daniel
2006-01-23 22:55:41 +00:00
Daniel Veillard
ff97523083 * doc//*: mostly finished the revamp in the plane, starts to look good
Daniel
2006-01-21 23:34:36 +00:00
Daniel Veillard
76777c51f7 * doc/* : total revamp of the web site based on Diana Fong design
but not completely integrated yet
Daniel
2006-01-20 15:49:04 +00:00
Daniel Veillard
2b019dd2f7 * docs/architecture.* docs/*: added a section on the architecture
and regenerated the docs.
Daniel
2005-12-21 16:59:34 +00:00
Daniel Veillard
b9ae742930 * docs/*: adding missing links to API page.
Daniel
2005-12-07 14:09:33 +00:00
Daniel Veillard
cf65cf953f * docs/* docs/html/*: more work on the docs generation
* include/libvir.h: adding informations on the header
Daniel
2005-12-07 10:59:26 +00:00
Daniel Veillard
d3b96d4a00 * configure.in docs/FAQ.html docs/Libxml2-Logo-90x34.gif
docs/Makefile.am docs/bugs.html docs/index.html docs/intro.html
  docs/libvir.html docs/redhat.gif docs/site.xsl: starting to add
  the web site, based on libxml2 one.
* src/hash.c: add a missing include
Daniel
2005-12-07 09:33:00 +00:00