Developer Docs

This document contains information about Nucleus that is only relevant to developers.

Developer Docs - Permalink

Table of Contents

  • XML-RPC interfaces
  • Nucleus Plugin API
  • Customized Install Scripts
  • Database Structure

Developer Docs - Permalink

Customized Install Scripts

This section contains information on how to customize the Nucleus install script. It can be customized in two ways:

  1. Automatically install skins
  2. Automatically install plugins

Note: this functionality is only available in versions > v2.2.

Developer Docs - Permalink

Configurations

Open up the install.php script and locate the following piece of code:

    // array with names of plugins to install. Plugin files must be present in the 
    // nucleus/plugin/ directory.
    //
    // example:
    //     array('NP_TrackBack', 'NP_MemberGoodies')
    $aConfPlugsToInstall = array();


    // array with skins to install. skins must be present under the skins/ directory with
    // a subdirectory having the same name that contains a skinbackup.xml file
    //
    // example:
    //     array('base','rsd')
    $aConfSkinsToImport = array();

This code is all you need to change: list the names of the plugins and skins you want to auto-install in the arrays.

Developer Docs - Permalink

Including the files

Next to changing the configuration, you'll need to add the files to the zipfile distribution.

Plugins

For plugins, place the files in the nucleus/plugins/ directory. Just as when you would install a plugin manually.

For skins, place them as directories under skins/, just as you would do when importing a skin manually. Don't forget to put the skinimport.xml file in there.

Developer Docs - Permalink

Don't forget

Don't forget to test your customized install script before distributing it.

Developer Docs - Permalink

Valid XHTML . © 2001 – 2012 by  The Nucleus Group . Running Nucleus CMS v3.64

gipoco.com is neither affiliated with the authors of this page nor responsible for its contents. This is a safe-cache copy of the original web site.