Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

de.smartics.userscripts.confluence.userscript-admin-tool
Document Properties Marker
doctypeapp-scripttool
overridefalse


Short Description
Search
A graphical tool to create, search, and edit userscripts.
NameUserscript Admin Tool
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
value

production

released

hide
Identifier
Type

Name List
doctypeapp-

script

tool-type
render-no-hits-as-blanktrue
names

Confluence Userscript

Dialog
property-restrict-value-rangetrue
propertyType


Suite
Name List
doctypeapp, app-extension, product-space
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
defaults-toancestor
propertySuite
hide
App Tool
Name List
doctypeapp-tool
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
defaults-toancestor
propertyApp Tool
Repository

System Link
file/src/main/resources/de/smartics/projectdoc/confluence/userscript-admin-tool.js
system-idurl-project-community-raw
labeluserscript-admin-tool.js
titleThe source code of the script on Bitbucket.

hideDownload
Attachment Link Macro
downloadCode
labelCode
hide

Since1.0
Deprecated
Removed
Sort Keyhide



Section
show-titlefalse
titleDescription

The Userscript Admin Tool provides a simple user interface to create, search, and edit 

Static Document Link
documentUserscript (Glossary)
labeluserscripts
installed on the local Confluence server.

From your idea to implementation on your Confluence server in a flash.


Section
The code of the script for reference
titleCodeintro-textUserscript

A userscript is configured with the following properties.

projectdoc-

ref-attachment-code-block-placeholder-macro
propertyDownload
Text Snippet
propertyRepository
Section
titleParameters

display-list
doctypeglossary-item
list-typeunnumbered
sort-by#BREADTH_FIRST
render-short-descriptiontrue
where$<DirectAncestorTitle>=[Userscript (Glossary)]
render

Display Tabledoctypeapp-parameterrender-no-hits-as-blanktrueselectName, Descriptionrestrict-to-immediate

-childrentrue

render

select-for-

classesparameters-table, display-table, parameters

nameShort Name


More information on using this userscript.
Section
titleStandard Input
Section
User Interface

The tool provides two functions.

  • The search tool allows to find existing userscripts
  • The editor allows to create or edit userscripts
titleDetails
intro-text
Section
titleUserscript Search

Installed userscripts can be found with the Userscript Search Dialog.

Screenshot shows the Userscript Search Dialog with one hit.

Per default the search dialog will open on clicking the shortcut 'qq'.

By clicking on a row of the hitlist the Userscript Editor Dialog opens.

The Create Button opens the Userscript Editor Dialog with an empty form. 


Section
titleUserscript Editor

The editor renders the property of the selected userscript.

Screenshot showing the Userscript Editor Dialog with a loaded Userscript.

With the editor the script may be altered or deleted.

You may also clear the form and create a new userscript. If the new userscript should be based on the userscript shown, click Reuse Form. Reusing the form detaches the current userscript and allows to edit the information and save a new userscript.

The find button allows to specify the namespace and name and retrieve the latest version for the userscript. Note that the form will be populated with the information form that userscript, overriding the current field values in the form.



Section
titleRelated ScriptsDetails
intro-textMore information on using this tool.


Section
titleStyling

The highlighting of a row on hover in the search results can be configured via a style sheet.

Code Block
languagecss
table.aui > tbody > tr.userscript-table-row.highlight {
  background-color: aliceblue;
}

To override the default, be more specific with .userscript-highlight.

Code Block
languagecss
table.aui > tbody > tr.userscript-table-row.highlight.userscript-highlight {
  background-color: darkblue;
  color: white;
}




Section
titleComponents
app-script
Display Table
Display Table
doctype
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
render-classesrelated-scriptscomponents-table, display-table, related-scriptscomponents
where$<Tags>~(${Tags$<projectdoc.doctype.app.app-tool> ~ (${Name},${Short Name})



Section
ignore-template-buttonstrue
titleSubordinate ScriptsApp Tools


Hide From Reader

Create from template
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-doctype-addon-app:projectdoc-blueprint-doctype-app-scripttool
buttonLabelCreate ScriptApp Tool

Display Table
doctypeapp-

script

tool
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
render-classeschildren-table, display-table, children


Section
required-permissionswrite-access
titleNotes

...

Section
titleResources
intro-textMore information on this topic is available by the following resources.


Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue


TitleShort Description
Managing Userscripts