Changeset 6565

Timestamp:

2004-01-21T11:18:33+13:00 (20 years ago)

Author:

jmt12

Message:

HelpFrame now looks in the appropriate language code named folder for help files. It also wants help_index.xml rather than the full help.xml.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• help/HelpFrame.java (modified) (9 diffs)
• util/StaticStrings.java (modified) (4 diffs)
• util/Utility.java (modified) (2 diffs)

trunk/gli/src/org/greenstone/gatherer/help/HelpFrame.java

@@ -47 +47 @@
 import org.apache.xerces.parsers.DOMParser;
 import org.greenstone.gatherer.Dictionary;
+import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
 import org.w3c.dom.*;
@@ -58 +59 @@
     extends JFrame {
 
+    static private final String NULL_STRING = "<null>";
+    /** The size of the frame */
+    static private final Dimension SIZE = new Dimension(760, 560);
+
     /** The HTML rendering pane */
     private CalHTMLPane view = null;
@@ -67 +72 @@
     private JSplitPane split_pane = null;
 
-    /** The size of the frame */
-    static final Dimension SIZE = new Dimension(760, 560);
 
 
@@ -79 +82 @@
     view = new CalHTMLPane(new CalHTMLPreferences(), new Observer(), "Help Pages");
 
-    HelpItem rootNode = new HelpItem(Dictionary.get("Help.Contents"), "<null>");
+    HelpItem rootNode = new HelpItem(Dictionary.get("Help.Contents"), NULL_STRING);
     model = new ContentsModel(rootNode);
     contents = new JTree((DefaultTreeModel) model);
@@ -141 +144 @@
         try {
         DOMParser parser = new DOMParser();
-        parser.parse(Utility.HELP_DIR + "help.xml");
+        parser.parse(Utility.getHelpIndex());
         Document document = parser.getDocument();
 
@@ -151 +154 @@
         for (int i = 0; i < children.getLength(); i++) {
             Node child = children.item(i);
-            if (child.getNodeName().equals("Section")) {
+            if (child.getNodeName().equals(StaticStrings.SECTION_ELEMENT)) {
             sectionNum++;
-            buildContentsHierarchy(rootNode, sectionNum + "", child);
+            buildContentsHierarchy(rootNode, sectionNum + StaticStrings.EMPTY_STR, child);
             }
         }
@@ -166 +169 @@
     {
         // Determine the section name
-        String sectionName = ((Element) node).getAttribute("name");
+        String sectionName = ((Element) node).getAttribute(StaticStrings.NAME_ATTRIBUTE);
 
         // Determine the section title
-        String sectionTitle = "";
+        String sectionTitle = StaticStrings.EMPTY_STR;
         NodeList children = node.getChildNodes();
         for (int i = 0; i < children.getLength(); i++) {
         Node child = children.item(i);
-        if (child.getNodeName().equals("Title")) {
-            sectionTitle = pos + ": " + child.getFirstChild().getNodeValue();
+        if (child.getNodeName().equals(StaticStrings.TITLE_ELEMENT)) {
+            sectionTitle = pos + StaticStrings.COLON_CHARACTER + StaticStrings.SPACE_CHARACTER + child.getFirstChild().getNodeValue();
         }
         }
@@ -186 +189 @@
         for (int i = 0; i < children.getLength(); i++) {
         Node child = children.item(i);
-        if (child.getNodeName().equals("Section")) {
+        if (child.getNodeName().equals(StaticStrings.SECTION_ELEMENT)) {
             sectionNum++;
-            buildContentsHierarchy(item, pos + "." + sectionNum, child);
+            buildContentsHierarchy(item, pos + StaticStrings.STOP_CHARACTER + sectionNum, child);
         }
         }
@@ -260 +263 @@
     public URL getURL()
     {
-        if (name != null && !name.equals("<null>")) {
+        if (name != null && !name.equals(NULL_STRING)) {
         try {
-            File file = new File(Utility.HELP_DIR + name + ".htm");
+            File file = new File(Utility.HELP_DIR + name + StaticStrings.HTM_FILE_EXTENSION);
             return file.toURL();
         }

trunk/gli/src/org/greenstone/gatherer/util/StaticStrings.java

@@ -119 +119 @@
     static final public String HTTP_PROTOCOL_STR                          = "http://";
     static final public String HELP_ARGUMENT                              = "-help";
+    static final public String HELP_INDEX_FILENAME                        = "help_index.xml";
+    static final public String HTM_FILE_EXTENSION                         = ".htm";
     static final public String IDENTIFIER_VALUE                           = "identifier";
     static final public String IMAGES_FOLDER                              = "images";
@@ -152 +154 @@
     static final public String MAPPING_ELEMENT                            = "Mapping";
     static final public String MARC_EXTENSION                             = ".marc";
+    static final public String MDS_ATTRIBUTE                              = "mds";
     static final public String METADATA_ARGUMENT                          = "-metadata";
     static final public String METADATA_BAK                               = "~metadata.xml";
@@ -190 +193 @@
     static final public String SEARCHTYPE_ELEMENT                         = "SearchType";
     static final public String SEARCHTYPE_STR                             = "searchtype";
+    static final public String SECTION_ELEMENT                            = "Section";
     static final public String SECTION_STR                                = "section";
     static final public String SEPARATOR_ATTRIBUTE                        = "separator";
@@ -216 +220 @@
     static final public String TEXT_STR                                   = "text";
     static final public String TIMESTAMP_ARGUMENT                         = "&uq=";
+    static final public String TITLE_ELEMENT                              = "Title";
     static final public String TRUE_STR                                   = "true";
-    static final public String TRUNCATED_STRING                            = "...";
+    static final public String TRUNCATED_STRING                           = "...";
     static final public String TYPE_ATTRIBUTE                             = "type";
     static final public String UNDERSCORE_CHARACTER                       = "_";

trunk/gli/src/org/greenstone/gatherer/util/Utility.java

@@ -370 +370 @@
             // If the token is bigger than two thirds width, before we've even started break it down.
             if(current_width + 1 + token.length() > width && token.length() > threshold) {
-            String prefix = token.substring(0, width - 1 - current_width);
-            token = token.substring(prefix.length());
-            if(current_width == 0) {
-                line = line + prefix;
+            if(width == current_width) {
+                lines.push(line);
+                line = token;
+                current_width = token.length();
             }
             else {
-                line = line + " " + prefix;
+                String prefix = token.substring(0, width - 1 - current_width);
+                token = token.substring(prefix.length());
+                if(current_width == 0) {
+                line = line + prefix;
+                }
+                else {
+                line = line + " " + prefix;
+                }
+                lines.push(line);
+                line = "";
+                current_width = 0;
             }
-            lines.push(line);
-            line = "";
-            current_width = 0;
             }
             // If adding the next token would push us over the maximum line width.
@@ -547 +554 @@
     return col_dir + ETC_DIR;
     }
+
+    /** Retrieve the full file path to the help index xml file.
+     * @return the full path as a String
+     */
+    static public String getHelpIndex() {
+    String help_index = HELP_DIR + Gatherer.config.getLanguage() + File.separator + StaticStrings.HELP_INDEX_FILENAME;
+    File help_index_file = new File(help_index);
+    // If that file can't be found, default to english
+    if(!help_index_file.exists()) {
+        help_index = HELP_DIR + StaticStrings.ENGLISH_LANGUAGE_STR  + File.separator + StaticStrings.HELP_INDEX_FILENAME;
+    }
+    return help_index;
+    }
+
+
     /** Method to retrieve an image icon with the given filename found in classpath or the resouces directory.
      *  @return The specified <strong>ImageIcon</strong>, or an error image replacement if no such images exists.