urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/doc/plugins/meta.mdwn

60 lines
1.8 KiB
Plaintext
Raw Normal View History

no longer need triple quotes
2006-08-23 22:27:18 +02:00
[[template id=plugin name=meta included=1 author="[[Joey]]"]]
* Allow preprocessor directives to contain python-like triple-quoted text blocks, for easy nesting of quotes inside. * Add a template plugin. * Use the template plugin to add infoboxes to each plugin page listing basic info about the plugin.
2006-08-23 07:41:07 +02:00
[[tag type/meta]]
* Reorganised the doc wiki's todo/* pages, using a link/tag to flag * Allow pagetemplate plugins to override *anything* in the template. * Add a meta plugin, which allows specifying various metadata about pages, like license and author. It also allows for inserting html link and meta tags into html, overriding the title, and adding hidden WikiLinks, which can be useful when using link-based globbing for page categorisation. * Remove preprocessor directives from inlined pages. * Allow simple preprocessor directive values to be specified w/o quotes.
2006-06-02 06:49:12 +02:00
This plugin allows inserting arbitrary metadata into the source of a page.
Enter the metadata as follows:
don't need double-escape on indented literal text as markdown doesn't mess with it
2006-07-28 02:33:57 +02:00
\[[meta field="value"]]
\[[meta field="value" param="value" param="value"]]
* Reorganised the doc wiki's todo/* pages, using a link/tag to flag * Allow pagetemplate plugins to override *anything* in the template. * Add a meta plugin, which allows specifying various metadata about pages, like license and author. It also allows for inserting html link and meta tags into html, overriding the title, and adding hidden WikiLinks, which can be useful when using link-based globbing for page categorisation. * Remove preprocessor directives from inlined pages. * Allow simple preprocessor directive values to be specified w/o quotes.
2006-06-02 06:49:12 +02:00
The first form sets a given field to a given value, while the second form
also specifies some additional sub-parameters.
You can use any field names you like, but here are some predefined ones:
* link
Specifies a link to another page. This is used to generate a html
<link> tag, and also as a way to make the wiki treat one page as
linking to another without displaying a user-visible link. The latter
can be useful when using links to categorise pages. A html link tag
would look like this:
don't need double-escape on indented literal text as markdown doesn't mess with it
2006-07-28 02:33:57 +02:00
\[[meta link="foo.css" rel="stylesheet" type="text/css"]]
* Reorganised the doc wiki's todo/* pages, using a link/tag to flag * Allow pagetemplate plugins to override *anything* in the template. * Add a meta plugin, which allows specifying various metadata about pages, like license and author. It also allows for inserting html link and meta tags into html, overriding the title, and adding hidden WikiLinks, which can be useful when using link-based globbing for page categorisation. * Remove preprocessor directives from inlined pages. * Allow simple preprocessor directive values to be specified w/o quotes.
2006-06-02 06:49:12 +02:00
A non-user-visible [[WikiLink]] would instead look like this:
don't need double-escape on indented literal text as markdown doesn't mess with it
2006-07-28 02:33:57 +02:00
\[[meta link=otherpage]]
* Reorganised the doc wiki's todo/* pages, using a link/tag to flag * Allow pagetemplate plugins to override *anything* in the template. * Add a meta plugin, which allows specifying various metadata about pages, like license and author. It also allows for inserting html link and meta tags into html, overriding the title, and adding hidden WikiLinks, which can be useful when using link-based globbing for page categorisation. * Remove preprocessor directives from inlined pages. * Allow simple preprocessor directive values to be specified w/o quotes.
2006-06-02 06:49:12 +02:00
* title
Overrides the title of the page, which is generally the same as the
page name.
* If the meta plugin overides the page title, set a title_overridden variable in the template to true. This allows doing things with the templates conditional on the title being overriden.
2006-08-12 19:51:32 +02:00
Note that if the title is overrideen, a "title_overridden" variable will
be set to a true value in the template; this can be used to format things
differently in this case.
* Reorganised the doc wiki's todo/* pages, using a link/tag to flag * Allow pagetemplate plugins to override *anything* in the template. * Add a meta plugin, which allows specifying various metadata about pages, like license and author. It also allows for inserting html link and meta tags into html, overriding the title, and adding hidden WikiLinks, which can be useful when using link-based globbing for page categorisation. * Remove preprocessor directives from inlined pages. * Allow simple preprocessor directive values to be specified w/o quotes.
2006-06-02 06:49:12 +02:00
* license
Specifies a copyright license for the page, for example, "GPL".
* author
Specifies the author of a page.
* Make aggregator save permalinks and author name to pages as metadata. * Add permalink and author support to meta plugin, affecting RSS feeds and blog pages. * Change titlepage() to encode utf-8 alnum characters. This is necessary to avoid UTF-8 creeping into filenames in urls. (There are still some other ways that it can get in.)
2006-08-04 02:01:51 +02:00
* permalink
web commit by JonasSmedegaard: Correct typo: perminent -> permanent.
2006-08-14 22:44:19 +02:00
Specifies a permanent link to the page, if different than the page
* Also generate rel=bookmark links for permalinks.
2006-08-04 06:29:18 +02:00
generated by ikiwiki.
* Make aggregator save permalinks and author name to pages as metadata. * Add permalink and author support to meta plugin, affecting RSS feeds and blog pages. * Change titlepage() to encode utf-8 alnum characters. This is necessary to avoid UTF-8 creeping into filenames in urls. (There are still some other ways that it can get in.)
2006-08-04 02:01:51 +02:00
* Reorganised the doc wiki's todo/* pages, using a link/tag to flag * Allow pagetemplate plugins to override *anything* in the template. * Add a meta plugin, which allows specifying various metadata about pages, like license and author. It also allows for inserting html link and meta tags into html, overriding the title, and adding hidden WikiLinks, which can be useful when using link-based globbing for page categorisation. * Remove preprocessor directives from inlined pages. * Allow simple preprocessor directive values to be specified w/o quotes.
2006-06-02 06:49:12 +02:00
If the field is not treated specially (as the link and title fields are),
the metadata will be written to the generated html page as a <meta>
header.
* Patch from Enrico that - allows preprocessor directives to have parameters with no specified value - fixes preprocessor directive parameter parsing so that foo=bar baz now means "foo=bar" and a "baz" with no value - Add a tag plugin that allows more easily tagging pages. The meta plugin can also still be used for this.
2006-07-27 23:38:02 +02:00
* Change meta tags to use html entity-escaped text for values, so that quotes and such can be represented in title tags. * Depend and build-depend on HTML::Parser for HTML::Entities which is used for the above. * Make --rebuild also cause --aggregate to re-download and write aggregated pages. * Avoid outputting duplicate meta info. * Include title metadata on aggregated posts for capitalised and un-munged titles.
2006-07-31 00:58:48 +02:00
The field value is treated as HTML entity-escaped text, so you can include
a quote in the text by writing `"` and so on.
* Allow preprocessor directives to contain python-like triple-quoted text blocks, for easy nesting of quotes inside. * Add a template plugin. * Use the template plugin to add infoboxes to each plugin page listing basic info about the plugin.
2006-08-23 07:41:07 +02:00
If this plugin is enabled, the title of this page will say that it is.
* Patch from Enrico that - allows preprocessor directives to have parameters with no specified value - fixes preprocessor directive parameter parsing so that foo=bar baz now means "foo=bar" and a "baz" with no value - Add a tag plugin that allows more easily tagging pages. The meta plugin can also still be used for this.
2006-07-27 23:38:02 +02:00
[[meta title="meta plugin (enabled)"]]