Plugin Directory

Changeset 2687312


Ignore:
Timestamp:
03/02/2022 08:43:15 AM (4 years ago)
Author:
shorthandconnect
Message:

Updated Install Docs

Location:
shorthand-connect
Files:
14 added
4 edited

Legend:

Unmodified
Added
Removed
  • shorthand-connect/trunk/README.txt

    r2602717 r2687312  
    44Tags: shorthand, api
    55Requires at least: 4
    6 Tested up to: 5.8.1
    7 Stable tag: 1.3.9
     6Tested up to: 5.9.1
     7Stable tag: 1.3.10
    88License: GPLv2 or later
    99License URI: http://www.gnu.org/licenses/gpl-2.0.html
     
    1717== Installation ==
    1818
    19 1a. Install the search for the plugin and install it within wp-admin:
    20 1b. Or, Upload `shorthand_connect` to the `/wp-content/plugins/` directory
    21 2. Activate the plugin through the 'Plugins' menu in WordPress
    22 3. Add your credentials:
    23 V1 - Go to Settings > Shorthand and enter in your user ID and API Key (get these from your account page in the Shorthand editor).
    24 v2 - Go to your organisation in the top right, and click the cog to get to settings.  Scroll to the bottom, and generate a new key.  Go to Settings > Shorthand and enter in your Token.
     191. Install the search for the plugin and install it within wp-admin.
     20  - Or alternately upload `shorthand_connect` to the `/wp-content/plugins/` directory.
     212. Activate the plugin through the 'Plugins' menu in WordPress.
     223. Go to Settings -> Shorthand to add your Shorthand API Token retrieved in the next step.
     233. Get your API token from Shorthand.com: (Only Admin/Owners will have access to generate API Tokens)
     24  - Open the workspace settings; either by clicking your organisation name from the dashboard OR from the top right menu when editing a story.
     25  - Under the sub-heading API Tokens generate either a Team Token or Workspace Token.
     26     - A Team Token only has access to published/prepared stories under the associated team.
     27     - A Workspace Token has access to all published/prepared stories.
    25284. Optionally change the CSS settings in the options to best present stories within your theme.
    26295. Optionally your theme can override the display of Shorthand stories via `single-shorthand_story.php` in your theme directory.
     
    3437
    3538== Changelog ==
     39
     40= 1.3.10 =
     41* Updated Installation instructions (Documentation only)
    3642
    3743= 1.3.9 =
     
    134140 - In your wp-config.php file, add `define('FS_CHMOD_DIR', 0777 )`;
    135141 - Contact [email protected] and [email protected] for further support and feedback
     142 - Some WP Plugins can aggressively cache or control how content is displayed at the theme-level; check page templates to ensure nothing is conflicting.
  • shorthand-connect/trunk/config.default.php

    r2483930 r2687312  
    11<?php
    22
    3 $serverURL = 'https://app.shorthand.com';
     3$serverURL = 'https://api.shorthand.com';
    44$serverv2URL = 'https://api.shorthand.com';
    55$allowversionswitch = true;
  • shorthand-connect/trunk/includes/api-v2.php

    r2602709 r2687312  
    66    global $serverv2URL;
    77    $token = get_option('sh_v2_token');
    8 
     8   
    99    if (!$token) {
    1010        return false;
  • shorthand-connect/trunk/includes/shorthand_options.php

    r2009514 r2687312  
    7070    if ($sh_css == '') {
    7171        $no_css = true;
    72         update_option('sh_css', $default_site_css);
     72        if(isset($default_site_css)){
     73            update_option('sh_css', $default_site_css);
     74        }
    7375        $sh_css = $default_sh_site_css;
    7476    }
     
    105107            <td><input type="text" id="sh_v2_token" name="sh_v2_token" value="<?php echo esc_attr($v2_token); ?>" size="28"></td>
    106108        </tr>
    107         <?php if($showServerURL || $serverURL != "https://app.shorthand.com") { ?>
    108         <tr class="v1row">
    109             <th scope="row"><?php _e("Service v1 URL" ); ?></th>
    110             <td><input type="text" disabled value="<?php echo esc_attr($serverURL); ?>" size="28"></td>
    111         </tr>
    112         <?php } ?>
    113         <?php if($showServerURL || $serverv2URL != "https://api.shorthand.com") { ?>
    114         <tr class="v2row">
    115             <th scope="row v1row"><?php _e("Service v2 URL" ); ?></th>
    116             <td><input type="text" disabled value="<?php echo esc_attr($serverv2URL); ?>" size="28"></td>
    117         </tr>
    118         <?php } ?>
    119109        </tbody></table>
    120110        <p class="submit">
Note: See TracChangeset for help on using the changeset viewer.