source: x/lib/grantlee.xml@ 9c0463d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY grantlee-download-http
           "http://downloads.grantlee.org/grantlee-&grantlee-version;.tar.gz">
  <!ENTITY grantlee-download-ftp  " ">
  <!ENTITY grantlee-md5sum        "6239b3703674f88b2236d30d0ed67eea">
  <!ENTITY grantlee-size          "1.1 MB">
  <!ENTITY grantlee-buildsize     "22 MB">
  <!ENTITY grantlee-time          "0.6 SBU (Using parallelism=4)">
]>

<sect1 id="grantlee" xreflabel="grantlee-&grantlee-version;">
  <?dbhtml filename="grantlee.html"?>

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>Grantlee-&grantlee-version;</title>

  <indexterm zone="grantlee">
    <primary sortas="a-grantlee">grantlee</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to grantlee</title>

    <para>
       Grantlee is a set of free software libraries written using the Qt
       framework. Currently two libraries are shipped with Grantlee: Grantlee
       Templates and Grantlee TextDocument. The goal of Grantlee Templates is
       to make it easier for application developers to separate the structure
       of documents from the data they contain, opening the door for theming.
    </para>

    &lfs110a_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&grantlee-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&grantlee-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &grantlee-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &grantlee-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &grantlee-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &grantlee-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Grantlee Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/> and <xref linkend="qt5"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (for documentation)
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/grantlee"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Grantlee</title>

    <para>
      Install <application>Grantlee</application> by
      running the following commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>none</seg>
        <seg>
          libGrantlee_Templates.so and
          libGrantlee_TextDocument.so
        </seg>
        <seg>
          /usr/lib/cmake/Grantlee5,
          /usr/lib/grantlee/5.2, and
          /usr/include/grantlee</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libGrantlee_Templates">
        <term><filename class="libraryfile">libGrantlee_Templates.so</filename></term>
        <listitem>
          <para>
            contains common documentation templates for separating documents
            from their structure
          </para>
          <indexterm zone="grantlee libGrantlee_Templates">
            <primary sortas="c-libGrantlee_Templates">libGrantlee_Templates.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libGrantlee_TextDocument">
        <term><filename class="libraryfile">libGrantlee_TextDocument.so</filename></term>
        <listitem>
          <para>
            contains functions that allow separating the content of text
            documents from their structure.
          </para>
          <indexterm zone="grantlee libGrantlee_TextDocument">
            <primary sortas="c-libGrantlee_TextDocument">libGrantlee_TextDocument.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>