qr/(^|\/)_MTN\//,
qr/\.dpkg-tmp$/],
wiki_link_regexp => qr{
- \[\[ # beginning of link
+ \[\[(?=[^!]) # beginning of link
(?:
- ([^\]\|\n\s]+) # 1: link text
+ ([^\]\|]+) # 1: link text
\| # followed by '|'
)? # optional
- ([^\s\]#]+) # 2: page to link to
+ ([^\n\r\]#]+) # 2: page to link to
(?:
\# # '#', beginning of anchor
([^\s\]]+) # 3: anchor text
usedirs => 1,
numbacklinks => 10,
account_creation_password => "",
+ prefix_directives => 0,
} #}}}
sub checkconfig () { #{{{
umask(possibly_foolish_untaint($config{umask}));
}
+ if (!$config{prefix_directives}) {
+ $config{wiki_link_regexp} = qr{
+ \[\[ # beginning of link
+ (?:
+ ([^\]\|\n\s]+) # 1: link text
+ \| # followed by '|'
+ )? # optional
+
+ ([^\s\]#]+) # 2: page to link to
+ (?:
+ \# # '#', beginning of anchor
+ ([^\s\]]+) # 3: anchor text
+ )? # optional
+
+ \]\] # end of link
+ }x,
+ }
+
run_hooks(checkconfig => sub { shift->() });
return 1;
my $handle=sub {
my $escape=shift;
+ my $prefix=shift;
my $command=shift;
my $params=shift;
if (length $escape) {
- return "[[$command $params]]";
+ return "[[$prefix$command $params]]";
}
elsif (exists $hooks{preprocess}{$command}) {
return "" if $scan && ! $hooks{preprocess}{$command}{scan};
return $ret;
}
else {
- return "[[$command $params]]";
+ return "[[$prefix$command $params]]";
}
};
- $content =~ s{
- (\\?) # 1: escape?
- \[\[ # directive open
- ([-\w]+) # 2: command
- \s+
- ( # 3: the parameters..
- (?:
- (?:[-\w]+=)? # named parameter key?
+ my $regex;
+ if ($config{prefix_directives}) {
+ $regex = qr{
+ (\\?) # 1: escape?
+ \[\[(!) # directive open; 2: prefix
+ ([-\w]+) # 3: command
+ ( # 4: the parameters..
+ \s+ # Must have space if parameters present
+ (?:
+ (?:[-\w]+=)? # named parameter key?
+ (?:
+ """.*?""" # triple-quoted value
+ |
+ "[^"]+" # single-quoted value
+ |
+ [^\s\]]+ # unquoted value
+ )
+ \s* # whitespace or end
+ # of directive
+ )
+ *)? # 0 or more parameters
+ \]\] # directive closed
+ }sx;
+ } else {
+ $regex = qr{
+ (\\?) # 1: escape?
+ \[\[(!?) # directive open; 2: optional prefix
+ ([-\w]+) # 3: command
+ \s+
+ ( # 4: the parameters..
(?:
- """.*?""" # triple-quoted value
- |
- "[^"]+" # single-quoted value
- |
- [^\s\]]+ # unquoted value
+ (?:[-\w]+=)? # named parameter key?
+ (?:
+ """.*?""" # triple-quoted value
+ |
+ "[^"]+" # single-quoted value
+ |
+ [^\s\]]+ # unquoted value
+ )
+ \s* # whitespace or end
+ # of directive
)
- \s* # whitespace or end
- # of directive
- )
- *) # 0 or more parameters
- \]\] # directive closed
- }{$handle->($1, $2, $3)}sexg;
+ *) # 0 or more parameters
+ \]\] # directive closed
+ }sx;
+ }
+
+ $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
return $content;
} #}}}
exit;
}
+ my $prefix=$config{prefix_directives} ? "!poll" : "poll";
+
my $content=readfile(srcfile($pagesources{$page}));
# Now parse the content, find the right poll,
# and find the choice within it, and increment its number.
my $edit=sub {
my $escape=shift;
my $params=shift;
- return "\\[[poll $params]]" if $escape;
+ return "\\[[$prefix $params]]" if $escape;
if (--$num == 0) {
$params=~s/(^|\s+)(\d+)\s+"?\Q$choice\E"?(\s+|$)/$1.($2+1)." \"$choice\"".$3/se;
if (defined $oldchoice) {
$params=~s/(^|\s+)(\d+)\s+"?\Q$oldchoice\E"?(\s+|$)/$1.($2-1 >=0 ? $2-1 : 0)." \"$oldchoice\"".$3/se;
}
}
- return "[[poll $params]]";
+ return "[[$prefix $params]]";
};
- $content =~ s{(\\?)\[\[poll\s+([^]]+)\s*\]\]}{$edit->($1, $2)}seg;
+ $content =~ s{(\\?)\[\[\Q$prefix\E\s+([^]]+)\s*\]\]}{$edit->($1, $2)}seg;
# Store their vote, update the page, and redirect to it.
writefile($pagesources{$page}, $config{srcdir}, $content);
./mdwn2man ikiwiki 1 doc/usage.mdwn > ikiwiki.man
./mdwn2man ikiwiki-mass-rebuild 8 doc/ikiwiki-mass-rebuild.mdwn > ikiwiki-mass-rebuild.man
./mdwn2man ikiwiki-makerepo 1 doc/ikiwiki-makerepo.mdwn > ikiwiki-makerepo.man
+ ./mdwn2man ikiwiki-transition 1 doc/ikiwiki-transition.mdwn > ikiwiki-transition.man
./mdwn2man ikiwiki-update-wikilist 1 doc/ikiwiki-update-wikilist.mdwn > ikiwiki-update-wikilist.man
$(MAKE) -C po
if [ "$$PROFILE" = 1 ]; then dprofpp; fi
install -d $(DESTDIR)$(PREFIX)/share/man/man1
install -m 644 ikiwiki.man $(DESTDIR)$(PREFIX)/share/man/man1/ikiwiki.1
install -m 644 ikiwiki-makerepo.man $(DESTDIR)$(PREFIX)/share/man/man1/ikiwiki-makerepo.1
+ install -m 644 ikiwiki-transition.man $(DESTDIR)$(PREFIX)/share/man/man1/ikiwiki-transition.1
install -m 644 ikiwiki-update-wikilist.man $(DESTDIR)$(PREFIX)/share/man/man1/ikiwiki-update-wikilist.1
install -d $(DESTDIR)$(PREFIX)/share/man/man8
install -d $(DESTDIR)$(PREFIX)/bin
install ikiwiki.out $(DESTDIR)$(PREFIX)/bin/ikiwiki
- install ikiwiki-makerepo ikiwiki-update-wikilist $(DESTDIR)$(PREFIX)/bin/
+ install ikiwiki-makerepo ikiwiki-transition ikiwiki-update-wikilist $(DESTDIR)$(PREFIX)/bin/
$(MAKE) -C po install DESTDIR=$(DESTDIR) PREFIX=$(PREFIX)
}
+ikiwiki (2.31) unstable; urgency=low
+
+ ikiwiki now has an new syntax for preprocessor directives, using the
+ prefix '!':
+
+ [[!directive ...]]
+
+ This new syntax no longer relies on spaces to distinguish between
+ wikilinks and preprocessor directives. Thus, wikilinks can use spaces
+ in their link text, and preprocessor directives without arguments (such
+ as "toc") need not use a trailing space.
+
+ To enable the new syntax, set prefix_directives to true in your ikiwiki
+ config. For backward compatibility with existing wikis,
+ prefix_directives currently defaults to false. In ikiwiki 3.0,
+ prefix_directives will default to true, and wikis which have not yet
+ converted to the new syntax will need to set prefix_directives to false
+ in their setup files.
+
+ To convert your wiki to the new syntax, ikiwiki provides a new script
+ ikiwiki-transition. It will convert preprocessor directives in
+ all files given on the command line. To convert an entire wiki:
+
+ find wikidir/ -type f -name '*.mdwn' -print0 | xargs -0 ikiwiki-transition prefix_directives
+
+ Even with prefix_directives disabled, ikiwiki now allows an optional '!'
+ prefix on preprocessor directives (but still requires a space). Thus, a
+ directive which uses a '!' prefix and contains a space will work with
+ ikiwiki 2.21 and newer, regardless of the value of prefix_directives.
+ This allows the underlay to work with all ikiwikis.
+
+ -- Josh Triplett <josh@freedesktop.org> Sat, 26 Jan 2008 16:26:47 -0800
+
ikiwiki (2.30) unstable; urgency=low
Ever feel that ikiwiki's handling of RecentChanges wasn't truely in the
Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild.
With this excellent new RecentChanges support, the mail notification system
- is showing its age (and known to be variously buggy and underimplemented for
+ is its age (and known to be variously buggy and underimplemented for
various VCSes), and so ikiwiki's support for sending commit mails is REMOVED
from this version. If you were subscribed to commit mails, you should be
able to accomplish the same thing by subscribing to a RecentChanges feed.
+ikiwiki (2.40) UNRELEASED; urgency=low
+
+ [ Josh Triplett ]
+ * Add new preprocessor directive syntax¸ using a '!' prefix. Add a
+ prefix_directives option to the setup file to turn this syntax on;
+ currently defaults to false, for backward compatibility. Support
+ optional '!' prefix even with prefix_directives off, and use that in
+ the underlay to support either setting of prefix_directives. Add NEWS
+ entry with migration information.
+
+ -- Josh Triplett <josh@freedesktop.org> Sat, 09 Feb 2008 23:01:19 -0800
+
ikiwiki (2.31) unstable; urgency=low
[ Joey Hess ]
--- /dev/null
+# NAME
+
+ikiwiki-transition - transition ikiwiki pages to new syntaxes
+
+# SYNOPSIS
+
+ikiwiki-transition prefix_directives page.mdwn...
+
+# DESCRIPTION
+
+`ikiwiki-transition` aids in converting ikiwiki pages when
+there's a major change in ikiwiki syntax.
+
+Currently only one such transition is handled, the `prefix_directives` mode
+converts an ikiwiki page from the old preprocessor directive syntax,
+requiring a space, to the new syntax, prefixed by '!'.
+
+Preprocessor directives which already use the new syntax will remain
+unchanged.
+
+Note that if the page contains wiki links with spaces, which some
+older versions of ikiwiki accepted, the prefix_directives transition will
+treat these as preprocessor directives and convert them.
+
+# AUTHOR
+
+Josh Triplett <josh@freedesktop.org>
+
+Warning: this page is automatically made into ikiwiki-transition's man page, edit with care
This wiki is powered by [ikiwiki](http://ikiwiki.info/).
-[[if test="enabled(version)"
- then="(Currently running version [[version ]].)"
+[[!if test="enabled(version)"
+ then="(Currently running version [[!version ]].)"
]]
Some documentation on using ikiwiki:
# Default settings for the recentchanges page.
#recentchangespage => "recentchanges",
#recentchangesnum => 100,
+ # Use new '!'-prefixed preprocessor directive syntax
+ #prefix_directives => 0,
# To add plugins, list them here.
#add_plugins => [qw{goodstuff search wikitext camelcase
-[[if test="enabled(inline)"
+[[!if test="enabled(inline)"
then="This wiki has the inline plugin **enabled**."
else="This wiki has the inline plugin **disabled**."]]
-[[if test="enabled(inline)"
+[[!if test="enabled(inline)"
then="You can"
else="If this wiki had the inline plugin enabled, you could"]]
turn any page on this wiki into a weblog by using the `inline`
[[PreProcessorDirective]]. For example:
- \[[inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
+ \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]]
Any pages that match the specified [[PageSpec]] (in the example, any
[[SubPage]] of "blog") will be part of the blog, and the newest 10
If you want your blog to have an archive page listing every post ever made
to it, you can accomplish that like this:
- \[[inline pages="blog/* and !*/Discussion" archive="yes"]]
+ \[[!inline pages="blog/* and !*/Discussion" archive="yes"]]
You can even create an automatically generated list of all the pages on the
wiki, with the most recently added at the top, like this:
- \[[inline pages="* and !*/Discussion" archive="yes"]]
+ \[[!inline pages="* and !*/Discussion" archive="yes"]]
If you want to be able to add pages to a given blog feed by tagging them,
you can do that too. To tag a page, just make it link to a page or pages
that represent its tags. Then use the special `link()` [[PageSpec]] to match
all pages that have a given tag:
- \[[inline pages="link(life)"]]
+ \[[!inline pages="link(life)"]]
Or include some tags and exclude others:
- \[[inline pages="link(debian) and !link(social)"]]
+ \[[!inline pages="link(debian) and !link(social)"]]
## usage
-[[meta title="Formatting wiki pages"]]
+[[!meta title="Formatting wiki pages"]]
Text on this wiki is, by default, written in a form very close to how you
might write text for an email message. This style of text formatting is
* To link to another page on the wiki, place the page's name inside double
square brackets. So you would use `\[[WikiLink]]` to link to [[WikiLink]].
-[[if test="enabled(smiley) and smileys" then="""
+[[!if test="enabled(smiley) and smileys" then="""
* Insert [[smileys]] and some other useful symbols. :-)
"""]]
-[[if test="enabled(shortcut) and shortcuts" then="""
+[[!if test="enabled(shortcut) and shortcuts" then="""
* Use [[shortcuts]] to link to common resources.
- \[[wikipedia War\_of\_1812]]
+ \[[!wikipedia War\_of\_1812]]
"""]]
-[[if test="enabled(toc)" then="""
+[[!if test="enabled(toc)" then="""
* Add a table of contents to a page:
- \[[toc ]]
+ \[[!toc ]]
"""]]
-[[if test="enabled(meta)" then="""
+[[!if test="enabled(meta)" then="""
* Change the title of a page:
- \[[meta title="full page title"]]
+ \[[!meta title="full page title"]]
"""]]
-[[if test="enabled(inline) and blog" then="""
+[[!if test="enabled(inline) and blog" then="""
* Create a [[blog]] by inlining a set of pages:
- \[[inline pages="blog/*"]]
+ \[[!inline pages="blog/*"]]
"""]]
-[[if test="enabled(template) and templates" then="""
+[[!if test="enabled(template) and templates" then="""
* Create and fill out [[templates]] for repeated chunks of
parameterized wiki text.
"""]]
-[[meta title="OpenID"]]
+[[!meta title="OpenID"]]
-[[if test="enabled(openid)"
+[[!if test="enabled(openid)"
then="This wiki has OpenID **enabled**."
else="This wiki has OpenID **disabled**."]]
* or any of the [many others out there](http://openiddirectory.com/index.php?dir=1)..
Your OpenID is the URL that you are given when you sign up.
-[[if test="enabled(openid)" then="""
+[[!if test="enabled(openid)" then="""
To sign in to this wiki using OpenID, just enter it in the OpenID field in the
signin form. You do not need to give this wiki a password or go through any
registration process when using OpenID.
It's also possible to make a page in the wiki usable as an OpenID url,
by delegating it to an openid server. Here's an example of how to do that:
- \[[meta openid="http://yourid.myopenid.com/"
+ \[[!meta openid="http://yourid.myopenid.com/"
server="http://www.myopenid.com/server"]]
Preprocessor directives are similar to a [[WikiLink]] in form, except they
-contain spaces and parameters. The general form is:
+begin with `!` and may contain parameters. The general form is:
- \[[directive param="value" param="value"]]
+ \[[!directive param="value" param="value"]]
This gets expanded before the rest of the page is processed, and can be used
to transform the page in various ways.
The quotes around values can be omitted if the value is a simple word.
Also, some directives may use parameters without values, for example:
- \[[tag foo]]
-
-Note that if a preprocessor directive has no parameters, a space still must
-be put after its name, to avoid confusion with a [[WikiLink]]. For example:
-
- \[[pagecount ]]
+ \[[!tag foo]]
A preprocessor directive does not need to all be on one line, it can be
wrapped to multiple lines if you like:
- \[[directive foo="baldersnatch"
+ \[[!directive foo="baldersnatch"
bar="supercalifragalisticexpealadocious" baz=11]]
Also, multiple lines of *quoted* text can be used for a value.
To allow quote marks inside the quoted text, delimit the block
of text with triple-quotes:
- \[[directive text="""
+ \[[!directive text="""
1. "foo"
2. "bar"
3. "baz"
"""]]
+
+ikiwiki also has an older syntax for preprocessor directives, which requires a
+space in directives to distinguish them from [[wikilinks|wikilink]]. This
+syntax has several disadvantages: it requires a space after directives with no
+parameters (such as `\[[!pagecount ]]`), and it prohibits spaces in
+[[wikilinks|wikilink]]. ikiwiki now provides the `!`-prefixed syntax shown
+above as the preferred alternative. However, ikiwiki still supports wikis
+using the older syntax, if their setup files disable the `prefix_directives`
+option. For backward compatibility with existing wikis, this option currently
+defaults to off, so ikiwiki uses the old directive syntax; however, future
+versions of ikiwiki will turn this on by default.
To link to an anchor inside a page, you can use something like
`\[[WikiLink#foo]]`
-**Note that you cannot use spaces in WikiLinks**. Replace spaces with
-underscores. The presence of spaces is used to distinguish between a
-[[PreprocessorDirective]] and a WikiLink.
+## Preprocessor directives and wikilinks
+
+ikiwiki has two syntaxes for
+[[preprocessor_directives|PreprocessorDirective]]. The older syntax
+used spaces to distinguish between preprocessor directives and
+wikilinks; as a result, with that syntax in use, you cannot use spaces
+in WikiLinks, and must replace spaces with underscores. The newer
+syntax, enabled with the `prefix_directives` option in an ikiwiki
+setup file, prefixes directives with `!`, and thus does not prevent
+links with spaces. Future versions of ikiwiki will turn this option
+on by default.
\ No newline at end of file
-[[meta title="RecentChanges"]]
+[[!meta title="RecentChanges"]]
Recent changes to this wiki:
-[[inline pages="internal(recentchanges/change_*) and !*/Discussion"
+[[!inline pages="internal(recentchanges/change_*) and !*/Discussion"
template=recentchanges show=0]]
----
+# 3.0
+
+Still in the early planning stages, version 3.0 will be an opportunity to
+make significant transitions.
+
+* Default to using prefix_directives.
+
+----
+
# future goals
* Improved [[todo/html]] stylesheets and templates.
-[[if test="enabled(shortcut)"
+[[!if test="enabled(shortcut)"
then="This wiki has shortcuts **enabled**."
else="This wiki has shortcuts **disabled**."]]
Some examples of using shortcuts include:
- \[[google foo]]
- \[[wikipedia War_of_1812]]
- \[[debbug 12345]]
+ \[[!google foo]]
+ \[[!wikipedia War_of_1812]]
+ \[[!debbug 12345]]
This page controls what shortcut links the wiki supports.
-* [[shortcut name=google url="http://www.google.com/search?q=%s"]]
-* [[shortcut name=archive url="http://web.archive.org/*/%S"]]
-* [[shortcut name=gmap url="http://maps.google.com/maps?q=%s"]]
-* [[shortcut name=gmsg url="http://groups.google.com/groups?selm=%s"]]
-* [[shortcut name=wikipedia url="http://en.wikipedia.org/wiki/%s"]]
-* [[shortcut name=wikitravel url="http://wikitravel.org/en/%s"]]
-* [[shortcut name=debbug url="http://bugs.debian.org/%s" desc="bug #%s"]]
-* [[shortcut name=deblist url="http://lists.debian.org/debian-%s" desc="debian-%s@lists.debian.org"]]
-* [[shortcut name=debpkg url="http://packages.debian.org/%s"]]
-* [[shortcut name=debpts url="http://packages.qa.debian.org/%s"]]
-* [[shortcut name=debmsg url="http://lists.debian.org/msgid-search/%s"]]
-* [[shortcut name=debrt url="https://rt.debian.org/Ticket/Display.html?id=%s"]]
-* [[shortcut name=debss url="http://snapshot.debian.net/package/%s"]]
- * Usage: `\[[debss package]]`, `\[[debss package#version]]`, or `\[[debss package/version]]`. See http://snapshot.debian.net for details.
-* [[shortcut name=fdobug url="https://bugs.freedesktop.org/show_bug.cgi?id=%s" desc="freedesktop.org bug #%s"]]
-* [[shortcut name=fdolist url="http://lists.freedesktop.org/mailman/listinfo/%s" desc="%s@lists.freedesktop.org"]]
-* [[shortcut name=gnomebug url="http://bugzilla.gnome.org/show_bug.cgi?id=%s" desc="GNOME bug #%s"]]
-* [[shortcut name=linuxbug url="http://bugzilla.kernel.org/show_bug.cgi?id=%s" desc="Linux bug #%s"]]
-* [[shortcut name=mozbug url="https://bugzilla.mozilla.org/show_bug.cgi?id=%s" desc="Mozilla bug #%s"]]
-* [[shortcut name=gnulist url="http://lists.gnu.org/mailman/listinfo/%s" desc="%s@gnu.org"]]
-* [[shortcut name=marcmsg url="http://marc.info/?i=%s"]]
-* [[shortcut name=marclist url="http://marc.info/?l=%s"]]
-* [[shortcut name=gmane url="http://dir.gmane.org/gmane.%s" desc="gmane.%s"]]
-* [[shortcut name=gmanemsg url="http://mid.gmane.org/%s"]]
-* [[shortcut name=cpan url="http://search.cpan.org/search?mode=dist&query=%s"]]
-* [[shortcut name=ctan url="http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=%s"]]
-* [[shortcut name=hoogle url="http://haskell.org/hoogle/?q=%s"]]
-* [[shortcut name=iki url="http://ikiwiki.info/%S/"]]
-* [[shortcut name=ljuser url="http://%s.livejournal.com/"]]
-* [[shortcut name=rfc url="http://www.ietf.org/rfc/rfc%s.txt" desc="RFC %s"]]
-* [[shortcut name=c2 url="http://c2.com/cgi/wiki?%s"]]
-* [[shortcut name=meatballwiki url="http://www.usemod.com/cgi-bin/mb.pl?%s"]]
-* [[shortcut name=emacswiki url="http://www.emacswiki.org/cgi-bin/wiki/%s"]]
-* [[shortcut name=haskellwiki url="http://haskell.org/haskellwiki/%s"]]
-* [[shortcut name=dict url="http://www.dict.org/bin/Dict?Form=Dict1&Strategy=*&Database=*&Query=%s"]]
-* [[shortcut name=imdb url="http://imdb.com/find?q=%s"]]
-* [[shortcut name=gpg url="http://pgpkeys.mit.edu:11371/pks/lookup?op=vindex&exact=on&search=0x%s"]]
-* [[shortcut name=perldoc url="http://perldoc.perl.org/search.html?q=%s"]]
-* [[shortcut name=whois url="http://reports.internic.net/cgi/whois?whois_nic=%s&type=domain"]]
-* [[shortcut name=cve url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=%s"]]
-* [[shortcut name=cia url="http://cia.vc/stats/project/%s"]]
-* [[shortcut name=ciauser url="http://cia.vc/stats/user/%s"]]
-* [[shortcut name=flickr url="http://www.flickr.com/photos/%s"]]
+* [[!shortcut name=google url="http://www.google.com/search?q=%s"]]
+* [[!shortcut name=archive url="http://web.archive.org/*/%S"]]
+* [[!shortcut name=gmap url="http://maps.google.com/maps?q=%s"]]
+* [[!shortcut name=gmsg url="http://groups.google.com/groups?selm=%s"]]
+* [[!shortcut name=wikipedia url="http://en.wikipedia.org/wiki/%s"]]
+* [[!shortcut name=wikitravel url="http://wikitravel.org/en/%s"]]
+* [[!shortcut name=debbug url="http://bugs.debian.org/%s" desc="bug #%s"]]
+* [[!shortcut name=deblist url="http://lists.debian.org/debian-%s" desc="debian-%s@lists.debian.org"]]
+* [[!shortcut name=debpkg url="http://packages.debian.org/%s"]]
+* [[!shortcut name=debpts url="http://packages.qa.debian.org/%s"]]
+* [[!shortcut name=debmsg url="http://lists.debian.org/msgid-search/%s"]]
+* [[!shortcut name=debrt url="https://rt.debian.org/Ticket/Display.html?id=%s"]]
+* [[!shortcut name=debss url="http://snapshot.debian.net/package/%s"]]
+ * Usage: `\[[!debss package]]`, `\[[!debss package#version]]`, or `\[[!debss package/version]]`. See http://snapshot.debian.net for details.
+* [[!shortcut name=fdobug url="https://bugs.freedesktop.org/show_bug.cgi?id=%s" desc="freedesktop.org bug #%s"]]
+* [[!shortcut name=fdolist url="http://lists.freedesktop.org/mailman/listinfo/%s" desc="%s@lists.freedesktop.org"]]
+* [[!shortcut name=gnomebug url="http://bugzilla.gnome.org/show_bug.cgi?id=%s" desc="GNOME bug #%s"]]
+* [[!shortcut name=linuxbug url="http://bugzilla.kernel.org/show_bug.cgi?id=%s" desc="Linux bug #%s"]]
+* [[!shortcut name=mozbug url="https://bugzilla.mozilla.org/show_bug.cgi?id=%s" desc="Mozilla bug #%s"]]
+* [[!shortcut name=gnulist url="http://lists.gnu.org/mailman/listinfo/%s" desc="%s@gnu.org"]]
+* [[!shortcut name=marcmsg url="http://marc.info/?i=%s"]]
+* [[!shortcut name=marclist url="http://marc.info/?l=%s"]]
+* [[!shortcut name=gmane url="http://dir.gmane.org/gmane.%s" desc="gmane.%s"]]
+* [[!shortcut name=gmanemsg url="http://mid.gmane.org/%s"]]
+* [[!shortcut name=cpan url="http://search.cpan.org/search?mode=dist&query=%s"]]
+* [[!shortcut name=ctan url="http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=%s"]]
+* [[!shortcut name=hoogle url="http://haskell.org/hoogle/?q=%s"]]
+* [[!shortcut name=iki url="http://ikiwiki.info/%S/"]]
+* [[!shortcut name=ljuser url="http://%s.livejournal.com/"]]
+* [[!shortcut name=rfc url="http://www.ietf.org/rfc/rfc%s.txt" desc="RFC %s"]]
+* [[!shortcut name=c2 url="http://c2.com/cgi/wiki?%s"]]
+* [[!shortcut name=meatballwiki url="http://www.usemod.com/cgi-bin/mb.pl?%s"]]
+* [[!shortcut name=emacswiki url="http://www.emacswiki.org/cgi-bin/wiki/%s"]]
+* [[!shortcut name=haskellwiki url="http://haskell.org/haskellwiki/%s"]]
+* [[!shortcut name=dict url="http://www.dict.org/bin/Dict?Form=Dict1&Strategy=*&Database=*&Query=%s"]]
+* [[!shortcut name=imdb url="http://imdb.com/find?q=%s"]]
+* [[!shortcut name=gpg url="http://pgpkeys.mit.edu:11371/pks/lookup?op=vindex&exact=on&search=0x%s"]]
+* [[!shortcut name=perldoc url="http://perldoc.perl.org/search.html?q=%s"]]
+* [[!shortcut name=whois url="http://reports.internic.net/cgi/whois?whois_nic=%s&type=domain"]]
+* [[!shortcut name=cve url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=%s"]]
+* [[!shortcut name=cia url="http://cia.vc/stats/project/%s"]]
+* [[!shortcut name=ciauser url="http://cia.vc/stats/user/%s"]]
+* [[!shortcut name=flickr url="http://www.flickr.com/photos/%s"]]
To add a new shortcut, use the `shortcut`
[[ikiwiki/PreprocessorDirective]]. In the url, "%s" is replaced with the
-[[if test="enabled(template)"
+[[!if test="enabled(template)"
then="This wiki has templates **enabled**."
else="This wiki has templates **disabled**."
]]
Templates are files that can be filled out and inserted into pages in the
wiki.
-[[if test="enabled(template) and enabled(inline)" then="""
+[[!if test="enabled(template) and enabled(inline)" then="""
## Available templates
These templates are available for inclusion onto other pages in this
wiki:
-[[inline pages="templates/* and !*/discussion" feeds=no archive=yes
+[[!inline pages="templates/* and !*/discussion" feeds=no archive=yes
sort=title template=titlepage]]
"""]]
Using a template works like this:
- \[[template id=note text="""Here is the text to insert into my note."""]]
+ \[[!template id=note text="""Here is the text to insert into my note."""]]
This fills out the [[note]] template, filling in the `text` field with
the specified value, and inserts the result into the page.
be included in it. Combined with multi-line quoted values, this allows for
large chunks of marked up text to be embedded into a template:
- \[[template id=foo name="Sally" color="green" age=8 notes="""
+ \[[!template id=foo name="Sally" color="green" age=8 notes="""
* \[[Charley]]'s sister.
* "I want to be an astronaut when I grow up."
* Really 8 and a half.
provide a link that can be used to create the template. The template is a
regular wiki page, located in the `templates/` directory.
-The template uses the syntax used by the [[cpan HTML::Template]] perl
+The template uses the syntax used by the [[!cpan HTML::Template]] perl
module, which allows for some fairly complex things to be done. Consult its
documentation for the full syntax, but all you really need to know are a
few things:
with no arguments, such as `\[[toc ]]`
--[[JoshTriplett]]
+
+[[done]] in version 2.21, using the '!'-prefixed syntax. --[[JoshTriplett]]
\ No newline at end of file
Toggle creating output files named page/index.html (default) instead of page.html.
+* --prefix-directives, --no-prefix-directives
+
+ Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently
+ defaults to --no-prefix-directives.
+
* --w3mmode, --no-w3mmode
Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
--- /dev/null
+#!/usr/bin/perl -i
+use warnings;
+use strict;
+
+my $regex = qr{
+ (\\?) # 1: escape?
+ \[\[(!?) # directive open; 2: optional prefix
+ ([-\w]+) # 3: command
+ ( # 4: the parameters (including initial whitespace)
+ \s+
+ (?:
+ (?:[-\w]+=)? # named parameter key?
+ (?:
+ """.*?""" # triple-quoted value
+ |
+ "[^"]+" # single-quoted value
+ |
+ [^\s\]]+ # unquoted value
+ )
+ \s* # whitespace or end
+ # of directive
+ )
+ *) # 0 or more parameters
+ \]\] # directive closed
+}sx;
+
+sub handle_directive {
+ my $escape = shift;
+ my $prefix = shift;
+ my $directive = shift;
+ my $args = shift;
+
+ if (length $escape) {
+ return "${escape}[[${prefix}${directive}${args}]]"
+ }
+ if ($directive =~ m/^(if|more|table|template|toggleable)$/) {
+ $args =~ s{$regex}{handle_directive($1, $2, $3, $4)}eg;
+ }
+ return "[[!${directive}${args}]]"
+}
+
+sub prefix_directives {
+ $/=undef; # process whole files at once
+
+ while (<>) {
+ s{$regex}{handle_directive($1, $2, $3, $4)}eg;
+ print;
+ }
+}
+
+sub usage {
+ print STDERR "Usage: ikiwiki-transition type file ...\n";
+ print STDERR "Currently supported transition types:\n";
+ print STDERR " prefix_directives\n";
+ exit 1;
+}
+
+usage() unless @ARGV;
+
+my $mode=shift;
+if ($mode eq 'prefix_directives') {
+ prefix_directives(@ARGV);
+}
+else {
+ usage();
+}
"render=s" => \$config{render},
"wrappers!" => \$config{wrappers},
"usedirs!" => \$config{usedirs},
+ "prefix-directives!" => \$config{prefix_directives},
"getctime" => \$config{getctime},
"numbacklinks=i" => \$config{numbacklinks},
"rcs=s" => \$config{rcs},
#!/usr/bin/perl
use warnings;
use strict;
-use Test::More tests => 16;
+use Test::More tests => 32;
BEGIN { use_ok("IkiWiki"); }
+my $prefix_directives;
+
sub linkify ($$$$) {
my $lpage=shift;
my $page=shift;
$renderedfiles{"$page.mdwn"}=[$page];
$destsources{$page}="$page.mdwn";
}
+
%config=IkiWiki::defaultconfig();
$config{cgiurl}="http://somehost/ikiwiki.cgi";
+ $config{srcdir}=$config{destdir}="/dev/null"; # placate checkconfig
# currently coded for non usedirs mode (TODO: check both)
$config{usedirs}=0;
+ $config{prefix_directives}=$prefix_directives;
+
+ IkiWiki::checkconfig();
return IkiWiki::linkify($lpage, $page, $content);
}
}
}
+# Tests that are the same for both styles of prefix directives.
+foreach $prefix_directives (0,1) {
+ ok(links_to("bar", linkify("foo", "foo", "link to [[bar]] ok", ["foo", "bar"])), "ok link");
+ ok(links_to("bar_baz", linkify("foo", "foo", "link to [[bar_baz]] ok", ["foo", "bar_baz"])), "ok link");
+ ok(not_links_to("bar", linkify("foo", "foo", "link to \\[[bar]] ok", ["foo", "bar"])), "escaped link");
+ ok(links_to("page=bar", linkify("foo", "foo", "link to [[bar]] ok", ["foo"])), "broken link");
+ ok(links_to("bar", linkify("foo", "foo", "link to [[baz]] and [[bar]] ok", ["foo", "baz", "bar"])), "dual links");
+ ok(links_to("baz", linkify("foo", "foo", "link to [[baz]] and [[bar]] ok", ["foo", "baz", "bar"])), "dual links");
+ ok(links_to("bar", linkify("foo", "foo", "link to [[some_page|bar]] ok", ["foo", "bar"])), "named link");
+ ok(links_text("some page", linkify("foo", "foo", "link to [[some_page|bar]] ok", ["foo", "bar"])), "named link text");
+ ok(links_text("0", linkify("foo", "foo", "link to [[0|bar]] ok", ["foo", "bar"])), "named link to 0");
+ ok(links_text("Some long, & complex page name.", linkify("foo", "foo", "link to [[Some_long,_&_complex_page_name.|bar]] ok, and this is not a link]] here", ["foo", "bar"])), "complex named link text");
+ ok(links_to("foo/bar", linkify("foo/item", "foo", "link to [[bar]] ok", ["foo", "foo/item", "foo/bar"])), "inline page link");
+ ok(links_to("bar", linkify("foo", "foo", "link to [[bar]] ok", ["foo", "foo/item", "foo/bar"])), "same except not inline");
+ ok(links_to("bar#baz", linkify("foo", "foo", "link to [[bar#baz]] ok", ["foo", "bar"])), "anchor link");
+}
+
+$prefix_directives=0;
+ok(not_links_to("some_page", linkify("foo", "foo", "link to [[some page]] ok", ["foo", "bar", "some_page"])),
+ "link with whitespace, without prefix_directives");
+ok(not_links_to("bar", linkify("foo", "foo", "link to [[some page|bar]] ok", ["foo", "bar"])),
+ "named link, with whitespace, without prefix_directives");
-ok(links_to("bar", linkify("foo", "foo", "link to [[bar]] ok", ["foo", "bar"])), "ok link");
-ok(links_to("bar_baz", linkify("foo", "foo", "link to [[bar_baz]] ok", ["foo", "bar_baz"])), "ok link");
-ok(not_links_to("bar", linkify("foo", "foo", "link to \\[[bar]] ok", ["foo", "bar"])), "escaped link");
-ok(links_to("page=bar", linkify("foo", "foo", "link to [[bar]] ok", ["foo"])), "broken link");
-ok(links_to("bar", linkify("foo", "foo", "link to [[baz]] and [[bar]] ok", ["foo", "baz", "bar"])), "dual links");
-ok(links_to("baz", linkify("foo", "foo", "link to [[baz]] and [[bar]] ok", ["foo", "baz", "bar"])), "dual links");
-ok(links_to("bar", linkify("foo", "foo", "link to [[some_page|bar]] ok", ["foo", "bar"])), "named link");
-ok(links_text("some page", linkify("foo", "foo", "link to [[some_page|bar]] ok", ["foo", "bar"])), "named link text");
-ok(not_links_to("bar", linkify("foo", "foo", "link to [[some page|bar]] ok", ["foo", "bar"])), "named link, with whitespace");
-ok(not_links_to("bar", linkify("foo", "foo", "link to [[some page|bar]] ok", ["foo", "bar"])), "named link text, with whitespace");
-ok(links_text("0", linkify("foo", "foo", "link to [[0|bar]] ok", ["foo", "bar"])), "named link to 0");
-ok(links_text("Some long, & complex page name.", linkify("foo", "foo", "link to [[Some_long,_&_complex_page_name.|bar]] ok, and this is not a link]] here", ["foo", "bar"])), "complex named link text");
-ok(links_to("foo/bar", linkify("foo/item", "foo", "link to [[bar]] ok", ["foo", "foo/item", "foo/bar"])), "inline page link");
-ok(links_to("bar", linkify("foo", "foo", "link to [[bar]] ok", ["foo", "foo/item", "foo/bar"])), "same except not inline");
-ok(links_to("bar#baz", linkify("foo", "foo", "link to [[bar#baz]] ok", ["foo", "bar"])), "anchor link");
+$prefix_directives=1;
+ok(links_to("some_page", linkify("foo", "foo", "link to [[some page]] ok", ["foo", "bar", "some_page"])),
+ "link with whitespace");
+ok(links_to("bar", linkify("foo", "foo", "link to [[some page|bar]] ok", ["foo", "bar"])),
+ "named link, with whitespace");
+ok(links_text("some page", linkify("foo", "foo", "link to [[some page|bar]] ok", ["foo", "bar"])),
+ "named link text, with whitespace");
#!/usr/bin/perl
use warnings;
use strict;
-use Test::More tests => 17;
+use Test::More tests => 19;
BEGIN { use_ok("IkiWiki"); }
is(IkiWiki::preprocess("foo", "foo", "[[foo]]", 0, 0), "[[foo]]", "not wikilink");
is(IkiWiki::preprocess("foo", "foo", "[[foo ]]", 0, 0), "foo()", "simple");
+is(IkiWiki::preprocess("foo", "foo", "[[!foo ]]", 0, 0), "foo()", "prefixed");
+is(IkiWiki::preprocess("foo", "foo", "[[!foo]]", 0, 0), "[[!foo]]", "prefixed, no space");
is(IkiWiki::preprocess("foo", "foo", "[[foo a=1]]", 0, 0), "foo(a => 1)");
is(IkiWiki::preprocess("foo", "foo", "[[foo a=\"1 2 3 4\"]]", 0, 0), "foo(a => 1 2 3 4)");
is(IkiWiki::preprocess("foo", "foo", "[[foo ]] then [[foo a=2]]", 0, 0),
<TMPL_VAR CONTENT>
<TMPL_LOOP NAME="TAGS">
-[[tag <TMPL_VAR TAG>]]
+[[!tag <TMPL_VAR TAG>]]
</TMPL_LOOP>
<TMPL_IF NAME="TITLE">
-[[meta title="<TMPL_VAR NAME="TITLE" ESCAPE=HTML>"]]
+[[!meta title="<TMPL_VAR NAME="TITLE" ESCAPE=HTML>"]]
</TMPL_IF>
<TMPL_IF NAME="PERMALINK">
-[[meta permalink="<TMPL_VAR NAME="PERMALINK" ESCAPE=HTML>"]]
+[[!meta permalink="<TMPL_VAR NAME="PERMALINK" ESCAPE=HTML>"]]
</TMPL_IF>
<TMPL_IF NAME="COPYRIGHT">
-[[meta copyright="<TMPL_VAR NAME="COPYRIGHT" ESCAPE=HTML>"]]
+[[!meta copyright="<TMPL_VAR NAME="COPYRIGHT" ESCAPE=HTML>"]]
</TMPL_IF>
-[[meta author="<TMPL_VAR NAME="NAME" ESCAPE=HTML>"]]
-[[meta authorurl="<TMPL_VAR NAME="URL" ESCAPE=HTML>"]]
+[[!meta author="<TMPL_VAR NAME="NAME" ESCAPE=HTML>"]]
+[[!meta authorurl="<TMPL_VAR NAME="URL" ESCAPE=HTML>"]]
-[[meta author="""<TMPL_VAR AUTHOR>"""]]
+[[!meta author="""<TMPL_VAR AUTHOR>"""]]
<TMPL_IF AUTHORURL>
-[[meta authorurl="""<TMPL_VAR AUTHORURL>"""]]
+[[!meta authorurl="""<TMPL_VAR AUTHORURL>"""]]
</TMPL_IF>
-[[meta title="""change to<TMPL_LOOP NAME="PAGES"> <TMPL_VAR PAGE></TMPL_LOOP> on <TMPL_VAR WIKINAME>"""]]
+[[!meta title="""change to<TMPL_LOOP NAME="PAGES"> <TMPL_VAR PAGE></TMPL_LOOP> on <TMPL_VAR WIKINAME>"""]]
<div class="metadata">
<span class="desc"><br />Changed pages:</span>
<span class="pagelinks">
-[[meta redir=ikiwiki/blog delay=10]]
+[[!meta redir=ikiwiki/blog delay=10]]
This page has moved to [[ikiwiki/blog|ikiwiki/blog]]. Please update your
links, as this redirection page will be removed in a future ikiwiki
-[[meta redir=ikiwiki/formatting delay=10]]
+[[!meta redir=ikiwiki/formatting delay=10]]
This page has moved to [[ikiwiki/formatting|ikiwiki/formatting]]. Please
update your links, as this redirection page will be removed in a future
-[[meta redir=ikiwiki/markdown delay=10]]
+[[!meta redir=ikiwiki/markdown delay=10]]
This page has moved to [[ikiwiki/markdown|ikiwiki/markdown]]. Please update
your links, as this redirection page will be removed in a future ikiwiki
-[[meta redir=ikiwiki/openid delay=10]]
+[[!meta redir=ikiwiki/openid delay=10]]
This page has moved to [[ikiwiki/openid|ikiwiki/openid]]. Please update your
links, as this redirection page will be removed in a future ikiwiki
-[[meta redir=ikiwiki/pagespec delay=10]]
+[[!meta redir=ikiwiki/pagespec delay=10]]
This page has moved to [[ikiwiki/pagespec|ikiwiki/pagespec]]. Please update
your links, as this redirection page will be removed in a future ikiwiki
-[[meta redir=ikiwiki/preprocessordirective delay=10]]
+[[!meta redir=ikiwiki/preprocessordirective delay=10]]
This page has moved to
[[ikiwiki/preprocessordirective|ikiwiki/preprocessordirective]]. Please
-[[meta redir=ikiwiki/subpage delay=10]]
+[[!meta redir=ikiwiki/subpage delay=10]]
This page has moved to [[ikiwiki/subpage|ikiwiki/subpage]]. Please update your
links, as this redirection page will be removed in a future ikiwiki
-[[meta redir=ikiwiki/wikilink delay=10]]
+[[!meta redir=ikiwiki/wikilink delay=10]]
This page has moved to [[ikiwiki/wikilink|ikiwiki/wikilink]]. Please update
your links, as this redirection page will be removed in a future ikiwiki
sipb-www / ikiwiki.git / commitdiff
