Differences

This shows you the differences between two versions of the page.

--- plugin:displayfile [2021-01-26 04:34] – jeckel
+++ plugin:displayfile [2021-01-28 19:46] – [Configuration Settings] jeckel
@@ Line 6: / Line 6: @@
 email      : jeckelmail@gmail.com
 type       : syntax
-lastupdate : 2021-01-25
+lastupdate : 2021-01-28
 compatible : Elenor of Tsort, Frusterick Manners, Greebo, Hogfather
 depends    :
@@ Line 27: / Line 27: @@
 ===== Usage =====
-This plugin offers a single custom element, ''displayfile'', that takes two arguments, ''lang'' and ''target''. The element is self-closing and should not be used as an open/close pair.
+The plugin offers a single block element that expands into the content of the specified file. The element is self-closing and should not be used as an open/close pair.
-^ Element | %%<displayfile%% ''lang'' ''target'' %%/>%% |
+^ Element ^ Note ^
+| ''%%<<display file LANG TARGET>>%%'' | |
+| ''%%<displayfile LANG TARGET />%%'' | DEPRECATED |
-|< 100% - - 100% >|
 ^ Argument ^ Required ^ Description ^
-| ''lang'' | yes | The language of the content file. This is used by Dokuwiki's built-in syntax highlighting GeSHi library. To disable syntax highlighting, specify a dask (-) character for the lang value. The supported lang values are the same as those provided by Dokuwiki's %%<code>%% and %%<file>%% markup and can be found on the Dokuwiki syntax page: [[https://www.dokuwiki.org/wiki:syntax#syntax_highlighting|Syntax Highlighting]] |
+| ''LANG'' | yes | The language of the content file. This is used by Dokuwiki's built-in syntax highlighting GeSHi library. To disable syntax highlighting, specify a dask (-) character for the ''LANG'' value. The supported ''LANG'' values are the same as those provided by Dokuwiki's %%<code>%% and %%<file>%% markup and can be found on the Dokuwiki syntax page: [[https://www.dokuwiki.org/wiki:syntax#syntax_highlighting|Syntax Highlighting]] |
-| ''target'' | yes | The specific part of a file path to the desired file on the local file system. This will be appended to the value of the plugin's ''root_path'' configuration option. The target value can be enclosed in single or double quotes (' or "). The target path part must be enclosed in quotes if it contains spaces. |
+| ''TARGET'' | yes | The specific part of a file path to the desired file on the local file system. This will be appended to the value of the plugin's ''root_path'' configuration option. The ''TARGET'' value can be enclosed in single or double quotes (' or "). The ''TARGET'' path part must be enclosed in quotes if it contains spaces. |
 ===== Configuration Settings =====
-The Display File Plugin has three settings that can be set in the Dokuwiki Configuration Manager:
+The plugin provides several settings that can be modified through the [[https://www.dokuwiki.org/config:manager|Configuration Manager]].
-  - **Root Path** (''root_path'') - Specifies the root directory displayed file paths will evaluate relative to. The default value is an empty string, which effectively disables the plugin.
+^ Setting ^ Default ^ Description ^
-  - **Deny Extensions List** (''deny_extensions'') - A space separated list of extensions that should disallowed by the ''displayfile'' element. The deny list supersedes the allow list. An empty list means no extension is explicitly disallowed. The default list includes ''sh''.
+| ''root_path'' | empty | Specifies the root directory displayed file paths will evaluate relative to. An empty value effectively disables the plugin. |
-  - **Allow Extension List** (''allow_extensions'') - A space separated list of extensions that should allowed by the ''displayfile'' element. An empty list means any extension not in the deny list will be allowed. The default list includes ''txt'', ''php'', ''js'', and ''css''.
+| ''deny_extensions'' | 'sh' | Space-separated list of extensions that should be disallowed by the ''displayfile'' element. The deny list supersedes the allow list. An empty list means no extension is explicitly disallowed. |
+| ''allow_extensions'' | 'txt php js css' | Space-separated list of extensions that should be allowed by the ''displayfile'' element. An empty list means any extension not in the deny list will be allowed. |
 ===== Future Plans =====