Add title in index pages, add reference in story
[gofetch.git] / src / be / nikiroo / gofetch / output / Output.java
index f293b047df8d351fc59971713a82f1f303f32f6c..dc197f0153b3b2167edb8edd438cb09afc24d6ea 100644 (file)
@@ -1,10 +1,8 @@
 package be.nikiroo.gofetch.output;
 
-import java.util.List;
-
-import be.nikiroo.gofetch.data.Comment;
 import be.nikiroo.gofetch.data.Story;
-import be.nikiroo.gofetch.support.BasicSupport.Type;
+import be.nikiroo.gofetch.support.BasicSupport;
+import be.nikiroo.gofetch.support.Type;
 
 /**
  * Base class for output operations.
@@ -52,38 +50,60 @@ public abstract class Output {
        }
 
        /**
-        * Get the header to use in the index file.
+        * Get the header to use in the main index file (the one which will
+        * reference all the supported web sites <tt>index</tt> files).
         * 
         * @return the header
         */
-       abstract public String getIndexHeader();
+       abstract public String getMainIndexHeader();
 
        /**
-        * Get the footer to use in the index file.
+        * Get the footer to use in the index file (the one which will reference all
+        * the supported web sites <tt>index</tt> files).
         * 
         * @return the footer
         */
-       abstract public String getIndexFooter();
+       abstract public String getMainIndexFooter();
+
+       /**
+        * Get the header to use in the index file (the supported web site
+        * <tt>index</tt> file this output is for).
+        * 
+        * @param support
+        *            the supported web site
+        * 
+        * @return the header
+        */
+       abstract public String getIndexHeader(BasicSupport support);
 
        /**
-        * Export a story (in resume mode).
+        * Get the footer to use in the index file (the supported web site
+        * <tt>index</tt> file this output is for).
+        * 
+        * @param support
+        *            the supported web site
+        * 
+        * @return the footer
+        */
+       abstract public String getIndexFooter(BasicSupport support);
+
+       /**
+        * Export the header of a story (a <i>resume</i> mode).
         * 
         * @param story
         *            the story
         * 
         * @return the resume
         */
-       abstract public String export(Story story);
+       abstract public String exportHeader(Story story);
 
        /**
         * Export a full story with comments.
         * 
         * @param story
         *            the story
-        * @param comments
-        *            the comments
         * 
         * @return the story
         */
-       abstract public String export(Story story, List<Comment> comments);
+       abstract public String export(Story story);
 }