Gooddogs Development Blog

Repository Module: Modify Display of Attributes

Mar 15

Written by:
3/15/2011 9:23 AM  RssIcon

Creating Custom Attributes

You drop a Repository module on a page and in the Module Settings, you setup an Attribute named “Color” and configure it to have 3 possible values, “Red”, “White” and “Blue”. You start by entering “Color” in the Attribute field and clicking on the “ADD ATTRIBUTE” link. You’ll then see your new Attrbute listed. Click on the new Attribute to select it, then begin entering Values for that Attribute. Enter “Red” and click “ADD VALUE”, then enter “Blue” and finally “White” clicking the “ADD VALUE” link after entering each one. When done you should have something that looks like this, a custom attribute with three possible values.

image

After we save our module settings, we’ll now see a checkbox list of Attributes available on the Upload form, where we can check which attributes we want assigned to the item we’re uploading.

image

However, If we now upload an item to our module, we won’t see our Custome Attributes Sad smile.

image

Displaying Custom Attributes

Next, in order to see the attributes that each item has been assigned, we need to make a small change to our “template.html” file.  As always, when modifying one of the standard template, copy the template folder from “DesktopModules/Repository/Templates” to “/Portals/n/RepositoryTemplates”.  If the “RepositoryTemplates” folder does not exist, just create it. 

So, in this example, we’ll modify the “default” folder. After copying it from it’s “DesktopModules” location to our “0” portal, we’ll edit the “template.html” file in the “default” folder now located in the “Portals” folder structure.

We need to add a new table row to the template to display our Custom Attributes. We open the “template.html” file with Notepad (or any text editor) and  add a new row.  We’ll add our Attributes after the FileSize and before the DownloadCount.

Before:

<tr>
  <td align="left" valign="top" class="SubHead" width="75">[LABEL:FileSize]td>
  <td align="left" valign="top" class="normal">[FILESIZE]td>
tr>
<tr>
  <td align="left" valign="top" class="SubHead" width="75">[LABEL:Downloads]td>
  <td align="left" valign="top" class="normal">[DOWNLOADCOUNT]td>
tr>

 

After:

<tr>
  <td align="left" valign="top" class="SubHead" width="75">[LABEL:FileSize]td>
  <td align="left" valign="top" class="normal">[FILESIZE]td>
tr>
<tr>
  <td align="left" valign="top" class="SubHead" width="75">Colortd>
  <td align="left" valign="top" class="normal">[ATTRIBUTE:Color]td>
tr>
<tr>
  <td align="left" valign="top" class="SubHead" width="75">[LABEL:Downloads]td>
  <td align="left" valign="top" class="normal">[DOWNLOADCOUNT]td>
tr>

 

Now, when we view our Repository module, we’ll see our Custom Attribute values displayed

image

FORMATTING YOUR ATTRIBUTES

As you can see, the Attributes that were selected when the item was uploaded are displayed as a comma separated list of values.  Some people have expressed an interest in having a space after each comma to better distinguish the values. 

While there is no way to currently change the display of the Attribute values within the module settings or the template, you can do it with a litle jQuery.  We want to inject some script at the bottom of our module which will re-format the values. So, the first thing we need to do is wrap the data in a div with a class name so that we can reference it from our jQuery script.

Change the line that injects the Attribute values from

<td align="left" valign="top" class="normal">[ATTRIBUTE:Color]td>

 

to

<td align="left" valign="top" class="normal"><div class="rAttributes">[ATTRIBUTE:Color]div>td>

 

what we did is wrap a div around the [ATTRIBUTE:Color] token and gave it a class of ‘rAttributes’.

Next, we’ll open the “footer.html” template file in our template folder.  The footer is injected into the module output at the bottom, which is exactly where we want to place our script.

Edit the “footer.html” template file with and add the following script block at the end of the file


Then save the file. The script will find any div with a class of ‘rAttributes’ and grab the html markup from within. Then it uses the replace() method to change all of the commas to commas followed by a space, and finally it modifies the html within our div.  Now, after we save the changes we go back to our Repository module and we now see a space between each item.

image

In fact, we can change our comma to just about any html markup, a
to show each attribute value on a separate line

image

In fact, we can use some jQuery string methods to parse the original attribute value string into individual values then nodify the div’s html to redisplay them any way we want.

Enjoy!

Tags:
Categories:
Search
Privacy Statement | Terms Of Use | Copyright 2007-2009 by Gooddogs.com