projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 4

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionThe Information Systems Extension for the projectdoc Toolbox allows to render a link with the HTML title as label via autoconvert of the pasted URL. 
Doctypetopichide
NameHTML Title as Link Text 
Short Name 
Parent
Parent Property
propertyParent
property-nameName
 

Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Documentation Gardener
propertyAudience
empty-as-nonefalse

 


Level of Experience

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

 
Expected Duration20 min 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 

Tags

Tag List
namesConfluence, URL, Autoconvert, projectdoc Toolbox
propertyTags

hide
Iteration

Iteration
valueproduction

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType

 
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors
 
Sort Keyhide
enable-heading-numberstruehide
Section
show-titlefalse
titleDescription

Pasting an URL to a Confluence page renders a representation that is clickable. If the URL points to an issue on a connected JIRA instance, this link is automatically converted to a macro that links to the issue. The feature responsible for this is Autoconvert for pasted Links.

The Information Systems Extension for the PDAC1 also provides autoconverters. Once an URL to a resource that is configured is pasted to a Confluence page, this URL is autoconverted to a projectdoc macro.

Column
width30%
Panel
titleContents

Table of Contents
outlinetrue
indent20px
stylenone

...

Section
titleHow to use?
Section
titleRequired Add-ons

 If you want to use this feature in your Confluence instance, you need to install the following add-ons.

Tour
replace-title-with-name
header-translationsMarketplace Icon=Atlassian Marketplacetrue
suppress-table-headingtrue
 
TitleShort DescriptionMarketplace Icon
PDAC1 

Information Systems Extension  

Section
titleConfiguration

You need to specify the remote information systems you want to enable autoconvert as space properties.

For this example we assume that autoconvert should be enabled for Wikipedia.

Steps
Section
titleOpen Space Homepage for Editing

Navigate to a space home page where you want to enable autoconvert.

Tip Box
titleUse the Index Space

Since this is often a site-wide decision, consider to set the properties in the index space.

Note that the delegate-space Delegate Space property allows to define parent pages where the index space the the root of all spaces.

Section
titleAdd Wikipedia URL

To add a remote server add the url-wikipedia-en space property.

This introduces the information system wikipedia-en (without the url- prefix) and specifies the root URL to the information system (which may or may not be a link by itself).

Section
titleEnable Autoconvert

Not every URL you specify should be considered for autoconverting. Therefore you need to inform projectdoc that this new URL is actually to be a base URL for autoconverting by the use of the space property information-system-autoconvert-hint Autoconvert Hint .

Multiple values are separated by comma. Note that you specify the system ID wikipedia-en you specified in the previous step. Also note that projectdoc needs to know how information is autoconverted. In our case it is linking, therefore we add ":link".

Section
titleCheck Configuration

Paste an URL to a page on Wikipedia in edit mode of a page in your Confluence and check that your configuration is correct!

Caution Box

Note that property names and values need to be free of any additional HTML envelopes! If you copy & paste values from an HTML page, there may be additional div or span elements around those values.

If you think everything should be all right, have a look at the page with the Confluence Source Editor or delete the lines and type them manually (without copy & paste).

For more information on this topic, please refer to Cannot access Property from a Document.

...

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH