Differences

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

--- plugin:displayfile [2021-01-28 19:43] – [Usage] jeckel
+++ plugin:displayfile [2021-01-28 19:45] – [Usage] jeckel
@@ 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 ^ Note ^
-| %%<<display file LANG TARGET>>%% | |
+| ''%%<<display file LANG TARGET>>%%'' | |
-| %%<displayfile LANG TARGET />%% | DEPRECATED |
+| ''%%<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 =====