moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor cleanup/standardization in file list, updated docs

This commit is contained in:
Bryan Ashby 2018-07-28 15:54:48 -06:00
parent 6f84ffd708
commit 096bc5497f
2 changed files with 26 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/file_area_list.js
View File

@ -218,7 +218,7 @@ exports.getModule = class FileAreaList extends MenuModule {
const config = this.menuConfig.config; const config = this.menuConfig.config;
const currEntry = this.currentFileEntry; const currEntry = this.currentFileEntry;
const uploadTimestampFormat = config.browseUploadTimestampFormat || this.client.currentTheme.helpers.getDateFormat('short'); const uploadTimestampFormat = config.uploadTimestampFormat || this.client.currentTheme.helpers.getDateFormat('short');
const area = FileArea.getFileAreaByTag(currEntry.areaTag); const area = FileArea.getFileAreaByTag(currEntry.areaTag);
const hashTagsSep = config.hashTagsSep || ', '; const hashTagsSep = config.hashTagsSep || ', ';
const isQueuedIndicator = config.isQueuedIndicator || 'Y'; const isQueuedIndicator = config.isQueuedIndicator || 'Y';

41
docs/modding/file-area-list.md
View File

@ -6,7 +6,7 @@ title: File Area List
The built in `file_area_list` module provides a very flexible file listing UI. The built in `file_area_list` module provides a very flexible file listing UI.
## Configuration ## Configuration
### Config Block ## Config Block
Available `config` block entries: Available `config` block entries:
* `art`: Sup configuration block used to establish art files used for file browsing: * `art`: Sup configuration block used to establish art files used for file browsing:
* `browse`: The main browse screen. * `browse`: The main browse screen.
@ -24,19 +24,24 @@ Available `config` block entries:
* `webDlLinkNeedsGenerated`: Text to present when no web download link is yet generated. Defaults to "Not yet generated". * `webDlLinkNeedsGenerated`: Text to present when no web download link is yet generated. Defaults to "Not yet generated".
* `webDlLinkNoWebserver`: Text to present when no web download is available (ie: webserver not enabled). Defaults to "Web server is not enabled". * `webDlLinkNoWebserver`: Text to present when no web download is available (ie: webserver not enabled). Defaults to "Web server is not enabled".
* `notAnArchiveFormat`: Presents text for the "archive type" field for non-archives. Defaults to "Not an archive". * `notAnArchiveFormat`: Presents text for the "archive type" field for non-archives. Defaults to "Not an archive".
* `browseUploadTimestampFormat`: Timestamp format for `browseInfoFormatXXX`. Defaults to current theme → system `short` date format. See also **Browse Info Format** below. * `uploadTimestampFormat`: Timestamp format for `xxxxxxInfoFormat##`. Defaults to current theme → system `short` date format. See also **Custom Info Formats** below.
Remember that entries such as `isQueuedIndicator` and `userRatingTicked` may contain pipe color codes! Remember that entries such as `isQueuedIndicator` and `userRatingTicked` may contain pipe color codes!
### Browse Info Format ## Custom Info Formats
Additional `config` block entries used for the `browse` page are as follows: Additional `config` block entries can set `xxxxxxInfoFormat##` formatting (where xxxxxx is the page name and ## is 10...99 such as `browseInfoFormat10`) for the various available pages:
* `browseInfoFormatXXX`: Where XXX is 10..._N_ such as `browseInfoFormat10`. See **Browse Page** below for format members. * `browseInfoFormat##` for the `browse` page. See **Browse Page** below.
* `detailsInfoFormat##` for the `details` page. See **Details Page** below.
* `detailsGeneralInfoFormat##` for the `detailsGeneral` tab. See **Details Page - General Tab** below.
* `detailsNfoInfoFormat##` for the `detialsNfo` tab. See **Details Page - NFO/README Viewer Tab** below.
* `detailsFileListInfoFormat##` for the `detailsFileList` tab. See **Details Page - Archive/File Listing Tab** below.
### Theming ## Theming
#### Browse Page ### Browse Page
The browse page uses the `browse` art described above. The following MCI codes are available:
* MCI 1 (ie: `%MT1`): File's short description (user entered, FILE_ID.DIZ, etc.). * MCI 1 (ie: `%MT1`): File's short description (user entered, FILE_ID.DIZ, etc.).
* MCI 2 (ie: `%HM2`): Navigation menu. * MCI 2 (ie: `%HM2`): Navigation menu.
* MCI 10..._N_: Custom entires with the following format members: * MCI 10...99: Custom entires with the following format members:
* `{fileId}`: File identifier. * `{fileId}`: File identifier.
* `{fileName}`: File name (long). * `{fileName}`: File name (long).
* `{desc}`: File short description (user entered, FILE_ID.DIZ, etc.). * `{desc}`: File short description (user entered, FILE_ID.DIZ, etc.).
@ -67,20 +72,24 @@ Additional `config` block entries used for the `browse` page are as follows:
* `{webDlLink}`: Web download link if generated else `webDlLinkNeedsGenerated` or `webDlLinkNoWebserver` described above. * `{webDlLink}`: Web download link if generated else `webDlLinkNeedsGenerated` or `webDlLinkNoWebserver` described above.
* `{webDlExpire}`: Web download link expiration using `webDlExpireTimeFormat` described above. * `{webDlExpire}`: Web download link expiration using `webDlExpireTimeFormat` described above.
#### Details Page ### Details Page
The details page uses the `details` art described above. The following MCI codes are available:
* MCI 1 (ie: `%HM1`): Navigation menu * MCI 1 (ie: `%HM1`): Navigation menu
* `%XY2`: Info area's top X,Y position. * `%XY2`: Info area's top X,Y position.
* `%XY3`: Info area's bottom X,Y position. * `%XY3`: Info area's bottom X,Y position.
* MCI 10..._N_: Custom entries with the format options described above in **Browse Page** via the `detailsInfoFormatXXX` `config` block entry. * MCI 10...99: Custom entries with the format options described above in **Browse Page** via the `detailsInfoFormat##` `config` block entry.
#### Details Page - General Tab ### Details Page - General Tab
* MCI 10..._N_: Custom entries with the format options described above in **Browse Page** via the `detailsGeneralInfoFormatXXX` `config` block entry. The details page general tab uses the `detailsGeneral` art described above. The following MCI codes are available:
* MCI 10...99: Custom entries with the format options described above in **Browse Page** via the `detailsGeneralInfoFormat##` `config` block entry.
#### Details Page - NFO/README Viewer Tab ### Details Page - NFO/README Viewer Tab
The details page nfo tab uses the `detailsNfo` art described above. The following MCI codes are available:
* MCI 1 (ie: `%MT1`): NFO/README viewer using the entries `longDesc`. * MCI 1 (ie: `%MT1`): NFO/README viewer using the entries `longDesc`.
* MCI 10..._N_: Custom entries with the format options described above in **Browse Page** via the `detailsNfoInfoFormatXXX` `config` block entry. * MCI 10...99: Custom entries with the format options described above in **Browse Page** via the `detailsNfoInfoFormat##` `config` block entry.
#### Detilas Page - Archive/File Listing Tab ### Details Page - Archive/File Listing Tab
The details page file list tab uses the `detailsFileList` art described above. The following MCI codes are available:
* MCI 1 (ie: `%VM1`): List of entries in archive. Entries are formatted using the standard `itemFormat` and `focusItemFormat` properties of the view and have all of the format options described above in **Browse Page**. * MCI 1 (ie: `%VM1`): List of entries in archive. Entries are formatted using the standard `itemFormat` and `focusItemFormat` properties of the view and have all of the format options described above in **Browse Page**.
* MCI 10..._N_: Custom entries with the format options described above in **Browse Page** via the `detailsFileListInfoFormatXXX` `config` block entry. * MCI 10...99: Custom entries with the format options described above in **Browse Page** via the `detailsFileListInfoFormat##` `config` block entry.