Changeset 1244467

Timestamp:

09/13/2015 11:28:03 AM (10 years ago)

Author:

C. E.

Message:

Bug fix

Location:

mathematica-toolbox

Files:

• tags/1.0.1/README.txt (modified) (1 diff)
• trunk/README.txt (modified) (3 diffs)
• trunk/public/Mathematica-WP-Toolbox-public.php (modified) (2 diffs)

mathematica-toolbox/tags/1.0.1/README.txt

@@ -22 +22 @@
 
 The highlighting feature can be triggered in two ways. In the editor `[wlcode]Wolfram Language code here[/wlcode]` can be used to place a code block directly into the text, however it is often desirable to put the code elsewhere and refer to it instead of putting it into the text itself. This is achieved by the shortcode `[wlcode field="name"]` where `name` refers to a custom post field that holds the code that should be inserted at that point. You may have to go to "screen options" at the top of the editor page to enable custom post fields before you can see the custom post field form.
+
+To write code as a part of a sentence, that is, inline, you can use the shortcode `[wlinline]code[/wlinline]`. This will wrap the code with the `<code>` tag and thus (in many themes) distinguish the code visually.
 
 **Embed Wolfram technologies**

mathematica-toolbox/trunk/README.txt

@@ -17 +17 @@
 **Syntax highlighting and formatting**
 
-* Uses the same highlighting script that is used on Mathematica.StackExchange.com and on Wolfram Community.
+* Uses the same highlighting script that is used on [Mathematica.StackExchange.com](http://mathematica.stackexchange.com) and on [Wolfram Community](http://community.wolfram.com).
 * Preserves code indentation and prevents WordPress from inserting `<br>` and `<p>` into code.
 * Replaces Wolfram Language character codes such as `\[Alpha]`, `\[Gamma]` etc. with their corresponding characters.
 
 The highlighting feature can be triggered in two ways. In the editor `[wlcode]Wolfram Language code here[/wlcode]` can be used to place a code block directly into the text, however it is often desirable to put the code elsewhere and refer to it instead of putting it into the text itself. This is achieved by the shortcode `[wlcode field="name"]` where `name` refers to a custom post field that holds the code that should be inserted at that point. You may have to go to "screen options" at the top of the editor page to enable custom post fields before you can see the custom post field form.
+
+To write code as a part of a sentence, that is, inline, you can use the shortcode `[wlinline]code[/wlinline]`. This will wrap the code with the `<code>` tag and thus (in many themes) distinguish the code visually.
 
 **Embed Wolfram technologies**
@@ -30 +32 @@
 * Display a link to the documentation of a Wolfram Language function.
 
-The [official plugin](https://wordpress.org/plugins/wolfram-cdf-plugin/) from Wolfram Research that embeds CDFs [does not work](http://mathematica.stackexchange.com/q/66311/731) since WordPress 4.0.1. The shortcode in this plugin takes exactly the same arguments, so the instructions for that plugin are still valid. There is a button beneath the text editor in the post admin area that inserts a template that is straightforward to fill out. You can upload the CDF and its backup image, which you get if you use the CDF export wizard in Mathematica, via the media uploader. Remember to take note of the dimension that the export wizard tells you that the CDF has, because you will need it later.
+The [official plugin](https://wordpress.org/plugins/wolfram-cdf-plugin/) from Wolfram Research that embeds CDFs [does not work](http://mathematica.stackexchange.com/q/66311/731) since WordPress 4.0.1. The shortcode in this plugin takes exactly the same arguments, so the instructions for that plugin are still valid and migration is painless. 
 
-When you create an "instant API" in the Wolfram Cloud using `CloudDeploy` and `APIFunction` Mathematica gives you a URL. `[WolframCloudAPI id=""]` accepts the ID part of that URL as a parameter and will output the API's return value. Any other parameters will be passed on to the API. By default `[WolframCloudAPI]` assumes that the return value of the API is an image. If it is data you should add `image="false"` as a parameter.
+The shortcode is `[WolframCDF source="" width="" height="" altimage="" altimagewidth="" altimageheight=""]`, and the parameters and the alternative image (that is shown to those that don't have the CDF player) can be retrieve from the export wizard in Mathematica. The CDF file and the image can be uploaded to WordPress' media library. `source` and `altimage` refer to the URLs of these two files.
+
+The Wolfram Language functions `CloudDeploy` and `APIFunction` can be used to deploy so called *instant APIs*. The url to an instant API includes an ID number that identifies that particular API. `[WolframCloudAPI id=""]` can be used to display the result of calling the API if it is an image, and `[WolframCloudAPI id="" image="false"]` if it isn't. Any extra parameters that the API needs can also be passed along There are two working examples for this feature under FAQ.
 
 The shortcode `[wldoc]function[/wldoc]` generates a link to the online documentation page of `function`.
@@ -38 +42 @@
 **Retrieve posts from Mathematica.StackExchange.com**
 
-`[mma_se_questions ids="11350;3345;3646"]` retrieves the questions with the given IDs. Note that the IDs are separated by semicolons. Answers can be retrieved similarly by `[mma_se_answers ids="25616;259"]`. The display format in each case is an unordered list.
+The shortcode `[mma_se_questions ids="11350;3345;3646"]` retrieves the questions with the given IDs. Note that the IDs are separated by semicolons. Answers can be retrieved similarly by `[mma_se_answers ids="25616;259"]`. The display format in each case is an unordered list.
 
 **Retrieve profile information from Mathematica.StackExchange.com**
 
-`[mma_se_user user_id="731"]` displays a link to the Mathematica.StackExchange user profile of user 731. The link text is the user's name. `[mma_se_user user_id="731" link="false"]` displays the name without turning it into a link.
+The shortcode `[mma_se_user user_id="731"]` displays a link to the Mathematica.StackExchange user profile of user 731. The link text is the user's name. `[mma_se_user user_id="731" link="false"]` displays the name without turning it into a link.
 
-`[mma_se_profile_box user_id="731"]` displays a box with basic facts about user 731. Please see the screenshots page for a better understanding of what the result is.
+The shortcode `[mma_se_profile_box user_id="731"]` displays a box with basic facts about user 731. Please see the screenshots page for a better understanding of what the result is.
 
-`[mma_se_user_questions user_id="731"]` and `[mma_se_user_answers user_id="731"]` displays lists of questions and answers respectively written by user 731. This shortcode is a direct interface between WordPress and the Stack Exchange API: any parameter in API can be added to the shortcode. For example `[mma_se_user_questions user_id="731" pagesize="5" sort="votes"]` returns the five questions asked by user 731 that have the most votes. You can see the full set of parameters in the [documentation](http://api.stackexchange.com/docs/answers-by-ids) for the Stack Exchange API.
+The shortcode `[mma_se_user_questions user_id="731"]` and `[mma_se_user_answers user_id="731"]` displays lists of questions and answers respectively written by user 731. This shortcode is a direct interface between WordPress and the Stack Exchange API: any parameter in the API can be added to the shortcode. For example `[mma_se_user_questions user_id="731" pagesize="5" sort="votes"]` returns the five questions asked by user 731 that have the most votes. The full set of parameters is in the [documentation](http://api.stackexchange.com/docs/answers-by-ids) for the Stack Exchange API.
 
 **Caching of results**
-Note that queries sent to the Stack Exchange API are cached in the background, so for example `[mma_se_user user_id="731"]` will only look that user up once a week at most, because a week is the default expiration time of the cache. It's good to let the cache expire because sometimes users change their names. However if you want you can add the `expiration` parameter to any of the `mma_se_*` calls and specify the expiration time in seconds.
+Note that queries sent to the Stack Exchange API are cached in the background, so for example `[mma_se_user user_id="731"]` will only look that user up once a week at most, because a week is the default expiration time of the cache. It's good to let the cache expire because sometimes users change their names. All `mma_se_` shortcodes accept a parameter called `expiration` that can be used to specify the expiration time in seconds.
 
 **Credits**

mathematica-toolbox/trunk/public/Mathematica-WP-Toolbox-public.php

@@ -436 +436 @@
           */
           add_shortcode( 'WolframCloudAPI', function( $parameters, $content = '' ) {
-              
-              $parameters = shortcode_atts(array(
-                'id' => '',
-                'image' => true
-              ), $parameters);
-              
-              $parameters['image'] = ($parameters['image'] === "false" || !$parameters['image']) ? false : true;
-              
-              if( $parameters['image'] ) {
-                return "<img src='https://www.wolframcloud.com/objects/{$parameters['id']}'>";
-              }
-
-              if( $parameters['id'] == '' ) {
-                  return;
+
+              if( !isset($parameters['image']) ) {
+                  $parameters['image'] = true;
+              }
+              if( $parameters['image'] === "false" || !$parameters['image'] ) {
+                  $parameters['image'] = false;
+              }
+              else {
+                  $parameters['image'] = true;
               }
               
               $query = "https://www.wolframcloud.com/objects/{$parameters['id']}?";
+              
+              if( !isset($parameters['id']) || $parameters['id'] == '' ) {
+                  return 'The ID parameters is required.';
+              }
               
               foreach( $parameters as $parameter => $value ) {
                   
-                  if( $parameter == 'id' ) {
+                  if( $parameter == 'id' || $parameter == 'image' ) {
                       continue;
                   }
@@ -465 +464 @@
               
               $query = trim( $query, '&' );
+              
+              if( $parameters['image'] ) {
+                return "<img src='$query'>";
+              }
               
               $response = wp_remote_get( $query );