WordPress.org
Get WordPress

Plugin Directory

Changeset 707471


Ignore:
Timestamp:
05/03/2013 02:25:23 PM (13 years ago)
Author:
Wolfram Research
Message:

updating readme.txt for 2.0 version

File:
1 edited

Legend:

Unmodified
Added
Removed

  • wolfram-cdf-plugin/trunk/readme.txt

    r707464 r707471  
    55Requires at least: 2.8.2
    66Tested up to: 3.3.1
    7 Stable tag: 1.2
     7Stable tag: 2.0
    88
    99The Wolfram CDF Plugin is a simple robust plugin that allows users to place CDF Documents on their WordPress Blogs.
    … …  
    1111== Description ==
    1212
    13 The Wolfram CDF Plugin adds a CDF Player button to the WordPress HTML post editor. 
     13The Wolfram CDF Plugin adds a CDF button to the WordPress HTML and visual post editors.
    1414
    15 To use this plug-in, open up a post you wish to edit, choose the html tab on the editor click.  Then, click on in
    16 the editor where you want the plugin to be and press the cdf button.  Upon doing so placeholder text will appear in
    17 the place you have selected.
     15To use this plugin, open up a post you wish to edit. Click in the editor where you want the CDF content to be displayed and click the CDF button. Placeholder text will appear in the place of your selection.
    1816
    19 This text will appear as:
     17The placeholder will appear as:
     18[WolframCDF source="" width="320" height="415" altimage="" altimagewidth="" altimageheight=""]
    2019
    21 [WolframCDF source="file" CDFwidth="w" CDFheight="h" altimage="file"]
     20After editing the placeholder, click the Publish/Update post button or the Preview button to view the content, in order to confirm that the placeholder was parsed and replaced by the CDF. While some attributes must be set in order for your CDF to appear on the page, others are optional:
     21   
     221. source
     23Required: Yes
     24Input type(s): file name with extension, url
     25Description: 'source' holds the CDF file name or the url where the file is located. To enter just the file's name, you must first add the file to WordPress using the file uploader.
     26   
     272. width
     28Required: Yes
     29Input type(s): integer
     30Description: 'width' holds an integer that describes the width in pixels of the CDF on your WordPress blog.
     31   
     323. height
     33Required: Yes
     34Input type(s): integer
     35Description: 'height' holds an integer that describes the height in pixels of the CDF on your WordPress blog.
     36   
     374. altimage
     38Required: No
     39Input type(s): file name with extension, url
     40Description: 'altimage' stores an image that will be displayed if the client does not have the CDF plugin installed. If left blank, a generic placeholder will appear.
     41   
     425. altimagewidth
     43Required: No
     44Input type(s): integer
     45Description: 'altimagewidth' holds an integer that describes the width in pixels of the alternate image, which may be different than the width of the CDF itself.
    2246
    23 [WolframCDF ] marks the text which gets parced and replaced witht he cdf.
     476. altimageheight
     48Required: No
     49Input type(s): integer
     50Description: 'altimageheight' holds an integer that describes the height in pixels of the alternate image, which may be different than the width of the CDF itself.
    2451
    25 The are several attributes which must be set in order for your plug-in to appear on thepage successfully.
     52When using Mathematica 9.0.1 (or higher), you can use the CDF Deployment Wizard (http://www.wolfram.com/cdf/adopting-cdf/deploying-cdf/) to generate your individual CDF files and alt images. The generated alt image includes an overlaid CDF Player logo, and when a user clicks on the image, they are taken to the download site for the CDF plugin. Once installed, the alt image disappears and the interactive CDF content is displayed.
    2653
    27 1. Source:
    28 Required: Yes
    29 Input type(s): file name with extension, url
    30 Description: Source holds the CDF file name or the url where the file is located.  If you wish to enter just the file's name,
    31 you must first upload the file to wordpress using the fileuploader. 
    32 
    33 2. CDFwidth:
    34 Required: Yes
    35 Input type(s): integer
    36 Description: CDFwidth holds an integer number that describes the width in pixels of the CDF file you wish to show on your
    37 WordPress blog.
    38 
    39 3. CDFheight:
    40 Required: yes
    41 Input type(s): integer
    42 Description: CDFheight holds an integer number that describes the height in pixels of the CDF file you wish to show on your
    43 WordPress blog.
    44 
    45 4. altimage:
    46 Required: no
    47 Input type(s): file name with extension, url
    48 Description: altimage stores an image which will be displayed if the client has not installed the CDF plugin.  If left
    49 blank a default image will appear.  This attribute is over ridden by altcont.
    50 
    51 5. altcont:
    52 Required: no
    53 Input type(s): plain text, html
    54 Description: altcont stores text or html which will be displayed if the client has not installed the CDF plugin.  If left
    55 blank a default image is appear.
    56 
    57 Once the place holder text has been entered and the attributes have been filled out press the Publish/Update post button
    58 or the Preview button to view the content.
    5954
    6055== Installation ==
    … …  
    8883For information on this topic please visit http://www.wolfram.com/cdf/adopting-cdf/deploying-cdf/web-delivery.html
    8984
     85= Do I have to use the altimage fields? =
     86No. If you do not fill in an altimage, a gray box will appear with a link to download the CDF plugin.
     87
     88= Why is my altimage resized? How can I stop this from happening? =
     89If nothing is given for the altimageheight and altimagewidth fields, the image will appear at the size of the CDF itself. When you enter values for altimageheight and altimagecontent, the image will take on those dimensions.
     90
     91
    9092== Screenshots ==
    9193
    … …  
    9496
    9597== Changelog ==
     98
     99= 2.0 =
     100* Removed altcont support, as it was not really used and was not as flexible as it could be.
     101* Streamlined the altimage functionality as well as added optional parameters (altimagewidth, altimageheight) to size the image independently of the CDF
     102* Added a quick tag button to the visual editor
     103* Removed the use of a template file to make the plugin more system I/O efficient
     104
    96105
    97106= 1.2 =
    … …  
    108117== Upgrade Notice ==
    109118
    110 = 1.2 =
     119= 2.0 =
    111120Version 1.2 allows you to add CDF Documents to you WordPress Blog
Note: See TracChangeset for help on using the changeset viewer.