aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-12-21 08:04:38 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-12-21 08:04:38 +0000
commit6b75d062894dc7244e707391dda8e12033e7d6c7 (patch)
treecbd01430596020e11e1a2fab8e691f643f4cc06c
parent144871b1f6d1f624499740db9cf530eeb73da3e2 (diff)
downloadpaludis-6b75d062894dc7244e707391dda8e12033e7d6c7.tar.gz
paludis-6b75d062894dc7244e707391dda8e12033e7d6c7.tar.xz
More faq work
-rw-r--r--doc/Makefile.am15
-rw-r--r--doc/faq.html.skel16
-rw-r--r--doc/footer.html6
-rw-r--r--doc/htmlfooter.html6
4 files changed, 22 insertions, 21 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8b3b984..ff97386 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -37,7 +37,7 @@ EXTRA_DIST = doxygen.conf.in header.html footer.html paludis.css \
faq.html.skel htmlheader.html htmlfooter.html
CLEANFILES = *~ news.html index.html changelog.html licence.html authors.html faq.html \
- cleannews cleanchangelog cleanauthors
+ cleannews cleanchangelog cleanauthors cleanfaqtoc
MAINTAINERCLEANFILES = Makefile.in $(tagfiles) arrow.png
@@ -139,13 +139,24 @@ index.html : index.html.skel htmlheader.html htmlfooter.html
-e '/@FOOTER@/d' \
< index.html.skel > index.html
-faq.html : faq.html.skel htmlheader.html htmlfooter.html
+faq.html : faq.html.skel htmlheader.html htmlfooter.html cleanfaqtoc
sed -e '/@HEADER@/r htmlheader.html' \
-e '/@HEADER@/d' \
-e '/@FOOTER@/r htmlfooter.html' \
-e '/@FOOTER@/d' \
+ -e '/@TOC@/r cleanfaqtoc' \
+ -e '/@TOC@/d' \
< faq.html.skel > faq.html
+cleanfaqtoc : faq.html.skel
+ sed -n -e 's!^<h\([23]\) id="\([^"]\+\)">\(.*\)</h\1>!\1 <li><a href="#\2">\3</a></li>!gp' \
+ < faq.html.skel \
+ | sed -e 's!^2 <li>\(.*\)</li>!</ul></li><li><strong>\1</strong><ul>!' \
+ -e 's!^3 !!' \
+ | sed -e '1s!^</ul></li>!<ul>!' \
+ -e '$$s!$$!</ul></li></ul>!' \
+ > cleanfaqtoc
+
licence.html : licence.html.skel htmlheader.html htmlfooter.html ../COPYING
sed -e '/@HEADER@/r htmlheader.html' \
-e '/@HEADER@/d' \
diff --git a/doc/faq.html.skel b/doc/faq.html.skel
index 217344c..0daf3cc 100644
--- a/doc/faq.html.skel
+++ b/doc/faq.html.skel
@@ -19,7 +19,9 @@ these is liable to get you hurt.</p>
<p>This document also describes some things that are not bugs or missing
functionality. Pestering anyone about these is liable to get you hurt a lot.</p>
-<h2>Paludis is Stricter than Portage</h2>
+@TOC@
+
+<h2 id="stricter">Paludis is Stricter than Portage</h2>
<h3 id="mergingweirdstuff">Merging Weird Stuff</h3>
@@ -78,9 +80,9 @@ honour <code>ROOT</code>. To temporarily disable sandbox for these packages,
<code>export SANDBOX_PREDICT=/</code> or <code>export SANDBOX_WRITE=/</code> as
appropriate.</p>
-<h2>Undesirable Misfunctionality</h2>
+<h2 id="misfunctionality">Undesirable Misfunctionality</h2>
-<h3>wget Resume Support</h3>
+<h3 id="wgetresume">wget Resume Support</h3>
<p>Non-Problem: With Portage, <code>wget -c</code> is used to attempt to resume
downloads of partial files. With Paludis, resumes are not allowed.</p>
@@ -95,7 +97,7 @@ notice only after lots of bandwidth has been wasted.</p>
<p>Having said that, if you really want this functionality, you can implement it
using a custom fetcher.</p>
-<h3>Build Resume / Skip First Support</h3>
+<h3 id="skipfirst">Build Resume / Skip First Support</h3>
<p>Non-Problem: Paludis doesn't have an equivalent to --resume --skipfirst in
Portage.</p>
@@ -105,16 +107,16 @@ an ebuild exits with an error, Paludis will echo a resume command (<code>paludis
-i10 =sys-apps/foo-1.23-r1 =app-misc/fnord-2 ...</code>) that can be used to
resume the build.</p>
-<h3>No Automatic Niceness Support</h3>
+<h3 id="nice">No Automatic Niceness Support</h3>
<p>Non-Problem: There's no <code>PORTAGE_NICENESS</code> equivalent.</p>
<p>Rationale: Learn how to use <code>nice</code>. There's no
<code>GCC_NICENESS</code> or <code>VIM_NICENESS</code> either.</p>
-<h2>Paludis Does Things Differently</h2>
+<h2 id="differences">Paludis Does Things Differently</h2>
-<h3>No <code>--tree</code> Equivalent</h3>
+<h3 id="tree">No <code>--tree</code> Equivalent</h3>
<p>Paludis does not have something identical to <code>emerge --tree</code>. It
does, however, have <code>--show-install-reasons</code>, which we find to be
diff --git a/doc/footer.html b/doc/footer.html
index 2641c55..0483246 100644
--- a/doc/footer.html
+++ b/doc/footer.html
@@ -2,12 +2,6 @@
<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>
- <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>
</body>
</html>
diff --git a/doc/htmlfooter.html b/doc/htmlfooter.html
index 0a9d382..383c100 100644
--- a/doc/htmlfooter.html
+++ b/doc/htmlfooter.html
@@ -2,12 +2,6 @@
<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>