h5ai-flpsite/src/_h5ai/conf/options.json
2015-04-06 20:56:59 +02:00

339 lines
9.8 KiB
JSON

/*
{{pkg.name}} {{pkg.version}}
{{pkg.homepage}}
Options
*/
{
/*
General view options.
- binaryPrefix: boolean, set to true uses 1024B=1KiB when formatting file sizes (see http://en.wikipedia.org/wiki/Binary_prefix)
- hidden: array of strings, don't list items matching these regular expressions
- hideFolders: boolean, hide all folders in the main view
- hideIf403: boolean, hide files and folders that are not readable by the server
- hideParentFolder: boolean, hide parent folder links in the main view
- modes: array of strings, subset of ["details", "grid", "icons"]
the first value indicates the default view mode. If only one value
is given the view mode is fixed and the selector buttons are hidden.
The user selected view mode is also stored local in modern browsers
so that it will be persistent.
- setParentFolderLabels: boolean, set parent folder labels to real folder names
- sizes: array of numbers
the first value indicates the default view size. If only one value
is given the view size is fixed and the selector buttons are hidden.
The user selected view size is also stored local in modern browsers
so that it will be persistent.
- smartBrowsing: boolean, use History API if available (no need to reload the whole page)
- theme: string, name of one of the folders in "_{{pkg.name}}/images/themes", defaults to "default"
- unmanaged: array of strings, don't manage folders containing one of those files
- unmanagedInNewWindow: boolean, open unmanaged links in new window/tab
*/
"view": {
"binaryPrefix": false,
"hidden": ["^\\.", "^_{{pkg.name}}"],
"hideFolders": false,
"hideIf403": true,
"hideParentFolder": false,
"modes": ["details", "grid", "icons"],
"setParentFolderLabels": true,
"sizes": [20, 40, 60, 80, 100, 150, 200, 250, 300, 350, 400],
"smartBrowsing": true,
"theme": "",
"unmanaged": ["index.html", "index.htm", "index.php"],
"unmanagedInNewWindow": false
},
/*** Extensions (in alphabetical order) ***/
/*
Watch and update current folder content.
- interval: number, update interval in milliseconds, at least 1000
*/
"autorefresh": {
"enabled": false,
"interval": 5000
},
/*
Enable a context menu (right-click) on some elements.
*/
"contextmenu": {
"enabled": false
},
/*
Show a clickable breadcrumb.
*/
"crumb": {
"enabled": true
},
/*
Allow customized header and footer files.
First checks for files "_h5ai.header.html" and "_h5ai.footer.html" in the current directory.
If not successful it checks all parent directories (starting in the current directory) for
files "_h5ai.headers.html" and "_h5ai.footers.html".
Note the different filenames: "header" (only current) - "headers" (current and sub directories)!
The file's content will be placed inside a <div/> tag above/below the main content.
If a file's extension is ".md" instead of ".html" its content will be interpreted as markdown.
*/
"custom": {
"enabled": true
},
/*
Enable packaged download of selected entries.
To select files the "select"-extension needs to be enabled.
- type: string, "php-tar", "shell-tar" or "shell-zip"
- packageName: string, basename of the download package, null for current filename or foldername
- alwaysVisible: boolean, always show download button (defaults to download the current folder)
*/
"download": {
"enabled": true,
"type": "php-tar",
"packageName": null,
"alwaysVisible": false
},
/*
Allow filtering the displayed files and folders.
Will check entries for right order of characters, i.e.
"ab" matches "ab", "axb", "xaxbx" but not "ba".
Space separated sequences get OR-ed.
Filters will be treated as JavaScript regular expressions
if you prefix them with "re:".
*/
"filter": {
"enabled": true
},
/*
Calc the size of folders.
This operation is real slow. The calculated sizes differ slightly for both
calculation types since "php" only adds the file size, while "shell-du"
also adds the sizes for the actual folder files.
- type: string, "php" (sloooow) or "shell-du" (sloow)
*/
"foldersize": {
"enabled": false,
"type": "php"
},
/*
Adds Google Universial Analytics asynchronous tracking code.
see: https://developers.google.com/analytics/devguides/collection/analyticsjs/
- id: string, account ID
*/
"google-analytics-ua": {
"enabled": false,
"id": "UA-000000-0"
},
/*
Enable a generic info side bar.
- show: boolean, initial visible to first time users
- qrcode: boolean, show a QR-Code
- qrColor: string, QR-Code fill color
*/
"info": {
"enabled": true,
"show": false,
"qrcode": true,
"qrColor": "#999"
},
/*
Localization, for example "en", "de" etc. - see "_h5ai/conf/l10n" folder for
possible values. Adjust it to your needs. If lang is not found
it defaults to "en".
- lang: string, default language
- useBroserLang: boolean, try to use browser language
*/
"l10n": {
"enabled": true,
"lang": "en",
"useBrowserLang": true
},
/*
Adds peer5 p2p downloader which is based on webrtc (see peer5.com).
- id: string, the API key
*/
"peer5": {
"enabled": false,
"id": "z142i5n5qypq4cxr"
},
/*
Adds Piwik tracker javascript code.
- baseURL: string, do not include the protocol, e.g. "mydomain.tld/piwik"
- idSite: number
*/
"piwik-analytics": {
"enabled": false,
"baseURL": "some/url",
"idSite": 1
},
/*
Play a audio preview on click.
- types: array of strings
*/
"preview-aud": {
"enabled": true,
"types": ["aud"]
},
/*
Show an image preview on click.
- types: array of strings
- size: number, sample size, or false for original size
*/
"preview-img": {
"enabled": true,
"size": false,
"types": ["img", "img-bmp", "img-gif", "img-ico", "img-jpg", "img-png", "img-raw"]
},
/*
Show text file preview on click.
"types" maps file types to http://prismjs.com languages.
Additional type are:
- "markdown" to render Markdown text
- "none" for floating text
- "fixed" for fixed width text
- types: dict string to string, maps types to languages
*/
"preview-txt": {
"enabled": true,
"types": {
"txt": "fixed",
"txt-authors": "fixed",
"txt-license": "fixed",
"txt-c": "c",
"txt-cpp": "cpp",
"txt-css": "css",
"txt-diff": "fixed",
"txt-h": "c",
"txt-hpp": "cpp",
"txt-install": "fixed",
"txt-log": "fixed",
"txt-java": "java",
"txt-scala": "scala",
"txt-js": "javascript",
"txt-json": "javascript",
"txt-makefile": "fixed",
"txt-md": "markdown",
// "txt-php": "php",
"txt-py": "python",
"txt-readme": "fixed",
"txt-rb": "ruby",
"txt-rtf": "fixed",
"txt-script": "bash",
"txt-xml": "fixed"
}
},
/*
Play a video preview on click.
- types: array of strings
*/
"preview-vid": {
"enabled": true,
"types": ["vid-avi", "vid-flv", "vid-mkv", "vid-mov", "vid-mp4", "vid-mpg", "vid-webm"]
},
/*
Make entries selectable.
At the moment only needed for packaged download.
- clickndrag: boolean, allow first mouse button + drag selection
- checkboxes: boolean, show a checkbox on mouse over item
*/
"select": {
"enabled": true,
"clickndrag": true,
"checkboxes": true
},
/*
Default sort order.
"column" and "reverse" are locally stored.
- column: number, 0 for "Name", 1 for "Date", 2 for "Size"
- reverse: boolean, false for ascending, true for descending
- ignorecase: boolean, compare ignorecase
- natural: boolean, use natural sort order
- folders: number, where to place folders, 0 for "top", 1 for "in place", 2 for "bottom"
*/
"sort": {
"enabled": true,
"column": 0,
"reverse": false,
"ignorecase": true,
"natural": false,
"folders": 0
},
/*
Show thumbnails for image files. Needs the "/_{{pkg.name}}/cache" folder to be
writable for the web Server.
- img: array of strings
- mov: array of strings
- doc: array of strings
- delay: number, delay in milliseconds after "dom-ready" before thumb-requesting starts
- size: number, size in pixel of the generated thumbnails
- exif: boolean, use included EXIF thumbs if possible
*/
"thumbnails": {
"enabled": true,
"img": ["img-bmp", "img-gif", "img-ico", "img-jpg", "img-png"],
"mov": ["vid-avi", "vid-flv", "vid-mkv", "vid-mov", "vid-mp4", "vid-mpg", "vid-webm"],
"doc": ["x-pdf", "x-ps"],
"delay": 1,
"size": 240,
"exif": false
},
/*
Replace window title with current breadcrumb.
*/
"title": {
"enabled": true
},
/*
Show a folder tree.
Note that this might affect performance significantly.
- show: boolean, initial visible to first time users
- maxSubfolders: number, max number of subfolders to show in tree
- naturalSort: boolean, use natural sort order for folders
*/
"tree": {
"enabled": true,
"show": true,
"maxSubfolders": 50,
"naturalSort": false
}
}