diff options
Diffstat (limited to 'doc/ikiwiki')
-rw-r--r-- | doc/ikiwiki/directive/img.mdwn | 6 | ||||
-rw-r--r-- | doc/ikiwiki/directive/inline/discussion.mdwn | 68 | ||||
-rw-r--r-- | doc/ikiwiki/directive/pagestats.mdwn | 10 | ||||
-rw-r--r-- | doc/ikiwiki/pagespec.mdwn | 15 | ||||
-rw-r--r-- | doc/ikiwiki/pagespec/attachment.mdwn | 10 | ||||
-rw-r--r-- | doc/ikiwiki/pagespec/po.mdwn | 16 |
6 files changed, 110 insertions, 15 deletions
diff --git a/doc/ikiwiki/directive/img.mdwn b/doc/ikiwiki/directive/img.mdwn index 1d1f29bea..66efd008e 100644 --- a/doc/ikiwiki/directive/img.mdwn +++ b/doc/ikiwiki/directive/img.mdwn @@ -18,9 +18,9 @@ making the image smaller than the specified size. You can also specify only the width or the height, and the other value will be calculated based on it: "200x", "x200" -You can also pass `alt`, `title`, `class` and `id` parameters. These are -passed through unchanged to the html img tag. If you include a `caption` -parameter, the caption will be displayed centered beneath the image. +You can also pass `alt`, `title`, `class`, `align` and `id` parameters. +These are passed through unchanged to the html img tag. If you include a +`caption` parameter, the caption will be displayed centered beneath the image. The `link` parameter is used to control whether the scaled down image links to the full size version. By default it does; set "link=somepage" to link diff --git a/doc/ikiwiki/directive/inline/discussion.mdwn b/doc/ikiwiki/directive/inline/discussion.mdwn index 3f62c2767..be0665d04 100644 --- a/doc/ikiwiki/directive/inline/discussion.mdwn +++ b/doc/ikiwiki/directive/inline/discussion.mdwn @@ -56,3 +56,71 @@ to nowhere for 20 bugs.« is shown inlined. > > So no, you can't reference template directive parameters inside inline's > template, because it's already expanded at that point. --[[Joey]] + +>> Thank you for the explanation. Can you think of another way to accomplish +>> my goals? +>> +>> Right now, I only see the option to edit the title with the +>> `[[/ikiwiki/directive/meta]]` directive and the field `title`. +>> +>> How could a solution look like? +>> +>> 1. The possibility to add custom fields to the `meta` directive. +>> 1. The possibility to specify in a page, how the page should be displayed +>> when used by inlined. That could be done by a new directive `cinlined` +>> (for »custom inlined«) which is chosen by the `inline` directive to +>> display if told to do so. +>> +>> [[!cinlined text="""Text which can also use Parameter, bla blubb …"""]] +>> --[[PaulePanter]] +>>> You can make the body of a page change depending on whether it's being +>>> inlined, with the [[ikiwiki/directive/if]] directive from the +>>> [[plugins/conditional]] plugin: +>>> +>>> \[[!if test="inlined()" +>>> then="""[[!template id=productsummary +>>> location="Warehouse 23" price=20 +>>> ]]""" +>>> else="""[[!template id=productdetail +>>> location="Warehouse 23" price=20 +>>> description="Every home should have one" +>>> ]]""" +>>> ]] +>>> +>>> Perhaps that does some of what you want? +>>> +>>> If you want to go beyond that, my inclination would be to write +>>> a simple plugin to deal with whatever it is you want to do (bug +>>> metadata or product metadata or whatever) rather than prematurely +>>> generalizing. --[[smcv]] + +## meta parameters are not enough + +I think I have the same problem as Paule, as I want extra arbitary parameters in my template. + +This is what I am doing currently, which makes my skin crawl. In `wgts/foo.mdwn` +I have resorted to using AUTHORURL as the location of this widgets icon: + + [[!meta authorurl="/ico/aHR0cDovL2JvbmRpLm9tdHAub3JnL3dpZGdldHMvYmF0dGVyeQ==.png" ]] + +In templates I have a file called `wgtlist.tmpl`: + + <div class="widget"> + <TMPL_IF NAME="AUTHORURL"> + <img src="<TMPL_VAR AUTHORURL>" /> + </TMPL_IF> + <TMPL_IF NAME="PERMALINK"> + <a href="<TMPL_VAR PERMALINK>"><TMPL_VAR TITLE></a><br /> + <TMPL_ELSE> + <a href="<TMPL_VAR PAGEURL>"><TMPL_VAR TITLE></a><br /> + </TMPL_IF> + Posted <TMPL_VAR CTIME> + </div> + +My index page has: + + [[!inline pages="./wgts/*" show=5 feeds=no actions=no rootpage="wgts" archive="yes" template=wgtlist]] + +Else can you please suggest a smarter way of getting certain data out from pages for a inline index? + +--[[hendry]] diff --git a/doc/ikiwiki/directive/pagestats.mdwn b/doc/ikiwiki/directive/pagestats.mdwn index cfb5737a5..426f3e4af 100644 --- a/doc/ikiwiki/directive/pagestats.mdwn +++ b/doc/ikiwiki/directive/pagestats.mdwn @@ -12,4 +12,14 @@ And here's how to create a table of all the pages on the wiki: \[[!pagestats style="table"]] +The optional `among` parameter limits counting to pages that match a +[[ikiwiki/PageSpec]]. For instance, to display a cloud of tags used on blog +entries, you could use: + + \[[!pagestats pages="tags/*" among="blog/posts/*"]] + +or to display a cloud of tags related to Linux, you could use: + + \[[!pagestats pages="tags/* and not tags/linux" among="tagged(linux)"]] + [[!meta robots="noindex, follow"]] diff --git a/doc/ikiwiki/pagespec.mdwn b/doc/ikiwiki/pagespec.mdwn index b476bde1f..5f0f44e2e 100644 --- a/doc/ikiwiki/pagespec.mdwn +++ b/doc/ikiwiki/pagespec.mdwn @@ -24,17 +24,18 @@ match all pages except for Discussion pages and the SandBox: Some more elaborate limits can be added to what matches using these functions: -* "`link(page)`" - match only pages that link to a given page (or glob) -* "`tagged(tag)`" - match pages that are tagged or link to the given tag (or glob) -* "`backlink(page)`" - match only pages that a given page links to -* "`creation_month(month)`" - match only pages created on the given month +* "`link(page)`" - matches only pages that link to a given page (or glob) +* "`tagged(tag)`" - matches pages that are tagged or link to the given tag (or + tags matched by a glob) +* "`backlink(page)`" - matches only pages that a given page links to +* "`creation_month(month)`" - matches only pages created on the given month * "`creation_day(mday)`" - or day of the month * "`creation_year(year)`" - or year -* "`created_after(page)`" - match only pages created after the given page +* "`created_after(page)`" - matches only pages created after the given page was created -* "`created_before(page)`" - match only pages created before the given page +* "`created_before(page)`" - matches only pages created before the given page was created -* "`glob(someglob)`" - match pages that match the given glob. Just writing +* "`glob(someglob)`" - matches pages that match the given glob. Just writing the glob by itself is actually a shorthand for this function. * "`internal(glob)`" - like `glob()`, but matches even internal-use pages that globs do not usually match. diff --git a/doc/ikiwiki/pagespec/attachment.mdwn b/doc/ikiwiki/pagespec/attachment.mdwn index 344a4a734..419f00ee4 100644 --- a/doc/ikiwiki/pagespec/attachment.mdwn +++ b/doc/ikiwiki/pagespec/attachment.mdwn @@ -16,14 +16,14 @@ check all attachments for viruses, something like this could be used: The regular [[ikiwiki/PageSpec]] syntax is expanded with the following additional tests: -* "`maxsize(size)`" - Tests whether the attachment is no larger than the +* "`maxsize(size)`" - tests whether the attachment is no larger than the specified size. The size defaults to being in bytes, but "kb", "mb", "gb" etc can be used to specify the units. -* "`minsize(size)`" - Tests whether the attachment is no smaller than the +* "`minsize(size)`" - tests whether the attachment is no smaller than the specified size. -* "`ispage()`" - Tests whether the attachment will be treated by ikiwiki as a +* "`ispage()`" - tests whether the attachment will be treated by ikiwiki as a wiki page. (Ie, if it has an extension of ".mdwn", or of any other enabled page format). @@ -31,7 +31,7 @@ additional tests: use `!ispage()` ; if you only want to allow wiki pages to be uploaded as attachments, use `ispage()`. -* "`mimetype(foo/bar)`" - This checks the MIME type of the attachment. You can +* "`mimetype(foo/bar)`" - checks the MIME type of the attachment. You can include a glob in the type, for example `mimetype(image/*)`. -* "`virusfree()`" - Checks the attachment with an antiviral program. +* "`virusfree()`" - checks the attachment with an antiviral program. diff --git a/doc/ikiwiki/pagespec/po.mdwn b/doc/ikiwiki/pagespec/po.mdwn new file mode 100644 index 000000000..e0264dd50 --- /dev/null +++ b/doc/ikiwiki/pagespec/po.mdwn @@ -0,0 +1,16 @@ +[[!if test="enabled(po)" + then="This wiki has po support **enabled**." + else="This wiki has po support **disabled**."]] + +If the [[!iki plugins/po desc=po]] plugin is enabled, the regular +[[ikiwiki/PageSpec]] syntax is expanded with the following additional +tests that can be used to improve user navigation in a multi-lingual +wiki: + +* "`lang(LL)`" - tests whether a page is written in the language + specified as a ISO639-1 (two-letter) language code. +* "`currentlang()`" - tests whether a page is written in the same + language as the current page. + +Note that every non-po page is considered to be written in +`po_master_language`, as specified in `ikiwiki.setup`. |