aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-09-20 18:59:27 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-09-20 18:59:27 +0000
commitd1999f0357d893924acdc84f7c6c93dab144aa7e (patch)
tree3bdd3fc1a28b607c1768d660710827e0891a9c23 /doc
parent7f087e18aef78ea8d1b115bed669cfd108237b47 (diff)
downloadikiwiki-d1999f0357d893924acdc84f7c6c93dab144aa7e.tar
ikiwiki-d1999f0357d893924acdc84f7c6c93dab144aa7e.tar.gz
* Add taglink preprocessor directive, supporting visible tag links.
Closes: #443344
Diffstat (limited to 'doc')
-rw-r--r--doc/news/version_2.6.1.mdwn2
-rw-r--r--doc/plugins/tag.mdwn4
-rw-r--r--doc/tags.mdwn16
3 files changed, 15 insertions, 7 deletions
diff --git a/doc/news/version_2.6.1.mdwn b/doc/news/version_2.6.1.mdwn
index 2388ff587..2aea23479 100644
--- a/doc/news/version_2.6.1.mdwn
+++ b/doc/news/version_2.6.1.mdwn
@@ -4,4 +4,4 @@ ikiwiki 2.6.1 released with [[toggle text="these changes"]]
* Fix minor bug when blogging by cgi, introduced in last version.
* Fix a bug in unlockwiki intorduced last version that made it crash ikiwiki
if it wasn't locked when called. This is known to break post-commit
- emails."""]] \ No newline at end of file
+ emails."""]]
diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 2f541e532..c221624cd 100644
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -11,6 +11,10 @@ tagged with a given tag, for example. The tags will also show up on blog
entries and at the bottom of the tagged pages, as well as in RSS and Atom
feeds.
+If you want a visible [[WikiLink]] along with the tag, use taglink instead:
+
+ \[[taglink foo]]
+
This plugin has a configuration option. Set --tagbase=tags and links to tags
will be located under the specified base page. If ikiwiki is configured
this way, then the example above actually tags the page with the tags
diff --git a/doc/tags.mdwn b/doc/tags.mdwn
index 8d3a85cef..cd54fed36 100644
--- a/doc/tags.mdwn
+++ b/doc/tags.mdwn
@@ -2,17 +2,21 @@ While ikiwiki supports hierarchically categorising pages by creating
[[SubPage]]s, that's often not flexible enough, and it can also be useful
to tag pages in various non-hierarchical ways.
-Since this is a wiki, tagging is just a form of linking. For example, since
-this page links to [[features]], it can be considered to have something to
-do with ikiwiki's features. If you want to put pages into a category, the
-typical wiki way to do so is to create a "CategoryFoo" page and link pages
-in the category to it. That is just another form of tagging.
+Since this is a wiki, tagging is just a form of linking. The general rule
+is that all tags are links, but not all links are tags. So a tag is a
+special link that ikiwiki knows is intended to be used as a tag.
-Sometimes you may want to tag a page without putting a visible link on it.
+Generally you will tag a page without putting a visible link on it.
The [[tag_plugin|plugins/tag]] allows you to do so, like this:
\[[tag mytag othertag thirdtag]]
+You can also tag a page with a visible link:
+
+ \[[taglink mytag]]
+
+This tag will be displayed just like a regular [[WikiLink]].
+
One way to use these tags is to create a [[blog]] of pages that have a
particular set of tags. Or just look at the [[BackLinks]] to a tag page to
see all the pages that are tagged with it. [[Plugins]] can be written to do