Plugin: LMURLParts

Helper plugin that keep track of URL parts.

General plugin info
Author:Leo
Current version:1.1.2
Download:NP_LMURLParts_v112.zip
Support: Plugin comments or forum thread
Compability:Nucleus CMS 3.50

Plugin overview

The NP_LMURLParts plugin is a helper plugin that keep track of URL parts. It is used by several LM-plugins to handle URL parts. An URL part is a string that is used as a part of an URL, and is unique for a blog or globally on a Nucleus site.

The main purpose for this plugin is to provide unique URL parts for the Fancier URL scheme and Compact URL scheme in the NP_LMFancierURL plugin. Other plugins that want to utilize the NP_FancierURL plugin for parsing and generating URLs can register it's URL parts with this plugin.

The plugin must be installed before any plugin that is dependant on it.

Installation

  • Upload the NP_LMURLParts.php file and the lmurlparts directory from the zip file to the Nucleus CMS plugins directory (nucleus/plugins) on your web server.
  • Go to the Plugins page in the admin area. You should be able to select the plugin in the dropdown list under the "Install New Plugin" section and press the "Install Plugin" button.

Upgrade

  • Take a backup of the current plugin files. You will need these if you want to rollback to the previous version after the upgrade.
  • Take a backup of the database used for you Nucleus installation.
  • Replace the old plugin files with the new ones by uploading the NP_LMURLParts.php file and the lmurlparts directory from the zip file to the Nucleus CMS plugins directory (nucleus/plugins) on your web server. Do not uninstall the plugin.
  • Go to the Plugins page in the admin area and press the "Update subscription list" button.
  • If a plugin data upgrade is needed, will an upgrade plugin data option be available on the NP_LMURLParts plugin admin page. Choose this option to upgrade the plugin data.
  • After the plugin data upgrade has been performed may a rollback option and a commit option be available on the NP_LMURLParts plugin admin page. Not all upgrades support the rollback and commit option.
  • If you are not pleased with the new version of the plugin you may use the rollback option to rollback the plugin data upgrade. After the rollback of the plugin data upgrade you have to replace the new plugin files with the old plugin files.
  • If you are pleased with the new version of the plugin you should use the commit option to commit the plugin data upgrade. After the commit of the plugin data upgrade will any rollback and commit options disappear.

Configuration

The NP_LMURLParts plugin has the following options on the global level:

  • Delete NP_LMURLParts data tables on uninstall? - Choose if all data should be deleted when the plugin is uninstalled.
  • Choose encoding - Choose which encoding that should be used when making text URL friendly.
    • AUTO - Use the encoding defined by the language used. This is the default value.
    • ISO-8859-1 - Use ISO-8859-1 encoding.
    • UTF-8 - Use UTF-8 encoding.
    • ASCII - Use ASCII encoding.

Usage

The URL parts and keywords are administered from the plugin admin page which can be accessed from either the quick menu in the admin area, or from the admin link for the plugin in the plugin list. A user can edit the parts and keywords for the blogs he is admin for. The blog super admin can edit global parts and keywords and the parts and keywords for all blogs.

In the admin area for the NP_LMURLParts plugin you first choose which blog you want to edit URL parts for. If you are the admin of a single blog you will autmatically choose this blog for editing URL parts. It you are a super admin you will also be able to choose to edit top level URL parts.

You will get a list of URL part types to choose from. After you have choosen which URL part type you want to edit you get a list of the defined URL parts for that type. This list will show the names used in your blog for the items, categorys, archives and special skinparts and the currently defined name to use in URLs to identify these.

The following operations can be used on an URL part:

  • Edit - Edit the URL part. When you change a URL part manually will it also be locked. The URL part must be URL friendly and contain only lowercase 7-bit letters (a-z), numbers (0-9) and the minus character. Multipart URL parts can also include / characters, and must start with a / character.
  • Lock - Locks the URL part so any updates to the names of an item, category, archive or special skinparts won't change the URL part that identifies it.
  • UnLock - Unlocks the URL part so any updates to the names of an item, category, archive or special skinparts will update the URL part that identifies it.

For blogs and global URL parts you can also choose to edit URL part keywords.

Support and Bug reports

For additional support and/or bug reports please use the Nucleus forum plugin announce thread or the plugin page comment section.

Compability

This version of the NP_LMURLParts is tested against version 3.64 of Nucleus CMS. Minimum version of Nucleus CMS needed for using the plugin is 3.50.

Version History

  • v1.0.0 2011-06-27: by Leo (http://www.slightlysome.net)
    • Initial version released with NP_LMFancierURL v2.0
  • v1.0.1 2011-08-06: by Leo (http://www.slightlysome.net)
    • Super admin could not choose to edit top level parts if the site only had one blog.
    • New error message when the edited urlpart is a valid number (not a legal urlpart).
    • Released with NP_LMFancierURL v2.0.1
  • v1.1.0 2011-08-27: by Leo (http://www.slightlysome.net)
    • The plugin is now released separately from NP_LMFancerURL.
    • Handling multipart urlparts. Multipart urlparts can contain "/", otherwise the same rules as the normal urlparts.
    • Implemented my suggested plugin data upgrade handling. The plugin does the upgrade handling by itself, and is not dependent of any core changes or other handling plugins.
    • Should now handle missing mbstring PHP extension which gave the blank page on the LMFancierURL installation for some.
    • Implemented my suggested AdminPluginNotification event in the plugin. Used AdminPrePageFoot event to trigger the AdminPluginNotification event. Will show the notification on the bottom of the admin pages instead on the top as suggested. Used for notification on upgrade handling status and missing mbstring PHP extension.
    • Plugin help is now available for all who have access to plugin admin page.
    • Missing blog level change link on admin page when only one blog on blogsite.
    • Made the plugin admin page styling more similar to the admin area default styling.
  • v1.1.1 2012-06-23: by Leo (http://www.slightlysome.net)
    • Minor changes to support a new version of NP_LMFanicerURL.
  • v1.1.2 2013-05-20: by Leo (http://www.slightlysome.net)
    • Changes for PHP 5.4.
    • Fixed bug when making string url friendly when the first character is a 8 bit character.
    • Removed the need for mbstring PHP extension. Uses encoding defined for the current language.

Download

Download NP_LMURLParts v1.1.2. The latest version of the NP_LMURLParts plugin can be downloaded from the NP_LMURLParts plugin page.


Add Comment

Spam and off topic comments will be deleted.

Allowed BBCode:[b] [i] [u] [s] [color=] [size=] [quote] [code] [email] [url]