Skip to content

Commit

Permalink
Expanding the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dougalcampbell committed Sep 9, 2012
1 parent dce4fdb commit 1331eed
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions readme.txt
Expand Up @@ -2,10 +2,10 @@

Contributors: dougal
Donate link: http://dougal.gunters.org/donate
Tags:
Tags: documents, shortcode, shortcode-only, files, attachments, pdf, word, excel, spreadsheet, text
License: GPL2
Requires at least: 2.5
Tested up to: 3.0
Tested up to: 3.4
Stable tag: 1.0


Expand All @@ -14,7 +14,7 @@ Stable tag: 1.0
By adding a simple [documents] shortcode in your post or page, you get a
list of all documents (non-image/audio/video) attached. Each item in the
document list can be styled with CSS to indicate different document types
(e.g., .doc, .pdf, etc).
based on file extension (e.g., .doc, .pdf, etc).

== Installation ==

Expand All @@ -23,13 +23,18 @@ directory, then activate the plugin.

== Frequently Asked Questions ==

= Where is the settings page? =

There is no settings page. Just upload attachments to a post or page, and put
the [documents] shortcode where you wish the list of attachments to appear.

= How can I limit which attachments are listed? =

There are two attributes you can use with the shortcode to control which
attached documents are listed: `mimetype` and `ext`.

The default mimetype match is for mimetype "application/*". For other types,
you will need to specifically override that attribute.
The default match is for mimetype "application/*". For other types, you will
need to specifically override that attribute.

Examples:

Expand All @@ -45,6 +50,14 @@ Examples:
Just application/pdf mimetypes:
[documents mimetype="application/pdf"]

= I got an error trying to upload a file! =

If WordPress tells you that a file failed to upload due to an error ("Sorry, this file type is not permitted for security reasons."), you may need to adjust the list of allowed file extensions. For one way to do this, see:

http://wordpress.org/extend/plugins/ap-extended-mime-types/
http://wordpress.org/extend/plugins/manage-upload-types/
http://www.wprecipes.com/wordpress-tip-allow-upload-of-more-file-types


== Changelog ==
= 1.0 =
Expand Down

0 comments on commit 1331eed

Please sign in to comment.