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 yelp-tools-download-http
|
---|
8 | "&gnome-download-http;/yelp-tools/3.4/yelp-tools-&yelp-tools-version;.tar.xz">
|
---|
9 | <!ENTITY yelp-tools-download-ftp
|
---|
10 | "&gnome-download-ftp;/yelp-tools/3.4/yelp-tools-&yelp-tools-version;.tar.xz">
|
---|
11 | <!ENTITY yelp-tools-md5sum "8435aac25edbc530f878e93440c3d262">
|
---|
12 | <!ENTITY yelp-tools-size "192 KB">
|
---|
13 | <!ENTITY yelp-tools-buildsize "1.5 MB">
|
---|
14 | <!ENTITY yelp-tools-time "less than 0.1 SBU">
|
---|
15 | ]>
|
---|
16 |
|
---|
17 | <sect1 id="yelp-tools" xreflabel="yelp-tools-&yelp-tools-version;">
|
---|
18 | <?dbhtml filename="yelp-tools.html"?>
|
---|
19 |
|
---|
20 |
|
---|
21 | <title>yelp-tools-&yelp-tools-version;</title>
|
---|
22 |
|
---|
23 | <indexterm zone="yelp-tools">
|
---|
24 | <primary sortas="a-yelp-tools">yelp-tools</primary>
|
---|
25 | </indexterm>
|
---|
26 |
|
---|
27 | <sect2 role="package">
|
---|
28 | <title>Introduction to Yelp Tools</title>
|
---|
29 |
|
---|
30 | <para>
|
---|
31 | <application>Yelp Tools</application> is a collection of
|
---|
32 | scripts and build utilities to help create, manage, and publish
|
---|
33 | documentation for Yelp and the web. Most of the heavy lifting
|
---|
34 | is done by packages like Yelp Xsl and itstool. This package just
|
---|
35 | wraps things up in a developer-friendly way.
|
---|
36 | </para>
|
---|
37 |
|
---|
38 | &lfs70_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (HTTP): <ulink url="&yelp-tools-download-http;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (FTP): <ulink url="&yelp-tools-download-ftp;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download MD5 sum: &yelp-tools-md5sum;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download size: &yelp-tools-size;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated disk space required: &yelp-tools-buildsize;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated build time: &yelp-tools-time;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">Yelp Tools Dependencies</bridgehead>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
77 | <para role="required">
|
---|
78 | <xref linkend="yelp-xsl"/>
|
---|
79 | </para>
|
---|
80 |
|
---|
81 | <para condition="html" role="usernotes">
|
---|
82 | User Notes: <ulink url="&blfs-wiki;/yelp-tools"/>
|
---|
83 | </para>
|
---|
84 | </sect2>
|
---|
85 |
|
---|
86 | <sect2 role="installation">
|
---|
87 | <title>Installation of Yelp Tools</title>
|
---|
88 |
|
---|
89 | <para>
|
---|
90 | Install <application>Yelp Tools</application> by running the following
|
---|
91 | commands:
|
---|
92 | </para>
|
---|
93 |
|
---|
94 | <screen><userinput>./configure --prefix=/usr &&
|
---|
95 | make</userinput></screen>
|
---|
96 |
|
---|
97 | <para>
|
---|
98 | This package does not come with a test suite.
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <para>
|
---|
102 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
106 | </sect2>
|
---|
107 |
|
---|
108 | <sect2 role="content">
|
---|
109 | <title>Contents</title>
|
---|
110 |
|
---|
111 | <segmentedlist>
|
---|
112 | <segtitle>Installed Programs</segtitle>
|
---|
113 | <segtitle>Installed Directory</segtitle>
|
---|
114 |
|
---|
115 | <seglistitem>
|
---|
116 | <seg>
|
---|
117 | yelp-build, yelp-check and yelp-new
|
---|
118 | </seg>
|
---|
119 | <seg>
|
---|
120 | /usr/share/yelp-tools
|
---|
121 | </seg>
|
---|
122 | </seglistitem>
|
---|
123 | </segmentedlist>
|
---|
124 |
|
---|
125 | <variablelist>
|
---|
126 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
127 | <?dbfo list-presentation="list"?>
|
---|
128 | <?dbhtml list-presentation="table"?>
|
---|
129 |
|
---|
130 | <varlistentry id="yelp-build">
|
---|
131 | <term><command>yelp-build</command></term>
|
---|
132 | <listitem>
|
---|
133 | <para>
|
---|
134 | is used to build output formats from
|
---|
135 | Mallard or DocBook files.
|
---|
136 | </para>
|
---|
137 | <indexterm zone="yelp-tools yelp-build">
|
---|
138 | <primary sortas="b-yelp-build">yelp-build</primary>
|
---|
139 | </indexterm>
|
---|
140 | </listitem>
|
---|
141 | </varlistentry>
|
---|
142 |
|
---|
143 | <varlistentry id="yelp-check">
|
---|
144 | <term><command>yelp-check</command></term>
|
---|
145 | <listitem>
|
---|
146 | <para>
|
---|
147 | is used to keep track of the work while you write.
|
---|
148 | </para>
|
---|
149 | <indexterm zone="yelp-tools yelp-check">
|
---|
150 | <primary sortas="b-yelp-check">yelp-check</primary>
|
---|
151 | </indexterm>
|
---|
152 | </listitem>
|
---|
153 | </varlistentry>
|
---|
154 |
|
---|
155 | <varlistentry id="yelp-new">
|
---|
156 | <term><command>yelp-new</command></term>
|
---|
157 | <listitem>
|
---|
158 | <para>
|
---|
159 | is used to create a new Mallard page file
|
---|
160 | from a template.
|
---|
161 | </para>
|
---|
162 | <indexterm zone="yelp-tools yelp-new">
|
---|
163 | <primary sortas="b-yelp-new">yelp-new</primary>
|
---|
164 | </indexterm>
|
---|
165 | </listitem>
|
---|
166 | </varlistentry>
|
---|
167 |
|
---|
168 | </variablelist>
|
---|
169 |
|
---|
170 | </sect2>
|
---|
171 |
|
---|
172 | </sect1>
|
---|