Greenstone Wiki

User Tools

Site Tools

You are here: index » en » user » rss
en:user:rss

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:user:rss [2017/08/20 21:33] – [Turn on RSS] kjdonen:user:rss [2025/08/04 02:06] (current) – [Configuring RSS feed info] kjdon
Line 1: Line 1:
 +
 +
 +
 ====== RSS ====== ====== RSS ======
 [[http://en.wikipedia.org/wiki/RSS|RSS]] technology allows you to  [[http://en.wikipedia.org/wiki/RSS|RSS]] technology allows you to 
Line 8: Line 11:
  
 ===== Turn on RSS ===== ===== Turn on RSS =====
-<TABAREA tabs="Greenstone3,Greenstone2"> +<tabbox Greenstone3>
-<TAB>+
 To turn on RSS for a collection, go to the **Format Features** section of GLI's Format Panel.  To turn on RSS for a collection, go to the **Format Features** section of GLI's Format Panel. 
 Select which page(s) on which you want the RSS link to appear (choose 'global' to have it appear Select which page(s) on which you want the RSS link to appear (choose 'global' to have it appear
Line 26: Line 28:
 NOTE: the RSS serviceRack must also be included in the collectionConfig.xml file (it should be there by default). If RSS is not working after setting the option to true, check that you have **<serviceRack name="RSSRetrieve"/>** inside the **<serviceRackList>** of the collection's **etc/collectionConfig.xml** file. NOTE: the RSS serviceRack must also be included in the collectionConfig.xml file (it should be there by default). If RSS is not working after setting the option to true, check that you have **<serviceRack name="RSSRetrieve"/>** inside the **<serviceRackList>** of the collection's **etc/collectionConfig.xml** file.
  
-</TAB> +<tabbox Greenstone2>
-<TAB>+
 To turn on RSS for a collection, go to GLI's Format panel's Collection Specific Macros, and paste the following: To turn on RSS for a collection, go to GLI's Format panel's Collection Specific Macros, and paste the following:
  
Line 45: Line 46:
 {{ :en:rss-gs2.png?direct&600 |}} {{ :en:rss-gs2.png?direct&600 |}}
  
-</TAB> +</tabbox>
-</TABAREA>+
  
 ===== Configuring RSS feed info ===== ===== Configuring RSS feed info =====
Line 71: Line 71:
 Note, plugouts are the opposite to plugins. Plugins handle converting document formats to Greenstone's internal representation. Plugouts take the internal representation and write them out to file. By default, the import process uses the GreenstoneXMLPlugout, which writes out documents as GreenstoneXML archive files. If you export a collection to another format e.g. MARCXML, then a different plugout will be used. Note, plugouts are the opposite to plugins. Plugins handle converting document formats to Greenstone's internal representation. Plugouts take the internal representation and write them out to file. By default, the import process uses the GreenstoneXMLPlugout, which writes out documents as GreenstoneXML archive files. If you export a collection to another format e.g. MARCXML, then a different plugout will be used.
  
-These plugout options cannot currently be set using GLI. To change them, you will need to edit the collection's configuration file by hand. Make sure the collection is not open in GLI before you start editing the file. Once you have edited the file, save it, and rebuild the collection to regenerate the rss file.+Plugout options can be set by specifying a plugout in the collection's configuration file, along with its options. Unfortunately, there was a bug in Greenstone 3.12 which means that this element is removed from the config file when you open the collection in GLI.  
 + 
 +Alternatively you can use the import options //-saveas// and //-saveas_options//. 
 +  * **-saveas** specifies what type of output format to use (default: GreenstoneXML) and therefore which plugout (default GerenstoneXMLPlugout) 
 +  * **-saveas_options** specifies any options to pass to the plugout.   
 + 
 +You can set these in the import options pane of the Create Pane in GLI - if you do that here, they will only be applied when building the collection through GLI. \\ 
 +You can also set import options directly into the config file using GLI's //Edit->Edit collectionConfig.xml//. If you use this method,  the options will be available for use in GLI and for command line building. 
 + 
 +<tabbox Greenstone3> 
 +The three ways to specify plugout option, for example, setting the -rss_title option: 
 +   *  1. Create Pane, import option //-saveas_options//.  
 + 
 +<code> 
 +  -saveas_options -rss_title dc.Title,Title 
 +</code> 
 + 
 +   * 2. Add importOptions directly into the collectionConfig.xml file.  
 + 
 +In GLI, Edit->Edit collectionConfig.xml. Or open up the file //%%greenstone3/web/sites/localsite/collect/<collname>/etc/collectionConfig.xml%%// in an editor. Add the following as a child node of the top level CollectionConfig element: 
 +<code> 
 +  <importOption name="saveas_options" value="-rss_title dc.Title,Title"/> 
 +</code> 
 + 
 +   * 3. Add a plugout element directly into the collectionConfig.xml file.
  
-<TABAREA tabs="Greenstone3,Greenstone2"> +In GLI, Edit->Edit collectionConfig.xml. Or open up the file //%%greenstone3/web/sites/localsite/collect/<collname>/etc/collectionConfig.xml%%// in an editor.
-<TAB> +
-Open up the file //%%greenstone3/web/sites/localsite/collect/<collname>/etc/collectionConfig.xml%%//.+
 Inside the //%%<import>%%// node, add code like the following: Inside the //%%<import>%%// node, add code like the following:
 <code> <code>
 <plugout name="GreenstoneXMLPlugout"> <plugout name="GreenstoneXMLPlugout">
-   <option name="-rss_title" value="dc.Title, Title"/>+   <option name="-rss_title" value="dc.Title,Title"/>
 </plugout> </plugout>
 </code> </code>
-</TAB> +<tabbox Greenstone2>
-<TAB>+
 Open up the file //%%greenstone2/collect/<collname>/etc/collect.cfg%%//. Add the line Open up the file //%%greenstone2/collect/<collname>/etc/collect.cfg%%//. Add the line
 <code> <code>
 plugout GreenstoneXMLPlugout -rss_title "dc.Title,Title" plugout GreenstoneXMLPlugout -rss_title "dc.Title,Title"
 </code> </code>
-</TAB> +</tabbox>
-</TABAREA>+
  
en/user/rss.1503264813.txt.gz · Last modified: 2017/08/20 21:33 by kjdon