From d6fd1f1cc878b5dffdfae30f6dfee77c235c438e Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 25 Aug 2008 14:19:39 -0400 Subject: rename preprocessordirective to directive Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-) --- doc/basewiki.mdwn | 2 +- .../Spaces_in_link_text_for_ikiwiki_links.mdwn | 2 +- ...i_links_still_processed_inside_code_blocks.mdwn | 2 +- doc/features.mdwn | 4 +-- doc/ikiwiki.mdwn | 2 +- doc/ikiwiki/blog.mdwn | 8 ++--- doc/ikiwiki/directive.mdwn | 39 ++++++++++++++++++++++ doc/ikiwiki/markdown.mdwn | 6 ++-- doc/ikiwiki/preprocessordirective.mdwn | 39 ---------------------- doc/ikiwiki/wikilink.mdwn | 6 ++-- doc/ikiwiki/wikilink/discussion.mdwn | 2 +- doc/plugins/creole.mdwn | 2 +- doc/plugins/edittemplate.mdwn | 2 +- doc/plugins/inline.mdwn | 2 +- doc/plugins/listdirectives.mdwn | 11 ++++++ doc/plugins/meta/discussion.mdwn | 2 +- doc/plugins/pagecount.mdwn | 2 +- doc/plugins/rst.mdwn | 2 +- doc/plugins/txt.mdwn | 2 +- doc/plugins/write.mdwn | 6 ++-- doc/plugins/write/tutorial.mdwn | 10 +++--- doc/shortcuts.mdwn | 4 +-- ...n_to_list_available_pre-processor_commands.mdwn | 2 ++ ...conditional_text_based_on_ikiwiki_features.mdwn | 4 +-- doc/todo/format_escape.mdwn | 2 +- doc/todo/graphviz.mdwn | 2 +- doc/todo/htmlvalidation.mdwn | 4 +-- doc/todo/latex.mdwn | 2 +- doc/todo/linktitle.mdwn | 6 ++-- doc/todo/pageindexes.mdwn | 2 +- ...reprocessor_directive_for_proposed_changes.mdwn | 2 +- doc/todo/progressbar_plugin.mdwn | 2 +- doc/todo/rss_title_description.mdwn | 2 +- doc/todo/shortcut_link_text.mdwn | 2 +- ...ot_work_in_PreprocessorDirective_arguments.mdwn | 6 ++-- 35 files changed, 104 insertions(+), 91 deletions(-) create mode 100644 doc/ikiwiki/directive.mdwn delete mode 100644 doc/ikiwiki/preprocessordirective.mdwn create mode 100644 doc/plugins/listdirectives.mdwn (limited to 'doc') diff --git a/doc/basewiki.mdwn b/doc/basewiki.mdwn index 29f632375..e1f876acb 100644 --- a/doc/basewiki.mdwn +++ b/doc/basewiki.mdwn @@ -13,7 +13,7 @@ It currently includes these pages: * [[ikiwiki/markdown]] * [[ikiwiki/openid]] * [[ikiwiki/pagespec]] -* [[ikiwiki/PreprocessorDirective]] +* [[ikiwiki/directive]] * [[ikiwiki/subpage]] * [[ikiwiki/wikilink]] diff --git a/doc/bugs/Spaces_in_link_text_for_ikiwiki_links.mdwn b/doc/bugs/Spaces_in_link_text_for_ikiwiki_links.mdwn index 27919f7be..f6dbacad7 100644 --- a/doc/bugs/Spaces_in_link_text_for_ikiwiki_links.mdwn +++ b/doc/bugs/Spaces_in_link_text_for_ikiwiki_links.mdwn @@ -16,7 +16,7 @@ reported in [[index/discussion#index11h1]]. > want multiple words. > > This was a decision I made a long time ago due to the ambiguity between a -> WikiLink and a [[ikiwiki/PreProcessorDirective]]. Is "\[[foo bar|baz]]" a wikilink to +> WikiLink and a [[ikiwiki/Directive]]. Is "\[[foo bar|baz]]" a wikilink to > baz with a link text of "foo bar", or an instance of preprocessor > directive "foo" with a parameter of "bar|baz"? If it's interpreted as a > wikilink today, that could change tomorrow if a new preprocessor directive diff --git a/doc/bugs/wiki_links_still_processed_inside_code_blocks.mdwn b/doc/bugs/wiki_links_still_processed_inside_code_blocks.mdwn index ede16a029..b2a8b0632 100644 --- a/doc/bugs/wiki_links_still_processed_inside_code_blocks.mdwn +++ b/doc/bugs/wiki_links_still_processed_inside_code_blocks.mdwn @@ -1,6 +1,6 @@ In [[ikiwiki/markdown]] syntax, none of the other special characters get processed inside a code block. However, in ikiwiki, [[wiki_links|ikiwiki/wikilink]] and -[[preprocessor_directives|ikiwiki/preprocessordirective]] still get processed +[[preprocessor_directives|ikiwiki/directive]] still get processed inside a code block, requiring additional escaping. For example, `[links don't work](#here)`, but `a [[ikiwiki/wikilink]] becomes HTML`. --[[JoshTriplett]] diff --git a/doc/features.mdwn b/doc/features.mdwn index c6fc95c0b..8e3c0799c 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -32,7 +32,7 @@ Any page with a filename ending in ".mdwn" is converted from markdown to html by ikiwiki. Markdown understands text formatted as it would be in an email, and is quite smart about converting it to html. The only additional markup provided by ikiwiki on top of regular markdown is the [[ikiwiki/WikiLink]] and -[[ikiwiki/PreprocessorDirective]]. +the [[ikiwiki/directive]]. If you prefer to use some other markup language, ikiwiki allows others to easily be added by [[plugins]]. For example it also supports traditional @@ -74,7 +74,7 @@ can change the look and layout of all pages in any way you would like. Plugins can be used to add additional features to ikiwiki. The interface is quite flexible, allowing plugins to implement additional markup -languages, register [[ikiwiki/PreProcessorDirective]]s, hook into [[CGI]] mode, +languages, register [[directives|ikiwiki/directive]], hook into [[CGI]] mode, and more. Most of ikiwiki's features are actually provided by plugins. Ikiwiki's backend RCS support is also pluggable, so support for new revision control systems can be added to ikiwiki. diff --git a/doc/ikiwiki.mdwn b/doc/ikiwiki.mdwn index c98a97e59..89337d051 100644 --- a/doc/ikiwiki.mdwn +++ b/doc/ikiwiki.mdwn @@ -9,7 +9,7 @@ Some documentation on using ikiwiki: * [[ikiwiki/formatting]] * [[ikiwiki/blog]] * [[ikiwiki/pagespec]] -* [[ikiwiki/PreprocessorDirective]] +* [[ikiwiki/directive]] * [[ikiwiki/wikilink]] * [[ikiwiki/markdown]] * [[ikiwiki/subpage]] diff --git a/doc/ikiwiki/blog.mdwn b/doc/ikiwiki/blog.mdwn index 19ec7ac30..53d4c7a96 100644 --- a/doc/ikiwiki/blog.mdwn +++ b/doc/ikiwiki/blog.mdwn @@ -7,7 +7,7 @@ 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: +[[directive]]. For example: \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]] @@ -17,9 +17,9 @@ of them will appear in the page. Note that if files that are not pages match the [[PageSpec]], they will be included in the feed using RSS enclosures, which is useful for podcasting. -The optional `rootpage` parameter tells the wiki that new posts to this blog -should default to being [[SubPage]]s of "blog", and enables a form at the -top of the blog that can be used to add new items. +The optional `rootpage` parameter tells the wiki that new posts to this +blog should default to being [[SubPages|SubPage]] of "blog", and enables a +form at the top of the blog that can be used to add new items. If you want your blog to have an archive page listing every post ever made to it, you can accomplish that like this: diff --git a/doc/ikiwiki/directive.mdwn b/doc/ikiwiki/directive.mdwn new file mode 100644 index 000000000..9a01aaa82 --- /dev/null +++ b/doc/ikiwiki/directive.mdwn @@ -0,0 +1,39 @@ +[[!meta robots="noindex, follow"]] +Directives are similar to a [[WikiLink]] in form, except they +begin with `!` and may contain parameters. The general form is: + + \[[!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]] + +A directive does not need to all be on one line, it can be +wrapped to multiple lines if you like: + + \[[!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=""" + 1. "foo" + 2. "bar" + 3. "baz" + """]] + +ikiwiki also has an older syntax for 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 the `prefix_directives` option is not enabled. +For backward compatibility with existing wikis, this option currently +defaults to off, so ikiwiki supports the old syntax. diff --git a/doc/ikiwiki/markdown.mdwn b/doc/ikiwiki/markdown.mdwn index bbda9add7..a4190945f 100644 --- a/doc/ikiwiki/markdown.mdwn +++ b/doc/ikiwiki/markdown.mdwn @@ -8,6 +8,6 @@ For documentation about the markdown syntax, see [[formatting]] and [markdown mode](http://jblevins.org/projects/markdown-mode/) for emacs can help in editing. -Note that [[WikiLink]]s and [[PreProcessorDirective]]s are not part of the -markdown syntax, and are the only bit of markup that this wiki handles -internally. +Note that [[WikiLinks|WikiLink]] and [[directives|directive]] are not part +of the markdown syntax, and are the only bit of markup that this wiki +handles internally. diff --git a/doc/ikiwiki/preprocessordirective.mdwn b/doc/ikiwiki/preprocessordirective.mdwn deleted file mode 100644 index 743c0d9f5..000000000 --- a/doc/ikiwiki/preprocessordirective.mdwn +++ /dev/null @@ -1,39 +0,0 @@ -[[!meta robots="noindex, follow"]] -Preprocessor directives are similar to a [[WikiLink]] in form, except they -begin with `!` and may contain parameters. The general form is: - - \[[!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]] - -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" - 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=""" - 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 the `prefix_directives` option is not enabled. -For backward compatibility with existing wikis, this option currently -defaults to off, so ikiwiki supports the old syntax. diff --git a/doc/ikiwiki/wikilink.mdwn b/doc/ikiwiki/wikilink.mdwn index bd5e3d185..371c2528f 100644 --- a/doc/ikiwiki/wikilink.mdwn +++ b/doc/ikiwiki/wikilink.mdwn @@ -23,11 +23,11 @@ page, but the link will appear like this: [[foo_bar|SandBox]]. To link to an anchor inside a page, you can use something like `\[[WikiLink#foo]]` -## Preprocessor directives and wikilinks +## Directives and WikiLinks ikiwiki has two syntaxes for -[[preprocessor_directives|PreprocessorDirective]]. The older syntax -used spaces to distinguish between preprocessor directives and +[[directives|directive]]. The older syntax +used spaces to distinguish between 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 diff --git a/doc/ikiwiki/wikilink/discussion.mdwn b/doc/ikiwiki/wikilink/discussion.mdwn index e69fcb31b..e4b1f933f 100644 --- a/doc/ikiwiki/wikilink/discussion.mdwn +++ b/doc/ikiwiki/wikilink/discussion.mdwn @@ -14,7 +14,7 @@ BTW, ikiwiki doesn't displays the #foo anchor in the example --[[Paweł|ptecza]] > No such syntax exists in markdown. ikiwiki could certainly have a -> [[preprocessor_directive|preprocessordirective]] for it, though. +> [[preprocessor_directive|directive]] for it, though. > --[[JoshTriplett]] >> [[!tag wishlist]] diff --git a/doc/plugins/creole.mdwn b/doc/plugins/creole.mdwn index ed347e2c5..4b0adb4f1 100644 --- a/doc/plugins/creole.mdwn +++ b/doc/plugins/creole.mdwn @@ -12,5 +12,5 @@ wiki markup formats, so should be fairly easy to guess at. There is also a [CheatSheet](http://www.wikicreole.org/wiki/CheatSheet). Links are standard [[WikiLinks|ikiwiki/WikiLink]]. Links and -[[ikiwiki/PreProcessorDirectives]] inside `{{{ }}}` blocks are still expanded, +[[ikiwiki/directives]] inside `{{{ }}}` blocks are still expanded, since this happens before the creole format is processed. diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn index a68f7f0a1..674bdc863 100644 --- a/doc/plugins/edittemplate.mdwn +++ b/doc/plugins/edittemplate.mdwn @@ -3,7 +3,7 @@ This plugin allows registering template pages, that provide default content for new pages created using the web frontend. To register a -template, insert a [[Preprocessor_Directive|/ikiwiki/preprocessordirective]] on some other page. +template, insert a [[ikiwiki/directive]] on some other page. \[[!edittemplate template="bugtemplate" match="bugs/*"]] diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn index e66c9103f..1ea401c6a 100644 --- a/doc/plugins/inline.mdwn +++ b/doc/plugins/inline.mdwn @@ -1,6 +1,6 @@ [[!template id=plugin name=inline core=1 author="[[Joey]]"]] -This is a [[ikiwiki/PreProcessorDirective]] that allows including one wiki page +This is a [[ikiwiki/directive]] that allows including one wiki page inside another. For example: \[[!inline pages="blog/*"]] diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn new file mode 100644 index 000000000..3645813b8 --- /dev/null +++ b/doc/plugins/listdirectives.mdwn @@ -0,0 +1,11 @@ +[[!template id=plugin name=listdirectives author="Will"]] +[[!tag type/meta]] + +This plugin generates a list of available +[[directives|ikiwiki/directive]]. + + \[[!listdirectives]] + +Each directive links to a wiki page with the same name. The location of the +pages in the wiki can be controlled via the `directive_description_dir` +setting in the setup file. diff --git a/doc/plugins/meta/discussion.mdwn b/doc/plugins/meta/discussion.mdwn index 8388a1172..814b93a41 100644 --- a/doc/plugins/meta/discussion.mdwn +++ b/doc/plugins/meta/discussion.mdwn @@ -11,7 +11,7 @@ Now I've work-arounded it using apostrophes in another way --[[Paweł|ptecza]] -> As with any other parameter in a [[ikiwiki/preprocessordirective]], you can +> As with any other parameter in a [[ikiwiki/directive]], you can > triple-quote, and then include quotation marks inside. --[[Joey]] >> Thanks for the hint! Toggle plugin is probably my favourite ikiwiki diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn index 790f033ca..84a02c3f1 100644 --- a/doc/plugins/pagecount.mdwn +++ b/doc/plugins/pagecount.mdwn @@ -1,7 +1,7 @@ [[!template id=plugin name=pagecount author="[[Joey]]"]] [[!tag type/meta]] -Provides a \\[[!pagecount ]] [[ikiwiki/PreProcessorDirective]] that is +Provides a \\[[!pagecount ]] [[ikiwiki/directive]] that is replaced with the total number of pages currently in the wiki. The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn index b415ecdb9..9355597ac 100644 --- a/doc/plugins/rst.mdwn +++ b/doc/plugins/rst.mdwn @@ -11,7 +11,7 @@ ikiwiki. Limitations include: * There are issues with inserting raw html into documents, as ikiwiki does with [[WikiLinks|ikiwiki/WikiLink]] and many - [[PreprocessorDirectives|ikiwiki/PreprocessorDirective]]. + preprocessor [[directives|ikiwiki/directive]]. So while you may find this useful for importing old files into your wiki, using this as your main markup language in ikiwiki isn't recommended at diff --git a/doc/plugins/txt.mdwn b/doc/plugins/txt.mdwn index c27728929..1b7e7821b 100644 --- a/doc/plugins/txt.mdwn +++ b/doc/plugins/txt.mdwn @@ -9,6 +9,6 @@ txt files is done; the file contents is displayed to the user as-is, with html markup characters such as ">" escaped. The only exceptions are that [[WikiLinks|WikiLink]] and -[[PreprocessorDirectives|PreprocessorDirective]] are still expanded by +[[directives|directive]] are still expanded by ikiwiki, and that, if the [[!cpan URI::Find]] perl module is installed, URLs in the txt file are converted to hyperlinks. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index b9601ea57..cde0b50fd 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -123,7 +123,7 @@ make arbitrary changes. The function is passed named parameters "page", ### preprocess -Adding a [[ikiwiki/PreProcessorDirective]] is probably the most common use +Adding a preprocessor [[ikiwiki/directive]] is probably the most common use of a plugin. hook(type => "preprocess", id => "foo", call => \&preprocess); @@ -158,7 +158,7 @@ can assume it's being run in scan mode, and avoid doing expensive things at that point.) Note that if the [[htmlscrubber]] is enabled, html in -[[ikiwiki/PreProcessorDirective]] output is sanitised, which may limit what +preprocessor [[ikiwiki/directive]] output is sanitised, which may limit what your plugin can do. Also, the rest of the page content is not in html format at preprocessor time. Text output by a preprocessor directive will be linkified and passed through markdown (or whatever engine is used to @@ -500,7 +500,7 @@ function that is called after the error message is printed, to do any final cleanup. If called inside a preprocess hook, error() does not abort the entire -wiki build, but instead replaces the [[ikiwiki/PreProcessorDirective]] with +wiki build, but instead replaces the preprocessor [[ikiwiki/directive]] with a version containing the error message. In other hooks, error() is a fatal error, so use with care. Try to avoid diff --git a/doc/plugins/write/tutorial.mdwn b/doc/plugins/write/tutorial.mdwn index 5b810a18f..2823c47b7 100644 --- a/doc/plugins/write/tutorial.mdwn +++ b/doc/plugins/write/tutorial.mdwn @@ -5,9 +5,9 @@ What should the plugin do? Let's make it calculate and output the Fibonacci sequence. To output the next number in the sequence, all a user has to do is write this on a wiki page: - [[!fib ]] + [[!fib]] -When the page is built, the [[ikiwiki/PreProcessorDirective]] will be +When the page is built, the [[ikiwiki/directive]] will be replaced by the next number in the sequence. Most of ikiwiki's plugins are written in Perl, and it's currently easiest @@ -39,16 +39,16 @@ register hooks that ikiwiki will call later. } This has hooked our plugin into the preprocess hook, which ikiwiki uses to -expand [[PreprocessorDirectives|ikiwiki/preprocessordirective]]. Notice +expand preprocessor [[directives|ikiwiki/directive]]. Notice that "fib" has shown up again. It doesn't actually have to match the module name this time, but it generally will. This "fib" is telling ikiwiki what -kind of PreprocessorDirective to handle, namely one that looks like this: +kind of preprocessor directive to handle, namely one that looks like this: [[!fib ]] Notice the `\&preprocess`? This is how you pass a reference to a function, and the `preprocess` function is the one that ikiwiki will call to expand -the PreprocessorDirective. So, time to write that function: +the preprocessor directive. So, time to write that function: sub preprocess { my %params=@_; diff --git a/doc/shortcuts.mdwn b/doc/shortcuts.mdwn index 037c31ee6..4bb677489 100644 --- a/doc/shortcuts.mdwn +++ b/doc/shortcuts.mdwn @@ -61,13 +61,13 @@ This page controls what shortcut links the wiki supports. * [[!shortcut name=ohloh url="http://www.ohloh.net/projects/%s"]] To add a new shortcut, use the `shortcut` -[[ikiwiki/PreprocessorDirective]]. In the url, "%s" is replaced with the +[[ikiwiki/directive]]. In the url, "%s" is replaced with the text passed to the named shortcut, after url-encoding it, and '%S' is replaced with the raw, non-encoded text. The optional `desc` parameter 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 +[[ikiwiki/directive]]. Avoid using a `name` that conflicts with an existing directive. These directives also accept a `desc` parameter that will override the one provided at definition time. diff --git a/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn b/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn index 0524627d4..b8ef2409d 100644 --- a/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn +++ b/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn @@ -412,3 +412,5 @@ This is what I was using for `preprocessor-description.tmpl`: The preprocessor command currently has no description. Maybe you should edit this page to add one. + +[[tag done]] diff --git a/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn b/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn index 4bdcf3d01..17585af65 100644 --- a/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn +++ b/doc/todo/conditional_text_based_on_ikiwiki_features.mdwn @@ -25,7 +25,7 @@ include an `else` clause; if so, you could label the text used if true as `then`. Syntax could vary greatly here, both for the -[[ikiwiki/PreprocessorDirective]] and for the condition itself. +[[ikiwiki/Directive]] and for the condition itself. > I think this is a good thing to consider, although conditionals tend to > make everything a lot more complicated, so I also want to KISS, and not @@ -57,7 +57,7 @@ Syntax could vary greatly here, both for the > --[[Joey]] >> [[ikiwiki/PageSpec]] syntax seems perfect, and your proposed syntax for the `if` ->> [[ikiwiki/PreprocessorDirective]] looks fine to me. +>> [[ikiwiki/Directive]] looks fine to me. >> >> [[ikiwiki/PageSpec]]s don't give you `none` for free, since `!foo/*` as a boolean >> would mean "does any page not matching `foo/*` exist", not "does `foo/*` diff --git a/doc/todo/format_escape.mdwn b/doc/todo/format_escape.mdwn index 315b2d88f..8dfe05581 100644 --- a/doc/todo/format_escape.mdwn +++ b/doc/todo/format_escape.mdwn @@ -219,7 +219,7 @@ Index: doc/plugins/rst.mdwn -* reStructuredText does not allow raw html to be inserted into - documents, but ikiwiki does so in many cases, including - [[WikiLinks|ikiwiki/WikiLink]] and many -- [[PreprocessorDirectives|ikiwiki/PreprocessorDirective]]. +- [[Directives|ikiwiki/Directive]]. +* Some bits of ikiwiki may still assume that markdown is used or embed html + in ways that break reStructuredText. (Report bugs if you find any.) * It's slow; it forks a copy of python for each page. While there is a diff --git a/doc/todo/graphviz.mdwn b/doc/todo/graphviz.mdwn index 66ca0ae32..3f2514a99 100644 --- a/doc/todo/graphviz.mdwn +++ b/doc/todo/graphviz.mdwn @@ -1,5 +1,5 @@ How about a plugin providing a -[[preprocessor_directive|ikiwiki/preprocessordirective]] to render a +[[preprocessor_directive|ikiwiki/directive]] to render a [[!debpkg graphviz]] file as an image via one of the graphviz programs ("dot" by default) and include the resulting image on the page, using the "cmapx" image map format? graphviz files themselves could also render the diff --git a/doc/todo/htmlvalidation.mdwn b/doc/todo/htmlvalidation.mdwn index 96bcd926b..e376b840e 100644 --- a/doc/todo/htmlvalidation.mdwn +++ b/doc/todo/htmlvalidation.mdwn @@ -31,8 +31,8 @@ Because [ [inlinepage] ] isn't separated by a blank line it gets treated as a block-level element. Hmm, will this stop all formatting, including *'s to em-tags? --[[JeroenSchot]] Ah didn't realize you meant it fixed it at the markdown level. I'll - think about making postprocessordirectives into - [[ikiwiki/preprocessordirective]]s instead, then I could use that fix (but I'm not + think about making postprocessor directives into + preprocessor directives instead, then I could use that fix (but I'm not sure how feasible it is to do that). --[[Joey]] Done.. inlining is now a preprocessor directive, happens before diff --git a/doc/todo/latex.mdwn b/doc/todo/latex.mdwn index e96e4b782..56d3b1c0c 100644 --- a/doc/todo/latex.mdwn +++ b/doc/todo/latex.mdwn @@ -1,5 +1,5 @@ How about a plugin adding a -[[preprocessor_directive|ikiwiki/preprocessordirective]] to render some given LaTeX +[[preprocessor_directive|ikiwiki/directive]] to render some given LaTeX and include it in the page? This could either render the LaTeX as a PNG via [[!debpkg dvipng]] and include the resulting image in the page, or perhaps render via [HeVeA](http://pauillac.inria.fr/~maranget/hevea/index.html), diff --git a/doc/todo/linktitle.mdwn b/doc/todo/linktitle.mdwn index d5b53e082..6df3bfdce 100644 --- a/doc/todo/linktitle.mdwn +++ b/doc/todo/linktitle.mdwn @@ -2,15 +2,15 @@ Pages could have a `linktitle` (perhaps via [[plugins/meta]]), and [[wikilinks|ikiwiki/wikilink]] could use that title by default when linking to the page. That would allow pages to have a simple, easily linkable name (without spaces, for instance), but use the proper title for links. For -example, [[ikiwiki/PreprocessorDirective]] could use the `linktitle` +example, [[ikiwiki/Directive]] could use the `linktitle` "preprocessor directive", and pages for [[users]] could have `linktitle`s that put spaces in their names. Ideally, perhaps two versions of the title could exist, one for general use, and an optional one for if the case in the actual link starts with an -uppercase letter. That would allow [[ikiwiki/preprocessordirective]] to +uppercase letter. That would allow [[ikiwiki/directive]] to use the link text "preprocessor directive", but -[[ikiwiki/PreprocessorDirective]] to use the link text "Preprocessor +[[ikiwiki/Directive]] to use the link text "Preprocessor Directive", for use at the beginnings of sentences. If the second version did not exist, the first version would apply to both cases. However, that also seems like potential overkill, and less important than the basic diff --git a/doc/todo/pageindexes.mdwn b/doc/todo/pageindexes.mdwn index c2de20a34..cf28bec96 100644 --- a/doc/todo/pageindexes.mdwn +++ b/doc/todo/pageindexes.mdwn @@ -1,5 +1,5 @@ Might be nice to support automatically generating an index based on headers in a page, for long pages. This could be done as a sanitize hook that -parsed the html, with a preprocessordirective that controlled it. +parsed the html, with a directive that controlled it. [[todo/done]] diff --git a/doc/todo/preprocessor_directive_for_proposed_changes.mdwn b/doc/todo/preprocessor_directive_for_proposed_changes.mdwn index c0af59eba..1542f39ae 100644 --- a/doc/todo/preprocessor_directive_for_proposed_changes.mdwn +++ b/doc/todo/preprocessor_directive_for_proposed_changes.mdwn @@ -7,7 +7,7 @@ which can't be made through the web interface: Of course in these cases, you can add your request to a discussion page and wait for someone with the access/confidence to apply them. -Maybe this can be enhanced with a [[ikiwiki/PreprocessorDirective]]: +Maybe this can be enhanced with a [[ikiwiki/Directive]]: 
 \[[!suggest op=merge dstfile=trunk srcfile=branches/jk oldrev=1234 newrev=1342]]
diff --git a/doc/todo/progressbar_plugin.mdwn b/doc/todo/progressbar_plugin.mdwn
index 4f3cf148b..3401bca85 100644
--- a/doc/todo/progressbar_plugin.mdwn
+++ b/doc/todo/progressbar_plugin.mdwn
@@ -209,7 +209,7 @@ Here is a potential documentation page:
 [[!template id=plugin name=progress author="[[Will]]"]]
 [[!tag type/meta]]
 
-Provides a \\[[!progress ]] [[ikiwiki/PreProcessorDirective]] that is
+Provides a \\[[!progress ]] [[ikiwiki/Directive]] that is
 replaced with a progress bar.
 
 There are two possible parameter sets.  The first is a single parameter
diff --git a/doc/todo/rss_title_description.mdwn b/doc/todo/rss_title_description.mdwn
index 3f56a10e0..f0138cb72 100644
--- a/doc/todo/rss_title_description.mdwn
+++ b/doc/todo/rss_title_description.mdwn
@@ -18,7 +18,7 @@ A few pointers and I might be able to implement this myself. -- JamesWestby
 > Now, the description field currently defaults to the wiki name,
 > and that could indeed stand to be made configurable. Since the
 > current (svn) version of ikiwiki supports long, word-wrapped
-> blocks of text as parameters to [[ikiwiki/PreProcessorDirective]]s, seems
+> blocks of text as parameters to [[ikiwiki/Directive]]s, seems
 > to me the best way would be to simple modify inline.pm to make the
 > descripion configurable by such parameter, with a fallback to the
 > wiki name. You'll need to modify rsspage.tmpl to use whatever new
diff --git a/doc/todo/shortcut_link_text.mdwn b/doc/todo/shortcut_link_text.mdwn
index 765c445ab..952e84608 100644
--- a/doc/todo/shortcut_link_text.mdwn
+++ b/doc/todo/shortcut_link_text.mdwn
@@ -1,4 +1,4 @@
-[[plugins/shortcut]] creates link shortcut [[ikiwiki/PreprocessorDirective]]s,
+[[plugins/shortcut]] creates link shortcut [[ikiwiki/Directive]]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
diff --git a/doc/todo/smileys_do_not_work_in_PreprocessorDirective_arguments.mdwn b/doc/todo/smileys_do_not_work_in_PreprocessorDirective_arguments.mdwn
index a55a66141..06c06e191 100644
--- a/doc/todo/smileys_do_not_work_in_PreprocessorDirective_arguments.mdwn
+++ b/doc/todo/smileys_do_not_work_in_PreprocessorDirective_arguments.mdwn
@@ -1,11 +1,11 @@
-Several [[ikiwiki/PreprocessorDirective]]s take ikiwiki-formatted text as arguments,
+Several [[ikiwiki/Directive]]s take ikiwiki-formatted text as arguments,
 such as the `then` and `else` arguments of the new `if` directive, or the
 `desc` argument of the `shortcut` directive.  However, smileys do not work in
 these arguments.
 
-Since the arguments to [[ikiwiki/PreprocessorDirective]]s might use the same syntax as
+Since the arguments to [[ikiwiki/Directive]]s might use the same syntax as
 smileys for a different meaning, smiley substitution should not happen until
-after [[ikiwiki/PreprocessorDirective]]s.
+after [[ikiwiki/Directive]]s.
 
 --[[JoshTriplett]]
 
-- 
cgit v1.2.3