Reformats config comments.

This commit is contained in:
Lars Jung 2012-08-11 02:19:29 +02:00
parent 2f288703bf
commit 9ac5973907

View file

@ -1,25 +1,25 @@
/* /*
* h5ai {{version}} h5ai {{version}}
*
* Configuration Configuration
* options, types and localization options, types and localization
*/ */
var H5AI_CONFIG = { var H5AI_CONFIG = {
"options": { "options": {
/* /*
* The absolute links to webroot and h5ai. The absolute links to webroot and h5ai.
* Do not change this unless you know what you are doing. Do not change this unless you know what you are doing.
*/ */
"rootAbsHref": "/", "rootAbsHref": "/",
"h5aiAbsHref": "/_h5ai/", "h5aiAbsHref": "/_h5ai/",
/* /*
* Spacing of the main content. Spacing of the main content.
* Left and right will be added to a minimum of 30px. Top and bottom Left and right will be added to a minimum of 30px. Top and bottom
* are calculated relative to the top and bottom bar heights. are calculated relative to the top and bottom bar heights.
*/ */
"spacing": { "spacing": {
"maxWidth": 960, "maxWidth": 960,
@ -30,33 +30,30 @@ var H5AI_CONFIG = {
}, },
/* /*
* An array of view modes the user may choose from. Currently there An array of view modes the user may choose from. Currently there
* are two possible values: "details" and "icons". The first value are two possible values: "details" and "icons". The first value
* indicates the default view mode. If only one value is given the indicates the default view mode. If only one value is given the
* view mode is fixed and the selector buttons are hidden. view mode is fixed and the selector buttons are hidden.
* The user selected view mode is also stored local in modern browsers The user selected view mode is also stored local in modern browsers
* so that it will be persistent. so that it will be persistent.
*
* Set parent folder labels to real folder names. Set parent folder labels to real folder names.
*/ */
"view": { "view": {
"modes": ["details", "icons"], "modes": ["details", "list", "icons"],
"setParentFolderLabels": true "setParentFolderLabels": true
}, },
/*** Extensions (in alphabetical order) ***/
/* /*
* Extensions in alphabetical order. Watch current folder content.
*/ Folders possibly visible in the tree view that are not the
current folder might not be updated.
/* Interval will be a least 1000 milliseconds.
* Watch current folder content.
* Folders possibly visible in the tree view that are not the
* current folder might not be updated.
*
* Interval will be a least 1000 milliseconds.
*/ */
"autoupdate": { "autoupdate": {
"enabled": true, "enabled": true,
@ -64,15 +61,23 @@ var H5AI_CONFIG = {
}, },
/* /*
* Show a clickable breadcrumb. Show a context menu when hovering a file entry.
*/
"context-menu": {
"enabled": true,
"deleteBtn": true
},
/*
Show a clickable breadcrumb.
*/ */
"crumb": { "crumb": {
"enabled": true "enabled": true
}, },
/* /*
* Filenames of customized header and footer files to look for Filenames of customized header and footer files to look for
* in each folder. in each folder.
*/ */
"custom": { "custom": {
"enabled": true, "enabled": true,
@ -81,50 +86,60 @@ var H5AI_CONFIG = {
}, },
/* /*
* EXPLICITLY: USE "shell" ON YOUR OWN RISK. File upload via drag'n'drop. Folders are not supported.
* The working file size seems to be very broser dependent.
* Requires PHP on the server.
* Enable packaged download of selected entries. Max file size is in MB.
* Execution: "php", "shell". */
* Supported formats: "tar", "zip". "dropbox": {
"enabled": true,
"maxfiles": 50,
"maxfilesize": 2000
},
/*
Requires PHP on the server.
Enable packaged download of selected entries.
Execution: "php", "shell".
Supported formats: "tar", "zip".
*/ */
"download": { "download": {
"enabled": true, "enabled": true,
"execution": "shell", "execution": "shell",
"format": "tar" "format": "zip"
}, },
/* /*
* Allow filtering the displayed files and folders. Allow filtering the displayed files and folders.
* Will check entries for right order of characters, i.e. Will check entries for right order of characters, i.e.
* "ab" matches "ab", "axb", "xaxbx" but not "ba". "ab" matches "ab", "axb", "xaxbx" but not "ba".
* Space separated sequences get OR-ed. Space separated sequences get OR-ed.
*
* Filters will be treated as JavaScript regular expressions Filters will be treated as JavaScript regular expressions
* if you prefix them with "re:". if you prefix them with "re:".
*/ */
"filter": { "filter": {
"enabled": true "enabled": true
}, },
/* /*
* Requires PHP on the server. Requires PHP on the server.
* Calc the size of folders. Calc the size of folders.
* Depends on du. Depends on du.
*/ */
"foldersize": { "foldersize": {
"enabled": true "enabled": true
}, },
/* /*
* Associative array of folders and their HTTP status codes to Associative array of folders and their HTTP status codes to
* avoid HEAD requests to that folders. The key (folder) must start avoid HEAD requests to that folders. The key (folder) must start
* and end with a slash (/). and end with a slash (/).
* For example For example
* "/some/folder/": 200 "/some/folder/": 200
* will always return HTTP status 200 (OK), which will be interpreted will always return HTTP status 200 (OK), which will be interpreted
* as a non auto indexed folder, that means a folder containing an as a non auto indexed folder, that means a folder containing an
* appropriate default index file. appropriate default index file.
*/ */
"folderstatus": { "folderstatus": {
"enabled": true, "enabled": true,
@ -132,17 +147,17 @@ var H5AI_CONFIG = {
}, },
/* /*
* Adds Google Analytics asynchronous tracking code. Adds Google Analytics asynchronous tracking code.
*
* for example: for example:
* "gaq": [ "gaq": [
* ["_setAccount", "UA-xxxxxx-x"], ["_setAccount", "UA-xxxxxx-x"],
* ["_setDomainName", ".your-domain.tld"], ["_setDomainName", ".your-domain.tld"],
* ["_trackPageview"], ["_trackPageview"],
* ["_trackPageLoadTime"] ["_trackPageLoadTime"]
* ] ]
*
* see: http://support.google.com/googleanalytics/bin/topic.py?hl=en&topic=27612 see: http://support.google.com/googleanalytics/bin/topic.py?hl=en&topic=27612
*/ */
"google-analytics": { "google-analytics": {
"enabled": true, "enabled": true,
@ -150,12 +165,12 @@ var H5AI_CONFIG = {
}, },
/* /*
* Localization, for example "en", "de" etc. - see "langs" below for Localization, for example "en", "de" etc. - see "langs" below for
* possible values. Adjust it to your needs. If lang is not found in possible values. Adjust it to your needs. If lang is not found in
* "langs" it defaults to "en". "langs" it defaults to "en".
*
* Optionally try to use browser language, falls back to previous Optionally try to use browser language, falls back to previous
* specified language. specified language.
*/ */
"l10n": { "l10n": {
"enabled": true, "enabled": true,
@ -164,18 +179,18 @@ var H5AI_CONFIG = {
}, },
/* /*
* Link the hover effects between crumb, main view and tree. Link the hover effects between crumb, main view and tree.
*/ */
"link-hover-states": { "link-hover-states": {
"enabled": true "enabled": true
}, },
/* /*
* Shows the server mode in the bottom left corner. Shows the server mode in the bottom left corner.
* display values: display values:
* 0: only show mode 0: only show mode
* 1: mode and servername 1: mode and servername
* 2: mode, servername and -version 2: mode, servername and -version
*/ */
"mode": { "mode": {
"enabled": true, "enabled": true,
@ -183,7 +198,7 @@ var H5AI_CONFIG = {
}, },
/* /*
* Show an image preview on click. Show an image preview on click.
*/ */
"preview-img": { "preview-img": {
"enabled": true, "enabled": true,
@ -191,11 +206,11 @@ var H5AI_CONFIG = {
}, },
/* /*
* Show text file preview on click. Show text file preview on click.
* "types" maps file types to SyntaxHighligher brushes. Special case: "markdown" will "types" maps file types to SyntaxHighligher brushes. Special case: "markdown" will
* be rendered as HTML. be rendered as HTML.
*
* For available brushes see http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/ For available brushes see http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/
*/ */
"preview-txt": { "preview-txt": {
"enabled": true, "enabled": true,
@ -226,7 +241,7 @@ var H5AI_CONFIG = {
}, },
/* /*
* Show QRCodes on hovering files. Show QRCodes on hovering files.
*/ */
"qrcode": { "qrcode": {
"enabled": true, "enabled": true,
@ -234,17 +249,17 @@ var H5AI_CONFIG = {
}, },
/* /*
* Make entries selectable. At the moment only needed for packaged download. Make entries selectable. At the moment only needed for packaged download.
*/ */
"select": { "select": {
"enabled": true "enabled": true
}, },
/* /*
* Default sort order is a two letter code. The first letter specifies Default sort order is a two letter code. The first letter specifies
* the column: "n" for "Name", "d" for "Date" or "s" for "Size". The the column: "n" for "Name", "d" for "Date" or "s" for "Size". The
* second letter specifies the sort order: "a" for "ascending" or "d" second letter specifies the sort order: "a" for "ascending" or "d"
* for "descending". for "descending".
*/ */
"sort": { "sort": {
"enabled": true, "enabled": true,
@ -252,19 +267,19 @@ var H5AI_CONFIG = {
}, },
/* /*
* Show additional info in a statusbar. Show additional info in a statusbar.
*/ */
"statusbar": { "statusbar": {
"enabled": true "enabled": true
}, },
/* /*
* Requires PHP on the server. Requires PHP on the server.
* Show thumbnails for image files. Needs the "/_h5ai/cache" folder to be Show thumbnails for image files. Needs the "/_h5ai/cache" folder to be
* writable for the Apache Server. writable for the Apache Server.
* - img thumbnails depend on PHP-GD - img thumbnails depend on PHP-GD
* - mov thumbnails depend on ffmpeg - mov thumbnails depend on ffmpeg
* - doc thumbnails depend on convert - doc thumbnails depend on convert
*/ */
"thumbnails": { "thumbnails": {
"enabled": true, "enabled": true,
@ -275,20 +290,20 @@ var H5AI_CONFIG = {
}, },
/* /*
* Replace window title with current breadcrumb. Replace window title with current breadcrumb.
*/ */
"title": { "title": {
"enabled": true "enabled": true
}, },
/* /*
* Show a folder tree. Show a folder tree.
* Note that this tree might have side effects as it sends HEAD requests Note that this tree might have side effects as it sends HEAD requests
* to the folders, and therefore will invoke index.php scripts. Use to the folders, and therefore will invoke index.php scripts. Use
* "folderstatus" above to avoid such requests. "folderstatus" above to avoid such requests.
* It might also affect performance significantly. It might also affect performance significantly.
*
* Slide tree bar into viewport if there is enough space. Slide tree bar into viewport if there is enough space.
*/ */
"tree": { "tree": {
"enabled": true, "enabled": true,
@ -297,9 +312,9 @@ var H5AI_CONFIG = {
}, },
/*
* File types mapped to file extensions. In alphabetical order. /*** File types mapped to file extensions. In alphabetical order. ***/
*/
"types": { "types": {
"archive": [".tar.bz2", ".tar.gz", ".tgz"], "archive": [".tar.bz2", ".tar.gz", ".tgz"],
"audio": [".aif", ".flac", ".m4a", ".mid", ".mp3", ".mpa", ".ra", ".ogg", ".wav", ".wma"], "audio": [".aif", ".flac", ".m4a", ".mid", ".mp3", ".mpa", ".ra", ".ogg", ".wav", ".wma"],
@ -369,14 +384,12 @@ var H5AI_CONFIG = {
}, },
/*
* Available translations. "en" in first place as a reference, otherwise in alphabetical order. /*** Available translations. ***/
*
* Date format is used in detailed view, for example: "YYYY-MM-DD HH:mm:ss"
* Syntax as specified by Moment.js (http://momentjs.com)
*/
"langs": { "langs": {
/* "en" in first place as a reference, otherwise in alphabetical order. */
"en": { "en": {
"lang": "english", "lang": "english",
"details": "details", "details": "details",
@ -390,7 +403,7 @@ var H5AI_CONFIG = {
"files": "files", "files": "files",
"download": "download", "download": "download",
"noMatch": "no match", "noMatch": "no match",
"dateFormat": "YYYY-MM-DD HH:mm", "dateFormat": "YYYY-MM-DD HH:mm", /* syntax as specified on http://momentjs.com */
"filter": "filter" "filter": "filter"
}, },