ADF Docs - User contributions [en]

PT Calendar2 Manage Copy Event

2011-06-17T15:23:57Z

Rwest:

Back to [[PT Calendar2 Build Subsites Templates and Pages|Build Subsites, Templates and Pages]]

== Overview ==
The Manage Event Copy Page is a lightbox page to copy event records or reoccurring events.

Follow these steps to configure the link and page for copying events.

== Steps ==
# Create a new page called 'Manage Copy Event' from the [[PT_Calendar2_Lightbox_Template|Lightbox Template]] and in the ''/lightbox/calendar/'' subsite.
# In the main content of the page place a Custom Script element.
# From the Custom Script element interface, click the "Edit" icon.
# Enter the following text into the Explicit Module path:
## ''/ADF/apps/pt_calendar2/customcf/lb_manage_copy_event_header.cfm''
# Select Finish
# Publish the page

== Update Configuration ==
Update the Calendar Configuration for the '''Manage Event Copy URL''' field. Edit the row in the datasheet and select the CommonSpot page that was created.

[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Calendar]]

PT Mobile

2011-04-08T17:03:13Z

Rwest: added better app description

== Overview ==
The Mobile Application is a small framework that makes it easier to present existing CommonSpot pages on mobile devices. The application provides:
* Automatic redirect to a new home page when a mobile device is detected
* Sample XSLT transformations to convert CS Page content into lightweight HTML
* Support for Android, iOS and Blackberry device recognition
* Support for server side and client side transformations

The goal of the application is to allow you to build a look and feel that works well on mobile devices without duplicating content.

== Requirements ==
ADF Version 1.5

ADF must be configured correctly for your site. [[Site Configuration (ADF.cfc)]] has instructions for configuration.

== Pre-installation Considerations ==
[[Overview|Application Development Framework (ADF)]] must be setup and configured on the server for the site. For detailed instructions, see the [[Overview|Application Development Framework (ADF)]] wiki page for Site Configurations.

== Installation/Setup ==
Each of the following steps should be completed fully and in the order presented:

# [[PT_Mobile_Extract|Extract Application]]
# [[PT_Mobile_Configuration|Configuration]]
# [[PT_Mobile_Getting_Started|Getting Started]]

[[Category:Project]]
[[Category:Mobile]]

CCAPI Config

2011-01-31T16:04:36Z

Rwest:

==Overview==
Sometimes your applications may need to add content programmatically (like creating pages, uploading documents and adding custom element content). The [[CCAPI]] Library Component makes it easy to add content into CommonSpot. The [[CCAPI]] Library Component utilizes an [[Application Configuration at the Site Level (XML)]] to load the settings into the [[CCAPI]] calls.

The CCAPI Config uses the [[Config|Core Config]] object to handle its site specific configuration.

<source lang="java">
Note: CommonSpot must be configured to allow API calls before using the ADF CCAPI components.
Please read the section of the Developers Guide on the Content Creation API
(search for "loaderrequest.dat").
</source>

== File format and location ==
To allow each site to have its own configuration for the CCAPI:
# Locate the '/_cs_apps/config/' directory in your site. If this directory does not exist, create it.
# Place a file in this directory called "ccapi.xml".
# Place the following XML content into the ccapi.xml file
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<settings>
<logging>
<enabled>1</enabled>
</logging>
<elements>
<UniqueElementName>
<pageID>30622</pageID>
<subsiteID>1</subsiteID>
<elementType>custom</elementType>
<controlName>posts</controlName>
</UniqueElementName>
</elements>
<wsVars>
<webserviceURL>http://cfusion/commonspot/webservice/cs_service.cfc?wsdl</webserviceURL>
<csuserid>csUserName</csuserid>
<cspassword>csPassword</cspassword>
<site>Demo</site>
<siteURL>http://cfusion/demo</siteURL>
<subsiteID>1</subsiteID>
<cssites>commonspot-sites</cssites>
</wsVars>
</settings>
</source>

== XML Components ==
There are three major components in the CCAPI XML Config file:
# <logging> This tag contains the flag to enable logging. <br><br>
# <elements> This tag contains the Custom Elements and Textblock elements that you would like to use. See the [[CCAPI Element|CCAPI Content]] page for additional information about how to add/edit data within Textblocks and Custom Elements.<br><br>
# <wsVars> This node contains the Web Services information for your site.<br><br>

== Example ==
For this example we will use a custom element called "News" with the following fields (Note: Field Labels in text, field names in brackets []):
* Title [title]
* Description [descr]
* Date Posted [datePosted]
* Content [content]
* Author [author]

Lets also assume that your Server has the following configuration:
* Site URL: http://cms.mysite.com
* CS Admin Username: admin
* CS Admin password: password

=== Sample Steps ===
If you want to easily populate this Custom Element using the CCAPI then you would do the following:

# Create a page somewhere in your site (we usually create a page called ccapi.cfm)
# Place thew "News" custom element in the page
# Give the element the name "NewsElement" (using the Element Indicators in CS v.5+ you would click the "more" icon and then go to Name)
# Save the page and move into read mode
# View the source of the page and look for the page and subsite IDs (Note: this will be in a javascript block near the top of the page - look for "jsPageID" and "subsiteID") - for the sake of our example lets say the pageID = 1345 and the subsiteID = 4
# Enter the code below into your CCAPI.xml file

<pre>
<?xml version="1.0" encoding="utf-8"?>
<settings>
<logging>
<enabled>1</enabled>
</logging>
<elements>
<News>
<pageID>1345</pageID>
<subsiteID>4</subsiteID>
<elementType>custom</elementType>
<controlName>NewsElement</controlName>
</News>
</elements>
<wsVars>
<webserviceURL>http://cms.mysite.com/commonspot/webservice/cs_service.cfc?wsdl</webserviceURL>
<csuserid>admin</csuserid>
<cspassword>password</cspassword>
<site>Demo</site>
<siteURL>http://cms.mysite.com</siteURL>
<subsiteID>1</subsiteID>
<cssites>commonspot-sites</cssites>
</wsVars>
</settings>
</pre>

=== Analyzing the file ===
We have created a <News> node under the <elements> node. The word "News" is arbitrary and really only needs to be unique (e.g. each xml node within elements needs to be unique).

In the <News> element we have configured it to use the information from the ccapi.cfm page we created above. Notice how the <elementType> is "custom" - thats because we are working with a Custom Element. The <controlName> contains the value you entered in the "Name" field for the "News" element on the page.

In the <wsVars> node we completed the information based on the settings for the server.

Note: Make sure you Reset the ADF whenever this file is added/modified

=== Code sample ===
Now it is simple to use the [[CCAPI]] to make calls to populate this custom element. Sample code would look like this:

<source lang="java">
<cfscript>
// setup a data structure for the news element content
newsData = structNew();
newsData.title = "My New News Article";
newsData.descr = "We are adding content via the CCAPI with the ADF";
newsData.datePosted = request.formattedTimestamp;
newsData.content = "Here is the content of the article (can contain <html>)";
newsData.author = "John Smith";
// make the call to create content
addContentResults = application.ADF.csContent.populateContent("News", newsData);
</cfscript>
</source>

The newsData structure contains all of the fields for the custom element. The call to "csContent" has 2 parameters the first being the "named element" - this matches the node in the <elements> section of the CCAPI.xml file from above. The second parameter is the actual data for the custom element.

[[Category:CCAPI]]

MediaWiki:Sidebar

2010-12-14T23:31:30Z

Rwest: changed the CCAPI link (again)

MediaWiki:Sidebar

2010-12-14T23:30:54Z

Rwest: changed the CCAPI link

Create New ADF App

2010-11-24T17:44:12Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

#REDIRECT [[ADF Applications]]

PT Forums Configuration

2010-11-24T17:42:36Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Gcronkright

Back to [[PT Forums Build Templates Pages|Build Templates/Pages]]

== Overview ==
The Forums Configuration Page will be used to manage the PTForums Configuration custom element. Follow these steps to configure the datasheet and page for adding the configuration settings.

== Steps ==
# Create a new page called 'Configuration Manager' in the ''/webadmin/forums/'' subsite.
# In the main content of the page, add a Custom Script element.
# Enter the explicit module path for:
## ''/ADF/apps/pt_forum/customcf/manage_configuration_header.cfm''
# From the Datasheet element interface, click the "Datasheet" icon.
# From the "Datasheet Views" dialog, follow the "Click here to create a new datasheet view" link.
# Enter the following information and then click "Next":
## Name: Forums Configuration
## Private: unchecked
## Default View: unchecked
## Description: View to manage the Forums Configuration
## Datasheet Source: Form Result/Custom Element Sheet
# From the Datasheet Source dialog choose the "ptForums Configuration" custom element and click "Next".
# From the Datasheet Columns Dialog choose a few columns from the Available Columns list and move them to the Selected Columns list. (CS_USERS_DSN, Forum_UI_Theme, FORUM_HOME_URL, etc...) and then click "Finish".
# You will be brought to the Datasheet View page; click "Close" to return to your page.
# You will see the datasheet element on this page now. Click the Datasheet element interface icon again and this time choose "Edit Columns".
# From the Datasheet View Column Properties dialog choose the link for "Add a new action column" again.
# Within the Action Column Properties dialog enter the following information and click "Finish":
## Header: Edit
## Hide Header: Checked
## Column Text: edit
## Window Target Name: <leave blank>
## Modules: edit-form-data.cfm
# No 'Delete' Action needed.
# Publish the page.

== Create Forum Configuration Record ==
We are creating a single Forum Configuration element record to be used within the application.

#Go to the '''Add New Config Data''' page
#Update the following fields:
## FORUM HOME URL - The home (or root) URL for your FORUM or site
## SUBSCRIPTION FROM EMAIL - The FROM email address for thread subscription post notifications
#Submit the form to create '''one record'''.

The other fields will be completed as the pages are built.

See the [[PT_Forums Site_Configuration|Site Configuration]] wiki page for more information on the fields and the correct values.

[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Forums]]

Custom Field Types

2010-11-24T17:42:32Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Ssmith

==Overview==
CommonSpot Custom Field Types (CFT) is one of (if not THE) most powerful API's available to you as a developer. Custom Field Types are described in detail in the CommonSpot Developers guide which is available in your CommonSpot Help (/commonspot/help/) or on the [http://www.paperthin.com PaperThin, Inc.] website.

However, in summary a Custom Field Type is an API that allows you to interact with any custom form (Custom Element, Metadata Form or Simple Form) within CommonSpot. With a Custom Field Type you can:
* Build a custom input control similar in complexity to the Rich Text Editor or as simple as the standard text input control
* Connect two fields in a custom element using jQuery or other JavaScript library
* Create an interface for content contributors that allows them to interact with non-CommonSpot data

== Custom Fields in the ADF (Extensions) ==
The /ADF/extensions/customfields/ directory contains some pretty powerful Custom Field Types. They are simple to install and even easier to use:
* [[General Chooser]]: The General Chooser is an extensible CFT that allow you to easily connect two custom elements together
* [[Custom Element Select]]: The Custom Element Select CFT is similar to the General Chooser as it allows you to connect two custom elements together
* [[Subsite Select]]: The Subsite Select CFT allows you to choose a subsite and bind the subsiteID to any element record
* [[Template Select]]: The Template Select CFT allows you to choose a templateID and bind it to any element record

Dev Create Eclipse Project

2010-11-24T17:42:29Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Renee.mckechnie

== Overview ==
To develop an application and commit the updates back to the SVN repository, the project needs to be set up through an IDE.

The following steps set up an ADF app to update and commit the latest code to the SVN repository.

== Steps ==
* Follow the instructions to set up the [[Developers_Guide|Development Environment]].
* Install the [http://subclipse.tigris.org/ Subclipse] plug-in into Eclipse.
* In Eclipse, in the Project Explorer view, create a new project.
* In the ''New Project'' dialog, select either ''Project'' or ''CFML Project''.
* Enter the project name in the text field. Uncheck the ''Use default location'' and enter the path for the SVN checked out app that was setup through the [[Developers_Guide|Development Environment]].
** [[File:svn_apps_eclipse_01.jpg]]
* In the ''Project References'' dialog, do not select any other projects and click ''finish''.
* In the Project Explorer view, you will now see the project and that it is connected to the SVN App's repository. You can also see your working copy from the SVN repository.
** [[File:svn_apps_eclipse_02.jpg]]

[[Category: How-to Guide]]

Dev Merge Branch

2010-11-24T17:42:26Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by WikiSysop

== Overview ==
Where branches are used to maintain separate lines of development, at some stage you will want to merge the changes made on one branch back into the trunk, or vice versa.

It is important to understand how branching and merging works in Subversion before you start using it, as it can become quite complex. It is highly recommended that you read the chapter [http://svnbook.red-bean.com/en/1.5/svn.branchmerge.html Branching and Merging] in the Subversion book, which gives a full description and many examples of how it is used.

The next point to note is that merging ''always'' takes place within a working copy. If you want to merge changes into a branch, you have to have a working copy for that branch checked out.

In general it is a good idea to perform a merge into an unmodified working copy. If you have made other changes in your WC, commit those first. If the merge does not go as you expect, you may want to revert the changes, and the ''Revert'' command will discard all changes including any you made before the merge.

More information view this page, [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-merge.html TortoiseSVN Merging].

== Merge a Branch ==
Follow the steps below to merge a branch back into the trunk.

* Locate the Apps directory (not within the ADF directory) and right click the checked out SVN repository. From the menu, select ''Merge...''.
** [[File:svn_apps_merge_01.jpg]]
* In the Merge dialog, select the merge type as ''Reintegrate a branch''.
** [[File:svn_apps_merge_02.jpg]]
* In the Tree Merge dialog, enter the URL for the branch that is being merged back into the trunk. If this is your working copy, then it will be auto populated correctly.
** [[File:svn_apps_merge_03.jpg]]
* In the Merge Options dialog, select the ''Merge'' button.
** [[File:svn_apps_merge_04.jpg]]
* The merge is completed and the trunk is now identical to the branch.

Building an ADF Application

2010-11-24T17:42:16Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

== Overview ==
ADF Applications are a combination of custom coding, CommonSpot API calls, and CommonSpot Custom Elements. Applications can do many things but on a whole they are used to allow content contributors to easily manage structured data within the CommonSpot site.

== Prerequisites ==
To build Applications using the ADF it is essential that you become familiar with some of the common interfaces available to you as a developer. Since the ADF is an extension of CommonSpot, the more you know about how CommonSpot works in general the better. Some places to get started:
* CommonSpot Documentation: browse to /commonspot/help/ on your CommonSpot Authoring server to gain access to all of the documentation available in your installation
* Browse the Articles on the [http://community.paperthin.com/articles/browse.cfm CommonSpot Community Site] to learn what others are doing with the API's
* Contact your Account Manager for upcoming training dates

== Core folders and files ==
The following steps are instructions for creating a new application in the ADF.

<pre>Note: A 'Starter App' is available for download on the [http://community.paperthin.com/projects/pt_starter_app/ CommonSpot Community Site]. See the [[Starter_Application|Starter Application]] wiki page for more details.
</pre>
# Pick a name for your application (See [[Best Practices for ADF Applications]] for more on naming your application)

# Create a new directory for your application (application names and application directories do NOT have to match) within the /ADF/apps/ directory
# Copy the contents of the 'Starter App' into your new application directory
# Open the 'AppBeanConfig.cfm' file in your applications directory. See the [[App Bean Config|App Bean Config]] wiki page for more details.
# Update the 'appBeanName' variable with the name for your application and the comment header at the top of the file with your application name.
<source lang="java">
// App specific variables
appBeanName = "myAppName";
</source>
# Save the updated 'AppBeanConfig.cfm' file.
# [[Reset_ADF|Reset the ADF]] for the server and site.
# If no error messages appear, then your application is configured within the ADF.

== Adding functionality ==
Where you go from here is very much up to you. Some things that you might do are:
* Build a CommonSpot Custom Element(s) to house your content
* Build a [[Custom Field Type]] to enhance the management of data
* Construct some [[Application Components]] to help control the entry and display of data from your Custom Element(s)

[[ADF Applications|Back to ADF Applications]]

[[Category: How-to Guide]]

PT Multimedia Getting Started

2010-11-24T17:42:12Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Dbeckstrom

== Overview ==
This guide is designed to help you quickly get started using the Multimedia application on your web site. Before you get started, there are some important concepts and terminology to understand. The Multimedia application supports uploading video and audio files, through dialog screens in the Multimedia application, directly to your web server and then to play them within your site. We refer to Multimedia served directly from your web server as “Locally Hosted”. The Multimedia application will also play videos that are hosted on third-party sites such as youtube, Yahoo and Vimeo. This guide uses the term “Externally Hosted” to refer to the serving of multimedia which resides on third-party sites.

Though the Multimedia application plays multimedia (locally hosted) without the need for a streaming server, if you wish to utilize a streaming server to take advantage of features such as digital rights, tracking and reporting, etc – you may easily customize the Multimedia application to use your in-house streaming server. The Multimedia application is designed to allow your coldfusion developers to add support for additional third-party sites, modify how media displays, etc.

If you only intend to present externally hosted media, then your Multimedia Configuration Manager page only requires that the “Upload Media Form”, “Pop-up Player URL” and “Search Results URL” fields be populated. If you intend to present both externally and locally hosted multimedia, or just locally hosted multimedia, then all fields must be populated before you begin. Instructions for these fields are described under the installation steps. This guide assumes installation is completed.

==Getting Started==
'''1)''' The first step in using the Multimedia application is to navigate to your Multimedia Manager page and click on either the “Series” or “Category” tab (or both) and create entries. Multimedia (audio and video) must be assigned to one or more Categories, one or more Series or a combination of Categories and Series.

*'''Series. ''' Series are how podcasts (which may be audio, video or both) are associated. For example, let’s say that you have three videos (part 1, part 2 and part 3) which together form a tutorial podcast on “making widgets.” You would create a Series entry called “making widgets.” When these three videos are entered into the multimedia application, you would assign them to the “making widgets” Series. If you don’t intend to create podcasts, the Series option could be repurposed as a secondary way of organizing your multimedia.

*'''Categories. ''' The primary means of organizing your multimedia is through the use of Categories. You might create a category called “Company News”, another category called “Lectures & Speeches” and one called “Events”. These are essentially “buckets” in which you place your locally hosted and externally hosted multimedia. You may have an unlimited number of categories and each video/audio item may be assigned to one or more categories. Renaming a category or series (by editing the name through the datasheet) does not break the application. Internally we use an ID – the display name may be changed at any time.

'''2)''' After you’ve created a number of categories, it’s time to add your multimedia. Still on the Multimedia Manager page, click on the Media tab and select the “Add new Media” button. You will be presented with a form in a lightbox. Enter a title in the “title” field (we recommend you keep titles relatively short). Select whether this item is hosted locally or externally. Note that the form will dynamically change to display the appropriate fields based on where (local or external) this item will originate. Select a radio button to designate this item as featured or not featured. Featured videos display larger than a thumbnail and are typically the focal point on the page. You should only have one video at a time, in each category, designated as featured. When it is time to present a new featured video, you would edit this video through the datasheet and select the “no” radio button for featured. The replacement featured video would be set to “yes”. Enter a short caption followed by a description which can be any length. The remainder of this dialog depends on whether you chose “Locally Hosted Media” or “Externally Hosted Media” above.

*'''For locally hosted''', we recommend that you provide a preview image by selecting the “select image” button and choosing an image from your file system. Preview images display as thumbnails and also display in the player prior to the start of the video. Preview images are not used for audio files. Selecting the “upload” button will present you with a dialog to upload your audio or video file to your server. The upload will only accept file types (extensions) that you specified in the Multimedia Manager Configuration “upload file types” field. Files that exceed the size specified in the Multimedia Manager Configuration “max file size” field will be rejected. Uploaded files will be stored in the directory specified in the Multimedia Manager “upload path” field. After browsing to your multimedia on your local file system and selecting it, select the “do upload” button.

*'''For externally hosted''', navigate to the site (such as youtube) and click on their link/button to display the video embed code. The correct code will contain the terms “embed” and “object” in the data – if instead you see a url followed by a question mark and some data that is not embed code and will not function within the multimedia application. Vimeo, youtube and google all provide true embed code for your use. Copy the embed code into your clipboard then paste it into the embed code field provided in the Commonspot dialog.

Still on the “Add new Media” dialog screen, select the “Category” tab. This is where you will assign the multimedia, you are adding, to one or more categories. Both the Category and Series tabs use a Commonspot field called a “General Chooser” which displays a drag-and-drop interface. Initially you will want to use the “show all categories” link to display within the general chooser all of the categories you created. In the future, you could alternatively use the search field to find a specific category. Left click on a category in the left column and while holding the left mouse button down drag the category to the right column and release the left mouse button. If you want to assign this multimedia item to a second category, repeat the process (for as many categories as is appropriate.)

When done, select the “submit” button . You will see the message you entered during the installation of the multimedia application – typically something like “Media uploaded successfully!” Close the lightbox containing the message and hit your browser reload button to reload the multimedia manager page. You will see your multimedia displayed in the datasheet.

We recommend that you populate the multimedia manager page with at least 4 starter (test) entries in the same category and at least one or two more entries in different categories. This will provide enough data for you to test features like “display row of 3” videos for a given category and test how to render multiple categories on a page.

'''3)''' To display video or audio on a page, place either the Multimedia Category Gallery element or the Multimedia Series Gallery Element on the page. Both of these elements are “choosers” which, through a drag and drop interface, allow you to choose either a category or series for which to display multimedia. We will use the Multimedia Category Gallery element. After placing the Multimedia Category Gallery element on a page, select the “Click here to define the custom element data” ghost text for the element. On the “Category Select” tab, select the “Show all items” link to display a list of available categories. Highlight a category in the left column by clicking it and then drag and drop it onto the right column to “choose” the category. Repeat the process for as many categories as desired. Note that choosing more than one category effectively merges the categories into a single list of multimedia and then presents them as one. If instead, you wish to present multimedia on the page grouped by category, then drop the category gallery element on the page multiple times and choose a single, but different, category for each instance of the element.

'''4)''' You will notice a tab called, “Results Filter” on the Multimedia and Series Gallery elements chooser dialogue. The normal “render mode” option, which permits filtering results for Commonspot elements, is not applicable when using the Multimedia and Series Gallery elements. It’s important to understand that when using a chooser to determine categories or series for which to display multimedia, you are choosing multimedia by how it is organized. Let’s look at an example of why the render mode option is not applicable in this situation. Say you have a category defined called, “events” and you choose that category via the category gallery element chooser. If you then used the “Render Mode” option to set some kind of filter, because this is a global custom element, the render mode could return more categories than what you chose or not categories at all – neither of these are desirable circumstances. Instead, we have provided the “Results Filter” tab to provide functions similar to the render mode option.

The “results limit” option on the “Results Filter” tab allows you to limit the results to 1 record, 3 records or return all multimedia for this category. If you were displaying a featured item, you would want to limit the results to 1. If you wanted to display a single thumb, you would limit the results to 1. Otherwise, you would choose to display 3 or all records.

The “Featured Limit” enables you to choose to display only a featured item, only items that are not featured or ignore the featured designation and return all items.

The final option on the “Results Filter” tab enables you choose whether you want multimedia sorted by title or release date.

The options on the “Results Filter” work in conjunction with the category you chose to further refine what multimedia is therefore eligible to appear on the page. After you have made your category and results filter selections, click the “finish” button to commit your selections. If you need to return to the element later to change something, select the edit icon for the element and choose the “Data” option from the menu.

'''5)''' The final step in rendering your multimedia is to choose how you want it displayed. Click on the edit icon for the multimedia category gallery element and from the menu choose the “edit Metadata” option. The metadata form presents you with a list of pre-defined display formats from which to choose.

To recap the process – drop the multimedia category gallery element on a page, choose one or more categories and set the render filter options to limit the results. Then select a display format option from the metadata form.

There are some combinations of settings which would render undesirable results. Choosing a render filter selection to limit records to 1 and choosing “row of 3 thumbs” as the display format would obviously not produce a row of three thumbs since only 1 multimedia item would be selected to display.

==Displaying Category Headers==
If you would like to display category (or series) headers, for example above a row of three thumbnails, with a link to view all videos in the category – that can be done by using the category or series element (as opposed to the gallery elements). Place the category element onto the page and move it to the header position. Navigate to the multimedia manager page and click on the category tab. Under the category ID column is the ID associated with each category. Find the appropriate category can copy the category ID into your clipboard. Return to the page where you placed the category element and click on the edit icon for the element. Choose “render mode” from the menu. On the rendering mode tab, select the “display existing element data (content reuse)” radio button. Then click on the filter tab and select “show subset of records” as the filter option. For field, choose “Categoryid”. For operator choose “equals”. For value, paste the category ID from your clipboard. Your filter would display something similar to:

*CategoryID equals 4B4C8EFC-265E-1C05-4D9A968DE839DBC1

Then select the Update button. Verify the correct category appears on the Preview tab and then select the “OK” button. The category header should display with a “view all” link to the right of the category name. If it does not display correctly, verify that the correct render handler is assigned to the category element. Click the edit icon for the category element and then select “more” to expand the menu and then select “custom render handlers”. Select the multimedia category name render handler. The “view all” link retrieves the path to the display page from the PT Multimedia Configuration Manager entry.

[[Category:Multimedia]]

Troubleshooting

2010-11-24T17:42:08Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Ssmith

=== ADF is not reseting ===
Make sure you're logged into the site. The IF block in the custom-application.cfm code requires the user to be logged into the site to reset the ADF. See the [[Reset_ADF|Reset ADF]] wiki page for more info.

=== ADF Applications AppBeanConfig is not updating the sites Application variables ===
Check that you do not have multiple copies of the AppBeanConfig anywhere in the ''apps'' directory. Ensure that you don't have any AppBeanConfig backup or old files under the ''apps'' directory. The AppBeanConfig sets an ''appBeanName'' variable, so if you have multiple files being called only the last file executed will load in application space.

=== How can I see the beans in my object factory? ===
To view all the beans in the object factory do a CF dump of the bean configuration structure:
<cfdump var="#server.ADF.beanConfig.getConfigStruct()#" label="ADF Bean Config" expand="false">

=== What is the ADF Library Component versioning schema? ===
The ADF version schema is based on ''major_minor_revisions''.

See the [[Library_Component_Versions|ADF Library Component Versions]] wiki page for details on ADF versioning schema.

=== Changes to your application components are not seen ===
If you use the "ResetServerADF" and "ResetApplicationADF" parameters and changes to your Application components are still not seen try the following:
# Make sure that the code in your application component is correct
# Make sure that you are logged into CommonSpot (Reset parameters don't function unless you are logged in)

=== Error calling CSContent.populateContent() ===
If you receive an error like:
<pre>
Element elementType is undefined in a Java object of type class com.paperthin.common.serialization.XMLDecoratedMap.
</pre>

Make sure that you have created your ccapi.xml [[CCAPI Config]] correctly. You are probably missing the "<elementType>" xml node.

=== Application Level Configuration Data not loaded ===
If you place an .xml file in your sites /_cs_apps/config directory but the variables you define do not appear in #server.ADF.environment[request.site.id]# then:

# You may have a mall formed XML file
# The value for "rootDir" in the ServerSites Table (from the CommonSpot-Sites database) does not match your site folder structure

=== AjaxService returns <wddx> not value ===
If you are calling AjaxService.cfc with jQuery (or other JS Library) and you are going to work with a return variable, be sure you add "returnformat='json'" to your functions. This is available ONLY in CF8 - it will return the data as a JSON object which will be formatted correctly for use in your return function.

=== ADF Reset is throwing an error when loading a component that was deleted ===
This usually occurs when you update the ADF applications [[App_Bean_Config|App Bean Config]] to remove a reference to a component. Check all your sites that are running a site level [[App_Bean_Config|App Bean Config]]. It is likely one of those config files has a reference to the deleted component.
See the [[Application_Site_Customization|Application Site Customization]] for additional information.

=== ColdFusion Error Msg: Element ADF_APP_NAME is undefined in a CFML structure referenced as part of an expression. ===
The ADF_APP_NAME is not in the /ADF/apps/ directory. This error results when the ADF.cfc for the site is attempting to load an ADF application that is not in the ADF. See the [[Site Configuration (ADF.cfc)]] wiki page for more info.

=== ColdFusion Error Msg: Element logging is undefined in a CFML structure referenced as part of an expression. ===
If you attempt to use any of the components of the CCAPI and you receive this error it is because either:
# You do not have the correct configuration - see [[CCAPI|CCAPI]] for more info or
# The configuration file has not been loaded - try reloading the ADF.

=== Method not found error ===
If you choose to extend a CFC for an Application written in the ADF at the site level (see [[Site Level Customizations]]) and you receive a "Method not found" error - be sure to check the CFC you have in your sites /_cs_apps/... directory - it MUST extend the original CFC from the application

=== Element Class is not defined ===
When calling the CCAPI for any of the actions, you may receive this error:

<pre>The value of CLASS attribute is invalid.</pre>

Be sure that you have a "ccapi.xml" file located in your sites /_cs_apps/config/ directory and that it is configured correctly.

Note: The path to the config file is controlled via the following code:

<pre>ExpandPath("#request.site.csAppsWebURL#config/ccapi.xml");</pre>

The variable: #request.site.csAppsWebURL# can sometimes be different if you have "/" ColdFusion mapping which goes to a different location.

=== Custom Element CCAPI fails with No DB Record Found ===
If you are having trouble using the Content Creation API to update a Custom Element and your populate_content_error.log file in the /commonspot/logs/ directory has the following entries:

<pre>Error recorded: Invalid pageid/pageName. No DB record found.</pre>

It could be that your custom element has a field "pageID" - which will cause this error.

=== General Chooser Field Type does not render ===
If your General Chooser Field is not rendering correctly, go to Firebug and look for any "Red" error "Net" calls. If you see the following error:

<pre>Cannot invoke method controller on an object of type coldfusion.runtime.Struct with named arguments.</pre>

Make sure that the Bean Name you placed into your GC properties dialog matches with your actual GC.cfc file

Remember to [[Reset ADF|reset the ADF]] after making any changes to GC files.

=== "Cannot invoke method" error returned by AjaxProxy ===

If you are calling a method in a component via the [[Ajax Proxy]] and you receive the following error:

<pre>Cannot invoke method "xyz" on an object of type coldfusion.runtime.Struct with named arguments.</pre>

You need to make sure that you have actually declared your component in your appBeanConfig.cfm

[[Category:Troubleshooting]]

Add ADF Library Components into App

2010-11-24T17:42:04Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

== Overview ==
ADF Library Components are CFC's loaded into the core ADF. The components are typically located in the /ADF/lib/ directory and are sectioned into "Classes" of sorts. By adding or "injecting" ADF Library Components into your applications, it will make it easier for you to:
* Program against particular versions of ADF Library Components
* Upgrade your applications

== Instructions ==
Here are some instructions for adding an ADF Library Component into an ADF Application:

# Open the ''AppBeanConfig.cfm'' file in your applications directory. See the [[App Bean Config|App Bean Config]] wiki page for more details.
# Identify what ADF Library components and version you want added to your application.
# Add the 'addConstructorDependency' command into the [[App Bean Config|App Bean Config]].
addConstructorDependency(BeanName, InjectedBeanName, PropertyName);
# The parameters for the 'addConstructorDependency' command are as follows:
## BeanName:string:required - The name of the bean (Singleton or Transient) to add the Dependency to.
## InjectedBeanName:string:required - The name of the bean to inject.
## PropertyName:string:optional - The optional property name to pass the bean into. Defaults to the bean name if not provided.
# The following is an example of adding a dependency for the ''Scripts_1_0'' ADF library component to your application.
addConstructorDependency(appBeanName, "scripts_1_0", "scripts");
# Where ''scripts_1_0'' is the ADF Library component and the property name will be ''scripts'' when referenced within the apps application scope (i.e. Application.MYAPP.scripts).

== Using ADF Library Components in your App ==
Now that you have loaded the ADF Library Component into your application you can now write code similar to this in your applications render handlers, custom scripts and custom field types:

<pre>
<cfscript>
application.myApp.scripts.loadJQuery();
application.myApp.scripts.loadJQueryUI();
</cfscript>
</pre>

[[Category: How-to Guide]]

ADF Training Agenda

2010-11-24T17:42:00Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

Welcome to the ADF Training class.

'''Training Goals'''

'''Class Structure'''

'''The Development Environment'''

'''The Docs'''

'''Terminology Review'''

'''Key Directories'''

'''Installation [Exercise]'''
Learn how easy it is to install the ADF

* Server Configuration
* Site Configuration
* Testing

'''Getting Started [Exercise]'''
Installing the PT Tag application

<b>Object Factory</b>
One of the core components of the ADF is the ADF Object Factory

* What is an Object Factory
* Different types/examples of Object Factories
* Beans
* Configurations
* Singleton
* Transient
* Dependency Injection

<b>ADF Object Factories</b>
There are 2 Object Factories within the ADF

* Server
* Site
* Initialization

<b>ADF Directories</b>
Review of the ADF open source libaray

* Core Framework
* Extensions
* Library
* Third Party
* Site Level

<b>Security</b>
Get an understanding for the security measures taken with the ADF

* General Concepts
* Ajax Calls
* Web configuration

<b>Resetting the ADF</b>

* When do I reset?
* What do I reset?

'''Working with the ADF'''
Where do I write all of my code so that I can update the ADF

* Library Components
* Applications
* Extensions

<b>Library Components</b>
Getting data from CommonSpot has never been easier. Learn how to use the Library components to integrate tightly with CommonSpot

* Configuration
* Examples
* Library API Review
* Community Site Documentation
* Versioning
* Dependency Injection

'''Getting Data from a Custom Element [Exercise]'''

'''Site Level ADF and Library [Exercise]'''
Configure the Site to use the ADF and to override standard ADF Library Components

* Extending Library Components at the site level

'''Custom Elements'''
The core data repository as seen through the eyes of the ADF

* Connecting Custom Elements
* UniqueID vs. dataPageID (pageID)

<b>Extensions [Exercise]</b>
There are many CommonSpot components available in the Extensions section of the ADF. Learn how to use them in your sites and Applications

* Datasheet Modules
* Custom Fields
* Custom Scripts
* The "list" field type

<b>General Chooser</b>
A unique, highly extendable Custom Field Type that is designed to easily connect two Custom Elements.

* General Information
* Building a chooser

<b>Custom Elements</b>
The core data repository as seen through the eyes of the ADF

* Connecting Custom Elements

<b>Third Party</b>
There are additional open source libraries included with the ADF. Learn how they can be used to extend your Application.

* General Overview
* Working with jQuery
** Examples
** jQueryUI
* Adding New Components

'''Environment Data'''
Variable data stored at the Server and Site level for Library Components and Applications

* Memory Structures
* XML Configuration

<b>Content Creation API [Exercise]</b>
An essential component of any ADF Application is the ability to create/modify new content

* General Concepts of CCAPI
* Configuring CommonSpot for CCAPI
* CCAPI vs. CCAPI
* Components
** CCAPI
** csContent
** csPage
** csSubsite
** csUpload
* Site Level Configuration

Examples
* Create a Page
* Populate Content (adding and editing)
* Create Subsites

<b>Ajax Proxy [Exercise]</b>
Adding Ajax calls to your Application code is a lot easier than you think. See how you can add Post/Get and general Ajax methods in a snap.

* General Usage
* jQuery and Ajax
* Returnformat - plain vs. json

<b>Applications [Exercise]</b>
At the heart of the ADF is the Application itself. We will learn how to construct and manage your Application code.

* What is an application?
* Major components of an Application
** AppBeanConfig
** App.cfc
** Components
** Custom Elements
** Site Level Configuration
** XML
** Custom Elements
* Override/Extending
** ADF Library Component
** Application Component at the Site Level
* Starter Application
* Naming Conventions
* Best Practices (A review of the Navigation Element)

<b>Community Site Projects</b>
Once you have built your application you will need to learn how to allow the community to leverage your code.

* Building a Project
* Supporting your Project
* Maintaining your code
** Uploading Initial Version
** Updating
* Documenting your Application

<b>SVN</b>
Maintaining your code is simple when you learn how easy you can store it in the publically available SVN

* SVN Server
* Tortoise
* Subclipse
* Folder configurations
** Branches
** Tags
** Trunk

PT Photo Gallery Upload Link CFT

2010-11-24T17:41:56Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Mcarroll

== Overview ==
The Photo Upload Link custom field type provides a link to create a photo element record. This is used to integrate a photo field into an element with using the Photo Gallery.

Follow the steps below to import the custom field type, if necessary, and configure the field type within an element.

== Import ==
# Check to see if the ''Photo Upload Link'' custom field type is already imported and active within the site. If not, then continue following the import steps. If the custom field type is active in the site, then proceed to the configure section below.
# Open the ''Field Render Masks & Custom Field Types'' window from the CommonSpot admin.
# Select the ''Import Custom Field Type'' link.
# Browse to the ADF and select the following path and file:
## '/ADF/apps/pt_photo_gallery/customfields/Photo-Upload-Link-Custom-Field-Type.zip'
## '''Important Note:''' The imported components render handlers and custom field types must be verified. During the import process the render handler paths may have been changed to reflect the current sites path. Review and update these paths to reference the ADF path. In most cases, this will just require a change in the path from the site name to 'ADF'. Custom field types will need to be unlocked.

== Configure ==
# Open the Custom Element field definitions with the Photo Upload Link field.
# Add a new field and select the type as ''Photo Upload Link''.
# Optional: In the properties tab, you can assign a value to the fields ID attribute. This is usefully when using JQuery or JavaScript to access the fields value via the DOM. Leaving this field blank is also acceptable.

[[Category:Photo Gallery]]

Twitter Import Elements

2010-11-24T17:41:48Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Cmora

== Overview ==
The Twitter Application has three Custom Components defined within CommonSpot. The components have been exported and are available in the app's "exported-objects" folder located at the root of the Twitter application directory (e.g. /ADF/apps/twitter/exported-objects/).

Optional: You may want to create a new category within the CommonSpot Element Gallery for 'Twitter Elements'.

To import these objects, you will need to be an administrator for your site. If you are not a site administrator, consult your Server administrator for more information.

== Import ==
Follow these steps to import the Custom Elements:

# Go to your site's admin.cfm (CommonSpot's Site Administrator).
# Expand the 'Elements & Forms' tab and click on 'Elements'.
# In the Manage Elements screen click on 'Manage Categories'.
# Now click the 'Add New Category' link and create a 'Twitter Elements' category.
# Close the 'Manage Element Categories' screen.
# Back in the 'Manage Elements' screen click on the 'Import Custom Element' link.
# Now click on 'Browse...' and go to the /ADF/apps/twitter/exported-objects/ folder
# Click on one of the ZIP files to import that custom element.
# Be sure to choose your new 'Twitter Elements' category
# Click Next.
# Repeat steps 7-10 for other custom elements in the exported-objects folder.

== Verify Imports ==
The imported components' render handlers must be verified. During the import process, the render handler paths may have been changed to reflect the current site's path.

Review and update these paths to reference the ADF path. In most cases, this will just require to be unlocked and a change in the path from the site name to 'ADF'.

[[Category:Twitter]]

Site Level Component

2010-11-24T17:41:35Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

== Overview ==
Have some code in a CFC that you would like to make accessible to your site? Building a Site Level Component is one of the easiest ways to take advantage of the ADF.

== How to Create a Site Level Component ==
If you have an existing CFC (or a new CFC that you would like to create) with some methods that you would like to use in CommonSpot Element Filters or in Render Handlers, Custom Scripts or CommonSpot Overrides, you can make them accessible by

* Create a directory called "components" in your sites /_cs_apps/ directory (e.g. /mySite/_cs_apps/)
* Place your component (CFC) into the newly created components directory
* Modify the <cfcomponent> to extend "ADF.core.SiteBase"

<source lang="java">
<cfcomponent extends="ADF.core.SiteBase"> ... {methods} ... </cfocmponent>
</source>

* [[Reset ADF| Reset the ADF]]

== Using your Site Level Component ==
Now that you have loaded your component you can write code as simple as this:

<source lang="java">
<cfset myData = application.ADF.mySiteLevelComponent.methodName("some value")>
</source>

[[Category: How-to Guide]]

Like Button

2010-11-24T17:41:31Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Cmora

== Overview ==
Like Button Custom Element which adds Facebook's Like button to a page, allows users to share interesting pages on Facebook.

== Fields ==
<h3>Like Button</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>
<tr>
<td>Action</td>
<td>action</td>
<td>Selection List</td>
<td>No</td>
<td>Options: Like, Recommend</td>
</tr>
<tr>
<td>Layout</td>
<td>layout</td>
<td>Selection List</td>
<td>No</td>
<td>Options: Standard, Button_Count</td>
</tr>
<tr>
<td>Show Faces</td>
<td>showFaces</td>
<td>Radio button</td>
<td>No</td>
<td>Default value: True</td>
</tr>
<tr>
<td>Color Scheme</td>
<td>colorScheme</td>
<td>Selection List</td>
<td>No</td>
<td>Options: Light, Dark</td>
</tr>
<tr>
<td>Font</td>
<td>font</td>
<td>Selection List</td>
<td>No</td>
<td>Options: Arial, Lucida Grande, Tahoma, Trebuchet MS, Verdana</td>
</tr>
<tr>
<td>Width</td>
<td>width</td>
<td>Number (integer)</td>
<td>No</td>
<td>Degault Value: 400</td>
</tr>
</table>

[[Category:Facebook]]

PT Photo Gallery Styles

2010-11-24T17:41:28Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rkahn

== Overview ==
There are several out of the box style options for the Photo Gallery application. The styles are defined in the following style sheets located in the ''/pt_photo_gallery/style/'' directory within the ADF Photo GalleryApp directory:

* ptPhotoGallery.css (/ADF/apps/pt_photo_gallery/style/ptPhotoGallery.css)

The recommended approach is to load this style sheet into your Base Plus One Template.

'Note:' the classes and styles defined for the Photo Gallery are targeted tightly for the layout generated by the Photo Gallery application and should not interfere with your site styles. However, it is a good idea to give these styles sheets higher precedence in your style definitions.

Like Box

2010-11-24T17:41:25Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Ssmith

== Overview ==
Like Box Custom Element that enables users to like your Facebook Page and view its stream directly on your website.

== Fields ==
<h3>Like Box Feed</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>
<tr>
<td>Page ID</td>
<td>pageID</td>
<td>Number (integer)</td>
<td>Yes</td>
<td>None</td>
</tr>
<tr>
<td>Show Stream</td>
<td>stream</td>
<td>Checkbox</td>
<td>N/A</td>
<td>Checked by default</td>
</tr>
<tr>
<td>Show Header</td>
<td>header</td>
<td>Checkbox</td>
<td>N/A</td>
<td>Not checked by default</td>
</tr>
<tr>
<td>Width</td>
<td>width</td>
<td>Number (integer)</td>
<td>No</td>
<td>None</td>
</tr>
<tr>
<td>Connections</td>
<td>connections</td>
<td>Number (integer)</td>
<td>No</td>
<td>10</td>
</tr>
</table>

[[Category:Facebook]]

Facebook App Like Box Element

2010-11-24T17:41:21Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Cmora

== Overview ==
The Like Box enables users to like your Facebook Page and view its stream directly from your website.

== Setup ==
1. Import the ''Like Box'' custom element. <br /> <br />
'''Note:''' Verify the path for the render handler points to the ''ADF'' mapping, not the current site's mapping.<br />

== Demo ==
To set up a demo of the Like Box custom element, follow these steps:
# Create a new page and place the ''Like Box'' element on the page.
# Click the 'New Data' button.
# Enter your Facebook Page's Page ID. If you don't know the ID for your Facebook Page, an easy way is to go to your Facebook Page and click on its profile picture. Once the page loads you'll see that the URL in the address bar ends with "id=xxxxxxxxxxxxxxxx", that number is your Facebook Page's Page ID.
# Edit the rest of the custom element data to your liking (or just leave the defaults) and click '''Save'''.
# Submit the changes to the page.

[[Category:Facebook]]

PT Multimedia Styles

2010-11-24T17:41:17Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rkahn

== Overview ==
The Multimedia application ships with a style sheet to insure proper display of your multimedia. The styles are defined in the following style sheet located in the ''/pt_multimedia/style/'' directory:

* ptmultimedia.css (/ADF/apps/pt_multimedia/style/ptmultimedia.css)

The recommended approach is to load this style sheet into your Base Plus One Template.

'Note:' the classes and styles defined for the Multimedia application are targeted tightly for the layout generated by the Multimedia application and should not interfere with your site styles. However, it is a good idea to give these styles sheets higher precedence in your style definitions.

Forum Messages

2010-11-24T17:41:13Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Ssmith

== Fields ==

<h3>Tab #1: Forum Messages</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>

<tr>
<td>MsgID</td>
<td>MsgID</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: CreateUUID()<br/>

</td>
</tr>

<tr>
<td>Thread Name</td>
<td>ThreadID</td>
<td>Custom Element Select Field</td>
<td>Yes</td>
<td>

</td>
</tr>

<tr>
<td>Message Name</td>
<td>msgName</td>
<td>text</td>
<td>Yes</td>
<td>
Maxlength: 255<br/>
Size: 40<br/>

</td>
</tr>

<tr>
<td>Message</td>
<td>msgBody</td>
<td>large_textarea</td>
<td>No</td>
<td>
Rows: 8<br/>
Size: 40<br/>

</td>
</tr>

<tr>
<td>User</td>
<td>profileID</td>
<td>Forums User Select Field</td>
<td>Yes</td>
<td>

</td>
</tr>

<tr>
<td>Message Created</td>
<td>msgPostDate</td>
<td>hidden</td>
<td>No</td>
<td>
Defaultvalue: Now()<br/>

</td>
</tr>

<tr>
<td>Attachment</td>
<td>attachment</td>
<td>Custom Hidden Field</td>
<td>No</td>
<td>

</td>
</tr>

<tr>
<td>Filename</td>
<td>filename</td>
<td>Custom Hidden Field</td>
<td>No</td>
<td>

</td>
</tr>

<tr>
<td>Message Modified Date</td>
<td>msgModifiedDate</td>
<td>Custom Hidden Field</td>
<td>No</td>
<td>

</td>
</tr>

<tr>
<td>Message Modified By</td>
<td>msgModifiedByProfileID</td>
<td>Custom Hidden Field</td>
<td>No</td>
<td>

</td>
</tr>

</table>

Follow Button

2010-11-24T17:41:10Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Cmora

== Overview ==
Follow Button Custom Element for adding Twitter follow buttons on CommonSpot pages.

== Fields ==
<h3>Follow Button</h3>
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>
<tr>
<td>Twitter Username</td>
<td>username</td>
<td>Text</td>
<td>Yes</td>
<td>N/A</td>
</tr>
</table>

[[Category:Twitter]]

PT Photo Gallery Lightbox Template

2010-11-24T17:41:06Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Mcarroll

== Overview ==
The Lightbox template will be used to render pages within a lightbox. The Lightbox template may already exist on your site if you have installed another ADF application. Check your sites templates before following the steps below to create the template.

== Steps ==
# Create a new page named ''Lightbox Template'' from the blank template.
# Submit and activate the page.
# Save the page as a template.
# Submit the template for public use.

Application Configuration at the Site Level (XML)

2010-11-24T17:41:03Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

== Overview ==
Every ADF Application can have Site Level configuration file to help the application do special things depending on the settings/pages/templates within your site. For example, the [[Profile| Profile Application]] has several settings which allow the application to interact with various pages within your site. The settings at the site level allow more than one CommonSpot site on your server to act differently but use the same application code base.

== Example Site Level Configuration for your App ==
Below is an example of how you could take advantage of an Site Level Configuration file within your application. For our example, we will create a fictitious application called "twitter". The application folder is located in /ADF/apps/twitter/ and contains various scripts/components and Custom Elements.

Lets say in your Twitter application you wanted to have various settings like API Limit and Retweet Style. By having these settings your application can be used in many sites and each site can have its own values.

=== Create config file ===
# Locate the ''_cs_apps'' directory in your site.
# If the ''_cs_apps/config'' directory does not exist, create it.
# Create a file called twitter.xml
# Place the following code in your twitter.xml file:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<settings>
<apiLimit>150</apiLimit>
<retweetStyle>Old</retweet>
</settings>
</pre>

=== Using site config variables ===
By default your Sites "App.cfc" (located in the /ADF/apps/myApp/components/ directory) contains a method (by virtue of extending AppBase.cfc (located in the /ADF/core/ directory) called "getAppConfig()". This returns back the current sites configuration which is based on the values entered into the XML file (mentioned above). Calling that function would return a structure like this:

[[File:Site_config_struct.png]]

== Related Guides ==
* [[Buidling an ADF Application]]
* [[Load_ADF_Components_into_Site|Load ADF Library Components into Site]]

[[Category: How-to Guide]][[Category: Site Configuration]]

Taxonomy 1 0-getCSTaxObj

2010-11-24T17:40:59Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Taxonomy_1_0]]

== Description ==
Returns the taxonomy object for a given taxonomy name

== Signature ==
public any <strong>getCSTaxObj</strong> ( string taxName )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>taxName</td>
<td>string</td>
<td></td>
</tr>

</table>

== Examples ==

Using the getCSTaxObj function is simple and straight forward. Making a call to this method will return a component which contains all of the Taxonomy API calls available in the CommonSpot Taxonomy.

=== CE Data calls return Taxonomy Term ID ===
If you have Taxonomy fields inside your Custom Element and you make calls to get data for that custom Element using CEData, the Taxonomy fields will return term ID's. You can convert those term ID's using code like this:
<source lang="cfm">
<cfscript>
// custom element data
data = application.ADF.ceData.getCEData("My Element");
// returns taxonomy object
taxObj = application.ADF.taxonomy.getCSTaxObj("My Taxonomy");
</cfscript>

<cfloop from="1" to="#arrayLen(data)#" index="itm">

<cfoutput>#taxObj.getTermName(data[itm].values.myTaxField)#</cfoutput>
</cfloop>
</source>

Utils 1 0-abort

2010-11-24T17:40:56Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public string <strong>abort</strong> ( )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

</table>

Scripts 1 0-loadJQueryUIStars

2010-11-24T17:40:52Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
Loads the JQuery UI Stars plugin

== Signature ==
public void <strong>loadJQueryUIStars</strong> ( string version )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 2.1] Script version to load.</td>
</tr>

</table>

Data 1 0-arraydeletearray

2010-11-24T17:40:47Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Data_1_0]]

== Description ==

== Signature ==
public array <strong>arraydeletearray</strong> ( array baseArray, array deleteArray )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>baseArray</td>
<td>array</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>deleteArray</td>
<td>array</td>
<td></td>
</tr>

</table>

Scripts 1 0-loadAutoGrow

2010-11-24T17:40:44Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
Loads the AutoGrow jQuery Plug-in Headers if not loaded.

== Signature ==
public void <strong>loadAutoGrow</strong> ( string version )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 1.2.2] AutoGrow version to load.</td>
</tr>

</table>

Site Configuration (ADF.cfc)

2010-11-24T17:40:40Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rwest

== Overview ==
A key part of the configuration of the ADF for your site is the ADF.cfc located in your sites /_cs_apps/ directory (e.g. /mySite/_cs_apps/ADF.cfc).

This ADF component file is used to build an ADF object factory into application space for the site. The ADF component contains three distinct operations:
# Load the ADF into the site.
# Load ADF applications into the site.
# Load the ADF library components into the site.

=== Site Components ===
This initialized call builds the ''application.ADF'' object factory. This function will load any site components in the '_cs_apps/components' directory into 'application.ADF' space. The structure reference name will be the file name of the component.

<source lang="java">
/*
*
* Load the Site Environment Configs/Elements and
* Components ('/_cs_apps/components') into the site.
*
*/
loadSite();
</source>

=== ADF Applications ===
To make an ADF application accessible at the site level, the ADF application must be loaded into the site's application scope.

This setup is in the ADF Component at the site. Call the loadApp function through the ADF cfc. Pass the argument for the ADF application bean name (this name is defined when creating a new ADF application, [[Create_New_App|Create New ADF App]]).
<source lang="java">
/*
* Load the ADF Application into application space
*
* SAMPLES:
* loadApp("CustomAppBeanName");
*/
loadApp("ptProfile");
</source>

=== ADF Library Components ===
This command will load the latest versions of the ADF library components into the site, making the ADF library components accessible through the application.ADF scope throughout the site.
<source lang="java">
/*
*
* Define the ADF components to load into the sites application space.
*
*/
loadLibrary();
</source>

=== ADF Library Components Overrides ===
This command will override the latest version of an ADF library component into the site.
<source lang="java">
/*
* Define specific ADF Lib component version to load into the sites application space.
*
* SAMPLE:
* resetLibrary("csdata_1_0", "csdata");
*
*/
resetLibrary("csdata_1_0", "csdata");
</source>

== Verify ==
To verify the site has been configured correctly, [[Reset ADF|reset the ADF]] on the site to load the ADF into application space.

[[Category: Site Configuration]]

PT Photo Gallery Photo Admin Datasheet

2010-11-24T17:40:34Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Mcarroll

== Overview ==
The Photo Gallery element is a global custom element. Managing data for global custom elements can be configured easily through the use of Datasheets. The following sections will describe how to configure the datasheet to manage the photo element data.

== Steps ==
# Open the ''Photo Manager'' page in author mode.
# On the first tab labeled "Photo" is a Datasheet element.
# From the Datasheet element interface, click the "Datasheet" icon.
# From the "Datasheet Views" dialog, follow the "Click here to create a new datasheet view" link.
# Enter the following information and then click "Next":
## Name: All Photos
## Private: unchecked
## Default View: unchecked
## Description: View to manage all of the photos
## Datasheet Source: Form Result/Custom Element Sheet
# From the Datasheet Source dialog choose the "Photo" custom element and click "Next".
# From the Datasheet Columns Dialog select the columns PhotoID, Photo, Title, Category from the Available Columns list and move them to the Selected Columns list and then click "Finish".
# You will be directed to the Datasheet View page. Click "Close" to return to your page.
# You will now see the datasheet element on this page. Click the Datasheet element interface icon again and choose "Edit Columns".
# From the Datasheet View Column Properties dialog, select the ''PhotoID'' column, then edit. Update the following settings for column:
## Remove the text from the ''Header'' field.
## Change the Render Handler to the following file: ''/ADF/apps/pt_photo_gallery/datasheet-modules/photo-update-edit-form-data.cfm''
# From the Datasheet View Column Properties dialog, select the ''Category'' column, then edit. Update the following setting for column:
## Change the Render Handler to the following file: ''/ADF/apps/pt_photo_gallery/datasheet-modules/category-display-render.cfm''
# From the Datasheet View Column Properties dialog, select the ''Photo'' column, then edit. Update the following setting for column:
## Change the Render Handler to the following file: ''/ADF/apps/pt_photo_gallery/datasheet-modules/photo-image-preview-display-render.cfm''
# Close the Edit Column window.
# Set the datasheet layout to sort by the ''Title'' field and results per page to 25.
# Publish this page.

[[Category:Photo Gallery]]

Blogs

2010-11-24T17:40:29Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Ssmith

=Overview=
Blogging in CommonSpot should be as simple and easy as managing events. Users should be able to add/modify/delete and reuse blog content easily. The reworking of the original blog application will build upon the lessons learned and take advantage of new ADF features.

== Getting Started ==
* [[Install CS Blog Version 2 | Install ]]

==Requirements==
* Each blog post should have their own page.
* Each blog should belong to a subsite.
* Tags should be used for both categorization and page metadata (keywords).
* Blog posts should have the option to display comments (or not)
* Blogs should be managed from a central administrator.

==Technical Specs==
* Custom Field type for categories should preform better than the previous application.
* Calendar Element will be handled similar to Events element using a RH on the Blog Element with the proper filter.
* Creating a blog post will use the [[Add Blog Post]] Custom script which will create the page similar to the way the American AUpedia application is completed.
* In the [[Add Blog Post]] functionality a [[CS CFT Subsite]] would be used to create a new subsite for the new blog.

==Elements==
[[Image:Cselements_blog.png]]
* [[CS Blog Version 2 Element Blog]]
* [[CS Blog Version 2 Element Post]]
* [[CS Blog Version 2 Element Comment]]

==Scenarios==
* [[Add Blog]]
* [[Edit Blog]]
* [[Add Blog Post]]
* [[Edit Blog Post]]

==Potential==
* Move Blog

[[Category:Project]]
[[Category:Blogs]]

PT Profile Subsites

2010-11-24T17:40:23Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Mcarroll

== Overview ==
It is '''highly recommended''' to create a Profile Web Admin subsite for administrators and a Profile Lightbox subsite for the lightbox pages. This allows security to be setup for the subsite to allow only administrators access for the webadmin and the CS toolbar turned off for the lightbox pages.

Your site may already have a ''webadmin'' and/or ''lightbox'' subsite. The steps below will add a ''profile'' subsite into the ''webadmin'' and ''lightbox'' subsites.

== Web Admin ==
# Create a new subsite under the site root called ''webadmin''.
# Create a new subsite under ''webadmin'' called ''profile''.
# Configure the ''/webadmin/profile/'' subsite Content Security to give 'No Rights' to 'Anonymous Users' and 'Authenticated Users'.
# Configure the ''/webadmin/profile/'' subsite Content Security to give permissions to the group of administrators who will manage the Profiles.

== Lightbox ==
# Create a new subsite under the site root called ''lightbox''.
# Create a new subsite under ''lightbox'' called ''profile''.

== Profiles ==
The subsite for the profile pages must be created manually. This subsite is custom to your implementation and can be any subsite within the site. This subsite will correspond to a [[PT_Profile_Roles|Profile Role]]. This means that all the profile pages created for this role will live in this subsite.

If you don't have a specific subsite then create a ''Profiles'' subsite under the site root.

The subsite for the profile pages is configured through the [[PT_Profile_Roles|Profile Roles]]. The subsite ID is stored in the [[PT_Profile_Site_Configuration|Site Configuration]] for the [[PT_Profile_Roles|Profile Roles]].

Once the subsite is in place for the profile pages then update the [[PT_Profile_Site_Configuration|Site Configuration]] with the subsite ID for the profile role.

[[Category:Profile]]

CS Blog Version 2 Element Comment

2010-11-24T17:40:14Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Rkahn

== Overview ==
Comments custom element used to store comment specific data.

== Fields ==
<table id="ce-fields">
<tr class="header">
<td>Field Name/Label</td>
<td>Field ID</td>
<td>Field Type</td>
<td>Required?</td>
<td>Properties</td>
</tr>
<tr>
<td>CommentID</td>
<td>CommentID</td>
<td>Unique ID</td>
<td>No</td>
<td></td>
</tr>
<tr>
<td>Name</td>
<td>name</td>
<td>text</td>
<td>No</td>
<td>Maximum Length: 255<br/>Size: 45</td>
</tr>
<tr>
<td>E-mail</td>
<td>email</td>
<td>Email</td>
<td>No</td>
<td>Maximum Length: 255<br/>Size: 20</td>
<tr/>
<tr>
<td>URL</td>
<td>blogURL</td>
<td>url</td>
<td>No</td>
<td>Maximum Length: 255<br/>Size: 45</td>
<tr/>
<tr>
<td>Comments</td>
<td>comments</td>
<td>small_textarea</td>
<td>No</td>
<td>Maximum Length: 255<br/>Size: 45<br/>row</td>
<tr/>
<tr>
<td>dateCreated</td>
<td>dateCreated</td>
<td>hidden</td>
<td>N/A</td>
<td>{request.formattedTimeStamp}</td>
<tr/>
<tr>
<td>createdBy</td>
<td>createdBy</td>
<td>hidden</td>
<td>N/A</td>
<td>{request.user.id}</td>
<tr/>
<tr>
<td>contentPageID</td>
<td>contentPageID</td>
<td>hidden</td>
<td>N/A</td>
<td>0</td>
<tr/>
<tr>
<td>formID</td>
<td>formID</td>
<td>hidden</td>
<td>N/A</td>
<td>0</td>
<tr/>
<tr>
<td>blogID</td>
<td>blogID</td>
<td>hidden</td>
<td>N/A</td>
<td>0</td>
<tr/>
<tr>
<td>postID</td>
<td>postID</td>
<td>hidden</td>
<td>N/A</td>
<td>0</td>
<tr/>

[[Category:Blog]]

PT Forums ADF Configuration

2010-11-24T17:40:09Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Gcronkright

Back to [[Forums|PT Forum Overview]]

== Overview ==
The PT Forums Application is built within the ADF. The ADF must be installed in the site to run the PT Forums Application, follow the [[Installation|ADF Installation]] instructions.

== Steps ==
* Open the sites 'ADF.cfc' ([[Site Configuration (ADF.cfc) | See Site Configuration (ADF.cfc) for more details]]) file (/_cs_apps/ADF.cfc) in a text editor. Locate the ''Load the ADF Application into application space'' comment in the file. Add (or uncomment) the following command under the comment section:
<source lang="java">
loadApp("ptForums");
</source>
* [[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Forums]]

PT Forums Messages

2010-11-24T17:40:03Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Mcarroll

Back to [[PT Forums Build Templates Pages|Build Templates/Pages]]

== Overview ==
The Forum Messages page is the last level of the forum listing pages. This page is where posts to a thread display.

To construct your Forum Messages page complete the following steps:

== Steps ==
# Create a CommonSpot page called 'Messages'* from the Forums template.
# Place the ''Forum Messages'' Custom Element on this page.
# Click ''Render Mode'' in the element interface.
# Select ''Display existing element data (content reuse)'' on the ''Rendering Mode'' tab.
# Select the ''Filter'' tab.
# Select Filter Type to ''Show subset of records''.
# Select the field drop-down as the ''Thread Name'' field.
# Select the operator as ''Equals''.
# Click the '...' button to open the ColdFusion expression window.
# Enter the text ''request.params.threadid'' as the expression and check the ''force cache'' checkbox. Click ''OK'' and then check the box to ''Ignore ColdFusion error'', then click ''OK''.
# Select the sort order drop-down as the ''Message Created'' field and ''Ascending''.
# Click ''OK'' on the render mode window.
# Click ''More'' in the element interface. Then the ''Custom Render Handlers'' menu option, and choose the ''Default'' or ''Messages Page'' Render Handler.
# Publish the Page

== Update Configuration ==
Update the ptForum Configuration for the 'FORUM MESSAGES URL' field. Edit the row in the datasheet and select the CommonSpot page that was created.

[[Reset ADF|Reset the ADF]] for the server and site.

[[Category:Forums]]

Getting Started

2010-11-24T17:39:47Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Ssmith

== Overview ==
[[Installation| Installing the ADF]] should have been a breeze. Now that you have it up and running what can you do with it? There are many aspects of the ADF that can help make it easier to organize and maintain your code. Here are a few things you can do to get started:

# Install the [[Starter Application | Starter App]]
# Create a [[Site Level Component]]
# [[Calling an ADF Library Component | Call a Library Component]]
# [[Site Level ADF Library Components Overrides | Extend a Library Component]]

PT Calendar2 Lightbox Template

2010-11-24T17:39:41Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Gcronkright

Back to [[PT Calendar2 Build Subsites Templates and Pages|Build Subsites, Templates and Pages]]

== Overview ==
The Lightbox template will be used to render pages within a lightbox.

== Steps ==
# Create a new page named 'Lightbox Template' from the blank template.
# Submit and activate the page.
# Save the page as a template.
# Submit the template for public use.

Data 1 0-ArraySort2D

2010-11-24T17:39:30Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Data_1_0]]

== Description ==

== Signature ==
public array <strong>ArraySort2D</strong> ( array arrayToSort, numeric sortColumn, string type, string delim, string sortOrder )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>arrayToSort</td>
<td>array</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>sortColumn</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>type</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>delim</td>
<td>string</td>
<td>[Default: |] </td>
</tr>

<tr>

<td> </td>

<td>sortOrder</td>
<td>string</td>
<td>[Default: asc] </td>
</tr>

</table>

Scripts 1 0-loadJQueryCheckboxes

2010-11-24T17:39:24Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
Loads the JQuery checkboxes Headers if not loaded.

== Signature ==
public void <strong>loadJQueryCheckboxes</strong> ( string version, boolean force )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 2.1] JQuery Checkboxes version to load.</td>
</tr>

<tr>

<td> </td>

<td>force</td>
<td>boolean</td>
<td>[Default: 0] Forces JQuery Checkboxes script header to load.</td>
</tr>

</table>

CSData 1 0-getDefaultRenderHandlerHTML

2010-11-24T17:39:18Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[CSData_1_0]]

== Description ==
Returns the HTML for the default render handler with the passed in element name.

== Signature ==
public string <strong>getDefaultRenderHandlerHTML</strong> ( string elementName, Array dataArray )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>elementName</td>
<td>string</td>
<td>Custom element name</td>
</tr>

<tr>

<td> </td>

<td>dataArray</td>
<td>Array</td>
<td>Render Handler data array</td>
</tr>

</table>

Scripts 1 0-loadjQuerySWFObject

2010-11-24T17:39:12Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
Loads the SWFObject jQuery Plug-in Flash Embed Headers if not loaded.

== Signature ==
public void <strong>loadjQuerySWFObject</strong> ( string version )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 1.0.9] jQuery SWFObject version to load.</td>
</tr>

</table>

Scripts 1 0-loadJQueryJSON

2010-11-24T17:39:05Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
Loads the JQuery JSON Headers if not loaded.

== Signature ==
public void <strong>loadJQueryJSON</strong> ( string version, boolean force )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 2.2] JQuery JSON version to load.</td>
</tr>

<tr>

<td> </td>

<td>force</td>
<td>boolean</td>
<td>[Default: 0] Forces JQuery JSON script header to load.</td>
</tr>

</table>

CSData 1 0-isCSPageActive

2010-11-24T17:38:57Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[CSData_1_0]]

== Description ==
Returns T/F for the active status of the page id.

== Signature ==
public boolean <strong>isCSPageActive</strong> ( numeric pageID )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>pageID</td>
<td>numeric</td>
<td>Page ID to verify the active/inactive status</td>
</tr>

</table>

Data 1 0-decimalRound

2010-11-24T17:38:49Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Data_1_0]]

== Description ==

== Signature ==
public numeric <strong>decimalRound</strong> ( numeric numberToRound, numeric numberOfPlaces )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>numberToRound</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>numberOfPlaces</td>
<td>numeric</td>
<td></td>
</tr>

</table>

Data 1 0-formatUUID

2010-11-24T17:38:37Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Data_1_0]]

== Description ==

== Signature ==
public UUID <strong>formatUUID</strong> ( string uuid )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>uuid</td>
<td>string</td>
<td></td>
</tr>

</table>

Data 1 0-capFirst

2010-11-24T17:38:31Z

Rwest: Reverted edits by Ecaxabu (Talk) to last revision by Api

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Data_1_0]]

== Description ==

== Signature ==
public string <strong>capFirst</strong> ( string str )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>str</td>
<td>string</td>
<td></td>
</tr>

</table>