File System Viewer

Table of Contents

Description

This extension contains functions for interacting with a file system.

See also How to add an extension, Using the Extension Dialog, Learn about DekiScript, Extensions Directory.

Configuration:

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") }}