X-Git-Url: http://git.alex.org.uk diff --git a/README b/README index f35f6d8..e9a53a7 100644 --- a/README +++ b/README @@ -60,6 +60,12 @@ page. For instance, if you wished to make a page redirect to download to the value 'myfile'. You will need to enable this module once you have installed it. +You should set the following meta keys: + download_file - the tag of the file (see above) + download_url - the base URL of the perl script, e.g + http://server.example.com/download/download.pl + download_error - if set, redirects to this page if a user is not set + Note, to avoid having to muck around with Wordpress, myfile could be a symlink, and the script will correctly name the downloaded file as per the target of the symlink. @@ -89,4 +95,17 @@ Usually this will do You will need to do your own log rotation. +You can include information about each download by using a shortcode: + +[ambdownloadinfo url='URL' file='FILENAME' dp='DECIMALPLACES']FORMAT[/ambdownloadinfo] + +FORMAT is like printf, but + $NAME represents the name of the file (per the target above) + $SIZE represents its size + $MD5SUM represents its md5sum (if expandedfile.md5sum exists) + $FSIZE represents the size written in a friendly manner + +Example usage (to be entered in the HTML editor) + The file is [ambdownloadinfo url='http://www.example.com/download' file='default']named $NAME has an + md5sum of $MD5SUM and is roughly $FSIZE in size[/ambdownloadinfo]