Clean up unused syntax
This commit is contained in:
27
README.md
27
README.md
@@ -21,8 +21,7 @@ It is likely unsuited for wider adoption without modification.
|
||||
|
||||
luxtools provides DokuWiki syntax that:
|
||||
|
||||
- Lists files from configured host filesystem roots (glob pattern)
|
||||
- Lists a directory's direct children (files + folders)
|
||||
- Lists a directory's direct children (files + folders) or files matching a glob pattern
|
||||
- Renders an image thumbnail gallery (with lightbox)
|
||||
- Provides "open this folder/path" links for local workflows
|
||||
- Embeds file-backed scratchpads with a minimal inline editor (no wiki revisions)
|
||||
@@ -155,14 +154,23 @@ This complements DokuWiki's built-in monospace formatting (`''`) by providing qu
|
||||
|
||||
### 1) List files by glob pattern
|
||||
|
||||
The `{{directory>...}}` syntax (or `{{files>...}}` for backwards compatibility) can handle both directory listings and glob patterns. When a glob pattern is used, it renders as a table:
|
||||
|
||||
```
|
||||
{{files>/Scape/projects/*&style=list}}
|
||||
{{files>/Scape/projects/*&style=table&tableheader=1&showsize=1&showdate=1}}
|
||||
{{files>/Scape/projects/*&recursive=1&sort=mtime&order=desc}}
|
||||
{{directory>/Scape/projects/*}}
|
||||
{{directory>/Scape/projects/*&tableheader=1&showsize=1&showdate=1}}
|
||||
{{directory>/Scape/projects/*&recursive=1&sort=mtime&order=desc}}
|
||||
```
|
||||
|
||||
Or using the legacy `files` keyword (same behavior):
|
||||
```
|
||||
{{files>/Scape/projects/*}}
|
||||
{{files>/Scape/projects/*&tableheader=1&showsize=1&showdate=1}}
|
||||
```
|
||||
|
||||
Notes:
|
||||
- Pattern matching is performed per-directory (safe glob via fnmatch).
|
||||
- Always renders as a table.
|
||||
- A directory can have a title file (default: `_title.txt`) to override the displayed folder name.
|
||||
|
||||
### 2) List a directory (folders + files) as a table
|
||||
@@ -221,7 +229,7 @@ Behaviour:
|
||||
Scratchpads render the referenced file as wikitext and (when you have edit rights on the host page) provide an inline editor that saves directly to the backing file.
|
||||
|
||||
|
||||
## Inline options reference (files/images/directory)
|
||||
## Inline options reference (directory/images)
|
||||
|
||||
The listing syntaxes accept options appended with &key=value:
|
||||
|
||||
@@ -236,14 +244,7 @@ The listing syntaxes accept options appended with &key=value:
|
||||
| randlinks | 0\|1 | Adds a cache-busting query parameter based on mtime. |
|
||||
| showsize | 0\|1 | Show file size (where supported). |
|
||||
| showdate | 0\|1 | Show last modified date (where supported). |
|
||||
| listsep | ", " | Separator used in list-style rendering for extra fields. |
|
||||
| maxheight | 500 | Container max-height in pixels; -1 disables scroll container. |
|
||||
|
||||
Additionally for `{{files>...}}`:
|
||||
|
||||
| Option | Values | Notes |
|
||||
|---|---|---|
|
||||
| style | list\|olist\|table | Output style. |
|
||||
| tableheader | 0\|1 | Render table header row. |
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user