projectdoc Toolbox

Sample script to register actions with a shortcut in Confluence.

Tags
Identifier
de.smartics.userscripts.confluence.install-shortcuts
Type
Repository
Since
1.0

The userscipt shows how users can configure shortcuts with Confluence to map their most used actions to their keyboard.

Code

The code of the script for reference.

install-shortcuts.js
/*
 * Copyright 2019-2024 Kronseder & Reiner GmbH, smartics
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
"use strict";

AJS.toInit(function () {
  const logToConsole = false;

  if (logToConsole) {
    AJS.log("[install-shortcuts] Starting to install shortcuts ...");
  }

  const logInstall = function(name, shortcut, url) {
    if (logToConsole) AJS.log(AJS.format("[install-shortcuts] Installing shortcut to {0} to {1}: {2}", name, shortcut, url));
  }

  const baseUrl = AJS.Meta.get('base-url');

  const restApiBrowserUrl = baseUrl + "/plugins/servlet/restbrowser#/";
  const restApiBrowserShortcut = "22";
  logInstall("REST API Browser", restApiBrowserShortcut, restApiBrowserUrl);
  AJS.whenIType(restApiBrowserShortcut).goTo(restApiBrowserUrl);

  const userscriptShortcut = "qq";
  logInstall("Userscript Admin Tool", userscriptShortcut, "JavaScript call");
  AJS.whenIType(userscriptShortcut).click("#userscripts-admin-tool");
});

Related Scripts

NameShort Description
Copy Page ID
Binds copying the identifier of the current page to a keystroke.
Hello World
Simply renders "Hello World!" to the browser's console.