modx CMS

Instructions

Installing
----------

1. Download the snippet zip file from the MODx Repository.

2. Extract the snippet zip file and place it as a folder called "kalender" in
your "/assets/snippets/" folder on your server.

3. You will find the following files and folders extracted:

=> readme.txt
=> kalender_screenshots.gif
=> kalender_snippet.php
=> kalender_snippet_copy_this.php
=> themes
=> gold
=> images
=> (images - *.gif files)
=> theme.css
=> theme.php
=> js
=> (overLib Javascript library - *.js files)

4. Create a new snippet called "Kalender" at the MODx Manager
(Resources=>Manager Resources=>Snippets=>New snippet)

5. Copy and paste everything from the file "kalender_snippet_copy_this.php"
as Snippet code and "Save".


Embedding Kalender into your template
-------------------------------------

To display the calendar to your website template, just use this snippet call:



Where parent=1257 points to the document id number where Kalender data resides.

MODx content documents that are stored as 'children' of $parent will feed Kalender.


Managing Kalender data using the MODx manager
---------------------------------------------

1) Only documents that are not a folder (isfolder=0) that is placed either directly
as a 'child-document' or any level below $parent will be reflected in the
Kalender.

2) Use 'pub_date' to mark your event in the Kalender.

3) You may also use 'unpub_date' for events that will last more than 1 day long.

4) Use "00:00:00" (midnight) to leave time notations blank.

5) When modifying the theme, take note that all CSS classes located in "theme.css"
as well as PHP variables located in "theme.php" MUST remain in-tact.

* New themes may be created by simply copying all elements in the default 'gold'
theme folder and pasting it as a new folder with a new theme name of your
choice.

More on Themes
--------------

By default, we have the 'gold' theme available for you.

But if you wish to create your own theme, just create a new folder in the "themes"
directory and copy EVERYTHING from the default 'gold' folder.

You are free to change the values, dimensions, etc of the theme files.
But it is IMPORTANT that you retain all file names, css classes and php
variables intact.

Example:

If I wanted to create an "aqua" theme my file structure would look like:

=> themes
=> gold
=> images
=> (images - *.gif files)
=> theme.css
=> theme.php
=> aqua
=> images
=> (images - *.gif files)
=> theme.css
=> theme.php

And my snippet call would look like this:




Snippet Parameters Explained
----------------------------

$theme string 'gold' : Color theme (should be same name as theme folder).

$parent int -1 : MODx document/folder id where calendar documents are stored.

$mm int current month : Month without leading zeros. Defaults to current month
when blank.

$yyyy int current year : Year. Defaults to current year when blank.