aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-08-28 01:59:01 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-08-28 01:59:01 +0000
commit9c5f4761d8bf785ca98d5fda66fbbe9dbe11897c (patch)
tree6e2c8fab91dd051a7acc2cf0ab7c71fc58f6c278 /doc
parent21c4bd8444480d6038d217fa2892d13ecce500ff (diff)
downloadikiwiki-9c5f4761d8bf785ca98d5fda66fbbe9dbe11897c.tar
ikiwiki-9c5f4761d8bf785ca98d5fda66fbbe9dbe11897c.tar.gz
* Support for looking in multiple directories for underlay files.
* Plugins can add new directories to the search path with the add_underlay function. * Split out smiley underlay files into a separate underlay, so if the plugin isn't used, the wiki isn't bloated with all those files.
Diffstat (limited to 'doc')
-rw-r--r--doc/basewiki.mdwn1
-rw-r--r--doc/blog.mdwn2
-rw-r--r--doc/bugs/brokenlinks_false_positives.mdwn6
-rw-r--r--doc/plugins/write.mdwn12
-rw-r--r--doc/smileys.mdwn4
-rw-r--r--doc/todo/conditional_underlay_files.mdwn7
-rw-r--r--doc/todo/wikiwyg/discussion.mdwn3
7 files changed, 26 insertions, 9 deletions
diff --git a/doc/basewiki.mdwn b/doc/basewiki.mdwn
index acc1b3a60..fca8902eb 100644
--- a/doc/basewiki.mdwn
+++ b/doc/basewiki.mdwn
@@ -13,7 +13,6 @@ It currently includes these pages:
* [[pagespec]]
* [[PreprocessorDirective]]
* [[shortcuts]]
-* [[smileys]]
* [[subpage]]
* [[wikilink]]
diff --git a/doc/blog.mdwn b/doc/blog.mdwn
index be4ed41e2..1593278d1 100644
--- a/doc/blog.mdwn
+++ b/doc/blog.mdwn
@@ -67,7 +67,7 @@ directive:
* `quick` - Build archives in quick mode, without reading page contents for
metadata. By default, this also turns off generation of any feeds.
* `template` - Specifies the template to fill out to display each inlined
- page. By default the `inlinepage` [[template|wikitemplates]] is used, while
+ page. By default the `inlinepage` template is used, while
the `archivepage` template is used for archives. Set this parameter to
use some other, custom template, such as the `titlepage` template that
only shows post titles. Note that you should still set `archive=yes` if
diff --git a/doc/bugs/brokenlinks_false_positives.mdwn b/doc/bugs/brokenlinks_false_positives.mdwn
new file mode 100644
index 000000000..64287dd89
--- /dev/null
+++ b/doc/bugs/brokenlinks_false_positives.mdwn
@@ -0,0 +1,6 @@
+The [[plugin/brokenlinks]] plugin falsely complains that
+[[helponformatting]] has a broken link to [[smileys]], if the smiley plgin
+is disabled. While the helponformatting page links to it inside a
+conditional, and so doesn't show the link in this case, ikiwiki scans for
+links w/o looking at conditionals and so still thinks the page contains the
+link.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 0c192eb64..4ec9e8c7b 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -461,8 +461,16 @@ that corresponds to that file.
#### `srcfile($)`
Given the name of a source file in the wiki, searches for the file in
-the source directory and the underlay directory, and returns the full
-path to the first file found.
+the source directory and the underlay directories (most recently added
+underlays first), and returns the full path to the first file found.
+
+#### `add_underlay($)`
+
+Adds a directory to the set of underlay directories that ikiwiki will
+search for files.
+
+If the directory name is not absolute, ikiwiki will assume it is in
+the parent directory of the configured underlaydir.
#### `displaytime($)`
diff --git a/doc/smileys.mdwn b/doc/smileys.mdwn
index dfe30430b..9915ec587 100644
--- a/doc/smileys.mdwn
+++ b/doc/smileys.mdwn
@@ -1,7 +1,3 @@
-[[if test="enabled(smiley)"
- then="This wiki has smileys **enabled**."
- else="This wiki has smileys **disabled**."]]
-
This page is used to control what smileys are supported by the wiki.
Just write the text of a smiley to display it.
diff --git a/doc/todo/conditional_underlay_files.mdwn b/doc/todo/conditional_underlay_files.mdwn
index 87f70696b..14ab4dac3 100644
--- a/doc/todo/conditional_underlay_files.mdwn
+++ b/doc/todo/conditional_underlay_files.mdwn
@@ -21,4 +21,9 @@ hackish.
> plugins were enabled.
>
> Using the conditionals in a page to control what other pages get built
-> feels complex to me, --[[Joey]]
+> feels complex to me.
+>
+> Instead, this has been implmented as the `add_underlay()` function.
+> [[done]]
+> --[[Joey]]
+
diff --git a/doc/todo/wikiwyg/discussion.mdwn b/doc/todo/wikiwyg/discussion.mdwn
index 642576b7c..79bb83a87 100644
--- a/doc/todo/wikiwyg/discussion.mdwn
+++ b/doc/todo/wikiwyg/discussion.mdwn
@@ -70,6 +70,9 @@ changes.diff:
you have something pretty specific in mind. I can talk to you about that more
on IRC later(assuming my internet is working right).
* Basically the idea is to change `$config{underlaydir}` to an array..
+ Ok, take a look at the new `add_underlay()` function. You can now just
+ `add_underlay("wikiwyg")` and it'll look in
+ /usr/share/ikiwiki/wikiwyg/ for the files.
* When is the WIKIWYG variable in misc.tmpl used?
* The WIKIWYG variable in misc.tmpl is used for the edit page. I believe that is what
you wanted me to do (Check [Revision 3840][]).