From 10c6b1f0978710cf5a9f309b6fdcaef922f9b07f Mon Sep 17 00:00:00 2001
From: Tomas Bzatek <tbzatek@users.sourceforge.net>
Date: Fri, 8 Oct 2010 17:02:47 +0200
Subject: Add basic Atom feed writer

---
 sample/src/entities/index.xml     |  6 ++++++
 sample/src/index.xml              | 10 +++++++++
 sample/src/setup.xml              | 43 +++++++++++++++++++++++++--------------
 sample/src/subdir/Tatry/index.xml |  3 +++
 4 files changed, 47 insertions(+), 15 deletions(-)

(limited to 'sample/src')

diff --git a/sample/src/entities/index.xml b/sample/src/entities/index.xml
index 54bdb2f..44776ca 100644
--- a/sample/src/entities/index.xml
+++ b/sample/src/entities/index.xml
@@ -11,6 +11,12 @@
       <author>META Author &#8594; '&amp;' "&amp;copy;"</author>
       <description><![CDATA[META Description &#8594; '&amp;' "&copy;" &lt; <b>ahoj!</b> <!-- comment <b>neco</b> -->]]></description>
     </meta>  
+    <news timestamp="2010-10-07T17:51:51+04:00" type="html" title="Entities test">
+      Entities &#8594; '&amp;' "&amp;copy;"
+    </news>
+    <news timestamp="2010-10-07T18:15:15.000Z" type="html" title="Entities test CDATA">
+      <![CDATA[Entities &#8594; '&amp;' "&copy;" &lt; <b>ahoj!</b> <!-- comment <b>neco</b> -->]]>
+    </news>
   </general>
   
   <items>
diff --git a/sample/src/index.xml b/sample/src/index.xml
index 92813f1..c5ec849 100644
--- a/sample/src/index.xml
+++ b/sample/src/index.xml
@@ -15,6 +15,16 @@
         This is footnote, text after item list.
       ]]>
     </footnote>
+    <news timestamp="2010-10-07T16:43:43+02:00" type="text" title="Introducing Atom feeds">
+      This is the first attempt of an Atom feed generator built in CGG. For the moment only textual and html records are supported.
+      This basic type of feed should serve as a "news" feed, to keep visitors notified about site updates.
+    </news>
+    <news timestamp="2010-10-07T16:47:47+02:00" type="text" title="Multiple news per page supported">
+      You can add second news for the same page, e.g. when you add new subgallery or new images.
+    </news>
+    <news title="Invalid item">
+      This item is missing a timestamp, which is important in Atom feed world. You should not see this record in your feed reader.
+    </news>
   </general>
   
   <items>
diff --git a/sample/src/setup.xml b/sample/src/setup.xml
index 88e7eba..80d04da 100644
--- a/sample/src/setup.xml
+++ b/sample/src/setup.xml
@@ -3,7 +3,7 @@
   <templates>
     <!-- path to templates (design)  -->
     <path>../../templates</path>
-    
+
     <!-- index: top level page -->
     <index>template-index.tmpl</index>   
     <!-- album: list of photos in directory -->
@@ -18,12 +18,12 @@
       styles.css
       scripts-general.js
     ]]></template_files>
-    
+
     <!--  specify index file name to use (default = index.html)                    -->
     <!--  e.g. you may want 'index.php' if your templates are server-side dynamic  -->
     <!--  filename extension is also used for separate image files                 -->
     <index_file>index.html</index_file>
-    
+
     <!--  use root gallery directory to store all support files   -->
     <!--  and relative paths in sub-albums                        -->
     <!--  default = no (old behaviour)                            -->
@@ -53,7 +53,7 @@
     <!--  erase embedded thumbnail image (both from original and big images)?    -->
     <!--   (allowed values: "yes", "no") default = no                            -->
     <erase_embed_thumbnail value="yes" />
-    
+
     <!--  don't copy full size (original) images                         -->
     <!--    <nofullsize/> can be used globally for whole gallery,        -->
     <!--    for full album or selectively for each image                 -->
@@ -64,31 +64,33 @@
     <thumbnail_dir>_thumb</thumbnail_dir>
     <preview_dir>_big</preview_dir>
     <original_dir>_orig</original_dir>
-    
+
     <!--  printf() format-style string of thumbnail file names  -->
     <!--    %s is mandatory, represents file name (with ext.)   -->
     <!--    %d is optional, denotes item index in the album     -->
     <!--       this also avoids conflicts with identical names  -->
     <thumbnail_name_format>thn_%d_%s</thumbnail_name_format>
   </images>
-  
+
   <meta>
-    <!--  global META tags in html head section  -->
-    <!--  these will automatically apply to _all_ pages unless overriden in the album  -->
-    <!--  it's not probably a good idea for large galleries  -->
+    <!--  Global metainformation for use in META tags in html head section  -->
+    <!--  and also for the Atom feed. In case of META tags these will       -->
+    <!--  automatically apply to _all_ pages unless overriden in the album. -->
+    <!--  This is probably not a good idea for large galleries.             -->
     <author>John Doe</author>
+    <author_email>johndoe@example.com</author_email>
     <description>CGG Sample gallery</description>
     <!--  keywords are usually not needed at all  -->
     <keywords>cataract, sample, gallery</keywords>
-    
+
     <!--  use item (image) title as <meta description> tag value          -->
     <!--   (allowed values: "yes", "no") default = yes                    -->
     <!--  this setting is independent from the global meta tags settings  -->
     <use_title_as_meta value="yes" />
-    
+
     <!--  mandatory site name, part of all page titles  -->
     <site title="CGG Testing Site" />
-    
+
     <!--  add your copyright string to every picture                          -->
     <!--  stored in EXIF::Image::Copyright and IPTC::Application2::Copyright  -->
     <!--  usual format: "Copyright, John Smith, 19xx. All rights reserved."   -->
@@ -102,20 +104,31 @@ And the second line.</add_copyright>
     <!--    declared earlier applies to favicons as well                 -->
     <favicon type="image/png">apple-red.png</favicon>
   </meta>
-  
+
   <navigation>
     <!--  enabled: jump to the parent item when going up in the structure  -->
     <!--  disabled: links will always go to the top of the parent page     -->
     <use_inpage_links value="yes" />
-    
+
     <!--  enabled: show "Go Up..." links if not top-level (default)  -->
     <!--  disabled: never show that link                             -->
     <show_go_up value="yes" />
-    
+
     <!--  show/hide exif table in single photo view  (default = yes)  -->
     <show_exif_table value="yes" />
   </navigation>
 
+  <feed enable="yes">
+    <!--  Atom feed generator, disabled by default.                  -->
+    <!--  Feeds are used to keep users informed about site updates.  -->
+    <!--  It's required to add corresponding <news> sections         -->
+    <!--  to particular album index files.                           -->
+    <filename>atomfeed.xml</filename>
+    <title>CGG Sample gallery site news</title>
+    <!--  It's crucial to set URL of the site. Enter root URL of the gallery.  -->
+    <base_url>http://www.example.com/</base_url>
+  </feed>
+
   <footer><![CDATA[
     So this is footer, suitable place for copyright, W3C validation links and advertisement! | 
     Generated with <a href="http://cgg.bzatek.net/" title="Cataract Gallery Generator">Cataract Gallery Generator</a>. |
diff --git a/sample/src/subdir/Tatry/index.xml b/sample/src/subdir/Tatry/index.xml
index 0e31ae3..566509e 100644
--- a/sample/src/subdir/Tatry/index.xml
+++ b/sample/src/subdir/Tatry/index.xml
@@ -5,6 +5,9 @@
     <title>Račkova dolina, Bystrá</title>
     <description><![CDATA[sobota 29. září 2007<br/>
     ]]></description>
+    <news timestamp="2010-10-07T18:18:18+02:00" type="text" title="Nested album">
+      This comes from a nested album, multiple levels.
+    </news>
   </general>
   
   <items>
-- 
cgit v1.2.3