[gnomeweb-wml] [pgo/yelp] Adding real content to index and download
- From: Shaun McCance <shaunm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnomeweb-wml] [pgo/yelp] Adding real content to index and download
- Date: Fri, 10 Dec 2010 19:36:59 +0000 (UTC)
commit 535ac227af7d349f58da3c534b3b98c771b08165
Author: Shaun McCance <shaunm gnome org>
Date: Fri Dec 10 14:32:47 2010 -0500
[pgo/yelp] Adding real content to index and download
projects.gnome.org/yelp/download.shtml | 23 ++++++++++++++++
projects.gnome.org/yelp/index.shtml | 45 +++++++++++++++++++++++++++++--
2 files changed, 65 insertions(+), 3 deletions(-)
---
diff --git a/projects.gnome.org/yelp/download.shtml b/projects.gnome.org/yelp/download.shtml
index c56df5f..ae179c2 100644
--- a/projects.gnome.org/yelp/download.shtml
+++ b/projects.gnome.org/yelp/download.shtml
@@ -5,6 +5,29 @@
<div id="body">
<div id="bottom">
+ <h2>Stable</h2>
+
+ <p>Yelp 2 is the stable version of Yelp, and should be included
+ by your distribution in your GNOME desktop.</p>
+
+ <h2>Unstable</h2>
+
+ <p>The development version of Yelp, Yelp 3, will be included in
+ GNOME 3.0. Your distribution may package it in a testing or
+ development repository. Otherwise, you will need to build it
+ from source.</p>
+
+ <p>To build Yelp, you need the latest <a href="http://webkitgtk.org/">WebKitGTK+</a>
+ and <a href="http://www.gtk.org/">GTK+</a> installed, as well as
+ any supporting libraries like GLib. WebKitGTK+ must be built against
+ GTK+ 3. Development packages of
+ <a href="http://ftp.gnome.org/pub/GNOME/sources/yelp-xsl/">yelp-xsl</a> and
+ <a href="http://ftp.gnome.org/pub/GNOME/sources/yelp/">yelp</a> are
+ available. Or grab them from GNOME git.</p>
+
+ <pre>git clone git://git.gnome.org/yelp-xsl
+git clone git://git.gnome.org/yelp</pre>
+
</div><!-- bottom -->
</div><!-- body -->
diff --git a/projects.gnome.org/yelp/index.shtml b/projects.gnome.org/yelp/index.shtml
index eb56744..b0de788 100644
--- a/projects.gnome.org/yelp/index.shtml
+++ b/projects.gnome.org/yelp/index.shtml
@@ -10,11 +10,50 @@
<div id="bottom">
<div id="bottomLeft">
+ <h2>Yelp</h2>
- <h2>Yelp</h2>
+ <p>Yelp is viewer and framework for documentation on the Linux
+ desktop. It is used heavily by the
+ <a href="http://www.gnome.org/">GNOME</a> desktop environment,
+ and its tools serve as the reference implementation for the
+ <a href="http://projectmallard.org/">Mallard</a> help format.
+ Yelp supports <a href="http://docbook.org/">DocBook</a>,
+ <a href="http://projectmallard.org/">Mallard</a>, HTML, man,
+ and info documents. Other formats may be added in the future.</p>
- <p>Yelp is the documentation viewer and framework used by the
- <a href="http://www.gnome.org/">GNOME</a> desktop environment.</p>
+ <p>The Yelp project consists of a number of packages:</p>
+
+ <ul>
+ <li><b>yelp</b> - The graphical help viewer used by GNOME.</li>
+ <li><b>libyelp</b> - A GTK+-based library that makes it easy to
+ build your own help viewer, or embed a help viewer in your
+ application. It's currently a part of yelp, but will be split
+ into a separate package in the future.</li>
+ <li><b>yelp-xsl</b> - The core XSLT stylesheets used by libyelp
+ and yelp. You can build off of these stylesheets to create sites
+ like <a href="http://library.gnome.org/">library.gnome.org</a>
+ or site-building tools like
+ <a href="http://gitorious.org/projectmallard/mallard-site-tool">mallard-site-tool</a>.</li>
+ <li><b>yelp-tools</b> - A set of command-line tools to build and
+ check your documentation, as well as an M4 file to use in your
+ autotools-based build chain. Currently in development.</li>
+ </ul>
+
+ <p>The stable version of Yelp also relies on gnome-doc-utils, an older
+ package containing much of what you'll find in yelp-xsl and yelp-tools.</p>
+
+ <h2>Contact</h2>
+
+ <p><a href="http://blogs.gnome.org/shaunm/tag/yelp/">Read Shaun's blog posts
+ on Yelp.</a></p>
+
+ <p>Yelp is developed by <a href="http://people.gnome.org/~shaunm/">Shaun
+ McCance</a> with help from the GNOME community. To discuss Yelp, email
+ the <a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-devel-list">gnome-doc-devel-list gnome org</a> mailing list.
+ <a href="https://bugzilla.gnome.org/enter_bug.cgi?product=Yelp">Report bugs</a> or
+ <a href="https://bugzilla.gnome.org/browse.cgi?product=Yelp">browse bugs</a>
+ in GNOME Bugzilla. You can also talk about Yelp on irc.gnome.org on the
+ #docs channel.</p>
<!-- bugs, contact, technologies/overview -->
</div>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]