Virtual File System

(Difference between revisions)
Jump to: navigation, search
(documented resources and properties in detail)
Line 1: Line 1:
−
Open Cms comes with an own filesystem. Most data like the dynamic pages of the Opencms [[Workplace]] as well as websites and website [[templates]] are stored in a special filesystem, the so-called Virtual File System (or VFS in short).
+
Open Cms comes with its own filesystem. Most data like the dynamic pages of the Opencms [[Workplace]] as well as websites and website [[templates]] are stored in a special filesystem, the so-called Virtual File System (or VFS in short).
  
−
The VFS is completely stored in the database. It has it's own set of access functions, an own, operating-system independent permission model and it knows it's own set of [[Resource|resource]] types. Because the file system is extensible, new custom resource types can be added, without modifying the core routines of opencms.
+
The VFS is completely stored in the database. It has its own set of access functions, an own, operating-system independent permission model and it knows its own set of [[Resource|resource]] types. New custom resource types can be added without modifying the core routines of opencms.
  
−
The Virtual file system cannot be normally accessed on the operating system level (although there are open cms extensions for making it available, e.g. through an FTP service).  
+
The Virtual file system cannot be normally accessed on the operating system level. There are OpenCms extensions for making it available, e.g. through an FTP service. From version 7 on, OpenCms will support WebDAV out of the box.
  
 +
==Resources==
 +
Files in the VFS are stored in the same hierarchical manner known from other file systems. They are called resources.
 +
Each resource is associated with a resource type, the publication attribute (<em>datereleased</em>), the expiration attribute (<em>dateexpired</em>) and a set of properties.
 +
 +
=== Resource Properties ===
 +
A property is a named string literal value attached to the resource.
 +
 +
There are several standard properties with predefined semantics evaluated by OpenCms during work with the resource. Most prominent is the <em>Title</em> property which is used to display the user-defined title for a resource in the explorer. You can access property values from JSP templates via the [[cms_property|cms:property]] tag.
 +
 +
Resource properties are an important part of OpenCms and widely used. You can define your own properties and map elements of your XML content to properties.
 +
 +
<dl>
 +
<dt>activemethod
 +
<dd>the active method in the administration view
 +
<dt>locale-available
 +
<dd>the allowed set of locales
 +
<dt>templateclass
 +
<dd>control the Java class for body.
 +
<dt>cache
 +
<dd>controls the caching
 +
<dt>ChannelId
 +
<dd>probably deprecated because the concept of channels in version 5.x seems to have been dropped
 +
<dt>content-conversion
 +
<dd>
 +
<dt>content-encoding
 +
<dd>content encoding
 +
<dt>default-file
 +
<dd>default file in folders
 +
<dt>Description
 +
<dd>resource description
 +
<dt>enable-notification
 +
<dd>
 +
<dt>export
 +
<dd>boolean indicating inclusion or exclusion from static export
 +
<dt>exportname
 +
<dd>the resource export name, during export this name is used instead of the resource name
 +
<dt>exportsuffix
 +
<dd>JSP additional suffix during static export, default is "html".
 +
<dt>folders.available
 +
<dd>control the folders where templates or default bodies should be available
 +
<dt>image.size
 +
<dd>the image geometry for image resources
 +
<dt>internal
 +
<dd>internal use (e.g. delete)
 +
<dt>Keywords
 +
<dd>resource keywords
 +
<dt>locale
 +
<dd>
 +
<dt>locale-default
 +
<dd>default locale of the resource
 +
<dt>login-form
 +
<dd>the login form
 +
<dt>NavImage
 +
<dd>icons to use for display of admin tools
 +
<dt>NavInfo
 +
<dd>used to group related tools in the admin view
 +
<dt>NavPos
 +
<dd>navigation position, used to determine the order of tools in the admin view
 +
<dt>NavText
 +
<dd>navigation text
 +
<dt>notification-interval
 +
<dd>
 +
<dt>relativeroot
 +
<dd>relative root link substitution
 +
<dt>restypes.available
 +
<dd>name that defines the available resource types for the "new" dialog
 +
<dt>category
 +
<dd>sort search results in categories
 +
<dt>search.extractionclass
 +
<dd>define a bean for search content extraction
 +
<dt>search.priority
 +
<dd>to boost certain search results
 +
<dt>secure
 +
<dd>secure transmission of resources
 +
<dt>stylesheet
 +
<dd>stylesheet of files
 +
<dt>template
 +
<dd>control the template
 +
<dt>template-elements
 +
<dd>control the template elements
 +
<dt>Title
 +
<dd>resource title
 +
<dt>visiblemethod
 +
<dd>visible method in the administration view
 +
<dt>
 +
<dd>
 +
 +
</dl>
 
=== See also: ===
 
=== See also: ===
 
[[Real File System]]
 
[[Real File System]]

Revision as of 12:41, 4 December 2006

Open Cms comes with its own filesystem. Most data like the dynamic pages of the Opencms Workplace as well as websites and website templates are stored in a special filesystem, the so-called Virtual File System (or VFS in short).

The VFS is completely stored in the database. It has its own set of access functions, an own, operating-system independent permission model and it knows its own set of resource types. New custom resource types can be added without modifying the core routines of opencms.

The Virtual file system cannot be normally accessed on the operating system level. There are OpenCms extensions for making it available, e.g. through an FTP service. From version 7 on, OpenCms will support WebDAV out of the box.

Resources

Files in the VFS are stored in the same hierarchical manner known from other file systems. They are called resources. Each resource is associated with a resource type, the publication attribute (datereleased), the expiration attribute (dateexpired) and a set of properties.

Resource Properties

A property is a named string literal value attached to the resource.

There are several standard properties with predefined semantics evaluated by OpenCms during work with the resource. Most prominent is the Title property which is used to display the user-defined title for a resource in the explorer. You can access property values from JSP templates via the cms:property tag.

Resource properties are an important part of OpenCms and widely used. You can define your own properties and map elements of your XML content to properties.

activemethod
the active method in the administration view
locale-available
the allowed set of locales
templateclass
control the Java class for body.
cache
controls the caching
ChannelId
probably deprecated because the concept of channels in version 5.x seems to have been dropped
content-conversion
content-encoding
content encoding
default-file
default file in folders
Description
resource description
enable-notification
export
boolean indicating inclusion or exclusion from static export
exportname
the resource export name, during export this name is used instead of the resource name
exportsuffix
JSP additional suffix during static export, default is "html".
folders.available
control the folders where templates or default bodies should be available
image.size
the image geometry for image resources
internal
internal use (e.g. delete)
Keywords
resource keywords
locale
locale-default
default locale of the resource
login-form
the login form
NavImage
icons to use for display of admin tools
NavInfo
used to group related tools in the admin view
NavPos
navigation position, used to determine the order of tools in the admin view
NavText
navigation text
notification-interval
relativeroot
relative root link substitution
restypes.available
name that defines the available resource types for the "new" dialog
category
sort search results in categories
search.extractionclass
define a bean for search content extraction
search.priority
to boost certain search results
secure
secure transmission of resources
stylesheet
stylesheet of files
template
control the template
template-elements
control the template elements
Title
resource title
visiblemethod
visible method in the administration view

See also:

Real File System

Retrieved from "http://www.opencms-wiki.org/index.php?title=Virtual_File_System&oldid=2067"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox