Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

INSITE.EDIT

Edits assets from the user interface.

Syntax

<INSITE.EDIT 
      ASSETID="id of asset"
      ASSETFIELD="Attribute_name of asset's field"
      ASSETTYPE="type of asset"
      [EWEBEDITPRO="true|false"] (deprecated)
      [MODE="text|html"]
      [EDITOR="type of editor"]
      [PARAMS="editor parameters"]
      [WIDTH="pixels or percentage"]
      [HEIGHT="pixels"]
      [ASSETFIELDVALUE="field value to be edited"]
      [VARIABLE="variable name"]
      [SSVARIABLE="session variable name"]
      [PROPERTY="property name"]
      [LIST="list name"]
      [COLUMN="column name"]
      />

Parameters

ASSETID (required)

Id of the asset to be edited.

ASSETFIELD (required)

Name of the field of the asset to be edited.

ASSETTYPE (required)

Type of asset to be edited.

EWEBEDITPRO (deprecated)

Deprecated. Use EDITOR parameter instead.

MODE (optional)

Legal values are html or text. The default value is html. When choosing text, Sites will encode characters such as <, >, &, < space >, " and '

EDITOR (optional)

The name of the editor to use for the attribute. Valid values are:

• fckeditor - uses the FCKeditor rich text editor
• ewebeditpro - uses the EWebEditPro rich text editor
• text - the old inline text editor; works only in Internet Explorer
• dojotext (default) - like text, but works in both Internet Explorer and Firefox
• number (for numeric fields) - like dojotext, but can impose numeric restrictions on values
• spinner (for integer fields) - like number, but adds up/down arrows to increment/decrement the value
• currency (for money fields) - like number, with some additional restrictions
• calendar (for date fields) - displays a calendar to select a date

PARAMS (optional)

when editor is specified as "dojotext", "number", "spinner", "currency", or "calendar", this specifies, in JSON format, the parameters that should be passed to the underlying Dojo widgets. See The Dojo Toolkit for more information about the widgets.
when editor is specified as "fckeditor", you may specify editorId and enableEmbeddedLinks in JSON format. See example.

WIDTH (optional)

Width of the asset in percentage or pixels. The default value is 100% for eWebEditPro or 450 pixels for FCKEditor. When combined with editor="dojotext", specifying a value (in pixels) for the width attribute will display a fixed-size edit box, instead of an autoresizable edit box.

HEIGHT (optional)

Height of the asset in pixels only. The default value is 200 pixels. Percentage values are unsupported. Height only works for FCKEditor.

Additionally, one of the following must be specified:

• ASSETFIELDVALUE - Literal value to initially fill in the field.
• VARIABLE - Name of the Sites variable that you want to stream to a page. For example, for a variable called foo, set the parameter equal to foo rather than to Variables.foo.
• SSVARIABLE - Name of the Sites session variable that you want to stream to a page.
• PROPERTY - A Sites property from the futuretense.ini property file.
• LIST and COLUMN - Specifies the name of a list, and the field within the list, respectively, to use for the value of this field.

Description

This tag allows you to edit assets from the Insite Editor UI. When viewed outside of the InSite Editor UI, this tag behaves exactly like RENDER.STREAM when MODE="html", or like STRING.STREAM when MODE="text".

When editing flex assets, the attribute name should be preceded by the prefix Attribute_ in the value of ASSETFIELD; for example, the FSIIBody attribute should be specified as Attribute_FSIIBody. For more information about editing assets, see the Sites Developer's Guide.

Examples

The following example facilitates editing a string field, using the default dojotext field editor (which supports both Internet Explorer and Firefox).

<!-- 
      The code sample assumes the initial value of the FSIIHeadline
      attribute is stored in a Sites variable called "Headline".
-->
<INSITE.EDIT
	 ASSETID="Variables.cid"
	 ASSETTYPE="Variables.c"
	 ASSETFIELD="Attribute_FSIIHeadline"
	 VARIABLE="Headline"
/>

The following example facilitates editing a string field, using the formerly-default inline text field editor (which only supports Internet Explorer). It also illustrates initializing the value from a field in a list.

<!-- 
      The code sample assumes the initial value of the FSIIHeadline
      attribute is stored in a list called "Articles", in a column called "Headline".
      
      This will only work on Internet Explorer, since the
      text editor type uses the WYSIWYG editing capabilities 
      provided by this browser.
-->
<INSITE.EDIT
      ASSETID="Variables.cid"
      ASSETTYPE="Variables.c"
      ASSETFIELD="Attribute_FSIIHeadline"
      LIST="Articles"
      COLUMN="Headline"
      EDITOR="text"
/>

The following example facilitates editing a blob field with FCKEditor.

<!-- 
      The code sample assumes the initial value of the FSIIBody
      attribute is stored in a Sites variable called "Body".
-->
<INSITE.EDIT
      ASSETID="Variables.cid"
      ASSETTYPE="Variables.c"
      ASSETFIELD="Attribute_FSIIBody"
      VARIABLE="Body"
      EDITOR="fckeditor"
      WIDTH="400"
      HEIGHT="300"
/>

The following example facilitates editing a blob field with specific FCKeditor.

<INSITE.EDIT
      ASSETID="Variables.cid"
      ASSETTYPE="Variables.c"
      ASSETFIELD="Attribute_FSIIBody"
      VARIABLE="Body"
      EDITOR="fckeditor"
      PARAMS="{params:{editorId: '1170996054393',enableEmbeddedLinks:'1'}}"
/>

The following example facilitates editing a date field with Dojo's calendar widget.

<!--
      The code sample assumes:
      1) the initial value of the FSIIPostDate attribute is stored in a
         Sites variable called "FormattedPostDate".
      2) the date format is "MM/dd/yy"
-->
<INSITE.EDIT
      ASSETID="Variables.cid"
      ASSETTYPE="Variables.c"
      ASSETFIELD="Attribute_FSIIPostDate"
      VARIABLE="FormattedPostDate"
      EDITOR="calendar"
      PARAMS="{constraints:{datePattern: 'MM/dd/yy'}}"
/>

The following example facilitates editing an 'int' flex attribute with dojo's NumberSpinner widget.

<!-- 
      The code sample assumes:
      1) a flex attribute called "MyIntAttribute", with data type 'int' 
         has been defined
      2) the initial value of the attribute is stored in 
         a Sites variable called "MyIntAttribute". 
      
      The number spinner will warn the user if the value is not in the 
      0-100 range.
-->

<INSITE.EDIT
      ASSETID="Variables.cid"
      ASSETTYPE="Variables.c"
      ASSETFIELD="Attribute_MyIntAttribute"
      VARIABLE="MyIntAttribute"
      EDITOR="spinner"
      PARAMS="{constraints:{min: 0, max: 100, places: 0}}"
/>

The following example facilitates editing a 'money' flex attribute with dojo's CurrencyTextBox widget.

<!--
      The code sample assumes:
      1) the initial value of the FSIIPrice attribute is stored in 
         a Sites variable called �Price�. 
      2) the number is formatted using the default currency format for 
         the en_US locale
-->

<INSITE.EDIT
      ASSETID="Variables.cid"
      ASSETTYPE="Variables.c"
      ASSETFIELD="Attribute_FSIIPrice"
      VARIABLE="Price"
      EDITOR="currency"
      PARAMS="{lang: 'en-us'}"
/>

		Home >	Contents >	Index >
	Oracle XML Tag Reference Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.