The ScreenSteps Online Knowledge Base Everything you need to know about ScreenSteps
Blue mango logo white 250
  • Table of Contents
  • Contact Us
ScreenSteps Documentation » API Examples » A quick note about WordPress permalinks

Topics

  • WordPress 5
    • What do I need to have to get started?
    • A quick note about WordPress permalinks
    • How do I install the ScreenSteps Live plugin?
    • How do I configure the ScreenSteps Live plugin?
    • How do I view content?
  • HTML and Javascript Widgets 1
    • Adding a ScreenSteps Live Search widget to your site
  • FogBugz Widgets 1
    • Adding a ScreenSteps Live widget to FogBugz
  • iFrame - Search From Any Web Page 1
    • Inserting a ScreenSteps Live iframe into a web page
  • Reference Lessons 4
    • Create an API Access user in ScreenSteps Live
    • Finding Your Space ID or Permalink
    • How to create a Zendesk CSS Widget
    • How to convert your old Zendesk template to the 2011 template

Quicklinks

  • Downloads
  • View forums
  • Submit a help request
  • Contact us
  • Retrieve a lost license key

Last Updated

Sep 23, 2011

Download Manual PDF

Other Resources

  • ScreenSteps Desktop & Workgroup

  • ScreenSteps 2.9
  • ScreenSteps Workgroup
  • Customizing HTML Templates
  • ScreenSteps: Tips & Tricks
  • Creating Word Templates
  • Publishing to Blogs & Wikis
  • ScreenSteps Live

  • ScreenSteps Live
  • Setting up a New Admin, Editor or Author on ScreenSteps Live
  • ScreenSteps Live Support Client
  • Integrating ScreenSteps Live With Other Services
  • Collaborating on ScreenSteps Live
  • ScreenSteps Live Remote Authentication
  • ScreenSteps Live API
  • API Examples
  • Implementation Guides

  • Creating a Software Manual With ScreenSteps
  • Creating a ScreenSteps Live Support Site
  • Zendesk and ScreenSteps Live
  • Help Scout and ScreenSteps Live
  • FAQs

  • FAQs

Comments

4 comments for this lesson

  • Prev: What do I need to have to get started?
  • Next: How do I install the ScreenSteps Live plugin?

A quick note about WordPress permalinks

WordPress allows you to configure the format of the permalink to posts in your blog. If you have configured your permalink so that it starts with a string rather than an integer then the ScreenSteps Live plugin will not work properly.

The ScreenSteps Live plugin generates URLs that don't actually exist and then parses the url to determine which manual or lesson to display. When using a permalink that starts with a string WordPress generates a 404 error before the ScreenSteps Live plugin gets a chance to parse the url.

In addition, WordPress advises people NOT to use permalinks that start with strings for performance reasons. For more information review the page located at http://codex.wordpress.org/Using_Permalinks. As of February 20, 2010 that page reads in part: "For performance reasons, it is not a good idea to start your permalink structure with the category, tag, author, or postname fields."

Example of a Bad Permalink

Example_of_a_bad_permalink_display

This is a bad example of a permalink. %postname% is a string and will cause performance issues with WordPress and will break the ScreenSteps Live plugin.

Example of a Good Permalink

Example_of_a_good_permalink_display

This is a good example of a permalink. %year% is an integer and will work just fine.

  • Prev: What do I need to have to get started?
  • Next: How do I install the ScreenSteps Live plugin?

Comments (4)

Kevin Gilbert Wednesday Nov 16 at 04:53 AM

In the soon-to-be released WordPress 3.3 there is significant changes to the handling of permalinks and the rewrite engine. How will that affect the plugin? Are you guys altering the plugin to take advantage of the improvements or will the plugin see benefits regardless. Thanks.

Trevor DeVore Wednesday Nov 16 at 04:55 AM

@Kevin: We are not aware of what changes are being made in WordPress 3.3 so I can't really say. If the update breaks the plugin then we can take a look at what is necessary to fix it.

Kevin Gilbert Wednesday Nov 16 at 05:05 AM

Take a look at the proposed changes in the "Internal: Performance Improvements" section on http://wpdevel.wordpress.com/2011/07/27/wordpress-3-3-proposed-scope/

They are removing the performance issues associated with using /%postname%/ as the permalink structure, making it not only the desired structure, but also eliminating any performance hits as a result. Will you guys rework the plugin so that we can use this structure without having to use a numeric prefix?

Trevor DeVore Wednesday Nov 16 at 05:08 AM

If WordPress doesn't display a 404 error before our plugin is able to process the request then everything should "just work". If WordPress continues to generate 404 error messages then I don't know that there is anything we can do about it.

Add your comment

E-Mail me when someone replies to this comment
Blue Mango Learning Systems © 2012