summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2012-08-04 12:13:19 +0200
committerJonas Smedegaard <dr@jones.dk>2012-08-04 12:13:19 +0200
commit0686e55e2a02a8e50cac8ac21a51d938a4cb0784 (patch)
tree0cc5cbcfd3e2a8fa6754e7bd8706f8a64e9f3e94
parent310150aea29904bc6a929ddcfbc191362ec19714 (diff)
Sync with ikiwiki 3.20120419.
-rw-r--r--ikiwiki/directive/graph.mdwn4
-rw-r--r--ikiwiki/directive/inline.mdwn13
-rw-r--r--ikiwiki/directive/meta.mdwn13
-rw-r--r--ikiwiki/directive/osm.mdwn69
-rw-r--r--ikiwiki/directive/trailitem.mdwn9
-rw-r--r--ikiwiki/directive/trailitems.mdwn25
-rw-r--r--ikiwiki/directive/traillink.mdwn16
-rw-r--r--ikiwiki/directive/trailoptions.mdwn18
-rw-r--r--ikiwiki/directive/waypoint.mdwn6
9 files changed, 165 insertions, 8 deletions
diff --git a/ikiwiki/directive/graph.mdwn b/ikiwiki/directive/graph.mdwn
index 8b066c2..7021e47 100644
--- a/ikiwiki/directive/graph.mdwn
+++ b/ikiwiki/directive/graph.mdwn
@@ -9,14 +9,14 @@ Nodes on the graph can link to external urls using regular graphviz syntax,
and a clickable imagemap will be created. As a special extension for
ikiwiki, [[WikiLinks|ikiwiki/wikilink]] can also be used. For example:
- \[[!graph src=""""
+ \[[!graph src="""
google [ href="http://google.com/" ]
sandbox [ href=\[[SandBox]] ]
help [ href=\[[ikiwiki/formatting]] ]
newpage [ href=\[[NewPage]] ]
google -> sandbox -> help -> newpage -> help -> google;
- """"]]
+ """]]
The `graph` directive supports the following parameters:
diff --git a/ikiwiki/directive/inline.mdwn b/ikiwiki/directive/inline.mdwn
index 22c18d9..a9c241a 100644
--- a/ikiwiki/directive/inline.mdwn
+++ b/ikiwiki/directive/inline.mdwn
@@ -113,9 +113,14 @@ Here are some less often needed parameters:
and/or `page/feed.rss`. This option is not supported if the wiki is
configured not to use `usedirs`.
* `pagenames` - If given instead of `pages`, this is interpreted as a
- space-separated list of links to pages (with the same
- [[SubPage/LinkingRules]] as in a [[ikiwiki/WikiLink]]), and they are inlined
- in exactly the order given: the `sort` and `pages` parameters cannot be used
- in conjunction with this one.
+ space-separated list of absolute page names ([[SubPage/LinkingRules]] are
+ not taken into account), and they are inlined in exactly the order given:
+ the `sort` and `pages` parameters cannot be used in conjunction with
+ this one.
+* `trail` - If set to "yes" and the [[!iki plugins/trail desc=trail]] plugin
+ is enabled, turn the inlined pages into a trail with next/previous links,
+ by passing the same options to [[ikiwiki/directive/trailitems]]. The `skip`
+ and `show` options are ignored by the trail, so the next/previous links
+ traverse through all matching pages.
[[!meta robots="noindex, follow"]]
diff --git a/ikiwiki/directive/meta.mdwn b/ikiwiki/directive/meta.mdwn
index 72cfc6f..984f685 100644
--- a/ikiwiki/directive/meta.mdwn
+++ b/ikiwiki/directive/meta.mdwn
@@ -59,6 +59,15 @@ Supported fields:
Specifies a short description for the page. This will be put in
the html header, and can also be displayed by eg, the [[map]] directive.
+* keywords
+
+ Specifies keywords summarizing the contents of the page. This
+ information will be put in the html header. Only letters,
+ numbers, spaces and commas are allowed in this string; other
+ characters are stripped. Note that the majority of search
+ engines, including Google, do not use information from the
+ keywords header.
+
* permalink
Specifies a permanent link to the page, if different than the page
@@ -133,8 +142,8 @@ Supported fields:
\[[!meta redir=otherpage]]
- Optionally, a delay (in seconds) can be specified. The default is to
- redirect without delay.
+ The default is to redirect without delay.
+ Optionally, a delay (in seconds) can be specified: "delay=10"
It can also be used to redirect to an external url. For example:
diff --git a/ikiwiki/directive/osm.mdwn b/ikiwiki/directive/osm.mdwn
new file mode 100644
index 0000000..6807a81
--- /dev/null
+++ b/ikiwiki/directive/osm.mdwn
@@ -0,0 +1,69 @@
+The `osm` directive is supplied by the [[!iki plugins/osm desc=osm]] plugin.
+
+This directive inserts an OpenStreetMap map onto a page.
+It is typically combined with the [[waypoint]] directive
+to add points to the map.
+
+## examples
+
+ \[[!osm]]
+ \[[!waypoint lat="45°30N" lon="73°40W" name="My city" tag="city"]]
+
+The osm directive will display the actual map, while the waypoint
+directive adds waypoints to the map.
+
+The above can also be shortened as:
+
+ \[[!waypoint lat="45°30N" lon="73°40W" name="My city" tag="city" embed]]
+
+The tag is also taken from the tags elsewhere in the page, so the
+above is equivalent to:
+
+ \[[!waypoint lat="45°30N" lon="73°40W" name="My city" embed]]
+ \[[!tag city]]
+
+The icon is also taken from the tag if attached to the tag page as
+icon.png (default, modifiable)..
+
+## map display
+
+ * `map` - map to display, defaults to "map"
+ * `zoom` - the level to zoom to on the OSM map
+ * `loc` - lattitude and longitude of the map center
+ * `lat` - lattitude
+ * `lon` - longitude
+ * `editable` - add edit controls in a separate layer
+ * `right` - float the map right
+ * `left` - float the map left (default)
+ * `width` - width of the map
+ * `height` - height of the map
+
+## waypoints
+
+Waypoints can be added to any page. By default the waypoint takes the
+name of the page, which allows you to easily tag pages and make them
+appear on the central map.
+
+Waypoints, by default, show up as a image (the `icon` parameter) link
+to the main map (or the `map` parameter provided). That markup can be
+hidden with the `hidden` parameter.
+
+ * `name` - the name of this point, defaults to the page name (!) must
+ be unique, otherwise later incantation will overwrite previous
+ ones.
+ * `map` - the map to add the point to (defaults to "map")
+ * `desc` - description to embed in the map
+ * `loc` - lattitude and longitude
+ * `lat` - lattitude
+ * `lon` - longitude
+ * `tag` - the type of points, maps to an icon in the osm_types array
+ * `hidden` - do not display the link to the map (will not affect `embed`)
+ * `icon` - URL to the icon to show in the link to the map and within
+ the map
+ * `embed` - embed the map display alongside the point, in which case
+ the regular arguments to the map display can be used
+
+## Links
+
+If two pages with waypoints have a link between them, that link will
+magically show up on the map. Now how awesome is that?
diff --git a/ikiwiki/directive/trailitem.mdwn b/ikiwiki/directive/trailitem.mdwn
new file mode 100644
index 0000000..59626b5
--- /dev/null
+++ b/ikiwiki/directive/trailitem.mdwn
@@ -0,0 +1,9 @@
+The `trailitem` directive is supplied by the
+[[!iki plugins/trail desc=trail]] plugin. It is used like this:
+
+ \[[!trailitem some_other_page]]
+
+to add `some_other_page` to the trail represented by this page, without
+generating a visible hyperlink.
+
+[[!meta robots="noindex, follow"]]
diff --git a/ikiwiki/directive/trailitems.mdwn b/ikiwiki/directive/trailitems.mdwn
new file mode 100644
index 0000000..387b403
--- /dev/null
+++ b/ikiwiki/directive/trailitems.mdwn
@@ -0,0 +1,25 @@
+The `trailitems` directive is supplied by the
+[[!iki plugins/trail desc=trail]] plugin. It adds pages
+to the trail represented by the current page, without producing any output
+on that page.
+
+ \[[!trailitems pages="posts/*" sort="age"]]
+
+ \[[!trailitems pagenames="a b c"]]
+
+Options are similar to [[!iki ikiwiki/directive/inline desc=inline]]:
+
+* `pages`: adds pages that match a [[ikiwiki/PageSpec]] to the trail
+ (cannot be used with `pagenames`)
+
+* `pagenames`: if used instead of `pages`, this is interpreted as a
+ space-separated list of absolute page names
+ ([[SubPage/LinkingRules]] are not taken into account)
+ to add to the trail
+
+* `sort`: add the pages matched by `pages` to the trail in this
+ [[ikiwiki/pagespec/sorting]] order (cannot be used with `pagenames`)
+
+* `reverse`: reverse the order of `sort` (cannot be used with `pagenames`)
+
+[[!meta robots="noindex, follow"]]
diff --git a/ikiwiki/directive/traillink.mdwn b/ikiwiki/directive/traillink.mdwn
new file mode 100644
index 0000000..090e253
--- /dev/null
+++ b/ikiwiki/directive/traillink.mdwn
@@ -0,0 +1,16 @@
+The `traillink` directive is supplied by the
+[[!iki plugins/trail desc=trail]]
+plugin. It generates a visible [[ikiwiki/WikiLink]], and also adds the
+linked page to the trail represented by the page containing the directive.
+
+In its simplest form, the first parameter is like the content of a WikiLink:
+
+ \[[!traillink some_other_page]]
+
+The displayed text can also be overridden, either with a `|` symbol or with
+a `text` parameter:
+
+ \[[!traillink Click_here_to_start_the_trail|some_other_page]]
+ \[[!traillink some_other_page text="Click here to start the trail"]]
+
+[[!meta robots="noindex, follow"]]
diff --git a/ikiwiki/directive/trailoptions.mdwn b/ikiwiki/directive/trailoptions.mdwn
new file mode 100644
index 0000000..d83f444
--- /dev/null
+++ b/ikiwiki/directive/trailoptions.mdwn
@@ -0,0 +1,18 @@
+The `trailoptions` directive is supplied by the
+[[!iki plugins/trail desc=trail]] plugin. It sets options for the
+trail represented by this page.
+
+ \[[!trailoptions sort="meta(title)" circular="no"]]
+
+Options available:
+
+* `sort`: sets a [[ikiwiki/pagespec/sorting]] order for the entire trail,
+ overriding the order in which they were added
+
+* `reverse`: reverses the order of the trail
+
+* `circular`: if set to `yes` or `1`, the trail is made into a loop by
+ making the last page's "next" link point to the first page, and the first
+ page's "previous" link point to the last page
+
+[[!meta robots="noindex, follow"]]
diff --git a/ikiwiki/directive/waypoint.mdwn b/ikiwiki/directive/waypoint.mdwn
new file mode 100644
index 0000000..e301f85
--- /dev/null
+++ b/ikiwiki/directive/waypoint.mdwn
@@ -0,0 +1,6 @@
+The `waypoint` directive is supplied by the [[!iki plugins/osm desc=osm]] plugin.
+
+This directive adds a waypoint ot an OpenStreetMap map displayed
+by the [[osm]] directive. See the [[osm]] directive for examples
+and options.
+