Documentation

Light-weight, fast, simple and powerful!
 
Translations of this page?:

Introduction

The update_url feature allows a plugin developer to specify a url to an xml file containing information about the latest version of his/her plugin.

Important note - Please be aware that early versions of Wolf CMS will keep using the format originally specified for Frog CMS. However, no official schema describing the correct & valid usage of the format has ever been formulated.

Before version 1.0 of Wolf CMS, we will create a full schema which describes all the valid entries in a plugin updates xml file.

How to activate it

In your plugin’s index.php file, make sure you have an entry like:

'update_url'  => 'http://www.wolfcms.org/plugin-versions.xml'

The location or name of the xml file are your choice as long as you make sure the link is valid and unlikely to change in the future.

Note: it is best to choose your location and name wisely. If you change the url in a later version of your plugin, all current users of the plugin will no longer be notified about any updates.

XML file structure

The xml file you point to with the update_url entry should be well-formed and conform to the example structure below. As you may notice, you can add multiple plugin entries in the same file:

<?xml version="1.0" encoding="iso-8859-1"?>
<wolf-plugins>
    <wolf-plugin>
        <id>archive</id>
        <version>1.0.0</version>
        <status>stable</status>
    </wolf-plugin>
    <wolf-plugin>
        <id>comment</id>
        <version>1.1.0</version>
        <status>stable</status>
    </wolf-plugin>
</wolf-plugins>

Important notes about this file structure

  1. The “status” entry is currently unused but this may change in the future.
  2. There is no formal XML Schema (yet) for this file. A formal schema will be defined before the release of Wolf CMS version 1.0.
 
the_update_url_feature.txt · Last modified: 2011-09-12 00:46 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license:GNU Free Documentation License 1.2
Copyright 2010 wolfcms.org / design by yello studio / Wolf CMS Inside