[% USE date -%]
[%
# This global template is included in every HTML file.  It is
# included before the DOCTYPE and it *must not* generate any
# output.  Be careful to chomp!  However it is a very useful
# place to put global variables.  Note that the only variable
# that is passed in here is topdir.

year = date.format(date.now, '%Y')
printable_date = date.format

# These are the sections / tabs of the site as they appear in
# the navigation at the top of all pages.

sections = [ "home", "learning", "docs", "faq", "about", "contact" ]

section_titles.home = "Home"
section_titles.learning = "Tutorials and videos"
section_titles.docs = "Documentation"
section_titles.faq = "FAQ"
section_titles.about = "About this site"
section_titles.contact = "Contact us"

section_paths.home = "/"
section_paths.learning = "/learning/"
section_paths.docs = "/docs/"
section_paths.faq = "/faq/"
section_paths.about = "/about/"
section_paths.contact = "/contact/"

# The full list of local resources under src/learning/
#
# Put new documents at the top.
#
# If the resource is really beginner level, then set difficulty = 0.
# Use this sparingly because these appear in 'Get started' on the
# front page of the site, and also at the top of the list.
#
# Other variables:
#   difficulty: Difficulty level 0 (absolute beginner) 1 (easy) .. 5 (hardest).
#   cmdline: (optional) Set to 1 if this involves using the command line.
#   author: (optional) String containing author's name.
#   date: (optional) Date last updated (use: date +%F)
#
# The text will be displayed to the user as:
#   <a href="/learning/[name]/">[link]</a> [rest]

learning_documents = [
  { difficulty = 0, cmdline = 1,
    name = "start-virt-tools",
    link = "Where to get virt tools.",
    rest = "Learn how to download or obtain virt tools on Fedora,
            Debian, Ubuntu, RHEL and more." },
  { difficulty = 0,
    name = "start-conventions",
    link = "Names and terms used in the rest of the documentation.",
    rest = "If you confused by words like <q>paravirt</q>, <q>migration</q>,
            <q>domain</q>, then start here." },
  { difficulty = 0,
    name = "start-install-with-virt-manager",
    link = "Install a virtual machine",
    rest = "with virt-manager.  A step by step guide to creating
            your first virtual machine using simple graphical tools." },
  { difficulty = 0,
    name = "start-vm-with-virt-manager",
    link = "Start and stop virtual machines",
    rest = "using graphical virt-manager." },
  { difficulty = 0, cmdline = 1,
    name = "start-list-with-command-line",
    link = "List virtual machines",
    rest = "from the command line and shell scripts." },
  { difficulty = 1, cmdline = 1,
    name = "start-stop-vm-with-command-line",
    link = "Start and stop virtual machines",
    rest = "from the command line and shell scripts." },
  { difficulty = 1, cmdline = 1,
    name = "check-hardware-virt",
    link = "Check if your hardware supports virtualization.",
    rest = "Hardware virtualization is supported by many but not all
            modern hardware.  If enabled it offers great performance
            benefits.  This article explains the different types of
            hardware virtualization and how to check if your hardware
            supports it." },
  { difficulty = 3, cmdline = 1,
    name = "install-with-command-line",
    link = "Install a virtual machine",
    rest = "using the command line.  Create a VM from the command line
            and shell scripts." },
  { difficulty = 5, cmdline = 1,
    author = "Richard W.M. Jones", date = "2010-10-12",
    name = "advanced-virt-df",
    link = "Advanced use of virt-df.",
    rest = "Check free disk space.  Regularly check from a cron job,
            draw graphs to predict future usage, and generate alerts
            if VMs are running low on space." },
]

# External documentation which appears on src/docs/
# This is for man pages, API documentation, etc which is hosted
# on upstream project sites.
#
# Variables:
#   project: Name of upstream project (used for categorization).
#   difficulty: Difficulty level 1 (easy) .. 5 (hardest).
#   url: Link to the resource.
#   name: Name of the resource.
#   description: Longer description of the resource.
#
# external_docs_projects is a list of the projects, and projects
# are displayed in this order on the docs/ page.

external_docs_projects = [ "libvirt", "libguestfs" ]

external_documents = [
    # Notable libvirt documentation.
    # XXX Go through libvirt.org site and find more.

    { project = "libvirt", difficulty = 4,
      url = "http://libvirt.org/html/libvirt-libvirt.html",
      name = "libvirt API documentation",
      description = "This is the main documentation for programming
        against the libvirt API." },

    { project = "libvirt", difficulty = 2,
      url = "http://libvirt.org/formatdomain.html",
      name = "libvirt domain XML",
      description = "This page documents the libvirt XML for
        domains (guests).  Use <code>virsh edit GuestName</code>
        to edit this for a particular libvirt guest." },

    # libguestfs man pages

    { project = "libguestfs", difficulty = 4,
      url = "http://libguestfs.org/guestfs.3.html",
      name = "libguestfs API documentation",
      description = "This is the main documentation for programming
        against the libguestfs API." },
    { project = "libguestfs", difficulty = 3,
      url = "http://libguestfs.org/guestfish.1.html",
      name = "guestfish manual page",
      description = "Guestfish is an interactive shell tool for viewing
        and editing disk images, exposing the full libguestfs API.
        This manual page is the primary reference for all guestfish
        operations." },
    { project = "libguestfs", difficulty = 2,
      url = "http://libguestfs.org/virt-cat.1.html",
      name = "virt-cat manual page",
      description = "virt-cat lets you display a single file from
        a guest or disk image." },
    { project = "libguestfs", difficulty = 2,
      url = "http://libguestfs.org/virt-df.1.html",
      name = "virt-df manual page",
      description = "virt-df lets you display the free disk space in
        a guest or disk image." },
    { project = "libguestfs", difficulty = 3,
      url = "http://libguestfs.org/virt-edit.1.html",
      name = "virt-edit manual page",
      description = "virt-edit lets you interactively edit a single
        file from a guest or disk image, <i>or</i>
        non-interactively edit from scripts" },
    { project = "libguestfs", difficulty = 2,
      url = "http://libguestfs.org/virt-inspector.1.html",
      name = "virt-inspector manual page",
      description = "virt-inspector can inspect an unknown disk image
        and produce a report on the operating system and applications
        contained inside it." },
    { project = "libguestfs", difficulty = 2,
      url = "http://libguestfs.org/virt-list-filesystems.1.html",
      name = "virt-list-filesystems manual page",
      description = "virt-list-filesystems is primarily a shell
        script tool for listing out the filesystems found inside
        a virtual machine or disk image, so you can iterate over them." },
    { project = "libguestfs", difficulty = 2,
      url = "http://libguestfs.org/virt-list-partitions.1.html",
      name = "virt-list-partitions manual page",
      description = "virt-list-partitions is like virt-list-filesystems
        except it lists the partitions found in the disk image." },
    { project = "libguestfs", difficulty = 2,
      url = "http://libguestfs.org/virt-ls.1.html",
      name = "virt-ls manual page",
      description = "virt-ls is like the <code>ls(1)</code> command
        for guests and disk images." },
    { project = "libguestfs", difficulty = 4,
      url = "http://libguestfs.org/virt-make-fs.1.html",
      name = "virt-make-fs manual page",
      description = "virt-make-fs can be used to prepare a disk
        image containing some predefined content." },
    { project = "libguestfs", difficulty = 3,
      url = "http://libguestfs.org/virt-rescue.1.html",
      name = "virt-rescue manual page",
      description = "virt-rescue is a <q>rescue shell</q> for virtual
        machines, similar in concept to the rescue disks used for
        physical machines." },
    { project = "libguestfs", difficulty = 3,
      url = "http://libguestfs.org/virt-resize.1.html",
      name = "virt-resize manual page",
      description = "virt-resize lets you expand or shrink guest disk
        images (offline only).  This complex topic is the subject
        of this manual page." },
    { project = "libguestfs", difficulty = 3,
      url = "http://libguestfs.org/virt-tar.1.html",
      name = "virt-tar manual page",
      description = "virt-tar can be used either to extract files and
        directories from a guest disk image, or to upload files and
        directories into a disk image." },
    { project = "libguestfs", difficulty = 3,
      url = "http://libguestfs.org/virt-win-reg.1.html",
      name = "virt-win-reg manual page",
      description = "virt-win-reg is a comprehensive Windows Registry
        export and merging tool, which you can use to export parts of
        the Registry from your Windows guests, or to merge changes
        into your Windows guests." },
    { project = "libguestfs", difficulty = 5,
      url = "http://libguestfs.org/guestmount.1.html",
      name = "guestmount manual page",
      description = "Guestmount uses libguestfs and FUSE to
        mount guest filesystems (from disk images) directly
        on the host." },

    # hivex man pages
    # XXX



      
]

# NB: Make sure you don't add blank lines to the end of this file!
-%]