Versions Compared

Key

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

...

Document Properties Marker
doctypeapp-script
overridefalse


Short DescriptionRenders a vertical banner on the left side of a Confluence page.
NameVertical Banner
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
namesIdentify Context
propertyTags


Flagshide
Iteration

Iteration
valueproduction

hide
Identifierde.smartics.userscripts.confluence.vertical-banner
Type

Name List
doctypeapp-script-type
render-no-hits-as-blanktrue
namesConfluence Userscript
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/projectdoc-bookmarklets-and-userscripts/raw/e6886c05befcc3505dd5dbc2526951c6bddf6743/src/main/resources/de/smartics/projectdoc/confluence/vertical-banner.js
system-idbitbucket-smarticsurl-project-community-raw
labelvertical-banner.js
titleThe source code of the script on Bitbucket.


Download
Attachment Link Macro
downloadCode
labelCode

Since1.0
Deprecated
Removed
Sort Keyhide


...

Section
show-titlefalse
titleDescription

The script renders a vertical banner with the name of the space on the left side of every page.

The banner contains text if the padding of the page is larger than the given threshold. If not, the banner is only a few pixel wide in the specified color.

All style information is hard coded to the script.


Section
titleCode
intro-textThe code of the script for reference.
Reference Attachment Code Block Placeholder
propertyDownload
Text Snippet
propertyRepository

...

Section
titleDetails

More information on using this userscript.

Section
titleBanner Rendering

If the page provides enough padding, the banner contains the name of space. If the padding is too thin, only a thin line is rendered.

Screenshot showing the banner with the space name on the left.Image RemovedScreenshot showing the banner with the space name on the left.Image Added Screenshot showing the banner without a label on the left.Image RemovedScreenshot showing the banner without label on the left.Image Added


Section
titleConfiguration of Userscript

Typically the banner is not required for every space of a Confluence site. To activate the script for specific spaces, the 

Static Document Link
documentuserscripts:Userscripts Administrator
to-lower-casetrue
 may define a space category, like banner, to be set.

Screenshot of the REST API Browser with the configuration for this userscript.Image RemovedScreenshot of the REST API Browser with the configuration for this userscript.Image Added

Configure the space category via the Space Tools.

Screenshot with Space Details on Space Tools.Image RemovedScreenshot with Space Details on Space Tools.Image Added

Once the categories contain a category 'banner', as specified in the 

Static Document Link
documentuserscripts:Activation Record
to-lower-casetrue
 via activation-space-categories, the banner will be shown on every page of that space.


...

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