Photos
Blog
Projects
vanrenterghem.biz
projects
/
git.ikiwiki.info.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge remote branch 'smcv/ready/transient-recentchanges'
[git.ikiwiki.info.git]
/
doc
/
ikiwiki
/
directive
/
meta.mdwn
diff --git
a/doc/ikiwiki/directive/meta.mdwn
b/doc/ikiwiki/directive/meta.mdwn
index f29a118bfea91d9957c30022312e558bc3b8b980..d66e26fc4e493574a9158f57a49b504beba07021 100644
(file)
--- a/
doc/ikiwiki/directive/meta.mdwn
+++ b/
doc/ikiwiki/directive/meta.mdwn
@@
-7,7
+7,8
@@
Enter the metadata as follows:
\[[!meta field="value" param="value" param="value"]]
The first form sets a given field to a given value, while the second form
\[[!meta field="value" param="value" param="value"]]
The first form sets a given field to a given value, while the second form
-also specifies some additional sub-parameters.
+also specifies some additional sub-parameters. You can have only one field
+per `meta` directive, use more directives if you want to specify more fields.
The field values are treated as HTML entity-escaped text, so you can include
a quote in the text by writing `"` and so on.
The field values are treated as HTML entity-escaped text, so you can include
a quote in the text by writing `"` and so on.
@@
-23,6
+24,13
@@
Supported fields:
be set to a true value in the template; this can be used to format things
differently in this case.
be set to a true value in the template; this can be used to format things
differently in this case.
+ An optional `sortas` parameter will be used preferentially when
+ [[ikiwiki/pagespec/sorting]] by `meta(title)`:
+
+ \[[!meta title="The Beatles" sortas="Beatles, The"]]
+
+ \[[!meta title="David Bowie" sortas="Bowie, David"]]
+
* license
Specifies a license for the page, for example, "GPL". Can contain
* license
Specifies a license for the page, for example, "GPL". Can contain
@@
-37,14
+45,19
@@
Supported fields:
Specifies the author of a page.
Specifies the author of a page.
+ An optional `sortas` parameter will be used preferentially when
+ [[ikiwiki/pagespec/sorting]] by `meta(author)`:
+
+ \[[!meta author="Joey Hess" sortas="Hess, Joey"]]
+
* authorurl
Specifies an url for the author of a page.
* description
* authorurl
Specifies an url for the author of a page.
* description
- Specifies a
"description" of the page. You could use this to provide
-
a summary, for example, to be picked up by
the [[map]] directive.
+ 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.
* permalink
* permalink
@@
-68,13
+81,18
@@
Supported fields:
* openid
Adds html <link> tags to perform OpenID delegation to an external
* openid
Adds html <link> tags to perform OpenID delegation to an external
- OpenID server (for `openid` and `openid2`). An optional `xrds-location`
+ OpenID server. This lets you use an ikiwiki page as your OpenID.
+
+ By default this will delegate for both `openid` and `openid2`. To only
+ delegate for one, add a parameter such as `delegate=openid`.
+
+ An optional `xrds-location`
parameter lets you specify the location of any [eXtensible Resource
DescriptorS](http://www.windley.com/archives/2007/05/using_xrds.shtml).
parameter lets you specify the location of any [eXtensible Resource
DescriptorS](http://www.windley.com/archives/2007/05/using_xrds.shtml).
-
This lets you use an ikiwiki page as your OpenID.
Example:
+ Example:
- \
\
[[!meta openid="http://joeyh.myopenid.com/"
+ \[[!meta openid="http://joeyh.myopenid.com/"
server="http://www.myopenid.com/server"
xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]]
server="http://www.myopenid.com/server"
xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]]