Author: sseifert
Date: Fri Mar 10 16:40:06 2017
New Revision: 1786383
URL: http://svn.apache.org/viewvc?rev=1786383&view=rev
Log:
update fsresource docs
Modified:
sling/site/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.mdtext
Modified:
sling/site/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.mdtext
URL:
http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.mdtext?rev=1786383&r1=1786382&r2=1786383&view=diff
==============================================================================
---
sling/site/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.mdtext
(original)
+++
sling/site/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.mdtext
Fri Mar 10 16:40:06 2017
@@ -4,7 +4,7 @@ Title: Accessing File System Resources (
## Introduction
-The File System Resource Provider provides access to the operating system's
file system through the Sling `ResourceResolver`. Multiple locations may be
mapped into the resource tree by configuring the file system location and the
resource tree root path for each location to be mapped. The provider supports
mapping folders and files as binaries, and content structures stored in JSON
files or FileVault XML format.
+The Apache Sling File System Resource Provider provides access to the
operating system's file system through the Sling `ResourceResolver`. Multiple
locations may be mapped into the resource tree by configuring the file system
location and the resource tree root path for each location to be mapped. The
provider supports mapping folders and files as binaries, and content structures
stored in JSON files or FileVault XML format.
To activate this feature, install the `org.apache.sling.fsresource` bundle.
You can get it from the Sling downloads page or from [Maven
Central][maven-central].
@@ -21,7 +21,7 @@ Files and directories are mapped into th
* Regular files are assigned the `nt:file` resource type
* Directories are assigned the `nt:folder` resource type
-Content stored in JSON or FileVault XML files are mapped with the resource
type stored in the files. If a resource type is missing `nt:unstructured' is
used as fallback.
+Content stored in JSON or FileVault XML files are mapped with the resource
type stored in the files. If a resource type is missing `nt:unstructured` is
used as fallback.
## Adapters
@@ -44,7 +44,7 @@ Which files are mounted depends on the '
* INITIAL_CONTENT: Sling-Initial-Content filesystem layout, supports file and
folders ant content files in JSON and jcr.xml format.
* FILEVAULT_XML: FileVault XML format (expanded content package).
-Further configuration parameters:
+Configuration parameters for each mapping:
| Parameter | Name | Description |
|-|-|-|
@@ -61,7 +61,10 @@ Further configuration parameters:
The mode maps only files and folders. This was the only mode supported in
fsresource versions before 1.3.
-No caching is used for this mode. Resource events are sent when file oder
folder changes are detected.
+Notes:
+
+* No caching is used for this mode.
+* Resource events are sent when file oder folder changes are detected.
### INITIAL_CONTENT file system layout
