Hide projectdoc Tools within Browser

...

Document Properties Marker

doctype	topic
override	false

Short Description

The projectdoc Toolbox installs a lot of macros and additional doctype add-ons install a lot of doctypes. This tips shows ways that allow to remove the projectdoc tools from the current page.

Name

Hide projectdoc Tools within Browser

hide

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property-restrict-value-range	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Userscript

System Link

file	/projectdoc-bookmarklets/raw/master/src/main/resources/de/smartics/projectdoc/userscripts/Hide%20projectdoc%20Tools.user.js
system-id	bitbucket-smartics
label	Hide projectdoc Tools.user.js

hide

Sort Key

hide

...

Section

title	Prerequisites

For bookmarklets there are no prerequisites.

For userscripts the browser needs to install a plugin a userscript manager like Grease Monkey or Tampermonkey that build must be installed to the browser. The userscript manager builds the context in which the script is executed.

...

Section

title	Common Approach

The common approach to both solutions is that a JavaScript is run in the browser that matches HTML elements and alters them to be hidden. Therefore all elements are rendered as normal and then are hidden by the script.

Content Marker

id	screenshots

projectdoc-content-marker

id	screenshots-bookmarklet

Section

Column

width	50%

Panel

title	Space Blueprint Wizard with projectdoc Blueprints

Image Added

Column

width	50%

Panel

title	Space Blueprint Wizard without projectdoc Blueprints

Image Added

Section

Column

width	50%

Panel

title	Page Blueprint Wizard with projectdoc Blueprints

Screenshot showing the Blueprint Wizard with projectdoc Blueprints Image Added

Column

width	50%

Panel

title	Page Blueprint Wizard without projectdoc Blueprints

Screenshot showing the Blueprint Wizard without projectdoc Blueprints Image Added

Section

Column

width	50%

Panel

title	Macro Browser with projectdoc Macros

Screenshot showing the Macro Browser with projectdoc Macros Image Added

Column

width	50%

Panel

title	Macro Browser without projectdoc Macros

Screenshot showing the Macro Browser without projectdoc Macros Image Added

Section

Column

width	50%

Panel

title	Macro Suggestions with projectdoc Macros

Screenshot showing the Macro Suggestions with projectdoc Macros Image Added

Panel

title	Macro Suggestions without projectdoc Macros

Column

width	50%

Macro Suggestions without projectdoc Macros Image Added

Note that this use case is not properly supported the bookmarklet. A user will probably not run the bookmarklet manually when using the autocomplete function to select a macro.

Note Box

title	Hide selectively?

The following examples show how to remove all macros or doctypes from the view.

In case you need to remove these tools selectively, you would need to adjust the CSS selectors in the scripts.

Section

title	Bookmarklet Solution

The bookmarklet solution is easily installed as a bookmark in a browser. The advantage is that no additional tools are required. The disadvantage is that the user needs to open the bookmarklet to remove the elements from the page manually each time.

This solution may be appropriate in case the user only occasionally wants to remove the element.

Transclusion

document	Hide projectdoc Tools
ids	Code

For more information on the bookmarklet, please visit Hide projectdoc Tools within Browser.

Section

title	Userscript Solution

The userscript can be configured to be automatically executed on every page whose URL matches a regular expression. This way a user may select the script to remove element only on certain spaces, while leave them untouched on others.

A userscript is a JavaScript script with some metadata. It may also use services provided by the userscript manager context.

Text Snippet

property	Userscript

The following screenshot shows the script installed with Tampermonkey.

Image Removed Screenshot showing the installed userscript in with Tampermonkey Image Added

You may want to edit the script and adjust the match URL to your Confluence server.

Code Block

language	js

// @match        https://*/confluence/*

The browser plugin may also take care of automatically update the scripts. The source of the script could be hosted in a controlled environment. We recommend to copy the script to your server and alter it to meet your specific requirements.

For more information on the userscript, please visit Hide projectdoc Tools.

projectdoc-section

title	Deactivation of Blueprints

As mentioned in the introduction, blueprints can be deactivated in your Confluence instance.

This short example walks you through the steps to deactivate the projectdoc Blank Document Doctype. This doctype is a meant as a simple starter for new users. Once the team uses the Core Doctypes or has designed their own doctypes, this doctype is no longer needed.

Caution Box

title	Internal Problems after deactivating Module?

If modules are deactivated, the space blueprint wizard may fail. This is related to Space Wizard Dialog fails after deactivating Add-on.

So in case you have deactivated modules you may want to check if the space wizard dialog still opens.

As an admin, go to Manage apps
Select the app that contains the blueprint you want to deactivate
Image Added
Open the list of modules by clicking on the plus sign
Image Added
Deactivate the following modules for each doctype: The doctype template, the home and index page template, the blueprint and the wizard module.
Image Added

For information on how to control blueprints on space level, please refer to the tip Overwhelmed with Blueprints?.

Section

ignore-template-buttons	true
title	Subordinate Topics

Hide From Reader

Create from template

blueprintModuleCompleteKey	de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-topic
buttonLabel	Create Topic

Display Table

doctype	topic
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Section

title	Resources

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description
Hide projectdoc Tools
Bookmarklets
Community Resources
Tampermonkey	The homepage of Tampermonkey.
Tampermonkey Documentation	Describes how the Tampermonkey API can be used and what is different to Geasemonkey.
Overwhelmed with Blueprints?

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-tip
Type	howto

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 4

New Version Current

Key

About

Keep up-to-date!

Powered by