aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-12-17 20:52:05 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-12-17 20:52:05 +0000
commit9520b05409e4a023212cc17edea4f9693c30344c (patch)
tree17892324994eaccf7d7864c9d03f0a4c5bdc065f
parent1d2a4e46580b69a917213071df619a11634a6937 (diff)
downloadpaludis-9520b05409e4a023212cc17edea4f9693c30344c.tar.gz
paludis-9520b05409e4a023212cc17edea4f9693c30344c.tar.xz
More webpage work
-rw-r--r--Makefile.am2
-rw-r--r--NEWS2
-rw-r--r--doc/Makefile.am99
-rw-r--r--doc/arrow.svg7
-rw-r--r--doc/authors.html.skel24
-rw-r--r--doc/changelog.html.skel26
-rw-r--r--doc/footer.html4
-rw-r--r--doc/header.html10
-rw-r--r--doc/htaccess5
-rw-r--r--doc/htmlfooter.html13
-rw-r--r--doc/htmlheader.html11
-rw-r--r--doc/index.html.skel90
-rw-r--r--doc/licence.html.skel26
-rw-r--r--doc/news.html.skel23
-rw-r--r--doc/paludis.css13
15 files changed, 338 insertions, 17 deletions
diff --git a/Makefile.am b/Makefile.am
index 8d16d6d..e846028 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -26,7 +26,7 @@ automake-deps-dist-hack.tmp :
dist-hook :
rm $(distdir)/automake-deps-dist-hack.tmp
-doxygen rdoc homepage upload-homepage :
+doxygen rdoc homepage htmlpages upload-homepage :
$(MAKE) -C doc $@
check-local :
diff --git a/NEWS b/NEWS
index 6769915..de64189 100644
--- a/NEWS
+++ b/NEWS
@@ -370,6 +370,6 @@ of every change, see the ChangeLog.
appropriate.
0.2.0:
- Initial public release.
+ * Initial public release.
.. vim: set tw=80 spell spelllang=en :
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 4bf8d1e..ba36859 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -22,9 +22,23 @@ docfiles = \
doc_programming_with_paludis.doxygen \
doc_cache_files.doxygen
-EXTRA_DIST = doxygen.conf.in header.html footer.html paludis.css $(docfiles) $(tagfiles)
-CLEANFILES = *~
-MAINTAINERCLEANFILES = Makefile.in $(tagfiles)
+htmlfiles = \
+ index.html \
+ news.html \
+ changelog.html \
+ licence.html \
+ authors.html \
+ arrow.svg
+
+EXTRA_DIST = doxygen.conf.in header.html footer.html paludis.css \
+ $(docfiles) $(tagfiles) $(htmlfiles) arrow.png htaccess \
+ news.html.skel index.html.skel changelog.html.skel licence.html.skel authors.html.skel \
+ htmlheader.html htmlfooter.html
+
+CLEANFILES = *~ news.html index.html changelog.html licence.html authors.html \
+ cleannews cleanchangelog cleanauthors
+
+MAINTAINERCLEANFILES = Makefile.in $(tagfiles) arrow.png
libstdc++.tag :
wget -O $@ http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/libstdc++.tag
@@ -66,13 +80,86 @@ rdoc :
endif
+cleanauthors : ../AUTHORS
+ sed -e '1,3d' \
+ -e 's,&,\&amp;,g' -e 's,<,\&lt;,g' -e 's,>,\&gt;,g' -e 's,@, at ,g' \
+ -e 's,^ \(.*\),<dd>\1</dd>,' \
+ -e 's,^\([^ <].*\),<dt>\1</dt>,' \
+ < ../AUTHORS > cleanauthors
+
+authors.html : authors.html.skel cleanauthors htmlheader.html htmlfooter.html
+ sed -e '/@AUTHORS@/r cleanauthors' -e '/@AUTHORS@/d' \
+ -e '/@HEADER@/r htmlheader.html' \
+ -e '/@HEADER@/d' \
+ -e '/@FOOTER@/r htmlfooter.html' \
+ -e '/@FOOTER@/d' < authors.html.skel > authors.html
+
+cleannews : ../NEWS
+ sed -e '1,6d' -e '$$d' < ../NEWS > cleannews
+
+news.html : news.html.skel cleannews htmlheader.html htmlfooter.html
+ sed -e '/@RELEASE_NOTES@/r cleannews' -e '/@RELEASE_NOTES@/d' \
+ -e '/@HEADER@/r htmlheader.html' \
+ -e '/@HEADER@/d' \
+ -e '/@FOOTER@/r htmlfooter.html' \
+ -e '/@FOOTER@/d' < news.html.skel | \
+ sed \
+ -e 's~^\([0-9].*\):~</li></ul><h3>&</h3><ul>~' \
+ -e 's~^ \*~</li><li>~' \
+ | tr '\012' '\007' \
+ | sed \
+ -e 's~</li></ul><h3>~<h3>~' \
+ -e 's~<ul>\a*</li>~<ul>~g' \
+ | tr '\007' '\012' > news.html
+
+cleanchangelog : ../ChangeLog
+ sed -e '1,7d' -e '$$d' -e 's,&,\&amp;,g' -e 's,<,\&lt;,g' -e 's,>,\&gt;,g' -e 's,@, at ,g' \
+ < ../ChangeLog \
+ | sed \
+ -e 's~^\(200[0-9]-[0-9][0-9].*\)~<dt>&</dt>~' \
+ | tr '\012' '\007' \
+ | sed -e 's~\a\t[\*\+] ~\a<dd>~g' \
+ | sed -e 's~\([^>]\)\a\a~\1</dd>\a~g' \
+ | sed \
+ -e 's,<dd>\([^:<]\+\):,<dd><code>\1</code>:<br />,g' \
+ | tr '\007' '\012' > cleanchangelog
+
+changelog.html : changelog.html.skel cleanchangelog htmlheader.html htmlfooter.html
+ sed -e '/@CHANGELOG@/r cleanchangelog' -e '/@CHANGELOG@/d' \
+ -e '/@HEADER@/r htmlheader.html' \
+ -e '/@HEADER@/d' \
+ -e '/@FOOTER@/r htmlfooter.html' \
+ -e '/@FOOTER@/d' < changelog.html.skel > changelog.html
+
+index.html : index.html.skel htmlheader.html htmlfooter.html
+ sed -e '/@HEADER@/r htmlheader.html' \
+ -e '/@HEADER@/d' \
+ -e '/@FOOTER@/r htmlfooter.html' \
+ -e '/@FOOTER@/d' \
+ < index.html.skel > index.html
+
+licence.html : licence.html.skel htmlheader.html htmlfooter.html ../COPYING
+ sed -e '/@HEADER@/r htmlheader.html' \
+ -e '/@HEADER@/d' \
+ -e '/@FOOTER@/r htmlfooter.html' \
+ -e '/@FOOTER@/d' \
+ -e '/@COPYING@/r ../COPYING' \
+ -e '/@COPYING@/d' \
+ < licence.html.skel > licence.html
+
clean-local :
rm -fr www
-maintainer-clean-local :
- rm -fr www
+arrow.png : arrow.svg
+ convert arrow.svg arrow.png
+
+htmlpages : $(htmlfiles) paludis.css www arrow.png
+ for s in $(htmlfiles) paludis.css arrow.png ; do cp $(srcdir)/$$s www/ ; done
+
+dothtaccess : htaccess
+ cp $(srcdir)/htaccess www/.htaccess
-homepage : doxygen rdoc
+homepage : doxygen rdoc htmlpages dothtaccess
upload-homepage : homepage
cd `readlink -f $(top_srcdir)/doc/www` && tar jc ./ --exclude ./ | \
diff --git a/doc/arrow.svg b/doc/arrow.svg
new file mode 100644
index 0000000..d0dc88e
--- /dev/null
+++ b/doc/arrow.svg
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" version="1.0" width="80" height="80">
+ <rect x="-10" y="-10" width="100" height="100" style="fill: #eeeeee;" />
+ <path d="M 10,30 L 40,30 L 40,10 L 70,40 L 40,70 L 40,50 L 10,50 z"
+ style="stroke: #999999; stroke-width: 1; stroke-dasharray: 3,3; fill: #eeeeee;" id="arrowhead"/>
+</svg>
+
diff --git a/doc/authors.html.skel b/doc/authors.html.skel
new file mode 100644
index 0000000..7a868ce
--- /dev/null
+++ b/doc/authors.html.skel
@@ -0,0 +1,24 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html lang="en" xml:lang="en">
+<head>
+<title>Paludis, the Other Package Mangler: Release Notes</title>
+<link rel="stylesheet" href="paludis.css" type="text/css" />
+</head>
+<body>
+@HEADER@
+
+ <h1>Paludis, the Other Package Mangler</h1>
+
+ <h2>Authors</h2>
+
+@AUTHORS@
+
+ </li></ul>
+
+@FOOTER@
+</body>
+</html>
+
+
+
diff --git a/doc/changelog.html.skel b/doc/changelog.html.skel
new file mode 100644
index 0000000..f648a68
--- /dev/null
+++ b/doc/changelog.html.skel
@@ -0,0 +1,26 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!-- vim: set ft=html : -->
+<html lang="en" xml:lang="en">
+<head>
+<title>Paludis, the Other Package Mangler: Release Notes</title>
+<link rel="stylesheet" href="paludis.css" type="text/css" />
+</head>
+<body>
+@HEADER@
+
+ <h1>Paludis, the Other Package Mangler</h1>
+
+ <h2>ChangeLog</h2>
+
+<dl>
+@CHANGELOG@
+</dd></dl>
+
+
+@FOOTER@
+</body>
+</html>
+
+
+
diff --git a/doc/footer.html b/doc/footer.html
index 8ec5307..2641c55 100644
--- a/doc/footer.html
+++ b/doc/footer.html
@@ -1,5 +1,7 @@
<div class="qindex" style="text-align: center; margin-top: 1em;">
- <p>Copyright &copy; 2005, 2006 <a href="http://ciaranm.org/">Ciaran McCreesh</a> and various others. See the <a href="PaludisAuthors.html">Authors list</a> and <a href="PaludisLicence.html">Licence</a> for details and redistribution conditions.</p>
+ <p>Copyright &copy; 2005, 2006 <a href="http://ciaranm.org/">Ciaran
+ McCreesh</a> and various others. See the <a href="../../authors.html">Authors
+ list</a> and <a href="../../licence.html">Licence</a> for details and redistribution conditions.</p>
<table style="border-style: none; margin: auto;">
<tr>
<td style="text-align: center; padding: 2px 50px;"><a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" border="0"></a></td>
diff --git a/doc/header.html b/doc/header.html
index da1822b..53c1bf7 100644
--- a/doc/header.html
+++ b/doc/header.html
@@ -7,11 +7,11 @@
</head>
<body>
<div class="qindex">About Paludis: [
- <a class="qindex" href="index.html">Paludis&nbsp;Homepage</a> |
- <a class="qindex" href="PaludisNews.html">News</a> |
- <a class="qindex" href="PaludisChangeLog.html">ChangeLog</a> |
- <a class="qindex" href="PaludisLicence.html">Licence</a> |
- <a class="qindex" href="PaludisAuthors.html">Authors</a> |
+ <a class="qindex" href="../../index.html">Paludis&nbsp;Homepage</a> |
+ <a class="qindex" href="../../news.html">Release&nbsp;Notes</a> |
+ <a class="qindex" href="../../changelog.html">ChangeLog</a> |
+ <a class="qindex" href="../../licence.html">Licence</a> |
+ <a class="qindex" href="../../authors.html">Authors</a> |
<a class="qindex" href="https://developer.berlios.de/projects/paludis/">Berlios&nbsp;Project</a> |
<a class="qindex" href="https://developer.berlios.de/project/showfiles.php?group_id=6360">Download</a> |
<a class="qindex" href="http://svn.pioto.org/viewvc/paludis/">SVN</a> ]
diff --git a/doc/htaccess b/doc/htaccess
new file mode 100644
index 0000000..4bd8fbb
--- /dev/null
+++ b/doc/htaccess
@@ -0,0 +1,5 @@
+# vim: set ft=apache :
+
+Redirect Permanent /News.html http://paludis.berlios.de/news.html
+Redirect Permanent /PaludisNews.html http://paludis.berlios.de/news.html
+
diff --git a/doc/htmlfooter.html b/doc/htmlfooter.html
new file mode 100644
index 0000000..0a9d382
--- /dev/null
+++ b/doc/htmlfooter.html
@@ -0,0 +1,13 @@
+<div class="qindex" style="text-align: center; margin-top: 1em;">
+ <p>Copyright &copy; 2005, 2006 <a href="http://ciaranm.org/">Ciaran
+ McCreesh</a> and various others. See the <a href="authors.html">Authors
+ list</a> and <a href="licence.html">Licence</a> for details and redistribution conditions.</p>
+
+ <table style="border-style: none; margin: auto;">
+ <tr>
+ <td style="text-align: center; padding: 2px 50px;"><a href="http://developer.berlios.de" title="BerliOS Developer"><img src="http://developer.berlios.de/bslogo.php?group_id=6360" border="0" alt="BerliOS Developer Logo"></a></td>
+ </tr>
+ </table>
+</div>
+
+
diff --git a/doc/htmlheader.html b/doc/htmlheader.html
new file mode 100644
index 0000000..5f2cbf9
--- /dev/null
+++ b/doc/htmlheader.html
@@ -0,0 +1,11 @@
+ <div class="qindex">About Paludis: [
+ <a class="qindex" href="index.html">Paludis&nbsp;Homepage</a> |
+ <a class="qindex" href="news.html">Release&nbsp;Notes</a> |
+ <a class="qindex" href="changelog.html">ChangeLog</a> |
+ <a class="qindex" href="licence.html">Licence</a> |
+ <a class="qindex" href="authors.html">Authors</a> |
+ <a class="qindex" href="https://developer.berlios.de/projects/paludis/">Berlios&nbsp;Project</a> |
+ <a class="qindex" href="https://developer.berlios.de/project/showfiles.php?group_id=6360">Download</a> |
+ <a class="qindex" href="http://svn.pioto.org/viewvc/paludis/">SVN</a> ]
+ </div>
+
diff --git a/doc/index.html.skel b/doc/index.html.skel
new file mode 100644
index 0000000..7893242
--- /dev/null
+++ b/doc/index.html.skel
@@ -0,0 +1,90 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html lang="en" xml:lang="en">
+<head>
+<title>Paludis, the Other Package Mangler</title>
+<link rel="stylesheet" href="paludis.css" type="text/css" />
+</head>
+<body>
+@HEADER@
+
+ <h1>Paludis, the Other Package Mangler</h1>
+
+ <p>Paludis is a package manager for use with <a
+ href="http://www.gentoo.org/">Gentoo</a> and related distributions. It
+ is entirely independent of Portage.</p>
+
+ <h2>For prospective users:</h2>
+
+ <h2>For new and current users:</h2>
+
+ <table border="0">
+ <tr>
+ <td valign="middle">
+ <object type="image/svg+xml" width="80" height="80"
+ data="arrow.svg">
+ <img src="arrow.png" alt="arrow" />
+ </object>
+ </td>
+ <td>
+ <p>The <a href="news.html">release notes</a> document major
+ changes between releases. More detailed information is available
+ in the <a href="changelog.html">changelog</a>.</p>
+
+ <p>An <a href="faq.html">FAQ</a> is available. You should familiarise
+ yourself with this list before asking questions.</p>
+
+ <p>There is a <a href="migration.html">guide to migrating to
+ Paludis</a> and a <a href="bootstrap.html">guide to
+ bootstrapping a chroot using Paludis</a>.</p>
+
+ <p>There is <a href="configuration.html">documentation on the
+ configuration files</a> and <a href="cachefiles.html">the
+ various optional caches</a> used by Paludis.</p>
+
+ <p><strong>Support</strong> is available via <code>#paludis</code> on
+ <code>irc.freenode.net</code> or the <a
+ href="lists.html">mailing lists</a>. Support is not
+ available via Gentoo's bugzilla or forums.</p>
+ </td>
+ </tr>
+ </table>
+
+ <h2>For developers:</h2>
+
+ <table border="0">
+ <tr>
+ <td valign="middle">
+ <object type="image/svg+xml" width="80" height="80"
+ data="arrow.svg">
+ <img src="arrow.png" alt="arrow" />
+ </object>
+ </td>
+ <td>
+ <p><strong>Subversion access</strong> is available via
+ <code>svn co svn://svn.pioto.org/paludis/trunk svn</code>. There
+ is also <a href="http://svn.pioto.org/viewvc/paludis/">viewvc</a>
+ for browsing via the web.</p>
+
+ <p>An <a href="programmingwithpaludis.html">overview of
+ Programming with Paludis</a>, covering both the C++ and the
+ Ruby APIs, is available.</p>
+
+ <p>There is <a href="doxygen/html"/>extensive C++ core API and implementation
+ documentation</a>. This is also available via <code>make
+ doxygen</code>.</p>
+
+ <p>Similarly, the <a href="ruby/">Ruby API documentation</a> is also
+ available via <code>make rdoc</code>.</p>
+
+ <p><strong>Development questions</strong> should be asked in <code>#paludis</code> on
+ <code>irc.freenode.net</code> or on the <a
+ href="lists.html">mailing lists</a>.</p>
+ </td>
+ </tr>
+ </table>
+
+@FOOTER@
+</body>
+</html>
+
diff --git a/doc/licence.html.skel b/doc/licence.html.skel
new file mode 100644
index 0000000..1c0cbc9
--- /dev/null
+++ b/doc/licence.html.skel
@@ -0,0 +1,26 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!-- vim: set ft=html : -->
+<html lang="en" xml:lang="en">
+<head>
+<title>Paludis, the Other Package Mangler: Release Notes</title>
+<link rel="stylesheet" href="paludis.css" type="text/css" />
+</head>
+<body>
+@HEADER@
+
+ <h1>Paludis, the Other Package Mangler</h1>
+
+ <h2>Licence</h2>
+
+<pre>
+@COPYING@
+</pre>
+
+@FOOTER@
+</body>
+</html>
+
+
+
+
diff --git a/doc/news.html.skel b/doc/news.html.skel
new file mode 100644
index 0000000..d8c327e
--- /dev/null
+++ b/doc/news.html.skel
@@ -0,0 +1,23 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html lang="en" xml:lang="en">
+<head>
+<title>Paludis, the Other Package Mangler: Release Notes</title>
+<link rel="stylesheet" href="paludis.css" type="text/css" />
+</head>
+<body>
+@HEADER@
+
+ <h1>Paludis, the Other Package Mangler</h1>
+
+ <h2>Release Notes</h2>
+
+@RELEASE_NOTES@
+
+ </li></ul>
+
+@FOOTER@
+</body>
+</html>
+
+
diff --git a/doc/paludis.css b/doc/paludis.css
index f928c2f..9b3f3dc 100644
--- a/doc/paludis.css
+++ b/doc/paludis.css
@@ -371,8 +371,15 @@ HR { height: 1px;
}
code {
- background-color: #f5f5f5;
- border: 1px solid #cccccc;
- padding: 2px;
+ background-color: #cccccc;
+}
+
+dd {
+ margin-left: 3em;
+ margin-bottom: 0.3em;
+}
+
+dt {
+ font-weight: bold;
}