Wiki updated for version 2.0 of the blogging application.

1 files changed, 25 insertions, 0 deletions

diff --git a/Arguments.md b/Arguments.md
new file mode 100644
index 0000000..da26303
--- /dev/null
+++ b/Arguments.md
@@ -0,0 +1,25 @@
+This document explains how to use the optional field for arguments in the content editor. This field can contain a list of arguments as key or key/value pairs formatted as follows: `FOO=value|BAR=value` (or `FOO=value|BAR`; `BAR` will be automatically set to `TRUE`).
+
+## How to access arguments in a template
+Lets assume that your argument string for a specific post is something like this: `HIGHLIGHT|PREVIEW_IMG=foobar.png`. You can now access the entire (unparsed) argument string in templates by `$POST['ATTR']['ARGV']` (see template documentation for further information). This contains the unparsed argument string as he was written in the content editor. You also can access an parsed version of the arguments as key->value array with `$POST['ARGV']`:
+
+### Unparsed: `$POST['ATTR']['ARGV']`:
+	string(32) "HIGHLIGHT|PREVIEW_IMG=foobar.png"
+
+### Parsed: `$POST['ARGV']`
+	array(2) {
+		["HIGHLIGHT"]=>
+		bool(true)
+		["PREVIEW_IMG"]=>
+		string(10) "foobar.png"
+	}
+
+## How this arguments can be used to do something special
+If you are a template developer, you can check in your templates if the argument `HIGHLIGHT` is present (arguments with no explicit value will be automatically set to `TRUE`). If true, you can highlight this post differently (if you have some "promo posts" or something: just check if this value is set and add an extra CSS class to your HTML markup which then will highlight your post). You even can add an preview image functionality. What if you want to show an preview image for each post in the list? There is no core functionality to do this, but with the argument functionality you can do this very simple:
+
+	<?php if(isset($POST['ARGV']['PREVIEW_IMG'])): ?>
+		<img class="preview-img" href="<?=Application::getFileURL("images/preview/{$POST['ARGV']['PREVIEW_IMG']}")?>" alt="" />
+	<?php endif; ?>
+
+## Conclusion
+The use cases of the arguments are practically unlimited. Please note that the `standard` template does not use any arguments provided in the argument field. It is up to you whether you implement this in your own template to do something special or not!
\ No newline at end of file