This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation.

Difference between revisions of "CMS"

From Group-Office Groupware and CRM Documentation
Jump to: navigation, search
(→‎Functions)
 
(22 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
Then you must add the following rewrite rule to your VirtualHost section:
 
Then you must add the following rewrite rule to your VirtualHost section:
  
−
RewriteEngine On<br />
+
<pre>
−
RewriteBase /modules/cms/<br />
+
<VirtualHost *:80>
−
RewriteRule ^(.*)$ run.php?site_id=<The Site ID here>&path=$1&basehref=/<br />
+
ServerName yourdomain.com
 +
ServerAlias www.yourdomain.com
 +
DocumentRoot /var/www/yourdomain.com
 +
<Directory /var/www/yourdomain.com>
 +
RewriteEngine On
 +
RewriteBase /groupoffice/modules/cms/
 +
 
 +
#allow robots.txt
 +
RewriteRule ^robots\.txt$ - [L]
 +
RewriteRule ^(.*)$ run.php?site_id=<The Site ID here>&path=$1&basehref=/&%{QUERY_STRING}
 +
</Directory>
 +
<Directory /var/www/yourdomain.com/groupoffice>
 +
RewriteEngine Off
 +
</Directory>
 +
</VirtualHost>
 +
</pre>
 +
 
 +
The rewrite base might be different in your environment. Here Group-Office is located in /groupoffice and the website runs at the top level.
 +
 
 +
If Group-Office already runs at the top level this setup won't work. In that case you create a dummy location:
  
 +
/var/www/yourdomain.com
  
−
The rewrite base might be different in your environment. Here Group-Office is located in the DocumentRoot.
+
In that folder you must create a symlink called "groupoffice" that points to Group-Office. You also create a copy of the config.php file and put it in /var/www/yourdomain.com.
 +
Make sure that the original config.php file is not located in the Group-Office source directory otherwise it will always use that config.php file. Group-Office searches trough each parent directory for the config.php file, in /etc/groupoffice and in /etc/groupoffice/yourdomain.com
  
  
Line 38: Line 59:
  
 
.id = id of the file<br />
 
.id = id of the file<br />
 +
.type = type of the folder defined in config.xml<br />
 
.folder_id = id of the file's folder<br />
 
.folder_id = id of the file's folder<br />
 
.extension = file extension<br />
 
.extension = file extension<br />
Line 51: Line 73:
 
'''$folder'''<br />
 
'''$folder'''<br />
 
.id = of the folder<br />
 
.id = of the folder<br />
 +
.type = type of the file defined in config.xml<br />
 
.parent_id = parent folder id<br />
 
.parent_id = parent folder id<br />
 
.ctime = Unix timestamp of the creation time of the folder<br />
 
.ctime = Unix timestamp of the creation time of the folder<br />
Line 62: Line 85:
 
To get a list of items from a folder you can use the following command:
 
To get a list of items from a folder you can use the following command:
  
−
{items}<br />
+
==={items}===
 
This function has the following parameters. They are all optional<br />
 
This function has the following parameters. They are all optional<br />
 
$root_path = Path to the parent folder of the items to list<br />
 
$root_path = Path to the parent folder of the items to list<br />
Line 72: Line 95:
  
 
$expand_levels = Defaults to 0 if you set a value it will expand into a treeview when a folder is clicked.<br />
 
$expand_levels = Defaults to 0 if you set a value it will expand into a treeview when a folder is clicked.<br />
 +
$expand_all = true or false to expand all levels. Defaults to only expand the selected folder.
 +
$no_folder_links = Only useful with expand_all=true. Folders will be rendered as div tags.
 
$class = Pass a class name to the items.<br />
 
$class = Pass a class name to the items.<br />
  
Line 77: Line 102:
 
$active_item_template = Use a sub template file for the active item<br />
 
$active_item_template = Use a sub template file for the active item<br />
 
$max_items = The maximum items to list.<br />
 
$max_items = The maximum items to list.<br />
 +
$wrap_div = true or false to put a &lt;div class=&quot;&quot;&gt;&lt;/div&gt; around each level
 +
$random=Show random items. Useful together with max_items
 +
$reverse=Sort in reverse order
 +
$no_folder_links=Don't make links to folders
 +
$start=Start at offset
 +
$level_template=Smarty template to use for each level of the tree
 
<br />
 
<br />
  
−
===Variables==
+
'''Variables'''
 +
 
 
When you use item_template and active_item_template you can use the following variable in the templates:
 
When you use item_template and active_item_template you can use the following variable in the templates:
  
 
'''$item'''<br />
 
'''$item'''<br />
−
.type = type of the item (folder or file)<br />
+
.type = type of the file or folder defined in config.xml
 +
.folder_id = id of the file's folder (file only)
 +
.parent_id = id of the folders' parent (folder only)
 +
.extension = file extension
 +
.size = filesize
 +
.ctime = Unix timestamp of the creation time of the file
 +
.mtime = Unix timestamp of the modification time of the file
 +
.name = Name of the file
 +
.content = Contents of the file
 +
.title = Meta title of the file
 +
.description = Meta description of the file
 +
.keywords = Meta keywords of the file
 
.name = name of the item<br />
 
.name = name of the item<br />
 +
.fstype = file or folder<br />
 +
.content = content of the item (Files only)<br />
 
.title = title of the item<br />
 
.title = title of the item<br />
 
.id = id of the item<br />
 
.id = id of the item<br />
 
.href = URL to the item<br />
 
.href = URL to the item<br />
 
.option_values = values from the config.xml that come from the <input>'s<br />
 
.option_values = values from the config.xml that come from the <input>'s<br />
 +
.index = the ascending index number of the item
 +
.safename = The filename without possibly unwanted characters for filesystems for example.
 +
.level = The level of the item in the folder structure. (Path: /Products/Monitors To list the Monitors folder the level is 1, to list the Products folder the level is 0)
 +
 +
 +
$parentitem = The parent folder of the item<br />
 +
$content = An autogenerated link<br />
 +
$level = The level of the item in the folder structure. (Path: /Products/Monitors To list the Monitors folder the level is 1, to list the Products folder the level is 0)<br />
 +
$is_in_path = true if the item is in the path that the visitor was currently viewing<br />
 +
$last_was_in_path = true if the last item in the loop was in the path that the visitor was currently viewing<br />
 +
$even = True if the index is even<br />
 +
 +
==={files}===
 +
This function can list files from the Group-Office file manager
 +
$path = The relative path to the folder to list. It defaults to the path identical to the current CMS file that is viewed.
 +
$template= The template file to use for each file listed.
 +
 +
'''Variables'''
 +
 +
When you use item_template and active_item_template you can use the following variable in the templates:
 +
 +
$file<br />
 +
.name = name of the item<br />
 +
.friendly_name = _ shown as spaces<br />
 +
.path = absolute path on server<br />
 +
.relpath = Relative path from $config['file_storage_path']<br />
 +
.mtime = modification time
 +
.size = size of file
 +
.type = MIME type
  
 
==Use Group-Office user authentication on a page==
 
==Use Group-Office user authentication on a page==
Line 94: Line 168:
  
 
<pre>
 
<pre>
−
{if $session.user_id>0}
+
{go_authenticate}
−
 
+
−
This content is is protected
+
−
 
+
−
{else}
+
−
<p>You need to login first. If you are not redirected click the link below.</p>
+
−
<a href="{$cms_url}login.php?site_id={$site.id}&basehref={$basehref|escape:'url'}&success_url=%2FLinktothispage">Click here to login</a>
+
−
<script type="text/javascript">
+
−
document.location="{$cms_url}login.php?site_id={$site.id}&basehref={$basehref|escape:'url'}&success_url=%2FDownload";
+
−
</script>
+
−
{/if}
+
 
</pre>
 
</pre>
−
 
−
Please make sure you change %2FLinktothispage into the correct URL to this page. %2F is a "/" because you must encode the URL.
 

Latest revision as of 13:23, 31 January 2011

To enable the CMS you need to install / enable the mod_rewrite module for Apache.

More info about mod_rewrite can be found here: http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html

You must know the Site ID of the website. This can be found in Group-Office at:

Websites -> Sites -> Double click the site

Then you must add the following rewrite rule to your VirtualHost section: 

<VirtualHost *:80>
ServerName yourdomain.com
ServerAlias www.yourdomain.com
DocumentRoot /var/www/yourdomain.com
<Directory /var/www/yourdomain.com>
RewriteEngine On
RewriteBase /groupoffice/modules/cms/

#allow robots.txt
RewriteRule ^robots\.txt$ - [L]
RewriteRule ^(.*)$ run.php?site_id=<The Site ID here>&path=$1&basehref=/&%{QUERY_STRING}
</Directory>
<Directory /var/www/yourdomain.com/groupoffice>
RewriteEngine Off
</Directory>
</VirtualHost>

The rewrite base might be different in your environment. Here Group-Office is located in /groupoffice and the website runs at the top level.

If Group-Office already runs at the top level this setup won't work. In that case you create a dummy location:

/var/www/yourdomain.com

In that folder you must create a symlink called "groupoffice" that points to Group-Office. You also create a copy of the config.php file and put it in /var/www/yourdomain.com. Make sure that the original config.php file is not located in the Group-Office source directory otherwise it will always use that config.php file. Group-Office searches trough each parent directory for the config.php file, in /etc/groupoffice and in /etc/groupoffice/yourdomain.com


Variables available in the templates

$site contains all the site properties:

.id = ID of the site
.name = Name of the site
.webmaster_email = Domain


$cms_url = the URL to the CMS module
$template_path = the filesystem path to the template directory
$template_URL = the URL to the template directory
$go_url = the URL to Group-Office
$modules = An array with module information
$images_url = The URL where the public files of the CMS editor are stored
$images_path = The filesystem path where the public files of the CMS editor are stored


$file is an array with the following members:

.id = id of the file
.type = type of the folder defined in config.xml
.folder_id = id of the file's folder
.extension = file extension
.size = filesize
.ctime = Unix timestamp of the creation time of the file
.mtime = Unix timestamp of the modification time of the file
.name = Name of the file
.content = Contents of the file
.title = Meta title of the file
.description = Meta description of the file
.keywords = Meta keywords of the file

$folder
.id = of the folder
.type = type of the file defined in config.xml
.parent_id = parent folder id
.ctime = Unix timestamp of the creation time of the folder
.mtime = Unix timestamp of the modification time of the folder
.name = Name of the folder
.disabled = Disabled folder (0 or 1)

Functions

To get a list of items from a folder you can use the following command:

{items}

This function has the following parameters. They are all optional
$root_path = Path to the parent folder of the items to list
$root_folder_id = ID of the parent folder of the items to list
$level = Display items of a level in the folder structure. (Path: /Products/Monitors To list the Monitors folder the level is 1, to list the Products folder the level is 0)
Use one of the above parameters optionally. If they are omitted it will list the items of the active folder. That is the folder of the file that the visitor is currently viewing.

$expand_levels = Defaults to 0 if you set a value it will expand into a treeview when a folder is clicked.
$expand_all = true or false to expand all levels. Defaults to only expand the selected folder. $no_folder_links = Only useful with expand_all=true. Folders will be rendered as div tags. $class = Pass a class name to the items.

$item_template = Use a sub template file for each item
$active_item_template = Use a sub template file for the active item
$max_items = The maximum items to list.
$wrap_div = true or false to put a <div class=""></div> around each level $random=Show random items. Useful together with max_items $reverse=Sort in reverse order $no_folder_links=Don't make links to folders $start=Start at offset $level_template=Smarty template to use for each level of the tree

Variables

When you use item_template and active_item_template you can use the following variable in the templates:

$item
.type = type of the file or folder defined in config.xml .folder_id = id of the file's folder (file only) .parent_id = id of the folders' parent (folder only) .extension = file extension .size = filesize .ctime = Unix timestamp of the creation time of the file .mtime = Unix timestamp of the modification time of the file .name = Name of the file .content = Contents of the file .title = Meta title of the file .description = Meta description of the file .keywords = Meta keywords of the file .name = name of the item
.fstype = file or folder
.content = content of the item (Files only)
.title = title of the item
.id = id of the item
.href = URL to the item
.option_values = values from the config.xml that come from the <input>'s
.index = the ascending index number of the item .safename = The filename without possibly unwanted characters for filesystems for example. .level = The level of the item in the folder structure. (Path: /Products/Monitors To list the Monitors folder the level is 1, to list the Products folder the level is 0)


$parentitem = The parent folder of the item
$content = An autogenerated link
$level = The level of the item in the folder structure. (Path: /Products/Monitors To list the Monitors folder the level is 1, to list the Products folder the level is 0)
$is_in_path = true if the item is in the path that the visitor was currently viewing
$last_was_in_path = true if the last item in the loop was in the path that the visitor was currently viewing
$even = True if the index is even

{files}

This function can list files from the Group-Office file manager $path = The relative path to the folder to list. It defaults to the path identical to the current CMS file that is viewed. $template= The template file to use for each file listed.

Variables

When you use item_template and active_item_template you can use the following variable in the templates:

$file
.name = name of the item
.friendly_name = _ shown as spaces
.path = absolute path on server
.relpath = Relative path from $config['file_storage_path']
.mtime = modification time .size = size of file .type = MIME type

Use Group-Office user authentication on a page

If you want a page to use Group-Office user authentication you can set this up in the following way Put this in your template: 

{go_authenticate}
Retrieved from "http://www.group-office.com/w/index.php?title=CMS&oldid=1138"