mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-01-09 06:24:12 +01:00
Add some rough documentation for config.js properties.
This commit is contained in:
@@ -27,30 +27,88 @@ the terms of any one of the MPL, the GPL or the LGPL.
|
|||||||
}}} ***** END LICENSE BLOCK *****/
|
}}} ***** END LICENSE BLOCK *****/
|
||||||
|
|
||||||
const configbase = { //{{{
|
const configbase = { //{{{
|
||||||
|
/**
|
||||||
|
* @property {[["string", "string"]]} A sequence of names and descriptions
|
||||||
|
* of the autocommands available in this application. Primarily used
|
||||||
|
* for completion results.
|
||||||
|
*/
|
||||||
autocommands: [],
|
autocommands: [],
|
||||||
|
|
||||||
get browserModes() [modes.NORMAL],
|
get browserModes() [modes.NORMAL],
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {object} Application specific defaults for option values. The
|
||||||
|
* property names must be the options' cannonical names, and the values
|
||||||
|
* must be strings as entered via :set.
|
||||||
|
*/
|
||||||
defaults: { guioptions: "rb" },
|
defaults: { guioptions: "rb" },
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {[["string", "string", "function"]]} An array of
|
||||||
|
* dialogs available via the :dialog command.
|
||||||
|
* [0] name - The name of the dialog, used as the first
|
||||||
|
* argument to :dialog.
|
||||||
|
* [1] description - A description of the dialog, used in
|
||||||
|
* command completion results for :dialog.
|
||||||
|
* [2] action - The function executed by :dialog.
|
||||||
|
*/
|
||||||
dialogs: [],
|
dialogs: [],
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {string[]} A list of features available in this
|
||||||
|
* application. Used extensively in feature test macros. Use
|
||||||
|
* liberator.has(feature) to check for a feature's presense
|
||||||
|
* in this array.
|
||||||
|
*/
|
||||||
features: [],
|
features: [],
|
||||||
|
|
||||||
guioptions: {},
|
guioptions: {},
|
||||||
|
|
||||||
hasTabbrowser: false,
|
hasTabbrowser: false,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {string} The name of the application that hosts the
|
||||||
|
* “liberated” application. E.g., "Firefox" or "Xulrunner".
|
||||||
|
*/
|
||||||
|
hostApplication: null,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {[string]} A list of HTML help files available under
|
||||||
|
* chrome://liberator/locale/. Used to generate help tag indeces for
|
||||||
|
* the :help command.
|
||||||
|
*/
|
||||||
helpFiles: [],
|
helpFiles: [],
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {function} Called on liberator startup to allow for any
|
||||||
|
* arbitrary application-specific initialization code.
|
||||||
|
*/
|
||||||
init: function () {},
|
init: function () {},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {object} A map between key names for key events should be ignored,
|
||||||
|
* and a mask of the modes in which they shoule be ignored.
|
||||||
|
*/
|
||||||
ignoreKeys: {},
|
ignoreKeys: {},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {[[]]} An array of application specific mode specifications.
|
||||||
|
* The values of each mode are passed to modes.addMode during
|
||||||
|
* liberator startup.
|
||||||
|
*/
|
||||||
modes: [],
|
modes: [],
|
||||||
|
|
||||||
optionDefaults: {},
|
/**
|
||||||
|
* @property {string} The name of “liberated” application.
|
||||||
|
* Required.
|
||||||
|
*/
|
||||||
|
name: null,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {[string]} A list of extra scripts in the liberator or
|
||||||
|
* application namespaces which should be loaded before liberator
|
||||||
|
* initialization.
|
||||||
|
*/
|
||||||
scripts: [],
|
scripts: [],
|
||||||
}; //}}}
|
}; //}}}
|
||||||
|
|
||||||
|
|||||||
@@ -119,7 +119,7 @@ function Tabs() //{{{
|
|||||||
|
|
||||||
options.add(["showtabline", "stal"],
|
options.add(["showtabline", "stal"],
|
||||||
"Control when to show the tab bar of opened web pages",
|
"Control when to show the tab bar of opened web pages",
|
||||||
"number", config.optionDefaults["showtabline"],
|
"number", config.defaults["showtabline"],
|
||||||
{
|
{
|
||||||
setter: function (value)
|
setter: function (value)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -33,7 +33,10 @@ const config = { //{{{
|
|||||||
|
|
||||||
/*** optional options, there are checked for existence and a fallback provided ***/
|
/*** optional options, there are checked for existence and a fallback provided ***/
|
||||||
features: ["hints", "mail", "marks", "addressbook", "tabs"],
|
features: ["hints", "mail", "marks", "addressbook", "tabs"],
|
||||||
defaults: { guioptions: "frb" },
|
defaults: {
|
||||||
|
guioptions: "frb",
|
||||||
|
showtabline: 1,
|
||||||
|
},
|
||||||
|
|
||||||
guioptions: {
|
guioptions: {
|
||||||
m: ["MenuBar", ["mail-toolbar-menubar2"]],
|
m: ["MenuBar", ["mail-toolbar-menubar2"]],
|
||||||
@@ -128,10 +131,6 @@ const config = { //{{{
|
|||||||
["COMPOSE"]
|
["COMPOSE"]
|
||||||
],
|
],
|
||||||
|
|
||||||
optionDefaults: {
|
|
||||||
showtabline: 1,
|
|
||||||
},
|
|
||||||
|
|
||||||
scripts: [
|
scripts: [
|
||||||
"addressbook.js",
|
"addressbook.js",
|
||||||
"mail.js",
|
"mail.js",
|
||||||
|
|||||||
@@ -33,7 +33,10 @@ const config = { //{{{
|
|||||||
|
|
||||||
/*** optional options, there are checked for existence and a fallback provided ***/
|
/*** optional options, there are checked for existence and a fallback provided ***/
|
||||||
features: ["bookmarks", "hints", "history", "marks", "quickmarks", "session", "tabs", "windows"],
|
features: ["bookmarks", "hints", "history", "marks", "quickmarks", "session", "tabs", "windows"],
|
||||||
defaults: { guioptions: "rb" },
|
defaults: {
|
||||||
|
guioptions: "rb",
|
||||||
|
showtabline: 2,
|
||||||
|
},
|
||||||
|
|
||||||
guioptions: {
|
guioptions: {
|
||||||
m: ["Menubar", ["toolbar-menubar"]],
|
m: ["Menubar", ["toolbar-menubar"]],
|
||||||
@@ -132,10 +135,6 @@ const config = { //{{{
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
optionDefaults: {
|
|
||||||
showtabline: 2,
|
|
||||||
},
|
|
||||||
|
|
||||||
scripts: [
|
scripts: [
|
||||||
"bookmarks.js",
|
"bookmarks.js",
|
||||||
"tabs.js",
|
"tabs.js",
|
||||||
|
|||||||
@@ -33,7 +33,10 @@ const config = { //{{{
|
|||||||
//mainWindowID: "mainplayer",
|
//mainWindowID: "mainplayer",
|
||||||
/*** optional options, there are checked for existence and a fallback provided ***/
|
/*** optional options, there are checked for existence and a fallback provided ***/
|
||||||
features: ["bookmarks", "hints", "marks", "history", "quickmarks", "session", "tabs", "windows", "player"],
|
features: ["bookmarks", "hints", "marks", "history", "quickmarks", "session", "tabs", "windows", "player"],
|
||||||
defaults: { guioptions: "mprb" },
|
defaults: {
|
||||||
|
guioptions: "mprb",
|
||||||
|
showtabline: 2,
|
||||||
|
},
|
||||||
|
|
||||||
guioptions: {
|
guioptions: {
|
||||||
m: ["Menubar", ["main-menubar"]],
|
m: ["Menubar", ["main-menubar"]],
|
||||||
@@ -175,10 +178,6 @@ const config = { //{{{
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
optionDefaults: {
|
|
||||||
showtabline: 2,
|
|
||||||
},
|
|
||||||
|
|
||||||
scripts: [
|
scripts: [
|
||||||
"bookmarks.js",
|
"bookmarks.js",
|
||||||
"tabs.js",
|
"tabs.js",
|
||||||
|
|||||||
Reference in New Issue
Block a user