Customize RSS Feed

Amir_Darejeh · August 18, 2015, 2:23pm

Hi all
1- I want to show articles’ download link in rss feed, what should I do?
2- Is it possible to create another rss feed for archived articles? I mean with this rss users can watch our archives and then by clicking in each date see articles of that issue.

Regards
Amir

beghelli · August 18, 2015, 4:01pm

Hi @Amir_Darejeh,

The plugin that implements web feed for issues is the WebFeed one, inside the generic folder. You would need to customize the WebFeedGatewayPlugin.inc.php file, inside the fetch method, assigning the article file object to the template manager so you could use it in the templates/rss.tpl, templates/rss2.tpl and templates/atom.tpl to build the url to download the file.

It’s not that hard to implement, but you need some programming skills.

The second question would require even more knowledge to implement, it’s not a trivial change. But basically you could use the WebFeed plugin as a base and create another one, so users could choose which one they wanted, or you could just extend the WebFeed plugin to implement archives also.

Cheers.

Amir_Darejeh · September 13, 2015, 9:46pm

Hi Bruno
Sorry for late answer, I’m working on it but still can’t get any result.
Could you help me to add other meta info to RSS? I need to show paper’s pic and pdf link.

Regards
Amir

beghelli · September 14, 2015, 3:07pm

Hi @Amir_Darejeh,

Sure, I can help. Can you post what you’ve done so far? Are we talking about OJS or OCS?

Thanks,
Bruno

Amir_Darejeh · September 14, 2015, 8:02pm

Thanks Bruno
I’m working on OJS and following codes are my changes in plugins / generic / webFeed / templates / atom.tpl

		{if $article->getLocalizedAbstract()}
			<summary type="html" xml:base="{url page="article" op="view" path=$article->getBestArticleId($currentJournal)}">{$article->getLocalizedAbstract()|strip|escape:"html"}xxx{$article->getFileName()|strip|escape:"html"}</summary>
		{/if}

But I only see xxxArray !!
What should I do >?

Regards
Amir

Amir_Darejeh · September 18, 2015, 3:12pm

Hi Bruno
Are you there?

andymp · September 20, 2015, 4:01pm

Hi @Amir_Darejeh,

Regarding the PDF link, you can try something like this in plugins/generic/webFeed/templates/rss2.tpl :

{foreach from=$article->getGalleys() item=galley name=galleyList} <enclosure url="{url page=“article” op=“view” path=$article->getBestArticleId($currentJournal)|to_array:$galley->getBestGalleyId($currentJournal)}" type=“application/pdf”></enclosure> {/foreach}

This is just an idea that will output article galleys links and names. Dont’ know anything about RSS so it may be not validated. Anyway, as you can see type= is set to application/pdf. Feel free to modify it as you need. Hope it helps.

Regards.

Amir_Darejeh · September 20, 2015, 9:25pm

Hi @andymp
Thanks for your help, But it doesn’t work!
Do you have any other solution?

Regards
Amir

beghelli · September 21, 2015, 4:47pm

Hi @Amir_Darejeh,

Sorry the long time to reply, having problems accessing internet locally here.

To get the article file name, you should try the getLocalizedFileName method, instead of the one you’re using.

Cheers,
Bruno

Amir_Darejeh · September 23, 2015, 9:22pm

Hi Bruno
Thank you, Bu it doesn’t work!
When I use getLocalizedFileName I see only an image name at the end of abstract!
Do have any other solution?!

Regards
Amir

beghelli · September 24, 2015, 12:48pm

Sorry @Amir_Darejeh,

I misunderstood what you were trying to get. To present the download links for the article galleys, check the templates/article/article.tpl file, starting at line 77. Basically you get the galleys from the article object, then you build the download url using both the article and galley id.

Cheers,
Bruno

Amir_Darejeh · September 24, 2015, 1:01pm

Hi @beghelli
Thanks, But My question is about customizing RSS Feed.
I want to add article’s image and pdf link to RSS feed.

Regards
Amir

beghelli · September 24, 2015, 1:13pm

@Amir_Darejeh,

I just pointed out where in the code you have something like you need. Then you can look at it, learn how to do it and implement yourself into the RSS Feed.

Regards,
Bruno

Amir_Darejeh · September 24, 2015, 1:19pm

It’s OK.
If you can conduct me to which codes that I must to use, or where can I find codes that I need; I’ll try to make it by myself.

Regards
Amir

beghelli · September 24, 2015, 1:35pm

@Amir_Darejeh,

I just pointed out to you some code to get the article galleys and to build the download url. But It will be hard to understand that if you have no coding skills, unfortunately. I also can’t code that to you, that’s an amount of time that I can’t spend on the support activity. What I can do is to help you while you’re doing the work and coming back with doubts and questions.

Regards,
Bruno

Amir_Darejeh · September 24, 2015, 1:43pm

Thanks Bruno, You right.
I was a programmer so still I have some programming skill.
You said > you should try the getLocalizedFileName method, instead of the one you’re using.
I putted your method in my code instead of getFileName(), But the result is an image name!

How can I get pdf name and link?

Regards
Amir

beghelli · September 24, 2015, 1:58pm

Check my previous message: Customize RSS Feed - #11 by beghelli

Amir_Darejeh · September 24, 2015, 2:11pm

ok Thank you,
I’ll try it and inform you

Regards
Amir

Amir_Darejeh · October 10, 2015, 9:24pm

Hi again
I did it with this code

<![CDATA[
<img src="http://www.gmj.ir/gmj/public/journals/1/{$article->getLocalizedFileName()|escape}"/>
        ]]>

but how can I replace http://www.gmj.ir/gmj/public/journals/1/ with a standard OJS address like

{url page="article" op="view" path=$article->getBestArticleId($currentJournal)}</link>
<link>{url page="article" op="view" path=$article->getBestArticleId($currentJournal)}

regards
Amir

ctgraham · October 12, 2015, 8:25pm

The smarty {url} function is what creates the standard OJS address. The parameters “page”, “op”, and “path” correspond to the URL components after the base URL.

For example, if

github.com

pkp/ojs/blob/ojs-stable-2_4_6/plugins/generic/webFeed/templates/rss2.tpl#L60



		<generator>OJS {$ojsVersion|escape}</generator>
		<docs>http://blogs.law.harvard.edu/tech/rss</docs>
		<ttl>60</ttl>

		{foreach name=sections from=$publishedArticles item=section key=sectionId}
			{foreach from=$section.articles item=article}
				<item>
					{* required elements *}
					<title>{$article->getLocalizedTitle()|strip|escape:"html"}</title>
					<link>{url page="article" op="view" path=$article->getBestArticleId($currentJournal)}</link>
					<description>{$article->getLocalizedAbstract()|strip|escape:"html"}</description>

					{* optional elements *}
					<author>{$article->getAuthorString()|escape:"html"}</author>
					{* <category/> *}
					{* <comments/> *}
					{* <source/> *}

					<dc:rights>
						{translate|escape key="submission.copyrightStatement" copyrightYear=$article->getCopyrightYear() copyrightHolder=$article->getLocalizedCopyrightHolder()}

generates
www . gmj . ir /gmj/public/journals/1/ article / view / $article_id
then

github.com

pkp/ojs/blob/ojs-stable-2_4_6/templates/article/article.tpl#L78


		{assign var=hasAccess value=1}
	{else}
		{assign var=hasAccess value=0}
	{/if}

	{if $galleys}
		<div id="articleFullText">
		<h4>{translate key="reader.fullText"}</h4>
		{if $hasAccess || ($subscriptionRequired && $showGalleyLinks)}
			{foreach from=$article->getGalleys() item=galley name=galleyList}
				<a href="{url page="article" op="view" path=$article->getBestArticleId($currentJournal)|to_array:$galley->getBestGalleyId($currentJournal)}" class="file" {if $galley->getRemoteURL()}target="_blank"{else}target="_parent"{/if}>{$galley->getGalleyLabel()|escape}</a>
				{if $subscriptionRequired && $showGalleyLinks && $restrictOnlyPdf}
					{if $article->getAccessStatus() == $smarty.const.ARTICLE_ACCESS_OPEN || !$galley->isPdfGalley()}
						<img class="accessLogo" src="{$baseUrl}/lib/pkp/templates/images/icons/fulltext_open_medium.gif" alt="{translate key="article.accessLogoOpen.altText"}" />
					{else}
						<img class="accessLogo" src="{$baseUrl}/lib/pkp/templates/images/icons/fulltext_restricted_medium.gif" alt="{translate key="article.accessLogoRestricted.altText"}" />
					{/if}
				{/if}
			{/foreach}
			{if $subscriptionRequired && $showGalleyLinks && !$restrictOnlyPdf}
				{if $article->getAccessStatus() == $smarty.const.ARTICLE_ACCESS_OPEN}

will generate
www . gmj . ir /gmj/public/journals/1/ article / view / $article_id / $galley_id