Versions Compared

Key

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

...

Document Properties Marker
doctypetopic
overridefalse


Short DescriptionA short overview on how to use bookmarklets in your browser to add additional features using the projectdoc Toolbox for Confluence.
NameBookmarklets for projectdoc
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
valuefocusedreleased

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
property-restrict-value-rangetrue
propertyType


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesProficient
propertyLevel of Experience


Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide


...

Section
show-titlefalse
titleDescription

Bookmarklets are JavaScript scripts stored in a bookmark of a user's browser. When users select this bookmark then – instead of opening the page at the end of the URL – the JavaScript code is executed.

Users of the projectdoc Toolbox for Confluence can easily extend their browser with bookmarklets to run actions including

  1. Alter Page Content
  2. Show Metadata
  3. Create based on projectdoc Document
  4. Create based on Web Page

This short tip gives one or two examples for each of these use cases.

Caution Box
titleprojectdoc Toolbox 4.2 required!

Most bookmarklets shown on this page require the projectdoc Toolbox with version 4.2 (which is about to be released by the end of January 2020).

This is because the JavaScripts use new services only the latest version will provide.



Section
titleSummary


Section
titlePrerequisites

To run bookmarklets on Confluence in the context of the projectdoc Toolbox, the following apps need to be installed:

The Bookmarklets Extension also provides an editor to create bookmarks from JavaScript scripts.

Dependent on the bookmarklet the Information Systems Extension or doctype add-ons are required.

...

Section
titleShow Metadata

Authors or readers may want to have access to metadata or related information to the page they are currently working with.

This information is typically shown in a separate window that could be kept open next to the main projectdoc document.

Example Box
titleExamples showing metadata


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





...

Section
titleCreate based on projectdoc Document

Working with projectdoc documents often results in creating new documents that are related to the current document. The context may provide information that is relevant as metadata for a new document.

Example Box
titleExamples creating new documents based on existing documents


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


TitleShort Description
Continue Eventwith





Section
titleCreate based on Web Page

When working on a project, information from the web may be relevant to store in the project's library for further reference. There may be certain reports or entities on remote information systems that require a representation in your documentation. Bookmarklets make it easy to scap relevant information form the page currently rendered in the browser and create a new projectdoc document of a certain doctype.

Example Box
titleExamples creating new documents based on existing documents


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


TitleShort Description
Create Resource




...