Introducing ARF for SharePoint

Search

Accessible SharePoint WebSites
Download ARF

Introducing ARF for SharePoint

http://blog.thekid.me.uk

After much work I have finally managed to release a version of ARF (Alternative Rendering Framework for SharePoint) for everyone to use. This version have been in development for a long time and is currently being used on four of my projects. It is open source and you are free to use the current version however you wish. You can download ARF from my companies website and there is also a quick start guide to help you on your way.

If you are familiar with the CKS:EBE then you will be at home with most of the concepts of ARF, in that it has numerous controls which produce XML and then XSLT is used to render the XML. However the EBE is ARF's little brother, with much less functionality and features when compared to ARF.

Installed as a feature

image

You have full control over which features of ARF you use. If you just want an easy way to produce a calendar view using XSL then just use that. You can use as little or as much as you like on your current site, without affecting its current operation.

ARF is a feature you can activate on your site collection, adding a list, a document library and column. All of these are there to support some of the functionality of ARF. If you are not using the functionality then they can be safely deleted.

ARF does not take over your site, instead it is a set of components which help with building your SharePoint site. ARF was initially designed to help with accessible SharePoint websites, but is also useful in other scenarios including XHTML compatibility.

Over 30 controls

ARF contains over 30 controls for you to use and it is entirely possible that you could develop a complete publishing site, conforming to XHTML and accessible without having to write a single line of code.

Controls include...

Compatibility Panel - Ensuring the HTML produced by its child controls are XHTML compliant
SiteQuery - Allow you to develop complex queries to list content
QSVisibility Panel - Allowing you to show and hide content based upon query string values
Calendar View - Allowing to to show calendar entries in your chosen format
Contact Form - Creating a contact form without writing any code

Sample XSL is included with ARF, giving you a quick start to creating your own XSL files.

Not just MOSS

You can use the vast majority of ARF controls in WSS as my companies website proves. This means that you can use ARF to create a lightweight publishing environment using just WSS.

Full Source Code

The full source code is released with ARF, providing you with the ability to see how things are done, debug when you need to or modify its behavior.

Sample Site Soon

We are currently creating a sample accessible publishing site using ARF. This we will provide as an exported site from SharePoint. This will allow you to see some samples and documentation of ARF on your own system.

I'll let you know when this is available for download.

Posted by Vincent Rothwell on Monday, 20 Oct 2008 16:51  - 19 Comments
Orininally printed from http://thekid.me.uk - Copyright Vincent Rothwell 2007
 

Comments

Monday, 20 Oct 2008 05:15 by Keith Dahlby
Did you mean for the source download not to include the ARF.Solution project files?

Tuesday, 21 Oct 2008 04:09 by Vince
Keith, Yes, at the moment becuase it contains some things that aren't ready. I'll put it up when I can. --Vince

Tuesday, 21 Oct 2008 05:00 by Randy Drisgill
Sounds interesting, is there any documentation on the Compatibility Panel or getting the pages to be W3C compliant using ARF?

Thursday, 23 Oct 2008 04:02 by Vince
Randy, The documentation will be in the sample site, which I hope to be ready really soon. ARF won't make your sites compliant as it still depends on your design, but it can help you achieve it. If you use the XSLT controls you can easily produce a compliant site. The compatability panel will help resolve issues in existing sites, but I would say that it is a last resort/band aid as there are normally other ways to solve the problem. However, if you use the panel in SPDesigner then you should get intellisence and the parameters are pretty straight forward. E.G. <ARF:CompatibilityPanel runat="server" RemoveFirstDiv="true"> <div id="idTest" runat="server">Vince</div> </ARF:CompatibilityPanel> This will remove the first div from the contained control. Useful when SharePoint is adding a <div> around a TextField and it is contained in a <p> tag. HTH, Vince

Thursday, 23 Oct 2008 01:20 by Steve Ruiz
Congratulations on the release, I look forward to trying it out!

Friday, 24 Oct 2008 02:08 by Steve
Thanks...hopefully the Sample site will make this easy --Vince

Sunday, 26 Oct 2008 08:49 by Tobias Zimmergren
Good one Vince. Looking forward to get some free time to check it out. Looks promising! Cheers

Monday, 27 Oct 2008 07:07 by choppy
well done! Thanks for sharing it. got a question, if I want to make SP accessible (AA compliant), is it correct that I need to make use of Compatibility Panel Control? are there any resource for it? thanks

Monday, 27 Oct 2008 07:46 by choppy
well done! Thanks for sharing it. got a question, if I want to make SP accessible (AA compliant), is it correct that I need to make use of Compatibility Panel Control? are there any resource for it? thanks

Tuesday, 28 Oct 2008 11:26 by Vince
Choppy, Using the Compatability panel will not in itself make SharePoint accessible, it will only help with particular layout problems. It can fix invalid XHTML, remove some of the SharePoint markup which is not required and remove the extra markup Word adds. There are other (better) ways to solve these problems and the compatability panel should really be seen as a last resort. However, you can add the reference to the top of your page layout and you should get intellisense showing you the options available. If you don't see the intllitsense (SPD doesn't always show it), re-start SPD and it should load the proxy DLL again. We will soon be releasing a full exported site with samples and documentation. Until then I will try to get some initial documentation out to help people get started. --Vince

Wednesday, 29 Oct 2008 02:46 by Anders Dissing
Hey Have you take a look at this http://getsharepointtovalidate.com/ CodePlex site: http://www.codeplex.com/GSPTV/

Monday, 3 Nov 2008 06:39 by Vince
Anders, I have, but it is a different approach to ARF. My personal preference is to not use control adapters as I don't believe them to be as flexible as XSLT. --Vince

Monday, 10 Nov 2008 11:31 by Jes
Hi Vince, First of all thanks for sharing and documenting this stuff. I've downloaded release wsp file and installed the bits. When I add an ARF:SiteQuery as per the doc I get an error in the design pane creating the control. Type ARF.Web.Controls.SiteQuery does not have a public proprty named "Xsl-XslName". If I remove the Xsl-XslName attribute then the control renders OK at dsign time. Am I doing something wrong? If I click on "ARF settings" in site settings I'm also getting an error 'id??' is not a valid identifier in the ARF/settings page. Thanks

Tuesday, 11 Nov 2008 11:54 by Vince
Jes, No your not doing anything wrong, the controls do not have any 'design time' support. Basically they produce XML and have no UI and so its not clear what should be displayed. As for the Xsl-XslName, SharePoint Designer is not as ASP.Net friendly as it could be...it does not recognise setting properties on objects. The Xsl is and object and XslName is a property of that object. The '-' format is the standard ASP.Net way of doing this, but SPD does not recognise it. You can safely ignore it. When you are creating your site add the SiteQuery control, with the required parameters and then look at the page on your site. Modify the XSL (specified in the Xsl-XslName property) to change the outputted HTML. If you want to see the XML add ?arf-xml=true to the URL or change the Xsl-XslName to Xsl-XslName="xml.xsl". HTH, Vince

Wednesday, 12 Aug 2009 09:14 by Leo Torres
Hello Vince, Dude this site is great Have gotten a lot of useful tips. I am still struggling with synchronizing two calendars. I followed the instructions on this link http://weblogs.asp.net/gunnarpeipman/archive/2009/01/24/creating-sharepoint-global-calendar.aspx But I really don't know where to place the code in Order for this to Work or where to get the List ID's for my calendars.. I have the Share Point Designer. I have used that to put data together form two calendars but it appears as a List on on calendar but not the other... I am a total newbie.. please give some guidance on where I could go to get some info on how to accomplish this... Thank you!!

Wednesday, 12 Aug 2009 11:24 by Leo Torres
Hello Vince, Dude this site is great Have gotten a lot of useful tips. I am still struggling with synchronizing two calendars. I followed the instructions on this link http://weblogs.asp.net/gunnarpeipman/archive/2009/01/24/creating-sharepoint-global-calendar.aspx But I really don't know where to place the code in Order for this to Work or where to get the List ID's for my calendars.. I have the Share Point Designer. I have used that to put data together form two calendars but it appears as a List on on calendar but not the other... I am a total newbie.. please give some guidance on where I could go to get some info on how to accomplish this... Thank you!!

Wednesday, 12 Aug 2009 05:58 by Leo Torres
Hello Vince, Dude this site is great Have gotten a lot of useful tips. I am still struggling with synchronizing two calendars. I followed the instructions on this link http://weblogs.asp.net/gunnarpeipman/archive/2009/01/24/creating-sharepoint-global-calendar.aspx But I really don't know where to place the code in Order for this to Work or where to get the List ID's for my calendars.. I have the Share Point Designer. I have used that to put data together form two calendars but it appears as a List on on calendar but not the other... I am a total newbie.. please give some guidance on where I could go to get some info on how to accomplish this... Thank you!!

Thursday, 10 Dec 2009 09:39 by Shane Perran
Hey Vince, Looks like a very promising venture, I'm anxious to get in and take a look. Good job! Shane

Wednesday, 27 Jan 2010 12:41 by roma
Nice post. Thank you for the info. Keep it up. http://www.xavor.com/whatwedo/solutions/sharepointmigrationtool.aspx http://www.xavor.com/whatwedo/solutions/xavorsharepointadmintools.aspx



Url

Email

Comments