summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdeodato Simó <dato@net.com.org.es>2008-03-02 17:29:02 +0100
committerJoey Hess <joey@kodama.kitenet.net>2008-03-02 18:04:09 -0500
commita8f08ab8e18877dd023430fc8926530244c74771 (patch)
tree86a5fd67b7d047a43d94c4781d47e5d3802957ab
parentbdb57e58334afb9ac1fab45f9f9653da4e5af98f (diff)
Make directives generated by shortcuts accept a `desc` parameter.
(cherry picked from commit 252da396bfa728b99af7c9bb304a7b5f3f6d94e6)
-rw-r--r--IkiWiki/Plugin/shortcut.pm3
-rw-r--r--debian/changelog8
-rw-r--r--doc/shortcuts.mdwn4
-rw-r--r--doc/todo/shortcut_with_different_link_text.mdwn6
4 files changed, 20 insertions, 1 deletions
diff --git a/IkiWiki/Plugin/shortcut.pm b/IkiWiki/Plugin/shortcut.pm
index fb096ecbd..c3e1f5446 100644
--- a/IkiWiki/Plugin/shortcut.pm
+++ b/IkiWiki/Plugin/shortcut.pm
@@ -62,6 +62,9 @@ sub shortcut_expand ($$@) { #{{{
}eg;
$text=~s/_/ /g;
+ if (defined $params{desc}) {
+ $desc=$params{desc};
+ }
if (defined $desc) {
$desc=~s/\%s/$text/g;
}
diff --git a/debian/changelog b/debian/changelog
index e5d6b44f6..bfd3266cb 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,11 @@
+ikiwiki (2.41) UNRELEASED; urgency=low
+
+ * Preprocessor directives generated by the shortcut plugin accept a `desc`
+ parameter that overrides the anchor text provided at shortcut definition
+ time. (Closes: #458126)
+
+ -- Adeodato Simó <dato@net.com.org.es> Sun, 02 Mar 2008 17:19:16 +0100
+
ikiwiki (2.40) unstable; urgency=low
[ Josh Triplett ]
diff --git a/doc/shortcuts.mdwn b/doc/shortcuts.mdwn
index e4e740897..8c0700165 100644
--- a/doc/shortcuts.mdwn
+++ b/doc/shortcuts.mdwn
@@ -7,6 +7,7 @@ Some examples of using shortcuts include:
\[[!google foo]]
\[[!wikipedia War_of_1812]]
\[[!debbug 12345]]
+ Check the \[[!cia ikiwiki desc="CIA page for %s"]].
This page controls what shortcut links the wiki supports.
@@ -62,7 +63,8 @@ controls the description of the link.
Remember that the `name` you give the shortcut will become a new
[[ikiwiki/PreprocessorDirective]]. Avoid using a `name` that conflicts
-with an existing directive.
+with an existing directive. These directives also accept a `desc`
+parameter that will override the one provided at definition time.
If you come up with a shortcut that you think others might find useful,
consider contributing it to the [shortcuts page on the ikiwiki
diff --git a/doc/todo/shortcut_with_different_link_text.mdwn b/doc/todo/shortcut_with_different_link_text.mdwn
index 07e999642..93f9651a4 100644
--- a/doc/todo/shortcut_with_different_link_text.mdwn
+++ b/doc/todo/shortcut_with_different_link_text.mdwn
@@ -57,5 +57,11 @@ So that the 'l' plugin inserts the location the page there, and markdown does th
For external links, that is no concern, however. So you could define for each shortcut an alternative directive, that inserts the URL. Perhaps `\[[url shortcutname params]]` or `\[[@shortcutname params]]` (if the preprocessor supported the @), and this could be extended to local links in an obvious manner: `\[[url page]]` or `\[[@page]]`. Now, if you could just get rid off the parantheses for markdown, for the short inline links --[[tuomov]] (who'd really rather not have two separate linking mechanisms: ikiwiki's heavy syntax and markdown's lighter one).
+---
+
+I've added code to make the \[[foo 123]] syntax accept a _desc_
+parameter. I've named it like this to signal that it overrides the
+_desc_ provided at description time. `%s` is expanded here as well.
+[[todo/done]] -- Adeodato Simó