View unanswered posts | View active topics

Reply to topic  [ 18 posts ]  Go to page 1, 2  Next
Site Admin
User avatar

Joined: Fri Feb 07, 2003 8:48 am
Posts: 2902
Location: Melbourne, Australia
Post Template parameters
Several people have asked for documentation on what parameters are available in the various template files. Until the main doco gets updated, here's a list.

In 2.0.2.alpha3, the following parameters are available:

<u>Channel summary pages</u>

CHANNEL-URL
CHANNEL-HOME-URL
CHANNEL-NAME
CHANNEL-DESCRIPTION
CHANNEL-IMAGE
CHANNEL-DETAILS

BACKGROUND-IMAGE
LAST-UPDATE-TIME
LAST-SUCCESSFUL-UPDATE-TIME
LAST-SUCCESSFUL-UPDATE-TIME-FORMATTED
FEED-ITEM-COUNT-INFO
FEED-ITEM-COUNT-INFO-FORMATTED

ITEM-NO
ITEM-IMAGE
ITEM-TITLE_FORMATTED
ITEM-DETAILS
plus standard item parameters (see below)



<u>Search results</u>

SEARCH-QUERY-STRING
SEARCH-RESULT-COUNT-MSG
ITEM-IMAGE
NO-SEARCH-RESULTS

ITEM-SCORE
plus standard item parameters (see below)



<u>Channel reports</u>

BACKGROUND-IMAGE
REPORT-TIME

CHANNEL-URL
ENCODED-CHANNEL-URL
CHANNEL-HOME-URL
CHANNEL-NAME
ENCODED-CHANNEL-NAME

ITEM-IMAGE
plus standard item parameters (see below)



<u>SendEmail channel hook</u>

CHANNEL-NAME

ITEM-URL
ITEM-TITLE
ITEM-HTML-DESCRIPTION
ITEM-DESCRIPTION



The standard item template parameters are:

ITEM-ID
ITEM-URL
ITEM-TITLE
ITEM-TITLE-FORMATTED
ITEM-TIMESTAMP

ITEM-DESCRIPTION
ITEM-DESCRIPTION-MARKEDUP
ITEM-DESCRIPTION-EXCERPT
ITEM-DESCRIPTION-PLAINTEXT

ITEM-AUTHOR-NAME
ITEM-AUTHOR-EMAIL
ITEM-SOURCE-NAME
ITEM-SOURCE-URL
ITEM-COMMENTS-URL


Fri Jul 16, 2004 12:37 am
Profile WWW

Joined: Tue Jun 29, 2004 9:59 pm
Posts: 113
Post 
Excellent. Thanks for spelling those out. I'm modifying a report template for the workpad... perhaps I'll be able a to dig a couple things I was looking for out of this list.


Fri Jul 16, 2004 1:00 am
Profile ICQ
Site Admin
User avatar

Joined: Fri Feb 07, 2003 8:48 am
Posts: 2902
Location: Melbourne, Australia
Post 
Some of the parameters above are new for 2.0.2.<u>alpha3</u> which hasn't actually been released yet. I'm just uploading the files now... :-)


Fri Jul 16, 2004 1:11 am
Profile WWW
Post Template Parameters
Sorry to resurrect an old post (again), but when you get a chance, can you update this list to show what each parameter links to in the original feed?

I just had a play with ITEM-AUTHOR-NAME, but for some reason its not picking it out of the feed i've got. (not sure whether thats a problem with the feed though).

Cheers.


Wed Dec 01, 2004 11:49 am
Site Admin
User avatar

Joined: Fri Feb 07, 2003 8:48 am
Posts: 2902
Location: Melbourne, Australia
Post Re: Template Parameters
There will be a list included in the doco for 2.1 which I'm putting together now.

For the moment, it'd be quicker if you post your template here and I'll take a look at it.


Thu Dec 02, 2004 8:33 pm
Profile WWW
Post Re: Template Parameters
I'll just wait until the documentation comes out i think :)

Thanks for the offer though.

Matt


Tue Dec 07, 2004 9:43 pm
Post Template Parameters
I know I said i'd wait, but...

Just to reiterate the issue (as an introduction to this post), I'm having troubles using the Item-author-name parameter in my channel template

My XML is coming from Greg Reinackers VSS to RSS generator - at http://www.rassoc.com/gregr/weblog/arch ... x?post=747

It looks something like this:
<item>
<title>Checked in $/Dev/Web/...</title>
<guid isPermaLink="false">file.txt:2:Checked in $/Dev/Web/...</guid>
<description>Modified to get fix translating bug.</description>
<pubDate>Wed, 08 Dec 2004 14:10:52 GMT</pubDate>
<dc:creator>Matt</dc:creator>
</item>

In my channel template, I'm trying to go:

... standard stuff ...

<DIV class="itemTitle">
<IMG src='{%ITEM-IMAGE%}'>
<A href="{%ITEM-URL%}">{%ITEM-AUTHOR-NAME%}: {%ITEM-TITLE-FORMATTED%}</A>
</DIV>

...standard stuff...

All i'm adding is the "{%ITEM-AUTHOR-NAME%}:" part.

The issue is, its just getting replaced with a blank string, not the <dc:creator> element.

Seeing i have the source to this vss to rss generator, if it turns out that awasu supports a different tag to this, I can easily modify that code.

So, at the risk of interrupting you and taking you away from the next (and i'm sure, the coolest) version of awasu, are you able to tell me if i'm doing anything wrong? Or should i modify the feed generator to generate something else?

Thanks heaps.
Matt


Tue Dec 21, 2004 10:42 pm

Joined: Sat Feb 08, 2003 8:36 pm
Posts: 247
Location: San Francisco, CA -- USA
Post 
The VSS to RSS code claims to be generating RSS 2.0. According to the RSS 2.0 spec (http://blogs.law.harvard.edu/tech/rss), you could include an <author> subelement.

Quote:
<author> sub-element of [item]

<author> is an optional sub-element of [item].

It's the email address of the author of the item. For newspapers and magazines syndicating via RSS, the author is the person who wrote the article that the [item] describes. For collaborative weblogs, the author of the item might be different from the managing editor or webmaster. For a weblog authored by a single individual it would make sense to omit the <author> element.

<author>lawyer@boyer.net (Lawyer Boyer)</author>


Syntax as above, but note it should "officially" be an e-mail address, not just a name.

If this doesn't help, Taka will have to jump in... :)


Tue Dec 21, 2004 11:47 pm
Profile
Site Admin
User avatar

Joined: Fri Feb 07, 2003 8:48 am
Posts: 2902
Location: Melbourne, Australia
Post Re: Template Parameters
Yes, <author> is technically supposed to be an email address but Awasu tries to be intelligent about how it handles this field.

Awasu also recognizes <dc:creator> and treats it the same as <author>. However, there's a bug that stops it from being picked up :-( The short-term fix is to change the VSS->RSS generator to output the <author> tag and I'll fix this bug for the 2.1 release.

Thanks for letting us know.


Wed Dec 22, 2004 5:48 am
Profile WWW
Post Template Parameters
Once again, I have to say that i'm impressed by the speed of response, and your willingness to track things down, and make a damn fine product into a brilliant product.

Kudos!


Wed Dec 22, 2004 10:52 am
Site Admin
User avatar

Joined: Fri Feb 07, 2003 8:48 am
Posts: 2902
Location: Melbourne, Australia
Post Re: Template Parameters
Matt wrote:
Once again, I have to say that i'm impressed by the speed of response, and your willingness to track things down, and make a damn fine product into a brilliant product.


Thanks for the kind words (and not mentioning that this was being caused by a bug :-)).


Wed Dec 22, 2004 8:22 pm
Profile WWW
Post report from workpad problem
Thanks for a great programme!
I've been trying to generate a feed from items added to the workpad using the following report but ITEM-TIMESTAMP, ITEM-SOURCE-URL and ITEM-SOURCE-NAME all generate blanks. Am I doing something wrong or are these parameters not carried over to workpad? If not any chance for the future? Any help appreciated.

<?xml version="1.0" encoding="utf-8" ?>

<rss>

<channel>

<title> latest </title>
<description>
Items extracted from various channels
</description>

{%REPEAT% Channels}
{%REPEAT% FeedItems}
<item>
<title> {%ITEM-TITLE%} </title>
<link> <![CDATA[ {%ITEM-URL%} ]]> </link>
<description> <![CDATA[ {%ITEM-DESCRIPTION%} ]]> </description>
<pubDate> {%ITEM-TIMESTAMP%} </pubDate>
<source url="{%ITEM-SOURCE-URL%}"> {%ITEM-SOURCE-NAME%} </source>
</item>
{%/REPEAT%}
{%/REPEAT%}

</channel>
</rss>


Sat Jun 04, 2005 1:51 pm
Site Admin
User avatar

Joined: Fri Feb 07, 2003 8:48 am
Posts: 2902
Location: Melbourne, Australia
Post Re: report from workpad problem
thatsmybiro wrote:
Am I doing something wrong or are these parameters not carried over to workpad? If not any chance for the future?


You're not doing anything wrong, it's a bug :oops:

I'll fix it for the next release (2.1.3).


Sat Jun 04, 2005 9:42 pm
Profile WWW
Post workpad reports
Thanks for the swift response and adding it to the list. I've been looking for something that will allow 'republishing' items from different feeds for a while and none of the options I've come across allow quite enough flexibility for what I need. Awasu's combination of the workpad and custom reports looks like it will do the job effortlessly when all the elements of a feed item are available from the workpad. Keep up the good work!


Mon Jun 06, 2005 3:27 pm

Joined: Thu Mar 16, 2006 9:18 am
Posts: 12
Post 
In the template what it's the path to put to hit the images if we put them in for example the folder "Resources\Channel Summary Templates\images" ?


Sat Mar 18, 2006 9:46 am
Profile
Display posts from previous:  Sort by  
Reply to topic   [ 18 posts ]  Go to page 1, 2  Next

Who is online
Users browsing this forum: No registered users and 1 guest

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum

Search for:
Jump to: