Pages XML File

Menu/Collection XML File

XML tags
- <dir> - contains directory folder data
Sample CMS pages XML file

–

Directory folder title text

mandatory, non repeatable

Sample for using:


<title><![CDATA[Access Control]]></title>

–

Directory folder access control list

optional, non repeatable

Attribute Name	Mandatory	Default	Description
inherit	No	1	1 - access control inheritance from higher level ACL list, 0 - stop inheritance

Sample for using:


<acl inherit="0">
	<entry type="role">demo</entry>
	<entry type="user">admin</entry>
</acl>

–

Directory folder access control list entry, contains user/group ID

mandatory, repeatable

Attribute Name	Mandatory	Default	Description
type	Yes	n/a	"user" - user ID, "role" - group id
r	No	1	1 - allow read page data using "Pages" tool, 0 - not allow read
w	No	1	1 - allow write page data using "Pages" tool, 0 - not allow write
e	No	1	1 - allow execute page (enter page URL in browser and get it), 0 - not allow execute
m	No	1	1 - allow manage page access control list using "pages" tool, 0 - not allow manage

Sample for using:


<entry type="admin" e="1" w="1"></entry>

–

Directory folder last update timestamp

optional, non repeatable

Sample for using:


<timestamp><![CDATA[2014-09-19 21:22:19]]></timestamp>

<doc>

–

Page tag

mandatory, repeatable

Attribute Name	Mandatory	Default	Description
type	No	n/a	0 - regular page (default), 1 - model page, 2 - sample page

Sample for using:


<doc type="1"> ... </doc>

–

Assigned to page model internal unique ID

optional, non repeatable

Sample for using:


<mdl><![CDATA[53ce35b1b0297]]></mdl>

–

Page internal unique ID (auto generated if empty)

mandatory, non repeatable

Sample for using:


<seq><![CDATA[53ce42b1b0297]]></seq>

–

Page unique pernament ID (PID - autogenerated if empty)

optional, non repeatable

Sample for using:


<pid><![CDATA[53b7e5c19d92d]]></pid>

–

Page type code

optional, non repeatable

Sample for using:


<code><![CDATA[regular]]></code>

–

Page URL

mandatory, non repeatable

Sample for using:


<url><![CDATA[/docs]]></url>

–

page URL regular expression (only if URL is RESTful style)

optional, non repeatable

Sample for using:


<url><![CDATA[/news/item/:id]]></url>
<regexp><![CDATA[^/news/item/[^/]+$]]></regexp>

–

Page alias redirect URL list

optional, non repeatable

Sample for using:


<alias><url><![CDATA[/xxx]]></url></alias>

–

Page alias redirect URL

optional, repeatable

Sample for using:


<alias><url><![CDATA[/xxx]]></url></alias>

–

Page redirect URL to another page (usually in another site)

optional, non repeatable

Attribute Name	Mandatory	Default	Description
code	No	302	Redirect code: 301, 302, 303 or 307

Sample for using:


<redirect><![CDATA[http://www.sample-site.com]]></redirect>

–

Page public availability: 1 - available, 0 - not available

optional, non repeatable

Attribute Name	Mandatory	Default	Description
start	No	0000-00-00 00:00:00	Date and time when public availability starts
stop	No	9999-00-00 00:00:00	Date and time when public availability stops

Sample for using:


<public start="2013-01-01 00:00:00">1</public>

–

Page request method (GET, POST, etc.). Default: "GET"

optional, repeatable

Sample for using:


<method>GET</method>
<method>POST</method>

–

Page title text to be used as menu title

mandatory, non repeatable

Sample for using:


<title><![CDATA[Docs]]></title>

–

Page extended title to be used in page title tag

optional, non repeatable

Sample for using:


<title_full><![CDATA[KUSoftas CMS Docs]]></title_full>

–

Page description text to be used in page meta tag

optional, non repeatable

Sample for using:


<desc><![CDATA[KUSoftas CMS Docs: overview (CMS features, system requirements, basics, access control), tools (setup, menu, pages, files, users, groups), administration (installation, backing up and restoring)]]></desc>

–

Page keywords text to be used in page meta tag

optional, non repeatable

Sample for using:


<keyw><![CDATA[cms, content management system, docs, documentation, web, access, administration, tools]]></keyw>

–

Page language 2-letter code ID to be used in page html tag

optional, non repeatable

Sample for using:


<lang><![CDATA[en]]></lang>

–

Topic code to be assigned to page

optional, repeatable

Sample for using:


<topic><![CDATA[docs]]></topic>

–

Optional keypair metadata

optional, repeatable (with distinct ID)

Attribute Name	Mandatory	Default	Description
id	No	n/a	ex. "fb:admins"

Sample for using:


<meta id="fb:admins"><![CDATA[<meta property="fb:admins" content="1234567890"/>]]></meta>

–

Page template file path

optional, non repeatable

Attribute Name	Mandatory	Default	Description
type	No	n/a	"site" - template is defined by file path, else - template is defined by file name (defined in tool "Setup", "List" tab, "Templates" list)
title	Yes (if type is not equal "site")	n/a	Defined in tool "Setup", "List" tab, "Templates" list

Sample for using:


<template title="Default template">index.tpl</template>

–

Page lifetime in seconds; 0 - unlimited, -1 - non cached

optional, non repeatable

Sample for using:


<life>3600</life>

–

Sitemap; 0 - don't include page into sitemap, 1 - include page into sitemap

optional, non repeatable

Sample for using:


<sitemap>1</sitemap>

–

The priority of this page relative to other pages on your site. Valid values range from 0.0 to 1.0. The default priority of a page is 0.5.

optional, non repeatable

Sample for using:


<sitemap_priority>0.7</sitemap_priority>

–

How frequently the page is likely to change. This value provides general information to search engines and may not correlate exactly to how often they crawl the page. Valid values are: 0 - always, 1 - hourly, 2 - daily, 3 - weekly, 4 - monthly, 5 - yearly, 6 - never

optional, non repeatable

Sample for using:


<sitemap_frequency>1</sitemap_frequency>

–

Inlude file into search index; 0 - don't include, 1 - include

optional, non repeatable

Sample for using:


<search>1</search>

–

Page option string to be used in page header section

optional, repeatable

Sample for using:


<option><![CDATA[<meta name="robots" content="noindex,follow"/>]]></option>

–

Page include file or datastream: css, js, template/html, datastream

optional, repeatable

Attribute Name	Mandatory	Default	Description
type	Yes	n/a	"file" - template/html file "css" - css file "js" - js file "ds" - datastream
file_id	No	n/a	To be accessed by ID in template variables or via URL (datastream). Applicable when type="file" or type="ds"
code	No	n/a	Datastream type code. Applicable only when type="ds"
mime	No	application/octet-stream	Datastream mime type. Applicable only when type="ds"
size	No	n/a	Datastream file size in bytes. Applicable only when type="ds"
storage	No	0	Datastream is stored into digital repository if storage="1". Applicable only when type="ds"
cache	No	n/a	Possible values: "cache", "nocache", "inline". Applicable only when type="file"
life	No	n/a	Include file caching lifetime in sec. Applicable only when type="file"
link	No	n/a	1 - include ID defined in system setup. Applicable only when type="css" or type="js"
ext	No	n/a	1 - include/datastream referenced by URL (usually in another site). Applicable only when type="css" or type="js" or type="ds"

Sample for using:


<include type="file" life="3600"><![CDATA[docs/cms-tools/files/file-editor-blockquate.htm]]></include>
<include type="css"><![CDATA[docs/docs.css]]></include>

–

Datastream availability via URL: 1 - available, 0 - not available

optional, non repeatable

Attribute Name	Mandatory	Default	Description
start	No	0000-00-00 00:00:00	Date and time when availability starts
stop	No	9999-00-00 00:00:00	Date and time when availability stops

Sample for using:


<public start="2013-01-01 00:00:00">1</public>

–

Datastream access control list

optional, non repeatable

Attribute Name	Mandatory	Default	Description
inherit	No	1	1 - access control inheritance from higher level ACL list, 0 - stop inheritance

Sample for using:


<acl inherit="0">
	<entry type="role">demo</entry>
	<entry type="user">admin</entry>
</acl>

–

Datastream access control list entry, contains user/group ID

mandatory, repeatable

Attribute Name	Mandatory	Default	Description
type	Yes	n/a	"user" - user ID, "role" - group id
r	No	1	1 - allow read page data using "Pages" tool, 0 - not allow read
w	No	1	1 - allow write page data using "Pages" tool, 0 - not allow write
e	No	1	1 - allow execute page (enter page URL in browser and get it), 0 - not allow execute
m	No	1	1 - allow manage page access control list using "pages" tool, 0 - not allow manage

Sample for using:


<entry type="admin" e="1" w="1"></entry>

–

Datastream last update timestamp

optional, non repeatable

Sample for using:


<timestamp><![CDATA[2014-09-19 21:22:19]]></timestamp>

–

Page routing php class function

optional, non repeatable

Sample for using:


<fnc>cms_route::def</fnc>

–

Directory folder access control list

optional, non repeatable

Attribute Name	Mandatory	Default	Description
inherit	No	1	1 - access control inheritance from higher level ACL list, 0 - stop inheritance

Sample for using:


<acl inherit="0">
	<entry type="role">demo</entry>
	<entry type="user">admin</entry>
</acl>

–

Directory folder access control list entry, contains user/group ID

mandatory, repeatable

Attribute Name	Mandatory	Default	Description
type	Yes	n/a	"user" - user ID, "role" - group id
r	No	1	1 - allow read page data using "Pages" tool, 0 - not allow read
w	No	1	1 - allow write page data using "Pages" tool, 0 - not allow write
e	No	1	1 - allow execute page (enter page URL in browser and get it), 0 - not allow execute
m	No	1	1 - allow manage page access control list using "pages" tool, 0 - not allow manage

Sample for using:


<entry type="admin" e="1" w="1"></entry>

Sample CMS pages XML file:


<?php echo '<?xml ';?>version="1.0" encoding="utf-8" <?php echo '?>';?>
<data>
	<doc>
		<url><![CDATA[/docs]]></url>
		<title><![CDATA[Docs]]></title>
		<title_full><![CDATA[KUSoftas CMS Docs]]></title_full>
		<desc><![CDATA[KUSoftas CMS Docs: overview (CMS features, system requirements, basics, access control), tools (setup, menu, pages, files, users, groups), administration (installation, backing up and restoring)]]></desc>
		<keyw><![CDATA[cms, content management system, docs, documentation, web, access, administration, tools]]></keyw>
		<lang><![CDATA[en]]></lang>
	</doc>
	<doc>
		<url><![CDATA[/]]></url>
		<title><![CDATA[Home]]></title>
		<title_full><![CDATA[KUSoftas CMS Home - skinnable, SEO optimized, jQuery, PHP, Smarty, jQuery based]]></title_full>
		<desc><![CDATA[KUSoftas CMS is skinnable, SEO optimized with jQuery and Ajax support, WYSIWYG content editing, WebDAV support based on PHP, Smarty, Slim, jQuery, Datatables, Dynatree etc.]]></desc>
		<keyw><![CDATA[cms, content management system, web, site, setup, menu, pages, files, users, groups, access control, permissions, jquery, elrte, elfinder, datatables, dynatree, mysql, sqlite, smarty, slim, webdav, superfish, drag and drop]]></keyw>
		<lang><![CDATA[en]]></lang>
		<template title="Home page template"><![CDATA[cms-demo.tpl]]></template>
		<include type="file"><![CDATA[home.html]]></include>
	</doc>
	<doc>
		<url><![CDATA[/search]]></url>
		<method><![CDATA[GET]]></method>
		<method><![CDATA[POST]]></method>
		<title><![CDATA[Search]]></title>
		<title_full><![CDATA[KUSoftas CMS Search Pages]]></title_full>
		<desc><![CDATA[KUSoftas CMS Search Pages]]></desc>
		<keyw><![CDATA[kusoftas, cms, content management system, search, pages, jquery, tipue]]></keyw>
		<lang><![CDATA[en]]></lang>
		<template title="Search template"><![CDATA[cms-demo-search.tpl]]></template>
		<include type="css" link="1"><![CDATA[tipue]]></include>
		<include type="css"><![CDATA[search/search.css]]></include>
		<include type="js" link="1"><![CDATA[tipue]]></include>
		<include type="js"><![CDATA[search/search_set.js]]></include>
		<include type="js"><![CDATA[search/search.js]]></include>
	</doc>
</data>

–

Page last update timestamp

optional, non repeatable

Sample for using:


<timestamp><![CDATA[2014-09-19 21:22:19]]></timestamp>