aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2012-04-26 12:54:55 -0400
committerJoey Hess <joey@kitenet.net>2012-04-26 12:54:55 -0400
commita29599d68aec2797eb6b3b48c8a151025a4d6fa4 (patch)
treedd7b585b7a0af66baee35e7483b13c2a82489670 /doc
parentd6fc24d10e030f4ff03e064364e0a8959f5efb46 (diff)
parent75edc3c2233461ad371710c05497e6c7e1e79a46 (diff)
downloadikiwiki-a29599d68aec2797eb6b3b48c8a151025a4d6fa4.tar
ikiwiki-a29599d68aec2797eb6b3b48c8a151025a4d6fa4.tar.gz
Merge branch 'master' of ssh://git.ikiwiki.info
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki/directive/graph/discussion.mdwn27
-rw-r--r--doc/install.mdwn7
-rw-r--r--doc/plugins/contrib/getfield/discussion.mdwn18
-rw-r--r--doc/plugins/contrib/syntax.mdwn2
-rw-r--r--doc/todo/allow_TMPL__95__LOOP_in_template_directives.mdwn14
-rw-r--r--doc/users/OscarMorante.mdwn2
6 files changed, 68 insertions, 2 deletions
diff --git a/doc/ikiwiki/directive/graph/discussion.mdwn b/doc/ikiwiki/directive/graph/discussion.mdwn
new file mode 100644
index 000000000..f88da7261
--- /dev/null
+++ b/doc/ikiwiki/directive/graph/discussion.mdwn
@@ -0,0 +1,27 @@
+How to align this?
+==================
+
+I have found this patch to be the only way I can float graphs to the right:
+
+[[!format diff """
+--- Plugin/graphviz.pm.orig 2012-04-25 10:26:59.531525247 -0400
++++ Plugin/graphviz.pm 2012-04-25 10:26:01.282922144 -0400
+@@ -87,8 +87,10 @@
+ error gettext("failed to run graphviz") if ($sigpipe || $?);
+ }
+
++ my $class = '';
++ $class = 'class="' . $params{class} if $params{class};
+ return "<img src=\"".urlto($dest, $params{destpage}).
+- "\" usemap=\"#graph$sha\" />\n".
++ "\" usemap=\"#graph$sha\" $class />\n".
+ $map;
+ }
+"""]]
+
+Then I can use `[[!graph class="align-right" ...]]`.. --[[anarcat]]
+
+> You can already use `<div class="align-right">[[!graph ...]]</div>`,
+> doesn't that have the same practical effect? --[[smcv]]
+
+> > It does! I didn't think of that, thanks! I am not used to plain HTML in wikis, and the [[plugins/contrib/osm]] plugin has "right" and "left" directives... --[[anarcat]]
diff --git a/doc/install.mdwn b/doc/install.mdwn
index 9c5d5939b..775769e88 100644
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -13,10 +13,13 @@ wrappers.
Ikiwiki requires the [[!cpan Text::Markdown::Discount]] (or
[[!cpan Text::Markdown]]), [[!cpan URI]],
-[[!cpan HTML::Parser]], [[!cpan HTML::Template]], and [[!cpan HTML::Scrubber]]
-perl modules be installed. It can also use a lot of other perl modules, if
+[[!cpan HTML::Parser]], [[!cpan HTML::Template]], [[!cpan YAML::XS]] and [[!cpan HTML::Scrubber]]
+perl modules be installed.
+It can also use a lot of other perl modules, if
they are available.
+In addition, Ikiwiki requires the 'gettext' package for internationalisation.
+
Various [[plugins]] use other perl modules and utilities; see their individual
documentation for details.
diff --git a/doc/plugins/contrib/getfield/discussion.mdwn b/doc/plugins/contrib/getfield/discussion.mdwn
index 5f7fffead..d3c1a1277 100644
--- a/doc/plugins/contrib/getfield/discussion.mdwn
+++ b/doc/plugins/contrib/getfield/discussion.mdwn
@@ -1,3 +1,21 @@
+## Multiple values arrays
+
+This breaks if there are multiple values for a single key. It works fine in the report plugin, but inline display shows the ARRAY reference, e.g.
+
+ IPv6:
+ - fd64:2c08:9fa7:4::1
+ - 2001:470:1d:4a6::1
+
+and:
+
+ {{$IPv6}}
+
+yields:
+
+ ARRAY(0x266db10)
+
+Seems to me this could be checked and `join(" ")`'d. :)
+
## Templating, and other uses
Like you mentioned in [[ftemplate]] IIRC, it'll only work on the same page. If it can be made to work anywhere, or from a specific place in the wiki - configurable, possibly - you'll have something very similar to mediawiki's templates. I can already think of a few uses for this combined with [[template]] ;) . --[[SR|users/simonraven]]
diff --git a/doc/plugins/contrib/syntax.mdwn b/doc/plugins/contrib/syntax.mdwn
index 5ca6311f9..da4213000 100644
--- a/doc/plugins/contrib/syntax.mdwn
+++ b/doc/plugins/contrib/syntax.mdwn
@@ -44,6 +44,8 @@ This plugin create the following CSS styles:
It can be downloaded from [here](http://taquiones.net/files/misc/) or through my personal debian repository at <http://taquiones.net/files/debian/>. There is a page with examples: <http://taquiones.net/software/syntax-examples.html>
+_**NOTE:** all the above links are broken_
+
Any help, comments or critics are welcome at <victor@taquiones.net>.
## version 0.9
diff --git a/doc/todo/allow_TMPL__95__LOOP_in_template_directives.mdwn b/doc/todo/allow_TMPL__95__LOOP_in_template_directives.mdwn
index 6d0bd0971..890c4cf4b 100644
--- a/doc/todo/allow_TMPL__95__LOOP_in_template_directives.mdwn
+++ b/doc/todo/allow_TMPL__95__LOOP_in_template_directives.mdwn
@@ -14,6 +14,20 @@ rather limited way.
> the form of a patch that is reviewable, not a gratuitous rewrite.
> --[[Joey]]
+>> Yes, my apologies for that. The two worker functions `mktmpl_hash`
+and `proc_tmpl_hash` are new. The `preprocess` function then starts
+by arranging the parameters into an array. This array is passed to the
+`mktmpl_hash` and it creates a hash, suitable for passing into the
+HTML::Template directly. The `proc_tmpl_hash` then walks the hash
+structure and processes the parameters.
+
+>> I know ... you weren't looking for an explanation, just a patch
+... totally understand. Point I'm trying to make, it's a 90% re-write
+anyway (and my `style(8)` will probably piss most people off).
+
+>> Anyway, would love to contribute so will try to get to doing this
+"correctly" and post as a patch.
+
I would, personally, only use this feature for very basic loops
and, although nested loops *might* be possible (with a little
more tinkering) it think any attempt would be better served by
diff --git a/doc/users/OscarMorante.mdwn b/doc/users/OscarMorante.mdwn
new file mode 100644
index 000000000..1e900f997
--- /dev/null
+++ b/doc/users/OscarMorante.mdwn
@@ -0,0 +1,2 @@
+Just testing the thing :)
+<oscar@morante.eu>