source: kde5/applications/grantlee.xml@ 0ed1e5d

<?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;
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

  <indexterm zone="grantlee5">
    <primary sortas="a-Grantlee">Grantlee</primary>
  </indexterm>

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

    <para>
      The <application>Grantlee</application> package contains a set of
      libraries that can be used to separate the structure of documents
      from the data they contain, opening the door for theming. 
    </para>

    &lfs76_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&grantlee5-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&grantlee5-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &grantlee5-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &grantlee5-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &grantlee5-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &grantlee5-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"/> and
      <xref linkend="graphviz"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/grantlee5"/>
    </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=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTS=OFF                  \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      If you have installed optional dependencies and wish to
      generate the API documentation, issue the following
      command:
    </para>

<screen><userinput>make docs</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>

    <para>
      If you have built the optional documentation, install it
      by running the following commands as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -dm755 $KF5_PREFIX/share/doc/grantlee-&grantlee5-version; &amp;&amp;
cp -v apidox/*    $KF5_PREFIX/share/doc/grantlee-&grantlee5-version; </userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/cmake-release.xml"/>

    <para>
      <parameter>-DBUILD_TESTS=OFF</parameter>: This switch is used to prevent
      building test programs and libraries that are of no use to an end user.
    </para>

  </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>
          $KF5_PREFIX/include/grantlee,
          $KF5_PREFIX/lib/cmake/Grantlee5 and
          $KF5_PREFIX/lib/grantlee
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>