diff --git a/client/index.html b/client/index.html index 2c6b7b78..b22b180e 100644 --- a/client/index.html +++ b/client/index.html @@ -82,491 +82,7 @@
- -
-
- -
-
-

Help

- -

Keyboard Shortcuts

- -
-
- Ctrl⌘ + ↑ / ↓ -
-
-

Switch to the previous/next window in the channel list

-
-
- -
-
- Ctrl⌘ + K -
-
-

- Mark any text typed after this shortcut to be colored. After - hitting this shortcut, enter an integer in the range - 0—15 to select the desired color, or use the - autocompletion menu to choose a color name (see below). -

-

- Background color can be specified by putting a comma and - another integer in the range 0—15 after the - foreground color number (autocompletion works too). -

-

- A color reference can be found - here. -

-
-
- -
-
- Ctrl⌘ + B -
-
-

Mark all text typed after this shortcut as bold.

-
-
- -
-
- Ctrl⌘ + U -
-
-

Mark all text typed after this shortcut as underlined.

-
-
- -
-
- Ctrl⌘ + I -
-
-

Mark all text typed after this shortcut as italics.

-
-
- -
-
- Ctrl⌘ + O -
-
-

- Mark all text typed after this shortcut to be reset to its - original formatting. -

-
-
- -

Autocompletion

- -

- To auto-complete nicknames, channels, commands, and emoji, type one of the characters below to open - a suggestion list. Use the ↑ and ↓ keys to highlight an item, and insert it by - pressing Tab or Enter (or by clicking the desired item). -

-

- Autocompletion can be disabled in settings. -

- -
-
- @ -
-
-

Nickname

-
-
- -
-
- # -
-
-

Channel

-
-
- -
-
- / -
-
-

Commands (see list of commands below)

-
-
- -
-
- : -
-
-

Emoji (note: requires two search characters, to avoid conflicting with common emoticons like :))

-
-
- -

Commands

- -
-
- /away [message] -
-
-

Mark yourself as away with an optional message.

-
-
- -
-
- /back -
-
-

Remove your away status (set with /away).

-
-
- -
-
- /ban nick -
-
-

Ban (+b) a user from the current channel. - This can be a nickname or a hostmask.

-
-
- -
-
- /banlist -
-
-

Load the banlist for the current channel.

-
-
- -
-
- /collapse -
-
-

- Collapse all previews in the current channel (opposite of - /expand) -

-
-
- -
-
- /connect host [port] -
-
-

- Connect to a new IRC network. If port starts with - a + sign, the connection will be made secure - using TLS. -

-

Alias: /server

-
-
- -
-
- /ctcp target cmd [args] -
-
-

- Send a CTCP - request. Read more about this on - the dedicated Wikipedia article. -

-
-
- -
-
- /deop nick [...nick] -
-
-

- Remove op (-o) from one or several users in the - current channel. -

-
-
- -
-
- /devoice nick [...nick] -
-
-

- Remove voice (-v) from one or several users in - the current channel. -

-
-
- -
-
- /disconnect [message] -
-
-

- Disconnect from the current network with an - optionally-provided message. -

-
-
- -
-
- /expand -
-
-

- Expand all previews in the current channel (opposite of - /collapse) -

-
-
- -
-
- /invite nick [channel] -
-
-

- Invite a user to the specified channel. If - channel is ommitted, user will be invited to the - current channel. -

-
-
- -
-
- /join channel -
-
-

Join a channel.

-
-
- -
-
- /kick nick -
-
-

Kick a user from the current channel.

-
-
- -
-
- /list -
-
-

Retrieve a list of available channels on this network.

-
-
- -
-
- /me message -
-
-

- Send an action message to the current channel. The Lounge will - display it inline, as if the message was posted in the third - person. -

-
-
- -
-
- /mode flags [args] -
-
-

- Set the given flags to the current channel if the active - window is a channel, another user if the active window is a - private message window, or yourself if the current window is a - server window. -

-
-
- -
-
- /msg channel message -
-
-

Send a message to the specified channel.

-
-
- -
-
- /nick newnick -
-
-

Change your nickname on the current network.

-
-
- -
-
- /notice channel message -
-
-

Sends a notice message to the specified channel.

-
-
- -
-
- /op nick [...nick] -
-
-

- Give op (+o) to one or several users in the - current channel. -

-
-
- -
-
- /part [channel] -
-
-

- Close the specified channel or private message window, or the - current channel if channel is ommitted. -

-

Aliases: /close, /leave

-
-
- -
-
- /rejoin -
-
-

- Leave and immediately rejoin the current channel. Useful to - quickly get op from ChanServ in an empty channel, for example. -

-

Alias: /cycle

-
-
- -
-
- /query nick -
-
-

Send a private message to the specified user.

-
-
- -
-
- /quit [message] -
-
-

- Disconnect from the current network with an optional message. -

-
-
- -
-
- /raw message -
-
-

Send a raw message to the current IRC network.

-

Aliases: /quote, /send

-
-
- -
-
- /slap nick -
-
-

Slap someone in the current channel with a trout!

-
-
- -
-
- /topic newtopic -
-
-

Set the topic in the current channel.

-
-
- -
-
- /unban nick -
-
-

Unban (-b) a user from the current channel. - This can be a nickname or a hostmask.

-
-
- -
-
- /voice nick [...nick] -
-
-

- Give voice (+v) to one or several users in the - current channel. -

-
-
- -
-
- /whois nick -
-
-

- Retrieve information about the given user on the current - network. -

-
-
- -

About The Lounge

- -

- {{#if gitCommit}} - The Lounge is running from source - ({{ gitCommit }}).
- {{else}} - The Lounge is in version {{version}} - (See release notes).
- {{/if}} - - Website
- Documentation
- Report a bug -

-
-
+
diff --git a/client/js/socket-events/configuration.js b/client/js/socket-events/configuration.js index dc5d996f..fd687a7b 100644 --- a/client/js/socket-events/configuration.js +++ b/client/js/socket-events/configuration.js @@ -13,6 +13,7 @@ socket.on("configuration", function(data) { $("#settings").html(templates.windows.settings(data)); $("#connect").html(templates.windows.connect(data)); + $("#help").html(templates.windows.help(data)); $("#play").on("click", () => { const pop = new Audio(); diff --git a/client/views/index.js b/client/views/index.js index 55a8266e..267f0691 100644 --- a/client/views/index.js +++ b/client/views/index.js @@ -24,6 +24,7 @@ module.exports = { sign_in: require("./windows/sign_in.tpl"), settings: require("./windows/settings.tpl"), connect: require("./windows/connect.tpl"), + help: require("./windows/help.tpl"), }, chan: require("./chan.tpl"), diff --git a/client/views/windows/help.tpl b/client/views/windows/help.tpl new file mode 100644 index 00000000..6db8d46d --- /dev/null +++ b/client/views/windows/help.tpl @@ -0,0 +1,482 @@ +
+ +
+
+

Help

+ +

Keyboard Shortcuts

+ +
+
+ Ctrl⌘ + ↑ / ↓ +
+
+

Switch to the previous/next window in the channel list

+
+
+ +
+
+ Ctrl⌘ + K +
+
+

+ Mark any text typed after this shortcut to be colored. After + hitting this shortcut, enter an integer in the range + 0—15 to select the desired color, or use the + autocompletion menu to choose a color name (see below). +

+

+ Background color can be specified by putting a comma and + another integer in the range 0—15 after the + foreground color number (autocompletion works too). +

+

+ A color reference can be found + here. +

+
+
+ +
+
+ Ctrl⌘ + B +
+
+

Mark all text typed after this shortcut as bold.

+
+
+ +
+
+ Ctrl⌘ + U +
+
+

Mark all text typed after this shortcut as underlined.

+
+
+ +
+
+ Ctrl⌘ + I +
+
+

Mark all text typed after this shortcut as italics.

+
+
+ +
+
+ Ctrl⌘ + O +
+
+

+ Mark all text typed after this shortcut to be reset to its + original formatting. +

+
+
+ +

Autocompletion

+ +

+ To auto-complete nicknames, channels, commands, and emoji, type one of the characters below to open + a suggestion list. Use the ↑ and ↓ keys to highlight an item, and insert it by + pressing Tab or Enter (or by clicking the desired item). +

+

+ Autocompletion can be disabled in settings. +

+ +
+
+ @ +
+
+

Nickname

+
+
+ +
+
+ # +
+
+

Channel

+
+
+ +
+
+ / +
+
+

Commands (see list of commands below)

+
+
+ +
+
+ : +
+
+

Emoji (note: requires two search characters, to avoid conflicting with common emoticons like :))

+
+
+ +

Commands

+ +
+
+ /away [message] +
+
+

Mark yourself as away with an optional message.

+
+
+ +
+
+ /back +
+
+

Remove your away status (set with /away).

+
+
+ +
+
+ /ban nick +
+
+

Ban (+b) a user from the current channel. + This can be a nickname or a hostmask.

+
+
+ +
+
+ /banlist +
+
+

Load the banlist for the current channel.

+
+
+ +
+
+ /collapse +
+
+

+ Collapse all previews in the current channel (opposite of + /expand) +

+
+
+ +
+
+ /connect host [port] +
+
+

+ Connect to a new IRC network. If port starts with + a + sign, the connection will be made secure + using TLS. +

+

Alias: /server

+
+
+ +
+
+ /ctcp target cmd [args] +
+
+

+ Send a CTCP + request. Read more about this on + the dedicated Wikipedia article. +

+
+
+ +
+
+ /deop nick [...nick] +
+
+

+ Remove op (-o) from one or several users in the + current channel. +

+
+
+ +
+
+ /devoice nick [...nick] +
+
+

+ Remove voice (-v) from one or several users in + the current channel. +

+
+
+ +
+
+ /disconnect [message] +
+
+

+ Disconnect from the current network with an + optionally-provided message. +

+
+
+ +
+
+ /expand +
+
+

+ Expand all previews in the current channel (opposite of + /collapse) +

+
+
+ +
+
+ /invite nick [channel] +
+
+

+ Invite a user to the specified channel. If + channel is ommitted, user will be invited to the + current channel. +

+
+
+ +
+
+ /join channel +
+
+

Join a channel.

+
+
+ +
+
+ /kick nick +
+
+

Kick a user from the current channel.

+
+
+ +
+
+ /list +
+
+

Retrieve a list of available channels on this network.

+
+
+ +
+
+ /me message +
+
+

+ Send an action message to the current channel. The Lounge will + display it inline, as if the message was posted in the third + person. +

+
+
+ +
+
+ /mode flags [args] +
+
+

+ Set the given flags to the current channel if the active + window is a channel, another user if the active window is a + private message window, or yourself if the current window is a + server window. +

+
+
+ +
+
+ /msg channel message +
+
+

Send a message to the specified channel.

+
+
+ +
+
+ /nick newnick +
+
+

Change your nickname on the current network.

+
+
+ +
+
+ /notice channel message +
+
+

Sends a notice message to the specified channel.

+
+
+ +
+
+ /op nick [...nick] +
+
+

+ Give op (+o) to one or several users in the + current channel. +

+
+
+ +
+
+ /part [channel] +
+
+

+ Close the specified channel or private message window, or the + current channel if channel is ommitted. +

+

Aliases: /close, /leave

+
+
+ +
+
+ /rejoin +
+
+

+ Leave and immediately rejoin the current channel. Useful to + quickly get op from ChanServ in an empty channel, for example. +

+

Alias: /cycle

+
+
+ +
+
+ /query nick +
+
+

Send a private message to the specified user.

+
+
+ +
+
+ /quit [message] +
+
+

+ Disconnect from the current network with an optional message. +

+
+
+ +
+
+ /raw message +
+
+

Send a raw message to the current IRC network.

+

Aliases: /quote, /send

+
+
+ +
+
+ /slap nick +
+
+

Slap someone in the current channel with a trout!

+
+
+ +
+
+ /topic newtopic +
+
+

Set the topic in the current channel.

+
+
+ +
+
+ /unban nick +
+
+

Unban (-b) a user from the current channel. + This can be a nickname or a hostmask.

+
+
+ +
+
+ /voice nick [...nick] +
+
+

+ Give voice (+v) to one or several users in the + current channel. +

+
+
+ +
+
+ /whois nick +
+
+

+ Retrieve information about the given user on the current + network. +

+
+
+ +

About The Lounge

+ +

+ {{#if gitCommit}} + The Lounge is running from source + ({{ gitCommit }}).
+ {{else}} + The Lounge is in version {{version}} + (See release notes).
+ {{/if}} + + Website
+ Documentation
+ Report a bug +

+
diff --git a/src/server.js b/src/server.js index 5550aae6..34305c4b 100644 --- a/src/server.js +++ b/src/server.js @@ -205,12 +205,6 @@ function index(req, res, next) { return next(); } - var data = _.merge( - pkg, - Helper.config - ); - data.gitCommit = Helper.getGitCommit(); - const policies = [ "default-src *", "connect-src 'self' ws: wss:", @@ -229,7 +223,7 @@ function index(req, res, next) { res.setHeader("Content-Security-Policy", policies.join("; ")); res.setHeader("Referrer-Policy", "no-referrer"); - res.render("index", data); + res.render("index", Helper.config); } function initializeClient(socket, client, token, lastMessage) { @@ -478,6 +472,7 @@ function getClientConfiguration() { ]); config.ldapEnabled = Helper.config.ldap.enable; + config.version = pkg.version; config.gitCommit = Helper.getGitCommit(); config.themes = themes.getAll();