From: Simon McVittie Date: Mon, 21 Jul 2008 11:45:54 +0000 (+0100) Subject: Migrate escaped directives (\[[) in doc/todo to have \[[! prefix X-Git-Tag: 2.55~109^2~3 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=1ca63edde0a1f09e58c9c1da1cf9ac7a6805750b;p=ikiwiki.git Migrate escaped directives (\[[) in doc/todo to have \[[! prefix --- diff --git a/doc/todo/ACL.mdwn b/doc/todo/ACL.mdwn index 9d2031340..6b23acfae 100644 --- a/doc/todo/ACL.mdwn +++ b/doc/todo/ACL.mdwn @@ -30,10 +30,10 @@ Here is how I see it: for a given (user, page, operation), as in:
-    \[[acl user=joe page=*.png allow=upload]]
-    \[[acl user=bob page=/blog/bob/* allow=*]]
-    \[[acl user=* page=/blog/bob/* deny=*]]
-    \[[acl user=http://jeremie.koenig.myopenid.com/ page=/todo/* deny=create
+    \[[!acl user=joe page=*.png allow=upload]]
+    \[[!acl user=bob page=/blog/bob/* allow=*]]
+    \[[!acl user=* page=/blog/bob/* deny=*]]
+    \[[!acl user=http://jeremie.koenig.myopenid.com/ page=/todo/* deny=create
            reason="spends his time writing todo items instead of source code"]]
     
@@ -43,5 +43,5 @@ Here is how I see it: Possibly could refer to other ACL pages, as in:
-    \[[acl user=* page=/subsite/* acl=/subsite/acl.mdwn]]
+    \[[!acl user=* page=/subsite/* acl=/subsite/acl.mdwn]]
     
diff --git a/doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn b/doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn index d43759a5b..543c346ac 100644 --- a/doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn +++ b/doc/todo/A_page_that_inlines_pages__61____34____42____34___results_in_unnecessary_feed_generation.mdwn @@ -3,7 +3,7 @@ getting regenerated even when I edited only a page that did not affect any feed. I found that the problem only occurs in the presence of a file that -contains \[[inline pages="*"]]. +contains \[[!inline pages="*"]]. > How is this unexpected? By inlining _every_ page in the wiki, you're > making that page depend on every other page; any change to any page in @@ -23,7 +23,7 @@ that it will create): cd /tmp mkdir ikiwiki-test; cd ikiwiki-test; mkdir src - echo '\[[inline pages="blog/*"]]' > src/myblog.mdwn + echo '\[[!inline pages="blog/*"]]' > src/myblog.mdwn mkdir src/blog; echo "A blog entry" > src/blog/entry.mdwn echo 'use IkiWiki::Setup::Standard { srcdir => "src", @@ -41,7 +41,7 @@ that it will create): echo "not a blog entry" > src/not-a-blog.mdwn ikiwiki --setup setup ls -l --time-style=full-iso output/myblog/index.rss - echo '\[[inline pages="*"]]' > src/archives.mdwn + echo '\[[!inline pages="*"]]' > src/archives.mdwn ikiwiki --setup setup ls -l --time-style=full-iso output/myblog/index.rss echo "still not blogging" >> src/not-a-blog.mdwn @@ -58,7 +58,7 @@ Here's the tail of the output that I see for this command: done $ ls -l --time-style=full-iso output/myblog/index.rss -rw-r--r-- 1 cworth cworth 459 2007-06-01 06:34:36.000000000 -0700 output/myblog/index.rss - $ echo '\[[inline pages="*"]]' > src/archives.mdwn + $ echo '\[[!inline pages="*"]]' > src/archives.mdwn $ ikiwiki --setup setup refreshing wiki.. scanning archives.mdwn diff --git a/doc/todo/Gallery.mdwn b/doc/todo/Gallery.mdwn index 8fa9a310e..fbf1802fd 100644 --- a/doc/todo/Gallery.mdwn +++ b/doc/todo/Gallery.mdwn @@ -39,7 +39,7 @@ I have implemented the first version of the Gallery Plugin for Ikiwiki as part o Plugin can be downloaded from [here](http://myweb.unomaha.edu/~ajain/gallery.tar). It can be used as :
-\[[gallery imagedir="images" thumbnailsize="200x200" cols="3" alt="Can not be displayed" title="My Pictures"]] +\[[!gallery imagedir="images" thumbnailsize="200x200" cols="3" alt="Can not be displayed" title="My Pictures"]] where-
* imagedir => Directory containing images. It will scan all the files with jpg|png|gif extension from the directory and will put it in the gallery.
diff --git a/doc/todo/Give_access_to_more_TMPL__95__VAR_variables_in_templates_inserted_by_the_template_plugin.mdwn b/doc/todo/Give_access_to_more_TMPL__95__VAR_variables_in_templates_inserted_by_the_template_plugin.mdwn index 2b2f6a5d0..a644e236b 100644 --- a/doc/todo/Give_access_to_more_TMPL__95__VAR_variables_in_templates_inserted_by_the_template_plugin.mdwn +++ b/doc/todo/Give_access_to_more_TMPL__95__VAR_variables_in_templates_inserted_by_the_template_plugin.mdwn @@ -54,7 +54,7 @@ of the pages tagged d1. My current plan is : -- thanks to the edittemplate plugin, `/view/dev/*` and `/view/howto/*` would contain respectively `\[[template id=dev_direction]]` and `\[[template id=howto_usage]]` +- thanks to the edittemplate plugin, `/view/dev/*` and `/view/howto/*` would contain respectively `\[[!template id=dev_direction]]` and `\[[!template id=howto_usage]]` - `/templates/dev_direction.mdwn` and `/templates/howto_usage.mdwn` would use `\[[!map ...]]` directives to build their views # My issue @@ -68,7 +68,7 @@ Where `BASENAME` value would be, e.g., `u1` or `d2`, depending on the page inserting the template. But `BASENAME` does not exist. I found that `` is replaced with the full path to the page, but I did not found how to get the page's basename in a template included -with a `\[[template id=...]]` directive. +with a `\[[!template id=...]]` directive. Any idea ? @@ -88,7 +88,7 @@ avoid the ad-hoc plugin solution. most possible of these pages. > The following patch adds a `basename` `TMPL_VAR` variable that can be -> used in the templates inserted by \[[template plugin]] : +> used in the templates inserted by \[[!template plugin]] : > diff --git a/IkiWiki/Plugin/template.pm b/IkiWiki/Plugin/template.pm > index a6e34fc..bb9dd8d 100644 diff --git a/doc/todo/New_preprocessor_directive_syntax.mdwn b/doc/todo/New_preprocessor_directive_syntax.mdwn index b37985994..2215cc4b4 100644 --- a/doc/todo/New_preprocessor_directive_syntax.mdwn +++ b/doc/todo/New_preprocessor_directive_syntax.mdwn @@ -14,8 +14,8 @@ Making this transition would fix two major warts: * The inability to use spaces in wikilinks or link text * The requirement to use a trailing space on a preprocessor directive - with no arguments, such as `\[[toc ]]` + with no arguments, such as `\[[!toc ]]` --[[JoshTriplett]] -[[done]] in version 2.21, using the '!'-prefixed syntax. --[[JoshTriplett]] \ No newline at end of file +[[done]] in version 2.21, using the '!'-prefixed syntax. --[[JoshTriplett]] diff --git a/doc/todo/Option_to_make_title_an_h1__63__.mdwn b/doc/todo/Option_to_make_title_an_h1__63__.mdwn index ff2997bee..efa07ad79 100644 --- a/doc/todo/Option_to_make_title_an_h1__63__.mdwn +++ b/doc/todo/Option_to_make_title_an_h1__63__.mdwn @@ -1,4 +1,4 @@ -Currently, the page title (either the name of the page or the title specified with `\[[meta title="..."]]`) shows up in a `
`. I tend to follow the [w3c guideline recommending the use of h1 for the title](http://www.w3.org/QA/Tips/Use_h1_for_Title); for this purpose, how about an option to make the page title an `

`, and shift the markdown headings down by one (making # an h2, ## an h3, etc; or alternatively making # equivalent to `\[[meta title="..."]]`)? +Currently, the page title (either the name of the page or the title specified with `\[[!meta title="..."]]`) shows up in a `
`. I tend to follow the [w3c guideline recommending the use of h1 for the title](http://www.w3.org/QA/Tips/Use_h1_for_Title); for this purpose, how about an option to make the page title an `

`, and shift the markdown headings down by one (making # an h2, ## an h3, etc; or alternatively making # equivalent to `\[[!meta title="..."]]`)? > The reason I don't use a h1 for the navbar is that while it incorporates > the page title, it's not just a page title, it has the links to parent pages. diff --git a/doc/todo/Short_wikilinks.mdwn b/doc/todo/Short_wikilinks.mdwn index 05f894dfe..b9aec9112 100644 --- a/doc/todo/Short_wikilinks.mdwn +++ b/doc/todo/Short_wikilinks.mdwn @@ -58,9 +58,9 @@ Other alternatives would be > I agree that a plugin would probably be more cumbersome, but it is very > doable. It might look something like this: - \[[link bar]] + \[[!link bar]] - \[[link bar=VeryLongPageName]] + \[[!link bar=VeryLongPageName]] >> This is, however, still missing specifying the link text, and adding that option would seem to me to complicate the plugin syntax a lot, unless support is added for the |-syntax for specifying a particular parameter to every plugin. @@ -74,13 +74,13 @@ Other alternatives would be >> ... Returning to this, the syntax infact wouldn't be so bad with the |-syntax, given a short name for the plugin: [[whatever|ref 1]] - \[[ref 1=page_with_long_name]] + \[[!ref 1=page_with_long_name]] >>> A way to do this that doesn't need hacking at the preprocessor syntax >>> follows: --[[Joey]] - \[[link bar=1]] - \[[dest 1=page_with_long_name]] + \[[!link bar=1]] + \[[!dest 1=page_with_long_name]] >>>> But this doesn't work so well for links that aren't valid keys. Such >>>> as stuff with spaces in it. I'd like to be able to write any kind of @@ -88,8 +88,8 @@ Other alternatives would be >>>>> You're right, and to fix that it could be turned around: --[[Joey]] - \[[link 1=bar]] - \[[dest 1=page_with_long_name]] + \[[!link 1=bar]] + \[[!dest 1=page_with_long_name]] >> It also shouldn't be difficult to support non-wiki links in this same >> way, so that you could still link everywhere in an uniform manner, as diff --git a/doc/todo/Support_wildcard_inside_of_link__40____41___within_a_pagespec.mdwn b/doc/todo/Support_wildcard_inside_of_link__40____41___within_a_pagespec.mdwn index 24f9054f7..2837634d9 100644 --- a/doc/todo/Support_wildcard_inside_of_link__40____41___within_a_pagespec.mdwn +++ b/doc/todo/Support_wildcard_inside_of_link__40____41___within_a_pagespec.mdwn @@ -2,7 +2,7 @@ I don't segregate my blog entries into a directory, but instead want my blog to simply consist of all pages that have been tagged. That is, I'd like to have my blog page look like this: - \[[inline pages="link(tag/*)"]] + \[[!inline pages="link(tag/*)"]] That doesn't work in ikiwiki 2.1, but I have it [working](http://www.cworth.org/blog) with the following patch: diff --git a/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn b/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn index 8f32c7364..61b19d302 100644 --- a/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn +++ b/doc/todo/__42__forward__42__ing_functionality_for_the_meta_plugin.mdwn @@ -22,7 +22,7 @@ I can also submit a Git patch, if desired. **OPT_DELAY** = delay=**D** | empty (*immediatelly*) -\[[meta forward="**WHITHER**" **OPT_DELAY**]] +\[[!meta forward="**WHITHER**" **OPT_DELAY**]] # Extensions and Ideas diff --git a/doc/todo/absolute_urls_in_wikilinks.mdwn b/doc/todo/absolute_urls_in_wikilinks.mdwn index fd47cb089..a0fe83e44 100644 --- a/doc/todo/absolute_urls_in_wikilinks.mdwn +++ b/doc/todo/absolute_urls_in_wikilinks.mdwn @@ -2,7 +2,7 @@ An option to have absolute urls in wikilinks instead of relative ones would be useful, for pages included into other pages out of the wiki rendering process (shtml for example) -since these pages can be included from a subdir. Ditto, links from \[[ inline ..]] or \[[map ..]]. +since these pages can be included from a subdir. Ditto, links from \[[!inline ..]] or \[[!map ..]]. > You can make a wikilink absolute by prefixing it with a /, see > [[ikiwiki/subpage/linkingrules/]]. Pagespecs match absolute by default. But what do @@ -10,11 +10,11 @@ since these pages can be included from a subdir. Ditto, links from \[[ inline .. > change. --Ethan >> I want the "last pages" in my sidebar. and some links to a few special pages. ->> \[[inline ]] or \\[[map ]] in the sidebar is a bad idea, (because each update rebuilds +>> \[[!inline ]] or \\[[!map ]] in the sidebar is a bad idea, (because each update rebuilds >> all the wiki), so I use server-side-include instead of the sidebar plugin; >> this reduces the dependencies >> my sidebar is generated as http://foo.org/menu/index.html, so all the links generated by ->> \[[inline ]] or \[[map ]] are relative to this position. +>> \[[!inline ]] or \[[!map ]] are relative to this position. >> Included from http://foo.org/section/sub/blah/index.shtml, the links are broken. >> >> — NicolasLimare diff --git a/doc/todo/calendar_--_archive_browsing_via_a_calendar_frontend.mdwn b/doc/todo/calendar_--_archive_browsing_via_a_calendar_frontend.mdwn index 0ea5d910c..0a036d315 100644 --- a/doc/todo/calendar_--_archive_browsing_via_a_calendar_frontend.mdwn +++ b/doc/todo/calendar_--_archive_browsing_via_a_calendar_frontend.mdwn @@ -1,6 +1,6 @@ I am serving notice that I am starting work on a calendar plugin inspired by Blosxom's calendar plugin. The current plan is to create a plugin that looks through all the source files matching a certain pagespec, and optionally spit out a month view for the specified month (default to current), or spit out a year view for a given year (defaulting to the current year), of a list of year with posts in them. The output would be a table, with the same CSS directives that the Blosxom plugin used to use (so that I can just reuse my css file). The links would be created to a $config{archivedir}/$year or $config{archivedir}/$year-$month file, which can just have - \[[inline pages="blog/* and !*/Discussion and creation_year($year) and creation_month($month)" rss="no" atom="no" show="0"]] + \[[!inline pages="blog/* and !*/Discussion and creation_year($year) and creation_month($month)" rss="no" atom="no" show="0"]] or some thing to generate a archive of postings. @@ -10,21 +10,21 @@ ManojSrivastava This plugin is inspired by the calendar plugin for Blosxom, but derivesno code from it. This plugin is essentially a fancy front end to archives of previous pages, usually used for blogs. It can produce a calendar for a given month, or a list of months for a given year. To invoke the calendar, just use the preprocessor directive: - \[[calendar ]] + \[[!calendar ]] or - \[[calendar type="month" pages="blog/* and !*/Discussion"]] + \[[!calendar type="month" pages="blog/* and !*/Discussion"]] or - \[[calendar type="year" year="2005" pages="blog/* and !*/Discussion"]] + \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]] The year and month entities in the out put have links to archive index pages, which are supposed to exist already. The idea is to create an archives hierarchy, rooted in the subdirectory specified in the site-wide customization variable, archivebase. archivebase defaults to "archives". Links are created to pages "$archivebase/$year" and "$archivebase/$year/$month". The idea is to create annual and monthly indices, for example, by using something like this sample from my archives/2006/01.mdwn - \[[meta title="Archives for 2006/01"]] - \[[inline rootpage="blog" atom="no" rss="no" show="0" pages="blog/* and !*/Discussion and creation_year(2006) and creation_month(01)" ]] + \[[!meta title="Archives for 2006/01"]] + \[[!inline rootpage="blog" atom="no" rss="no" show="0" pages="blog/* and !*/Discussion and creation_year(2006) and creation_month(01)" ]] I'll send in the patch via email. diff --git a/doc/todo/color_plugin.mdwn b/doc/todo/color_plugin.mdwn index 069e2d4c2..cb3e85b74 100644 --- a/doc/todo/color_plugin.mdwn +++ b/doc/todo/color_plugin.mdwn @@ -23,7 +23,7 @@ What do you think about it? --[[Paweł|ptecza]] > ``. A preprocessor directive is not really any less ugly than html > tags, though at least it could play nicely with nested markdown: --[[Joey]] > -> \[[color red,green """ +> \[[!color red,green """ > Xmas-colored markdown here > """]] diff --git a/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn b/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn index c6f1fefe1..4bdcf3d01 100644 --- a/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn +++ b/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn @@ -1,6 +1,6 @@ I'd like to see some way to conditionally include wiki text based on whether the wiki enables or disables certain features. For example, -[[ikiwiki/formatting]], could use `\[[if (enabled smiley) """Also, because +[[ikiwiki/formatting]], could use `\[[!if (enabled smiley) """Also, because this wiki has the smiley plugin enabled, you can insert \[[smileys]] and some other useful symbols."""]]`, and a standard template for [[plugins]] pages could check for the given plugin name to print "enabled" or @@ -52,7 +52,7 @@ Syntax could vary greatly here, both for the > As to the syntax, to fit it into standard preprocessor syntax, it would > need to look something like this: > -> \[[if test="enabled(smiley)" """foo"""]] +> \[[!if test="enabled(smiley)" """foo"""]] > > --[[Joey]] @@ -70,7 +70,7 @@ Syntax could vary greatly here, both for the >> >> A few use cases for `included`, which I would really like to see: >> ->> * On the sidebar page, you could say something like \[[if test="!included" +>> * On the sidebar page, you could say something like \[[!if test="!included" >> """This page, without this help message, appears as a sidebar on all >> pages."""]]. The help text would then only appear on the sidebar page >> itself, not the sidebar included on all pages. @@ -110,7 +110,7 @@ This is now completely [[todo/done]]! See [[plugins/conditional]]. Is there a way to test features other than plugins? For example, to add to [[ikiwiki/Markdown]] something like - \[[if test="enabled(multimarkdown)" then="You can also use..."]] + \[[!if test="enabled(multimarkdown)" then="You can also use..."]] (I tried it like that just to see if it would work, but I wasn't that lucky.) --ChapmanFlack diff --git a/doc/todo/else_parameter_for_map_plugin.mdwn b/doc/todo/else_parameter_for_map_plugin.mdwn index 50fe39357..12a91b4ee 100644 --- a/doc/todo/else_parameter_for_map_plugin.mdwn +++ b/doc/todo/else_parameter_for_map_plugin.mdwn @@ -14,14 +14,14 @@ documentation yet, I'm waiting for feedback first, but I'll do it for sure. -- [ >> Hmmm, what do you mean? Adding a syntax such as the one below? >> Or something else? - \[[if test="map(" then="..." else="..."]] + \[[!if test="map(" then="..." else="..."]] >> What would you write in the `then` clause? >> I'm not opposed at all to rewrite my two-liner, but I don't understand. >> --[[intrigeri]] - \[[if test="foo/*" then=""" - [[map pages="foo/*"]] + \[[!if test="foo/*" then=""" + [[!map pages="foo/*"]] """ else="no pages"]] --[[Joey]] diff --git a/doc/todo/fileupload/soc-proposal/discussion.mdwn b/doc/todo/fileupload/soc-proposal/discussion.mdwn index 1ce52f0ca..f85a956db 100644 --- a/doc/todo/fileupload/soc-proposal/discussion.mdwn +++ b/doc/todo/fileupload/soc-proposal/discussion.mdwn @@ -29,7 +29,7 @@ For images, videos, etc. it would be nice to have some kind of meta data file to height, compression, etc. which could be initially created by 'ikiwiki --generate-meta-stuff'. Then PageSpec should be teached to use these. Galleries could then be generated by means of -\[[inline pages="type(image/*) and year(2007)" template="gallery"]]. It +\[[!inline pages="type(image/*) and year(2007)" template="gallery"]]. It should of course be possible to edit this information via ikiwiki.cgi and with any text editor (Name: value). This should also allow for creations of default .html pages with the image/video/file/... and a discussion page. Probably named image.mdwn and image/discussion. diff --git a/doc/todo/language_definition_for_the_meta_plugin.mdwn b/doc/todo/language_definition_for_the_meta_plugin.mdwn index dd72ab3ce..33098c601 100644 --- a/doc/todo/language_definition_for_the_meta_plugin.mdwn +++ b/doc/todo/language_definition_for_the_meta_plugin.mdwn @@ -1,5 +1,5 @@ Here is a patch for the [[plugins/meta]] plugin. It adds the possibility to define the language -used for a page, with \[[meta lang="ja"]] +used for a page, with \[[!meta lang="ja"]] It doesn't insert the langage information in the xhtml meta elements, but defines a LANG variable to use in the templates, for example with diff --git a/doc/todo/latex.mdwn b/doc/todo/latex.mdwn index b07ccf308..e96e4b782 100644 --- a/doc/todo/latex.mdwn +++ b/doc/todo/latex.mdwn @@ -197,7 +197,7 @@ This are of course the minority of people (but I guess also the minority of peop > I'm thinking about renameing the preprocessor directive to teximg. -> \[[teximg code="" alt="foo"]] makes sense.. Would it make sense to rename +> \[[!teximg code="" alt="foo"]] makes sense.. Would it make sense to rename > the whole plugin, or do you think that other tex stuff should go in this > same plugin? diff --git a/doc/todo/meta_rcsid.mdwn b/doc/todo/meta_rcsid.mdwn index a09a48a64..81a2c1328 100644 --- a/doc/todo/meta_rcsid.mdwn +++ b/doc/todo/meta_rcsid.mdwn @@ -3,7 +3,7 @@ of CVS/SVN-style keywords (like '$Id$', etc.) from the source file in the page t > So the idea is you'd write something like: > -> \[[meta rcsid="$Id$"]] +> \[[!meta rcsid="$Id$"]] > > And this would be put at the bottom of the page or somewhere like that by > the template? diff --git a/doc/todo/metadata.mdwn b/doc/todo/metadata.mdwn index c1f99fb2b..361f00351 100644 --- a/doc/todo/metadata.mdwn +++ b/doc/todo/metadata.mdwn @@ -1,7 +1,7 @@ There should be a way to add metadata to a page. Probably a plugin could do this, for example: - \[[meta foo="bar"]] + \[[!meta foo="bar"]] Uses for this include: diff --git a/doc/todo/missingparents.pm.mdwn b/doc/todo/missingparents.pm.mdwn index 5d8b9c422..0cc7137ba 100644 --- a/doc/todo/missingparents.pm.mdwn +++ b/doc/todo/missingparents.pm.mdwn @@ -4,9 +4,9 @@ has a child). Basically, you give it a page called missingparents.mdwn, something like this:
-[[!missingparents pages="posts/* and !posts/*/*" generate="""[[template id=year text="$page"]]"""]]
-[[!missingparents pages="posts/*/* and !posts/*/*/*" generate="""[[template id=month text="$page"]]"""]]
-[[!missingparents pages="posts/*/*/* and !posts/*/*/*/*" generate="""[[template id=day text="$page"]]"""]]
+[[!missingparents pages="posts/* and !posts/*/*" generate="""[[!template id=year text="$page"]]"""]]
+[[!missingparents pages="posts/*/* and !posts/*/*/*" generate="""[[!template id=month text="$page"]]"""]]
+[[!missingparents pages="posts/*/*/* and !posts/*/*/*/*" generate="""[[!template id=day text="$page"]]"""]]
 
And it scans the whole wiki for pages that match the pagespecs but are missing diff --git a/doc/todo/nested_preprocessor_directives.mdwn b/doc/todo/nested_preprocessor_directives.mdwn index 7e7ef3a49..b5080dc3c 100644 --- a/doc/todo/nested_preprocessor_directives.mdwn +++ b/doc/todo/nested_preprocessor_directives.mdwn @@ -11,8 +11,8 @@ nesting, a new syntax would be needed. Maybe something xml-like? > > For example, I *think* you can unambiguously parse the following: > -> \[[if test="enabled(template) and templates/foo" then=""" -> [[template id=foo content="""Flying Purple People Eater"""]] +> \[[!if test="enabled(template) and templates/foo" then=""" +> [[!template id=foo content="""Flying Purple People Eater"""]] > """]] > > --[[JoshTriplett]] diff --git a/doc/todo/preprocessor_directive_for_proposed_changes.mdwn b/doc/todo/preprocessor_directive_for_proposed_changes.mdwn index e73e6c09e..c0af59eba 100644 --- a/doc/todo/preprocessor_directive_for_proposed_changes.mdwn +++ b/doc/todo/preprocessor_directive_for_proposed_changes.mdwn @@ -10,11 +10,11 @@ and wait for someone with the access/confidence to apply them. Maybe this can be enhanced with a [[ikiwiki/PreprocessorDirective]]:
-\[[suggest op=merge dstfile=trunk srcfile=branches/jk oldrev=1234 newrev=1342]]
+\[[!suggest op=merge dstfile=trunk srcfile=branches/jk oldrev=1234 newrev=1342]]
 
-\[[suggest op=move srcpage=/blog dstpage=/blog_support]]
+\[[!suggest op=move srcpage=/blog dstpage=/blog_support]]
 
-\[[suggest patch="""
+\[[!suggest patch="""
 Index: IkiWiki/CGI.pm
 ===================================================================
 --- IkiWiki/CGI.pm      (révision 4119)
diff --git a/doc/todo/recentchanges.mdwn b/doc/todo/recentchanges.mdwn
index 91128a860..25a8ea4db 100644
--- a/doc/todo/recentchanges.mdwn
+++ b/doc/todo/recentchanges.mdwn
@@ -92,7 +92,7 @@ your pages. --Ethan
 Here's a full design for redoing recentchanges, based on Ethan's ideas:
 
 * Add a recentchanges plugin that has a preprocessor directive:
-	\[[recentchanges num=100 pages=* template=recentchanges.tmpl]]
+	\[[!recentchanges num=100 pages=* template=recentchanges.tmpl]]
   If put on the [[recentchanges]] page, this would result in up to 100
   recentchanges/change_$id.mdwn files being created.
 * Which means the plugin has to store state and use a checkconfig hook
diff --git a/doc/todo/shortcut_link_text.mdwn b/doc/todo/shortcut_link_text.mdwn
index d03d37411..765c445ab 100644
--- a/doc/todo/shortcut_link_text.mdwn
+++ b/doc/todo/shortcut_link_text.mdwn
@@ -1,19 +1,19 @@
 [[plugins/shortcut]] creates link shortcut [[ikiwiki/PreprocessorDirective]]s,
 which substitute their argument into the specified shortcut URL to generate
 the link target, and use the argument as the link text.  For example, given
-the example [[shortcuts]], `\[[wikipedia ikiwiki]]` generates a link to
+the example [[shortcuts]], `\[[!wikipedia ikiwiki]]` generates a link to
 , with the link text "ikiwiki".  This
 works well in many cases; however, for things like the `debbug` example, it
 simply uses the number as the link text, which does not always provide
 enough context to understand the link at first glance.  For example,
-`\[[debbug 397501]]` generates a link to ,
+`\[[!debbug 397501]]` generates a link to ,
 with just "397501" as the link text.  While [[plugins/template]] provides a
 general solution for arbitrary cases, it would help to have a simple option
 via the shortcut plugin to set the link text, with a `%s` substitution.
-Thus, something like `\[[shortcut name=debbug
+Thus, something like `\[[!shortcut name=debbug
 url="http://bugs.debian.org/%s" desc="bug #%s"]]` might suffice on a
 Debian-specific wiki to indicate a bug number, while a more general wiki
-might use something like `\[[shortcut name=debbug
+might use something like `\[[!shortcut name=debbug
 url="http://bugs.debian.org/%s" desc="Debian bug #%s"]]`.
 
 > [[todo/done]] --[[Joey]]
diff --git a/doc/todo/shortcut_optional_parameters.mdwn b/doc/todo/shortcut_optional_parameters.mdwn
index daec3696a..445404315 100644
--- a/doc/todo/shortcut_optional_parameters.mdwn
+++ b/doc/todo/shortcut_optional_parameters.mdwn
@@ -6,39 +6,39 @@ Consider the "All files in this package search" on
 To create a "debfiles" [[shortcut|shortcuts]] that takes a package name, you
 could just hardcode the architecture and distribution:
 
-    \[[shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=unstable&arch=i386"]]
-    \[[debfiles ikiwiki]]
+    \[[!shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=unstable&arch=i386"]]
+    \[[!debfiles ikiwiki]]
 
 But what if you could have them as optional parameters instead?  The syntax
 for the invocation should look like this:
 
-    \[[debfiles ikiwiki dist=testing]]
+    \[[!debfiles ikiwiki dist=testing]]
 
 Some possible syntax choices for the shortcut definition:
 
-    \[[shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=%(dist)s&arch=%(arch)s" dist="unstable" arch="i386"]]
-    \[[shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=%(dist=unstable)s&arch=%(arch=i386)s"]]
-    \[[shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=%{dist=unstable}&arch=%{arch=i386}"]]
-    \[[shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=$*&searchmode=filelist&case=insensitive&version=${dist=unstable}&arch=${arch=i386}"]]
+    \[[!shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=%(dist)s&arch=%(arch)s" dist="unstable" arch="i386"]]
+    \[[!shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=%(dist=unstable)s&arch=%(arch=i386)s"]]
+    \[[!shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=%s&searchmode=filelist&case=insensitive&version=%{dist=unstable}&arch=%{arch=i386}"]]
+    \[[!shortcut name=debfiles url="http://packages.debian.org/cgi-bin/search_contents.pl?word=$*&searchmode=filelist&case=insensitive&version=${dist=unstable}&arch=${arch=i386}"]]
 
 --[[JoshTriplett]]
 
 Well, you can already do this kind of thing with templates. Invocation does
 look different:
 
-    \[[template id=debfiles package=ikiwiki dist=testing]]
+    \[[!template id=debfiles package=ikiwiki dist=testing]]
 
 --[[Joey]]
 
 > I think I would find templates sufficient, if:
 >
 > 1. I could use the name of the template as a preprocessor directive
->    (`\[[templatename ...]]`), rather than using the `template` directive
->    with an `id` argument (`\[[template id=templatename]]`).
+>    (`\[[!templatename ...]]`), rather than using the `template` directive
+>    with an `id` argument (`\[[!template id=templatename]]`).
 > 2. Template invocation allowed bare values in addition to `key=value`
 >    arguments, and template definition supported some means to access the
->    value.  This would allow `\[[debfiles ikiwiki]]` rather than
->    `\[[debfiles package=ikiwiki]]`.
+>    value.  This would allow `\[[!debfiles ikiwiki]]` rather than
+>    `\[[!debfiles package=ikiwiki]]`.
 > 3. I could use ikiwiki syntax in the template, not just HTML and
 >    HTML::Template.  (If I can already do that, then [[/plugins/template]]
 >    should make that more clear.)
diff --git a/doc/todo/shortcut_with_different_link_text.mdwn b/doc/todo/shortcut_with_different_link_text.mdwn
index 8041732ae..8615b2754 100644
--- a/doc/todo/shortcut_with_different_link_text.mdwn
+++ b/doc/todo/shortcut_with_different_link_text.mdwn
@@ -11,7 +11,7 @@ Window System protocol".  --[[JoshTriplett]]
 > If I don't understand this, can you give an HTML example? --[[JeremyReed]]
 
 >> The problem is like that in [[bugs/shortcuts_don't_escape_from_Markdown]]. We would like to use 
->> the shortcuts plugin but add a descriptive text -- in this case \[[xcbgit src/xcb.xsd|XML Schema...]]
+>> the shortcuts plugin but add a descriptive text -- in this case \[[!xcbgit src/xcb.xsd|XML Schema...]]
 >> The file src/xcb.xsd could be any url, and the point of shortcuts is that you get to shorten it.
 >> --Ethan
 
@@ -22,7 +22,7 @@ Window System protocol".  --[[JoshTriplett]]
 >>> However, I want to define a [[plugins/shortcut]] to save the typing.  If I
 >>> define something like `protogit` pointing to
 >>> `http://gitweb.freedesktop.org/?p=xcb/proto.git;a=blob;hb=HEAD;f=%s`, then
->>> I can write `\[[protogit src/xcb.xsd]]`; however, I then can't change the
+>>> I can write `\[[!protogit src/xcb.xsd]]`; however, I then can't change the
 >>> link text to anything other than what the shortcut defines as the link
 >>> text. I want to write something like
 >>> `\[[XML Schema for the X Window System Protocol|protogit src/xcb.xsd]]`,
@@ -44,7 +44,7 @@ Window System protocol".  --[[JoshTriplett]]
 
 ---
 
-One possible alternative, would be a general `\[[url ]]` scheme for all kinds of links. As mentioned in [[Short_wikilinks]], I have wanted a way to enter links to the wiki with markdown-style references,
+One possible alternative, would be a general `\[[!url ]]` scheme for all kinds of links. As mentioned in [[Short_wikilinks]], I have wanted a way to enter links to the wiki with markdown-style references,
 specifying the actual target elsewhere from the text, with just a short reference in the text. To facilitate automatic conversion from earlier (already markdownised) "blog", I finally ended up writing a custom plugin that simply gets the location of wikipage, and use markdown mechanisms:
 
     Here [is][1] a link.
@@ -55,11 +55,11 @@ specifying the actual target elsewhere from the text, with just a short referenc
 
 So that the 'l' plugin inserts the location the page there, and markdown does the rest. My plugin currently fails if it can't find the page, as that is sufficient for my needs. Differing colouring for non-existing pages is not doable in a straightforward manner with this approach.
 
-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).
+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_
+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.
 
diff --git a/doc/todo/shortcut_with_no_url_parameter__44___only_desc.mdwn b/doc/todo/shortcut_with_no_url_parameter__44___only_desc.mdwn
index c8e138820..56a74029e 100644
--- a/doc/todo/shortcut_with_no_url_parameter__44___only_desc.mdwn
+++ b/doc/todo/shortcut_with_no_url_parameter__44___only_desc.mdwn
@@ -16,8 +16,8 @@ It sounds like you're looking for templates, not shortcuts. --[[Joey]]
 > `url` still seems reasonable, and simple.  You could also use such shortcuts
 > without markup at all, as an abbreviation mechanism:
 > 
->     \[[shortcut name=spi desc="Software in the Public Interest, Inc."]]].
->     \[[shortcut name=sosp desc="Symposium on Operating System Principles"]]].
->     \[[shortcut name=cacm desc="Communications of the ACM"]]].
+>     \[[!shortcut name=spi desc="Software in the Public Interest, Inc."]]].
+>     \[[!shortcut name=sosp desc="Symposium on Operating System Principles"]]].
+>     \[[!shortcut name=cacm desc="Communications of the ACM"]]].
 >
 > --[[JoshTriplett]]
diff --git a/doc/todo/should_optimise_pagespecs.mdwn b/doc/todo/should_optimise_pagespecs.mdwn
index 15a36fe43..0ef8a7847 100644
--- a/doc/todo/should_optimise_pagespecs.mdwn
+++ b/doc/todo/should_optimise_pagespecs.mdwn
@@ -18,8 +18,8 @@ Couldn't isolate the cause, but some sources for this problem may be:
 
 Other special things in my templates and site:
 
-* a sidebar with \[[include pages="notes/\*" template=foo]] while notes.mdwn has 
-  a \[[include pages="notes/*"]] and uses the sidebar; removed it, doesn't change
+* a sidebar with \[[!include pages="notes/\*" template=foo]] while notes.mdwn has 
+  a \[[!include pages="notes/*"]] and uses the sidebar; removed it, doesn't change
 * a template (biblio.tmpl) calling the "img" plugin with a template parameter as the
   image filename; removed it, doesn't change
 * some strange games with tags whose page calls a "map" directive to show other tags
diff --git a/doc/todo/skip_option_for_inline_plugin.mdwn b/doc/todo/skip_option_for_inline_plugin.mdwn
index 06f1a8358..f37d75ccb 100644
--- a/doc/todo/skip_option_for_inline_plugin.mdwn
+++ b/doc/todo/skip_option_for_inline_plugin.mdwn
@@ -1,7 +1,7 @@
 How about a skip option for [[plugins/inline]]?  This would allow things like the following:
 
-    \[[inline pages="news/*" show="5"]]
-    \[[inline pages="news/*" skip="5" show="5" archive="yes"]]
+    \[[!inline pages="news/*" show="5"]]
+    \[[!inline pages="news/*" skip="5" show="5" archive="yes"]]
 
 > I just wrote a patch. --Ethan
 
diff --git a/doc/todo/toc_plugin_to_skip_one_level.mdwn b/doc/todo/toc_plugin_to_skip_one_level.mdwn
index 35290fc38..4891a1197 100644
--- a/doc/todo/toc_plugin_to_skip_one_level.mdwn
+++ b/doc/todo/toc_plugin_to_skip_one_level.mdwn
@@ -1,6 +1,6 @@
 It would be great if I could to this:
 
-     \[[toc levels=3 skip=1]]
+     \[[!toc levels=3 skip=1]]
 
 I use h1 for big title on each page, and don't want it in my toc on that page.
 
@@ -10,7 +10,7 @@ That way I could have toc for h2 and h3 and h1 is skipped bacause it is big titl
 > another option is added, I wonder why you're using a h1 for a title on
 > each page when the page name already appears at the top of each page. And
 > if the page name isn't right for the title, you can use 
-> \[[meta title="foo"]] to override it. And this purposefully doesn't show
+> \[[!meta title="foo"]] to override it. And this purposefully doesn't show
 > up in the toc. --[[Joey]]
 
 >> aaaahhh, I made a mistake. U used some other page.tmpl and title was hidden,
diff --git a/doc/todo/varioki_--_add_template_variables___40__with_closures_for_values__41___in_ikiwiki.setup.mdwn b/doc/todo/varioki_--_add_template_variables___40__with_closures_for_values__41___in_ikiwiki.setup.mdwn
index 484aa9d88..492a32b36 100644
--- a/doc/todo/varioki_--_add_template_variables___40__with_closures_for_values__41___in_ikiwiki.setup.mdwn
+++ b/doc/todo/varioki_--_add_template_variables___40__with_closures_for_values__41___in_ikiwiki.setup.mdwn
@@ -15,7 +15,7 @@ ManojSrivastava
 
 > I think you could now implement "toplvl" using [[conditionals|/plugins/conditional]]:
 >
->     \[[if test="destpage(/index)" then="""...""" else="""..."""]]
+>     \[[!if test="destpage(/index)" then="""...""" else="""..."""]]
 >
 > --[[JoshTriplett]]