Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionRuns a projectdoc cleanup on the referenced document.
Doctypeaddon-componenthide
NameDocument Cleanup
Parent
Parent Property
property-nameName

Audience
Name List
render-no-hits-as-blanktrue
addon-componentrole
propertyAudience

Type

Name List
doctypeaddon-component-type
render-no-hits-as-blanktrue
namesREST Service
propertyType


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
valuefinished

hide
Since1.2hide
Path

Display Property Reference
append-text/cleanup
property-nameParent
referred-property-namePath
appendtrue


HTTP MethodPOST
Deprecatedhide
Removedhide
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription
Content Marker
idProblem Statement

The PDAC1 is quite picky when processing property information in a properties table. It assumes that there is only plain text for the property name and the property controls. If an author copies a value from another web page as a property value, this text may contain additional HTML span or div elements. These elements are not rendered, but they are considered to be part of the value definition.

This problems can be manually solved using the Confluence Source Code Editor. The author simply needs to remove the extra HTML elements that have been added.

This service supports authors to execute some come cleanup procedures. These include:

  1. Remove any HTML elements from the property name
  2. Remove any HTML elements from the property controls
  3. Remove span, div, and p HTML elements from the property values
  4. Remove br elements from the property values

Document properties with the preserve control are not cleaned up. So this control enables page authors to override the cleaning process for a particular property.

Transclusion
documentPlease Backup your Data first!
idsSummary

Section
titleParameters

These parameters control the cleaning procedure of a projectdoc document.

Section
titleid-list

The comma-separated unique identifiers of the projectdoc documents to process.

The properties of these documents are cleaned. This includes the name, the value, and the controls of all properties. If a property is marked with preserve, this particular property is skipped and not cleaned.

Section
titlenew-version

 Flag to control whether a new version should be created. If set to false, the document is saved without creating a new version. Defaults to true to create a new version.

Section
titlecomment

 The optional comment for the version. If no new version is created, the current comment is overridden.

Section
titleinclude-children

If checked, the process also cleans up the child documents of the specified document.

If this boolean request parameter is set to true, not only the document specified with the id parameter is cleaned, but also all of its children and their children.

Section
titlehtml-elements

The comma-separated HTML tag names to remove from the property values. Defaults to span, div, p.

Select the names of HTML elements you want to remove here. If you set at least one element, the defaults are no longer taken into account. If you want to add additional elements to the defaults, you need to add the defaults as well.

Section
titleproperty-names

The list of comma-separated properties to cleanup. If none is given, all properties are cleaned. Note that properties with the preserve control are never cleaned.

Section
indextrue
titleRelated Components
Display Table
render-no-hits-as-blanktrue
render-modedefinition
where$<Parent>=[${Parent}]
Section
required-permissionswrite-access
titleNotes

Section
titleReferences

Section
titleResources
Tour
render-as-definition-listtrue
TitleShort Description
Bookmarklets List Macro