docs: make serve http/webdav template docs into a table

This commit is contained in:
Nick Craig-Wood 2020-05-04 18:31:22 +01:00
parent 4362ca7bb9
commit ef9e6794c2

View file

@ -55,23 +55,25 @@ identically.
--template allows a user to specify a custom markup template for http --template allows a user to specify a custom markup template for http
and webdav serve functions. The server exports the following markup and webdav serve functions. The server exports the following markup
to be used within the template to server pages: to be used within the template to server pages:
.Name The full path of a file/directory.
.Title "Directory listing of .Name".
.Sort The current sort used. This is changble via ?sort= parameter
Sort Options: namedirfist,name,size,time (defailt namedirfirst)
.Order The current ordering used. This is changable via ?order= paramter
Order Options: asc,desc (default asc)
.Query Currently unused.
.Breacrumb Allows for creating a relative navigation
-- .Link The relative to the root link of the Text.
-- .Text The Name of the directory.
.Entries Information about a specific file/directory.
-- .URL The 'url' of an entry.
-- .Leaf Currently same as 'URL' but intended to be 'just' the name.
-- .IsDir Boolean for if an entry is a directory or not.
-- .Size Size in Bytes of the entry.
-- .ModTime The UTC timestamp of an entry.
| Parameter | Description |
| :---------- | :---------- |
| .Name | The full path of a file/directory. |
| .Title | Directory listing of .Name |
| .Sort | The current sort used. This is changeable via ?sort= parameter |
| | Sort Options: namedirfist,name,size,time (default namedirfirst) |
| .Order | The current ordering used. This is changeable via ?order= parameter |
| | Order Options: asc,desc (default asc) |
| .Query | Currently unused. |
| .Breadcrumb | Allows for creating a relative navigation |
|-- .Link | The relative to the root link of the Text. |
|-- .Text | The Name of the directory. |
| .Entries | Information about a specific file/directory. |
|-- .URL | The 'url' of an entry. |
|-- .Leaf | Currently same as 'URL' but intended to be 'just' the name. |
|-- .IsDir | Boolean for if an entry is a directory or not. |
|-- .Size | Size in Bytes of the entry. |
|-- .ModTime | The UTC timestamp of an entry. |
#### Authentication #### Authentication