Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short DescriptionRequests to normalize the referenced values to allow inserting as raw XHTML.
 

Doctypepropertyhide
Nameprojectdoc-adjustVarValues-toXhtml
 

Parent
Parent Property
propertyParent
property-nameName
 

Audience
Name List
doctyperole
propertyAudience
hide
Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
namesadjust-property
propertyTags
 

Identifierprojectdoc-adjustVarValues-toXhtml
 

Component
Name List
doctypecomponent
propertyComponent
 

Required
 

TypeList of Strings
 

Short Type
Display Property
property-nameType
hide
Default Value
 

Value RangeList of blueprint parameter names.
 

Implementation
 

Since1.11
 

Deprecated Since
 

Until
 

Iteration
Iteration
valuefilled
hide
Reference
 

Sort Keyhide



Section
show-titlefalse
titleDescription

This property allows template authors to render an XHMTL value instead of a plain string entered by the user with a wizard.

Since it is used to normalize property values, redundant block elements are removed.

...

Section
titleExample of Usage

 A template author decides to allow XHTML for the short description (identified by projectdoc.doctype.common.shortDescription) in the wizard.

Code Block
languagexml
titleProperty in the Soy Template
<textarea 
  id="projectdoc.doctype.common.shortDescription" 
  name="projectdoc.doctype.common.shortDescription" 
  class="textarea long-field" 
  placeholder="{getText('projectdoc.blueprint.form.label.shortDescription.placeholder')}"
  rows="6"></textarea>

<input 
  id="projectdoc-adjustVarValues-toXhtml"
  name="projectdoc-adjustVarValues-toXhtml"
  type="hidden"
  value="projectdoc._doctype._common._shortDescription"> 

In the template the property is now inserted as raw XHTML (at:rawxhtml="true").

Code Block
languagexml
titleProperty in Page Template
<tr>
  <th class="confluenceTh"><at:i18n at:key="projectdoc._doctype._common._shortDescription"/></th>
  <td class="confluenceTd"><at:var at:name="projectdoc._doctype._common._shortDescription" 
                                   at:rawxhtml="true"/></td>
  <td class="confluenceTd"></td>
 </tr>


Version Box
titleVariable Names
since5.0

Since version 6.0 all dots in variable names have been replaced by underscores.

Before 6.xSince 6.x
projectdoc.doctype.common.shortDescriptionprojectdoc_doctype_common_shortDescription

Note that references to resources (for instance labels) and identifiers for property names still use dots as delimiters.



Section
titleSubordinate Properties
Display Table
doctypeproperty
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...