summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-01-29 15:05:49 -0500
committerJoey Hess <joey@kodama.kitenet.net>2008-01-29 15:05:49 -0500
commit47ee266163202f15fca3b108fad294bec262405a (patch)
treee83d75d593b57beaaf6ecd41de7fd5a63903d31e /doc/plugins
parent2bfd2e984132e5c235be066070c4e5b14d79b775 (diff)
improve support for internal pages
This makes it a lot quicker to deal with lots of recentchanges pages appearing and disappearing. It avoids needing to clutter up pagespecs with exclusions for those pages, by making normal pagespecs not match them.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/brokenlinks.mdwn2
-rw-r--r--doc/plugins/orphans.mdwn4
-rw-r--r--doc/plugins/pagecount.mdwn2
-rw-r--r--doc/plugins/recentchanges.mdwn2
-rw-r--r--doc/plugins/write.mdwn18
5 files changed, 19 insertions, 9 deletions
diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn
index 5c906e17b..208d7120b 100644
--- a/doc/plugins/brokenlinks.mdwn
+++ b/doc/plugins/brokenlinks.mdwn
@@ -10,4 +10,4 @@ pages to search for broken links, default is search them all.
If this plugin is turned on, here's a list of broken links on this wiki:
-[[brokenlinks pages="* and !recentchanges/change_* and !recentchanges"]]
+[[brokenlinks pages="* and !recentchanges"]]
diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn
index 6c6ebd6f9..74f4bae08 100644
--- a/doc/plugins/orphans.mdwn
+++ b/doc/plugins/orphans.mdwn
@@ -15,6 +15,6 @@ orphans.
Here's a list of orphaned pages on this wiki:
[[orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and
-!recentchanges/change_* and !recentchanges and !examples/* and !tips/* and
-!sandbox/* and !wikiicons/* and !plugins/*"]]
+!recentchanges and !examples/* and !tips/* and !sandbox/* and
+!wikiicons/* and !plugins/*"]]
"""]]
diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn
index c4cefd946..8f7029df8 100644
--- a/doc/plugins/pagecount.mdwn
+++ b/doc/plugins/pagecount.mdwn
@@ -10,5 +10,5 @@ pages to count, default is to count them all.
This plugin is included in ikiwiki, but is not enabled by default.
If it is turned on it can tell us that this wiki includes
-[[pagecount pages="* and !recentchanges/change_* and !recentchanges"]]
+[[pagecount pages="* and !recentchanges"]]
pages, of which [[pagecount pages="*/Discussion"]] are discussion pages.
diff --git a/doc/plugins/recentchanges.mdwn b/doc/plugins/recentchanges.mdwn
index 9e0d8dc51..69073adf0 100644
--- a/doc/plugins/recentchanges.mdwn
+++ b/doc/plugins/recentchanges.mdwn
@@ -9,6 +9,8 @@ Typically only the RecentChanges page will use the plugin, but you can
use it elsewhere too if you like. It's used like this:
\[[recentchanges pages="*" num=100 template=change]]
+ \[[inline pages="internal(recentchanges/change_*)"
+ template=recentchanges show=0]]
The pages describing recent changes will be created as [[subpages|subpage]]
of the page where the `recentchanges` directive is placed.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 9e27cc27f..4de7e434d 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -151,11 +151,6 @@ specifies the filename extension that a file must have to be htmlized using
this plugin. This is how you can add support for new and exciting markup
languages to ikiwiki.
-Note that if you choose a filename extension that starts with "_",
-ikiwiki will not render the page, or allow the page to be edited with the
-web interface. This is useful for certian types of internal-use pages, but
-should generally be avoided.
-
The function is passed named parameters: "page" and "content" and should
return the htmlized content.
@@ -536,6 +531,19 @@ destination file, as registered by `will_render`.
Passed a page and an extension, returns the filename that page will be
rendered to.
+## Internal use pages
+
+Sometimes it's useful to put pages in the wiki without having them be
+rendered to individual html files. Such internal use pages are collected
+together to form the RecentChanges page, for example.
+
+To make an internal use page, register a filename extension that starts
+with "_". Internal use pages cannot be edited with the web interface, are
+not scanned for wikilinks (though wikilinks and preprocessor directives can
+still appear on them, this is rarely a good idea), and are not matched by
+regular PageSpecs glob patterns, but instead only by a special `internal()`
+[[ikiwiki/PageSpec]].
+
## RCS plugins
ikiwiki's support for [[revision_control_systems|rcs]] also uses pluggable