Creating Add-ons - Revision history

Admin: /* Add-on Return String */

2015-07-06T14:55:31Z

‎Add-on Return String

Admin: /* Add-on Return String */

2015-07-06T14:30:57Z

‎Add-on Return String

Admin at 17:40, 2 July 2015

2015-07-02T17:40:25Z

Admin at 17:35, 2 July 2015

2015-07-02T17:35:13Z

Admin: /* Add-on Arguments */

2015-07-02T17:27:41Z

‎Add-on Arguments

Admin: /* Add-on Arguments */

2015-07-02T17:21:22Z

‎Add-on Arguments

Admin: /* Add-on Arguments */

2015-07-02T17:04:10Z

‎Add-on Arguments

Admin: /* Add-on Arguments */

2015-07-02T16:59:32Z

‎Add-on Arguments

Admin at 16:58, 2 July 2015

2015-07-02T16:58:20Z

Admin at 16:57, 2 July 2015

2015-07-02T16:57:34Z

@@ Line 346: / Line 346: @@
 : </nameValues> <br />
-Tabular Data
+'''Tabular Data''' <br />
 <?Contensive type="table" ?>
@@ Line 363: / Line 363: @@
 : </row>
 : </table>

@@ Line 362: / Line 362: @@
 :: <cell>row2 col2 data</cell>
 : </row>
-</table>
+: </table>

← Older revision		Revision as of 17:40, 2 July 2015
Line 328:		Line 328:

	'''updatable''' if yes or true, the collection can be updated from the Add-on Manager and automatically if the collection comes from the Collection Library. If false, updates will be blocked. <br />		'''updatable''' if yes or true, the collection can be updated from the Add-on Manager and automatically if the collection comes from the Collection Library. If false, updates will be blocked. <br />
		+
		+	==Add-on Return String==
		+
		+	An Add-on may return data when it is executed. Generally, this data is a text string result that will be output on the page. The data, however can be in one of two forms, Structured and Unstructured. <br />
		+
		+	#Unstructured Data - any type of text string not recognized by Contensive. An add-on dropped on a page is replaced by it's return string when the page is viewed. Unstructured data can be anything such as a simple text string or an XML document that does not have as it's top node a Contensive recognized tagname.
		+	#Structured Data - Structured data returns meta data to a calling process in XML format. This type of data is not generally used to produce output on a page. Contensive structured data must begin with a <?Contensive type="datatype" ?> processing instruction. The default data type is "namevalues".
		+
		+	'''Structured Data Types''' <br />
		+
		+	Simple Name Value pairs <br />
		+
		+	<?Contensive type="namevalues" ?> <br />
		+	: <nameValues> <br />
		+	:: <FirstName>FirstValue</FirstName> <br />
		+	:: <SecondName>SecondValue</SecondName> <br />
		+	: </nameValues> <br />
		+
		+	Tabular Data
		+
		+	<?Contensive type="table" ?>
		+	: <table>
		+	:: <cols>
		+	::: <col name="Column1Name" caption="Column1Caption" align="Column1Alignment"/>
		+	::: <col name="Column2Name" caption="Column2Caption" align="Column2Alignment"/>
		+	:: </cols>
		+	:: <row>
		+	::: <cell>row1 col1 data</cell>
		+	::: <cell>row1 col2 data</cell>
		+	:: </row>
		+	:: <row>
		+	:: <cell>row2 col1 data</cell>
		+	:: <cell>row2 col2 data</cell>
		+	: </row>
		+	</table>

← Older revision		Revision as of 17:35, 2 July 2015
Line 267:		Line 267:

	Unlike Scripts and Replacments, Add-on Objects are NOT supported in Contensive e-Mail. <br />		Unlike Scripts and Replacments, Add-on Objects are NOT supported in Contensive e-Mail. <br />
		+
		+	==Setting Page Add-ons==
		+
		+	A Setting Page Add-on produces a page of settings only visible in the admin site. It is an XML application. For more information, see the Collection file construction section. <br />
		+
		+	==Add-on Collections==
		+
		+	An Add-on Collection is a group of resources that provide a single common feature. Resources can be settings, functionality for your site, background processes, database settings, references to other collections, and just about any of feature requirement. <br />
		+
		+	A properly configured Add-on Collection can be distributed to any site and provide everything necessary to add the feature. <br />
		+
		+	The Collection can be a group of files, or it can be consolidated into a zip format. <br />
		+
		+	The Contensive Add-on Manager is used to unpack and install the Collection. To install an Add-on Collection from the Contensive Library, click on the Add-on Library tab, and check the Collection you wish to install. <br />
		+
		+	If you have an Add-on that does not come from the Library, go to the Manual Installation tab, and upload the file(s). <br />
		+
		+	A Collection consists of several basic file types: <br />
		+
		+	*An XML configuration file is required
		+	*Optional ActiveX DLL program files
		+	*Optional resource files to be installed to the website's root directory
		+	*Optional resource files to be installed in the website's Content Files directory
		+
		+	Thee files can be uploaded separately, or compressed into a single zip file for installation. <br />
		+
		+	'''Collection Resource Files''' <br />
		+
		+	Resource files include any file that needs to be installed for an Add-on Collection. These may include images, css files, icons, ActiveX DLLs, etc. <br />
		+
		+	Resource files that are simply installed in either the website's root folder or the Contensive content files do not need to be referenced in the Collection Configuration file. They will be installed by virtue of their presence. <br />
		+
		+	To install a file in the website's root folder, upload it with the collection. If the file is to be installed in a subfolder of the webs root, like 'images' for instance, you must upload a zip file with the structure in place. Contensive will unzip the Collection, and duplicate the directory structure starting at the root folder of the website. <br />
		+
		+	To install files in the Contnesive files folder, put your files in a subfolder called 'ContensiveFiles'. These files will be copied to the root of the Contensive files folder. These files may also include subfolders. To install Contensive files, your collection must be in zip format. <br />
		+
		+	'''Collection Installation File''' <br />
		+
		+	The Collection Installation file is an XML file that contains a description of features, settings, components and content to be imported. One configuration files is required for an Add-on Collection to install. A Collection Installation file is not needed to create a collection on your site, but if after creating it, you want to copy it to another site, an installation file is needed. There is an Add-on, Add-on Collection Export, which creates this file for you from your site's settings. <br />
		+
		+	The top node for an addon collection is the 'Collection'. <br />
		+
		+	<Collection name="" guid="" system="" updatable=""> <br />
		+	: <CDef /> <br />
		+	: <Data /> <br />
		+	: <ImportCollection /> <br />
		+	: <Addon /> <br />
		+	: <NavigatorEntry /> <br />
		+	: <SQLIndex /> <br />
		+	: <Styles /> <br />
		+	: <ScriptingModule Name="" guid="" /> <br />
		+	: <Resource Name="" Type="www\|content\|executable" Path="" /> <br />
		+	</Collection> <br />
		+
		+	'''Name''' is used to identify the collection in displayed lists. If the GUID is not present, name is used to locate a collection for upgrades. <br />
		+
		+	'''guid''' is string used to uniquely identify the collection. To create a new guid, use the Create GUID tool from Advanced Tool menu in the navigator any Contensive site <br />
		+
		+	'''system''' if yes or true, the collection can not be removed. It will be updated automatically from the Library. <br />
		+
		+	'''updatable''' if yes or true, the collection can be updated from the Add-on Manager and automatically if the collection comes from the Collection Library. If false, updates will be blocked. <br />

← Older revision		Revision as of 17:27, 2 July 2015
Line 235:		Line 235:
	\|#0093#		\|#0093#
	\|}		\|}
		+
		+	'''Webservice Add-ons''' <br />
		+
		+	A Webservice Add-on is an object that responds directly to a request at the website. <br />
		+
		+	To create a Webservice, first create an Add-on and add it to the site with the Add-on Manager. In this example, I will call the Add-on "SampleAddon". The SampleAddon will simply respond with the Message "Hello World". <br />
		+
		+	Upload the Add-on to the Add-on Manager, and hit your site with: <br />
		+
		+	?webservice=SampleAddon <br />
		+
		+	The site will respond with "Hello World". <br />
		+
		+	Your add-on code can read any other arguments from the querystring or submitted form, and change its output accordingly. <br />
		+
		+	'''Add-onScripts''' <br />
		+
		+	Add-on scripts are add-ons that create a javascript tag on the page. The link should return a javascript that creates the desired content. <br />
		+
		+	'''Add-on Replacements''' <br />
		+
		+	Use the Add-on interface to create simple replacements in the content. When a content manage drops your add-on into his content and displays the page, you can include non-dynamic replacement HTML. <br />
		+
		+	One common use for this replacement code is have Contensive add a 'marker' when the content manger drops the add-on. The when Contensive creates the page for display and returns it to your website script, you can programmically replace with something you create in the script. <br />
		+
		+	For instance, you may create a function HelloWorld() in your php page. Then create an Add-on called "HellowWorld" that simply adds the HTML "{{helloworld}}" to the content when it is <br />
		+
		+	'''Add-on ActiveX Objects''' <br />
		+
		+	Add-ons can use objects in activeX DLLs to produce content. They are created by developers, then installed with the Add-on Manager. When created, content managers can easily add them into their content by selecting them from the Add-on drop down menu. <br />
		+
		+	Unlike Scripts and Replacments, Add-on Objects are NOT supported in Contensive e-Mail. <br />

@@ Line 228: / Line 228: @@
 |{{!}}
 |#0124#
+|-
 |[
 |#0091#

@@ Line 226: / Line 226: @@
 |#0039#
 |-
-|"|"
+|{{!}}
 |#0124#
+-
-|"["
+|[
 |#0091#
 |-

@@ Line 229: / Line 229: @@
 |#0124#
+-
-|[
+|"["
 |#0091#
 |-

← Older revision		Revision as of 16:57, 2 July 2015
Line 126:		Line 126:
	: 4. Save the resulting .zip file <br />		: 4. Save the resulting .zip file <br />
	: 5. If you have created a Visual Studio Windows Library (DLL file), drag and drop it into the zip file as well. <br />		: 5. If you have created a Visual Studio Windows Library (DLL file), drag and drop it into the zip file as well. <br />
		+
		+	==Add-on Arguments==
		+
		+	The Add-on Arguments are name/value pairs you configure in the features tab of the add-on record when it is created. Then content managers can modify the value when the add-on is used. <br />
		+
		+	For instance, the "Page Content Review" add-on has two arguments, 'Review after this many days' and 'Rows per page'. They are entered in the Add-on record as follows: <br />
		+
		+	:: Review after this many days=90 <br />
		+	:: Rows per page=50 <br />
		+
		+	When a content manager drops this addon on a page, the default value shown are used. If they turn on advanced edit and click the options icon, they can modify these values. <br />
		+
		+	'''Argument Syntax''' <br />
		+
		+	The argument list is a list of name=value pairs, separated by carriage returns. <br />
		+
		+	Name <br />
		+
		+	:: can not contain a carriage return or an equal sign. See the list of escape codes below. <br />
		+
		+	Value <br />
		+
		+	:: The value can be a simple string or a Value-Constructor. A value-constructor is a sequence of instructions that sets up selection options for the content manager, and returns only the selected values to the add-on. See the list of escape codes below <br />
		+
		+	'''Value-Constructors''' <br />
		+
		+	Name=Default[OptionList]InputType <br />
		+
		+	:: Name is a reserved option name that the Add-on recognizes. You program the Add-on by providing values for the name options. <br />
		+
		+	:: Default is the default value used before the add-on options have been modified <br />
		+
		+	:: OptionList is a list of available options in square brackets, each option is separated by a vertical bar character "\|". For instance <br />
		+
		+	::: My Value = C[A\|B\|C] <br />
		+
		+	::: Creates a select box next to the caption "My Value", with the options A, B or C. By default, C is selected <br />
		+
		+	:: InputType is the method of displaying the input or options. For example, checkbox or select. Currently, these are supported: <br />
		+
		+	::: a. text <br />
		+	::: b. select <br />
		+	::: c. checkbox <br />
		+	::: d. radiobox <br />
		+	::: e. resourcelink <br />
		+	::: f. link <br />
		+
		+	:: An Option can also be a function <br />
		+
		+	'''Option Value Functions''' <br />
		+
		+	To generate an OptionList from a database table, use the List( contentName ) and ListID( contentName ) functions in the option list <br />
		+
		+	List( contentName, optional criteria ) <br />
		+
		+	:: The List function creates a list of names from a content table. The optional Criteria is an sql compatible criteria statement. When a selection is made, the name of the content record is returned. <br />
		+
		+	:: For example: <br />
		+
		+	:: GroupName=staff[List(groups)] <br />
		+
		+	:: When a content manager drops this on a page and edits the options, this option string will produce a drop down selector with all the groups in the Groups content. By default, the group staff will be selected. When the administrator selects one of the groups, it will replace "staff" in the instance of the Add-on on the page. <br />
		+
		+	ListID( contentName ) <br />
		+
		+	:: Returns a drop down select list of names from an database content. The optional Criteria is an sql compatible criteria statement. When a selection is made, the ID of the content record is returned. <br />
		+
		+	:: GroupName=20[ListID(groups,optional criteria)] <br />
		+
		+	:: When the administrator drops this on a page and double clicks on it, this option string will produce a drop down selector with all the groups in the Groups content. By default, the group with ID=20 will be selected. When the administrator selects one of the groups, its ID replace 30 in the instance of the Add-on on the page. <br />
		+
		+	ListFields( contentName ) <br />
		+
		+	:: Returns a drop down select list of all the fields in a content definition (meta data for a table). When a selection is made, the name of the field is returned. <br />
		+
		+	:: FieldName=email[ListFields(people)] <br />
		+
		+	:: When the administrator drops this on a page and double clicks on it, this option string will produce a drop down selector with all the groups in the Groups content. By default, the group with ID=20 will be selected. When the administrator selects one of the groups, its ID replace 30 in the instance of the Add-on on the page. <br />
		+
		+	'''Reserved characters''' <br />
		+
		+	There are several characters the system uses to parse the option list. When used in an option value, they must be replaced with the following: <br />
		+
		+	{\| class="wikitable"
		+	\|-
		+	\|&
		+	\|#0038#
		+	\|-
		+	\|=
		+	\|#0061#
		+	\|-
		+	\|,
		+	\|#0044#
		+	\|-
		+	\|"
		+	\|#0034#
		+	\|-
		+	\|'
		+	\|#0039#
		+	\|-
		+	\|\|
		+	\|#0124#
		+	-
		+	\|[
		+	\|#0091#
		+	\|-
		+	\|]
		+	\|#0093#
		+	\|}