aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/write.mdwn
diff options
context:
space:
mode:
authorsmcv <smcv@web>2014-09-23 03:54:53 -0400
committeradmin <admin@branchable.com>2014-09-23 03:54:53 -0400
commit15e8445c448302a16e4175374c43c4cdc058e503 (patch)
tree7b7b70fd1c9bd0e496e710260249eb21b21df598 /doc/plugins/write.mdwn
parentbefbcddbef1ea4f13937fce0c45012ca3907027e (diff)
downloadikiwiki-15e8445c448302a16e4175374c43c4cdc058e503.tar
ikiwiki-15e8445c448302a16e4175374c43c4cdc058e503.tar.gz
fix destsources documentation, and mention how attachments appear
Diffstat (limited to 'doc/plugins/write.mdwn')
-rw-r--r--doc/plugins/write.mdwn15
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 15f054c09..c3f531b66 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -742,17 +742,24 @@ The `%pagesources` has can be used to look up the source filename
of a page. So the key is the page name, and the value is the source
filename. Do not modify this hash.
+Attachments also appear in this hash, with the same key and value.
+
$pagesources{"foo"} = "foo.mdwn";
+ $pagesources{"logo/ikiwiki.png"} = "logo/ikiwiki.png";
+
### `%destsources`
The `%destsources` hash records the name of the source file used to
create each destination file. The key is the output filename (ie,
-"foo/index.html"), and the value is the source filename that it was built
-from (eg, "foo.mdwn"). Note that a single source file may create multiple
+"foo/index.html"), and the value is the name of the page that it was built
+from (eg, "foo"). Note that a single source file may create multiple
destination files. Do not modify this hash directly; call `will_render()`.
-
- $destsources{"foo/index.html"} = "foo.mdwn";
+
+Attachments also appear in this hash, with the same key and value.
+
+ $destsources{"foo/index.html"} = "foo";
+ $destsources{"logo/ikiwiki.png"} = "logo/ikiwiki.png";
## Library functions