Changeset 1248063

Timestamp:

09/18/2015 01:16:25 AM (10 years ago)

Author:

simon.ward

Message:

update trunk readme

File:

• pdf-creator-lite/trunk/readme.txt (modified) (2 diffs)

pdf-creator-lite/trunk/readme.txt

@@ -2 +2 @@
 Contributors: alexfurr, simon.ward
 Tags: academic, PDF
+License: GPLv2
 Requires at least: 3.0.1
-Tested up to: 4.0
-Stable tag: 1.1
+Tested up to: 4.3
+Stable tag: 1.2
 
-A light weight PDF convertor that turns the pages of your WP site into a customised PDF document. Currently, this only converts PAGES, not posts.
+Let visitors and admins create PDFs of your site content at the click of a button.
 
 == Description ==
 
-This tool was originally written as we need to convert an online handbook into a PDF for administrators. Currently this only converts PAGES (not posts) and you can only create PDFs if you are an administrator.
+PDF Creator Lite makes on-the-fly PDF documents of selected parts of your site. It has 2 main uses:
 
-**Features**
+**Use it on pages and posts so your readers can download PDFs:**
 
-*   Customise your PDF with fonts / background colours / link colours
-*   Add an optional table of contents / front page
-*   Add all of your site, or select specfic pages
-*   One click creation with preview
-*   uses tcpdf http://www.tcpdf.org/
+*Basic Use:*
+Just put the `[pdf-lite]` shortcode into your page or post and visitors can simply click a button to get a PDF document of that page.
 
+*More Control:*
+Use the shortcode parameters to choose specific pages, categories, or the entire site. Here's a few examples:
 
+Makes a PDF of all posts:
+`[pdf-lite allposts="true"]`
+
+Makes a PDF of all pages:
+`[pdf-lite allpages="true"]`
+
+Makes a PDF of selected pages/posts (use post ids or slugs):
+`[pdf-lite page="3, 28, my-post-slug"]`
+
+Makes a PDF of posts in the categories 'music' and 'food':
+`[pdf-lite cat="music, food"]`
+
+Changes the download icon:
+`[pdf-lite icon="3"]`
+
+See the full list of parameters on the settings page ( Dashboard->Tools->PDF Creator ).
+ 
+<br>
+**Use it as an admin tool to create customised PDFs of selected or all site pages (not posts):**
+
+- Customise the colours and fonts
+- Simple and easy to use
+
+Go to the settings page ( Dashboard->Tools->PDF Creator ) to make your PDF.
+
+<br>
 This plugin is supported by the <a href="http://cite.soton.ac.uk/">University of Southampton</a>
 
@@ -29 +55 @@
 2.  Activate the Plugin from Plugins page.
 
-== Frequently Asked Questions ==
-
-**Can this turn my posts into a PDF?**
-
-Not currently - it was built to handle pages e.g. an online handbook.
-
-**What options are there for my PDF**
-
-You can change the background colour, font colour, link colours, add an optional table of contents and front page
-
 
 == Screenshots ==
 
-1. PDF settings
-2. The converted PDF download page
+1. Format options
+2. Select which pages you want to convert
+3. The outputted file
 
 == Changelog ==
 
+= 1.2 = 
+* Added - Style options for shortcodes, the parameters are `font`, `fontcolor`, `linkcolor`, and `bgcolor`. `font` can be 'times', 'helvetica', or 'courier', and the colour options should be specified as hex values.
+
+= 1.1 = 
+* Fixed - A PDF Creation issue under certain conditions (this only affected users trying to make pdfs of quiz questions generated by Quiz-Tool-Lite). 
+
+= 1.0 =
+* Added - Frontend PDF downloads for site visitors, via the shortcode [pdf-lite]. The shortcode accepts various params to control the content in the pdf, see the settings page for a full list of options. 
+
 = 0.1 =
-* Initial release
+* Initial Release