[092e7fb] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY grantlee-download-http
|
---|
[da0bb01f] | 8 | "https://github.com/steveire/grantlee/releases/download/v&grantlee-version;/grantlee-&grantlee-version;.tar.gz">
|
---|
| 9 | <!-- "http://downloads.grantlee.org/grantlee-&grantlee-version;.tar.gz"> -->
|
---|
[092e7fb] | 10 | <!ENTITY grantlee-download-ftp " ">
|
---|
[da0bb01f] | 11 | <!ENTITY grantlee-md5sum "4ef8eae5dd61e3c7603d76208eb4d922">
|
---|
[092e7fb] | 12 | <!ENTITY grantlee-size "1.1 MB">
|
---|
[d6dbc81] | 13 | <!ENTITY grantlee-buildsize "27 MB">
|
---|
| 14 | <!ENTITY grantlee-time "0.4 SBU (Using parallelism=4)">
|
---|
[092e7fb] | 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect1 id="grantlee" xreflabel="grantlee-&grantlee-version;">
|
---|
| 18 | <?dbhtml filename="grantlee.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect1info>
|
---|
[d027410] | 21 | <date>$Date$</date>
|
---|
[092e7fb] | 22 | </sect1info>
|
---|
| 23 |
|
---|
| 24 | <title>Grantlee-&grantlee-version;</title>
|
---|
| 25 |
|
---|
| 26 | <indexterm zone="grantlee">
|
---|
| 27 | <primary sortas="a-grantlee">grantlee</primary>
|
---|
| 28 | </indexterm>
|
---|
| 29 |
|
---|
| 30 | <sect2 role="package">
|
---|
| 31 | <title>Introduction to grantlee</title>
|
---|
| 32 |
|
---|
| 33 | <para>
|
---|
[7c98ee5] | 34 | Grantlee is a set of free software libraries written using the Qt
|
---|
| 35 | framework. Currently two libraries are shipped with Grantlee: Grantlee
|
---|
| 36 | Templates and Grantlee TextDocument. The goal of Grantlee Templates is
|
---|
[092e7fb] | 37 | to make it easier for application developers to separate the structure
|
---|
| 38 | of documents from the data they contain, opening the door for theming.
|
---|
| 39 | </para>
|
---|
| 40 |
|
---|
[a9a66319] | 41 | &lfs112_checked;
|
---|
[092e7fb] | 42 |
|
---|
| 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
[d56e7df] | 46 | <para>
|
---|
| 47 | Download (HTTP): <ulink url="&grantlee-download-http;"/>
|
---|
| 48 | </para>
|
---|
[092e7fb] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[d56e7df] | 51 | <para>
|
---|
| 52 | Download (FTP): <ulink url="&grantlee-download-ftp;"/>
|
---|
| 53 | </para>
|
---|
[092e7fb] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[d56e7df] | 56 | <para>
|
---|
| 57 | Download MD5 sum: &grantlee-md5sum;
|
---|
| 58 | </para>
|
---|
[092e7fb] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[d56e7df] | 61 | <para>
|
---|
| 62 | Download size: &grantlee-size;
|
---|
| 63 | </para>
|
---|
[092e7fb] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[d56e7df] | 66 | <para>
|
---|
| 67 | Estimated disk space required: &grantlee-buildsize;
|
---|
| 68 | </para>
|
---|
[092e7fb] | 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
[d56e7df] | 71 | <para>
|
---|
| 72 | Estimated build time: &grantlee-time;
|
---|
| 73 | </para>
|
---|
[092e7fb] | 74 | </listitem>
|
---|
| 75 | </itemizedlist>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect3">Grantlee Dependencies</bridgehead>
|
---|
| 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 80 | <para role="required">
|
---|
[ed74a9a] | 81 | <xref linkend="cmake"/> and <xref linkend="qt5"/>
|
---|
[092e7fb] | 82 | </para>
|
---|
| 83 |
|
---|
[9c0463d] | 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
| 86 | <xref linkend="doxygen"/> (for documentation)
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
[092e7fb] | 89 | <para condition="html" role="usernotes">User Notes:
|
---|
| 90 | <ulink url="&blfs-wiki;/grantlee"/></para>
|
---|
| 91 |
|
---|
| 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2 role="installation">
|
---|
| 95 | <title>Installation of Grantlee</title>
|
---|
| 96 |
|
---|
[d56e7df] | 97 | <para>
|
---|
| 98 | Install <application>Grantlee</application> by
|
---|
| 99 | running the following commands:
|
---|
| 100 | </para>
|
---|
[092e7fb] | 101 |
|
---|
| 102 | <screen><userinput>mkdir build &&
|
---|
[b6d3d395] | 103 | cd build &&
|
---|
| 104 |
|
---|
| 105 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
[00e29190] | 106 | -DCMAKE_BUILD_TYPE=Release \
|
---|
[7c98ee5] | 107 | .. &&
|
---|
| 108 | make</userinput></screen>
|
---|
[092e7fb] | 109 |
|
---|
| 110 | <para>
|
---|
| 111 | This package does not come with a test suite.
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
[d56e7df] | 114 | <para>
|
---|
| 115 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 116 | </para>
|
---|
[092e7fb] | 117 |
|
---|
| 118 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | </sect2>
|
---|
| 121 |
|
---|
| 122 | <sect2 role="content">
|
---|
| 123 | <title>Contents</title>
|
---|
| 124 |
|
---|
| 125 | <segmentedlist>
|
---|
| 126 | <segtitle>Installed Programs</segtitle>
|
---|
| 127 | <segtitle>Installed Libraries</segtitle>
|
---|
| 128 | <segtitle>Installed Directories</segtitle>
|
---|
| 129 |
|
---|
| 130 | <seglistitem>
|
---|
| 131 | <seg>none</seg>
|
---|
| 132 | <seg>
|
---|
[9c0463d] | 133 | libGrantlee_Templates.so and
|
---|
| 134 | libGrantlee_TextDocument.so
|
---|
[092e7fb] | 135 | </seg>
|
---|
| 136 | <seg>
|
---|
[9c0463d] | 137 | /usr/lib/cmake/Grantlee5,
|
---|
| 138 | /usr/lib/grantlee/5.2, and
|
---|
| 139 | /usr/include/grantlee</seg>
|
---|
[092e7fb] | 140 | </seglistitem>
|
---|
| 141 | </segmentedlist>
|
---|
[9c0463d] | 142 |
|
---|
| 143 | <variablelist>
|
---|
| 144 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 145 | <?dbfo list-presentation="list"?>
|
---|
| 146 | <?dbhtml list-presentation="table"?>
|
---|
| 147 |
|
---|
| 148 | <varlistentry id="libGrantlee_Templates">
|
---|
| 149 | <term><filename class="libraryfile">libGrantlee_Templates.so</filename></term>
|
---|
| 150 | <listitem>
|
---|
| 151 | <para>
|
---|
| 152 | contains common documentation templates for separating documents
|
---|
| 153 | from their structure
|
---|
| 154 | </para>
|
---|
| 155 | <indexterm zone="grantlee libGrantlee_Templates">
|
---|
| 156 | <primary sortas="c-libGrantlee_Templates">libGrantlee_Templates.so</primary>
|
---|
| 157 | </indexterm>
|
---|
| 158 | </listitem>
|
---|
| 159 | </varlistentry>
|
---|
| 160 |
|
---|
| 161 | <varlistentry id="libGrantlee_TextDocument">
|
---|
| 162 | <term><filename class="libraryfile">libGrantlee_TextDocument.so</filename></term>
|
---|
| 163 | <listitem>
|
---|
| 164 | <para>
|
---|
| 165 | contains functions that allow separating the content of text
|
---|
| 166 | documents from their structure.
|
---|
| 167 | </para>
|
---|
| 168 | <indexterm zone="grantlee libGrantlee_TextDocument">
|
---|
| 169 | <primary sortas="c-libGrantlee_TextDocument">libGrantlee_TextDocument.so</primary>
|
---|
| 170 | </indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
| 173 | </variablelist>
|
---|
| 174 |
|
---|
[092e7fb] | 175 | </sect2>
|
---|
| 176 |
|
---|
| 177 | </sect1>
|
---|