Versions Compared

Key

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

...

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
  5. Changing the content of the page shown in the browser
  6. Showing metadata a projectdoc document
  7. Creating a projectdoc document related to a projectdoc document
  8. Creating a projectdoc document related to a web page

This short tip gives an example for each of these use cases.

...

Section
titlePrerequisites

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

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


Section
titleAltering Alter Page Content

Bookmarklets easily alter content shown that is rendered in the browser. These use cases are not special in the context of projectdocThis is not a special use case for the projectdoc Toolbox. They would work without any projectdoc tools installed.

Example Box
titleExamples altering page Content


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


TitleShort Description
Hide projectdoc Tools






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 Event





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





Section
ignore-template-buttonstrue
titleSubordinate Topics


Hide From Reader

Create from template
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-topic
buttonLabelCreate Topic

Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...