Blog | Roadmap | Browse Source | View Tickets | Register | Trac Login | Forgot Password?

Setting up an ICE repository

What is an ICE repository?

An ICE repository is a Subversion repository with some additional directories.

The first one is used to tell ICE how the folders within the repository are to be structured, this is known as the site folder (.site). This is done using site.py in the site folder, (built-in for version 2.0, but can be overwritten).

The second folder is the skin folder (.skin), this folder contains the XHTML templates, CSS and other common media used format the HTML render. A default skin is built-in for version 2.0 and can be customized.

The third is the templates (templates documents), the files are used for creating new document in ICE.

ICE repository files and folders:

Creating an ICE repository

For more detailed information about Subversion repositories see the Subversion website at http://subversion.tigris.org.

Using Subversion create a repository by typing the following in the command line within the directory you wish to create the Subversion database, (this is where the files will be checkout from):

svnadmin create $repository-name

You will then need to checkout the repository so you can add files for example:

To checkout a repository over the network:

svn co file://$full-path/$repository-name $name

To check a repository via a HTTP request:

svn co http://$domain/svn/$repository-name $name

ICE repository config URL

An ICE config URL is a special URL that tells ICE what the settings are for the given repository, for example:

http://localhost:8000/edit-config?
url=https://ice.usq.edu.au/svn/ice/trunk/sample-content
&name=ice-sample 

The base URL is http://localhost:8000?edit-config you add the given parameters as specified in the table below.

Parameter

Description

Default value

url

The SVN location of the repository folder that contains the .site and .skin folders

n/a

name

Folder name of the content to checkout the content into.

Ending folder name of the url eg http://..../sample is sample

path

The path is the location where you want the content checkout to on your system.

~ (Tilde) can be used to use the users home directory, e.g. ~/ICE/sample-content

Windows
c:/ice/$name

Mac
/Users/$username/$name

Linux
/home/$username/$name

template-path

The directory where the templates are located relative to the path

/templates

export-path

Where the content is exported, and is an absolute path.

~ (Tilde) can be used to use the users home directory, e.g. ~/ICE/sanmple-content/exports

Windows
c:/ice/$export-path

Mac
/Users/$username/$export-path

Linux
/home/$username/$export-path

* $username The username used to log onto the operating system

previous up next