Documentation Support > Extensions > Edit
| Format: | (:zap edit="<Group>.<Name>#ID(<flag1,flag2>)":) |
Requirements to Use: ZAP | ZAP Toolbox
Explanation: This command allows you to do some powerful things! The suggestions below give a few tips on it's main features, but do not begin to list its potential applications. Think of it as combining the best of ZAP's former log function, PmWiki's edit action, the SectionEdit recipe, and FOX. Best of all, you can combine it with anything else in ZAP as well!
1) Editing pages If set to a page name, the contents of the page will be replaced by the content of field editbody. ie: a fully functional alternative to PmWiki's edit form. Normally this is set in a textarea as follows:
(:textarea name=editbody:){(source Group.Name)}
2) Editing sections If set to a page name with an anchor beginning with #ID, everything between that anchor and the next #ID anchor can be edited or replaced. Use the same #ID in the source markup. This is a nice substitute for the SectionEdit recipe.
3) Top/Bottom You can append the contents of editbody to the top or bottom of the page by simply putting top or bottom as a flag in the edit command. This allows you to create logs of various kinds. Basically--the equivalent of FOX's insertion capability.
4) Append/Prepend If you have the markup (:zap:) on the target page, you can add the flags append or prepend and new posts will be appended or prepended in relation to the zap marker. This allows you to position logs in various ways in various places. Again, much like FOX.
5) Self-deleting links To create a self-deleting log entry you must first define an id field in your form (normally set to timestamp, etc), and then in the editbody field include something like the following
editbody = "[[#ID{$$id}]] text {$$delete}"
You can override the default value by setting your own editdelete field. Other configurations of course are possible.
6) Sort/Trim Finally, you can sort either lines in a page, lines in a section, or even whole sections, and trim them to a specified number. Just put sort or trim=# as flags (with # equal to the max number of entries). If another flag follows trim, put a comma after the number.
ZAP's Page Shortcuts can be used in the edit field.
The edit command uses ZAP's templating system. Before using the editbody field, it looks for an edittemplate field, and then a template at Group.Page-template (relative to the current page of the form). If it finds either, it will use them and ignore the editbody field. Be sure to use the {$$field} syntax in the editbody command, just as you would in a template.
As a security feature, this command can ONLY be set using the (:zap field="value":) format.