Permalink
Browse files

Convert README.md to GitHub-flavor

  • Loading branch information...
dougalcampbell committed Sep 11, 2012
1 parent 19c936b commit 42c7f599c9f59e274e1d0cb0370c522c516d5bef
Showing with 13 additions and 13 deletions.
  1. +13 −13 README.md
View
@@ -1,4 +1,4 @@
-=== Documents Shortcode ===
+# Documents Shortcode
Contributors: dougal
Donate link: http://dougal.gunters.org/donate
Tags: documents, shortcode, documents shortcode, shortcode-only, files, attachments, pdf, word, excel, spreadsheet, text
@@ -10,14 +10,14 @@ License URI: http://www.gnu.org/licenses/gpl-2.0.html
A `[documents]` shortcode which will display a list of attached files, with file type icons, and linked to the files for easy downloading.
-== Description ==
+## Description
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
based on file extension (e.g., .doc, .pdf, etc).
-== Installation ==
+## Installation
Copy the documents-shortcode folder and its contents to your wp-content/plugins
directory, then activate the plugin. Or better yet, use the built-in `Add New`
@@ -26,14 +26,14 @@ feature under your Dashboard's `Plugins` menu.
There is no configuration. Just type the `[documents]` shortcode into your
posts or pages to generate a list of attached files.
-== Frequently Asked Questions ==
+## Frequently Asked Questions
-= Where is the settings page? =
+### 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? =
+### 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`.
@@ -58,7 +58,7 @@ Examples:
All attached documents, regardless of type:
`[documents mimetype="*"]`
-= I got an error trying to upload a file! =
+### 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
@@ -69,7 +69,7 @@ this, see:
http://wordpress.org/extend/plugins/manage-upload-types/
http://www.wprecipes.com/wordpress-tip-allow-upload-of-more-file-types
-= How do I change the styling? =
+### How do I change the styling?
See the `dc_documents.css` file for the default styles. Document icons are in
the `images` sub-folder of the plugin.
@@ -80,15 +80,15 @@ posts with a rule similar to this:
`.post ul.dc_documents li a { font-family: Courier,monospace; }`
-= Why don't my attached images appear in the documents list? =
+### Why don't my attached images appear in the documents list?
By default, images are filtered out of the list (because, that's what
galleries are for, right?). If you want to list *all* attached documents,
with no filtering, just say so:
`[documents mimetype="*"]`
-= What file types are supported? =
+### What file types are supported?
*Technically*, any file type that WordPress will allow you to upload as an
attachment (see above). More specifically, there are icons included for the
@@ -107,11 +107,11 @@ list is slanted towards Microsoft applications, but that's just due to the
original plugin usage. Other extension => icon mappings will be added in the
future, and I am open to suggestions.
-= Can you make the icon bigger/smaller? =
+### Can you make the icon bigger/smaller?
At this time, the only supported icon size is 32 x 32 pixels.
-== Changelog ==
-= 1.0 =
+## Changelog
+### 1.0
* Initial release. 2012-09-10

0 comments on commit 42c7f59

Please sign in to comment.