Writer2xhtml custom config ui + preparing for EPUB

git-svn-id: svn://svn.code.sf.net/p/writer2latex/code/trunk@54 f0f2a975-2e09-46c8-9428-3b39399b9f3c

source/java/writer2latex/api/Config.java

@@ -98,7 +98,7 @@ public interface Config {
 	/** Get a complex option
 	 * 
 	 * @param sName the name of the complex option
-	 * @return
+	 * @return the option
 	 */
 	public ComplexOption getComplexOption(String sName);
 	

source/java/writer2latex/api/ContentEntry.java

@@ -0,0 +1,61 @@
+/************************************************************************
+ *
+ *  ContentEntry.java
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *  Copyright: 2002-2010 by Henrik Just
+ *
+ *  All Rights Reserved.
+ * 
+ *  Version 1.2 (2010-03-15)
+ *
+ */
+
+package writer2latex.api;
+
+/** This interface represents a content entry, that is a named reference
+ *  to a position within the output document.
+ */
+public interface ContentEntry {
+	/** Get the outline level of this <code>ContentEntry</code>.
+	 *  The top level is 1 (entries corresponding to indexes are considered
+	 *  top level).
+	 *  Note that intermediate levels may be missing (e.g. a heading of
+	 *  level 3 may follow immediately after a heading of level 1).
+	 * 
+	 * @return the outline level
+	 */
+	public int getLevel();
+	
+	/** Get the title for this entry
+	 * 
+	 * @return the title
+	 */
+	public String getTitle();
+	
+	/** Get the file associated with the entry
+	 * 
+	 * @return the output file
+	 */
+	public OutputFile getFile();
+	
+	/** Get the name of a target within the file, if any 
+	 * 
+	 * @return the target name, or null if no target is needed
+	 */
+	public String getTarget();
+
+}

source/java/writer2latex/api/ConverterResult.java

@@ -16,11 +16,11 @@
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  *  MA  02111-1307  USA
  *
- *  Copyright: 2002-2008 by Henrik Just
+ *  Copyright: 2002-2010 by Henrik Just
  *
  *  All Rights Reserved.
  * 
- *  Version 1.0 (2008-11-24)
+ *  Version 1.2 (2010-03-16)
  *
  */
  
@@ -46,6 +46,11 @@ public interface ConverterResult {
      */
     public Iterator<OutputFile> iterator();
     
+    /** Get the meta data associated with the source document
+     *  @return the meta data
+     */
+    public MetaData getMetaData();
+    
     /** Write all files of the <code>ConverterResult</code> to a directory.
      *  Subdirectories are created as required by the individual
      *  <code>OutputFile</code>s.

source/java/writer2latex/api/MetaData.java

@@ -0,0 +1,45 @@
+/************************************************************************
+ *
+ *  MetaData.java
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *  Copyright: 2002-2010 by Henrik Just
+ *
+ *  All Rights Reserved.
+ * 
+ *  Version 1.2 (2010-03-15)
+ *
+ */
+
+package writer2latex.api;
+
+/** This interface provides access to the predefined meta data of the
+ *  source document (currently incomplete)
+ */
+public interface MetaData {
+	/** Get the title of the source document
+	 * 
+	 * @return the title (may return an empty string)
+	 */
+	public String getTitle();
+	
+	/** Get the (main) language of the document
+	 * 
+	 * @return the language
+	 */
+	public String getLanguage();
+
+}

source/java/writer2latex/api/OutputFile.java

@@ -52,17 +52,8 @@ public interface OutputFile {
     
     /** Get the MIME type of the <code>OutputFile</code>.
      * 
-     *  @return string reprensentation of the MIME type
+     *  @return string representation of the MIME type
      */
     public String getMIMEType();
     
-    /** Get the sequence number of this <code>OutputFile</code>.
-     *  The master document has the sequence number 0.
-     *  Other files which are part of the main document flow has a unique, positive sequence number.
-     *  Auxiliary files like images always has the sequence number -1.
-     * 
-     *  @return the sequence number
-     */
-    public int getSequenceNumber();
-
 }