File Transfer protocol: use itemFormat + docs

This commit is contained in:
Bryan Ashby 2018-11-05 21:54:04 -07:00
parent 5286c52a26
commit 047d8fae89
4 changed files with 18 additions and 12 deletions

View File

@ -912,17 +912,14 @@
} }
fileTransferProtocolSelection: { fileTransferProtocolSelection: {
config: {
protListFormat: "|00|03{name}"
protListFocusFormat: "|00|19|15{name}"
}
0: { 0: {
mci: { mci: {
VM1: { VM1: {
height: 15 height: 15
width: 30 width: 30
focusTextStyle: first lower focusTextStyle: first lower
itemFormat: "|00|03{name}"
focusItemFormat: "|00|19|15{name}"
} }
} }
} }

View File

@ -4,7 +4,6 @@
// enigma-bbs // enigma-bbs
const MenuModule = require('./menu_module.js').MenuModule; const MenuModule = require('./menu_module.js').MenuModule;
const Config = require('./config.js').get; const Config = require('./config.js').get;
const stringFormat = require('./string_format.js');
const ViewController = require('./view_controller.js').ViewController; const ViewController = require('./view_controller.js').ViewController;
// deps // deps
@ -110,12 +109,7 @@ exports.getModule = class FileTransferProtocolSelectModule extends MenuModule {
function populateList(callback) { function populateList(callback) {
const protListView = vc.getView(MciViewIds.protList); const protListView = vc.getView(MciViewIds.protList);
const protListFormat = self.config.protListFormat || '{name}'; protListView.setItems(self.protocols);
const protListFocusFormat = self.config.protListFocusFormat || protListFormat;
protListView.setItems(self.protocols.map(p => stringFormat(protListFormat, p) ) );
protListView.setFocusItems(self.protocols.map(p => stringFormat(protListFocusFormat, p) ) );
protListView.redraw(); protListView.redraw();
return callback(null); return callback(null);
@ -131,6 +125,7 @@ exports.getModule = class FileTransferProtocolSelectModule extends MenuModule {
loadAvailProtocols() { loadAvailProtocols() {
this.protocols = _.map(Config().fileTransferProtocols, (protInfo, protocol) => { this.protocols = _.map(Config().fileTransferProtocols, (protInfo, protocol) => {
return { return {
text : protInfo.name, // standard
protocol : protocol, protocol : protocol,
name : protInfo.name, name : protInfo.name,
hasBatch : _.has(protInfo, 'external.recvArgs'), hasBatch : _.has(protInfo, 'external.recvArgs'),

View File

@ -71,6 +71,7 @@
- [Message Area List]({{ site.baseurl }}{% link modding/msg-area-list.md %}) - [Message Area List]({{ site.baseurl }}{% link modding/msg-area-list.md %})
- [BBS List]({{ site.baseurl }}{% link modding/bbs-list.md %}) - [BBS List]({{ site.baseurl }}{% link modding/bbs-list.md %})
- [Rumorz]({{ site.baseurl }}{% link modding/rumorz.md %}) - [Rumorz]({{ site.baseurl }}{% link modding/rumorz.md %})
- [File Transfer Protocol Select]({{ site.baseurl }}{% link modding/file-transfer-protocol-select.md %})
- Administration - Administration
- [oputil]({{ site.baseurl }}{% link admin/oputil.md %}) - [oputil]({{ site.baseurl }}{% link admin/oputil.md %})

View File

@ -0,0 +1,13 @@
---
layout: page
title: File Transfer Protocol Select
---
## The Rumorz Module
The built in `file_transfer_protocol_select` module provides a way to select a legacy file transfer protocol (X/Y/Z-Modem, etc.) for upload/downloads.
## Configuration
### Theming
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`) (the protocol list):
* `name`: The name of the protocol. Each entry is +op defined in `config.hjson` with defaults found in `config.js`. Note that the standard `{text}` field also contains this value.