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