FileSystem

This extension contains functions for interacting with a file system  Related Links: Extension Overview, DekiScript Overview, Extension Demos.

Assembly: mindtouch.deki.services
SID: http://services.mindtouch.com/deki/draft/2008/03/filesystem
License: none

This service requires Deki Wiki 1.9.1 or later.

To enable this extension, follow these steps:

1. Go to Service management in the Control Panel of your wiki.
2. Under Add Service, click on Local, and select type Extension.
3. Enter a description and the extension SID: http://services.mindtouch.com/deki/draft/2008/03/filesystem
4. Add any additional configuration settings that are required by the extension (see below).
5. Click on add service.

Before the FileSystem service can be used, it must be configured.

If you need to configure multiple file systems for the same wiki, register this extension once for each file system.  Use the following preference to specify a unique namespace value for each registration.  Invoke the service using this value instead of filesystem.  For example, if you set namespace=filesystem1, you would invoke the service with filesystem1.tree("...") instead of filesystem.tree("...").  

Functions:

filesystem.tree(folder : str, topDirectoryOnly : bool?, pattern : str) : xml

Displays a browsable file system tree.

Parameters:

Name	Type	Description
folder	str	The top directory
topDirectoryOnly	bool?	Optional.  Specifies whether to include all directories or only the top directory (default: false)
pattern	str	Optional.  Search pattern (default: nil)

Samples:

	Output
To display the contents of the root directory: {{ filesystem.tree("/") }}
To display a list of files in the root directory: {{ filesystem.tree("/", true) }}
To search opt/deki/src/services/Deki for files that end with ".cs": {{ filesystem.tree("opt/deki/src/services/Deki", false, "*.cs") }}