xseed 1.0.0

data/lib/xseed/documentation/config.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Xseed
+  module Documentation
+    # Configuration class for HTML documentation generation
+    # Ported from xs3p core/parameters.xsl
+    class Config
+      # Title of HTML document
+      attr_accessor :title
+
+      # If true, sorts the top-level schema components by type, then name
+      # Otherwise, displays components in the order they appear in the schema
+      attr_accessor :sort_by_component
+
+      # If true, prints all super-types in the type hierarchy box
+      # Otherwise, prints the parent type only
+      attr_accessor :print_all_super_types
+
+      # If true, prints all sub-types in the type hierarchy box
+      # Otherwise, prints the direct sub-types only
+      attr_accessor :print_all_sub_types
+
+      # If true, prints out the Glossary section
+      attr_accessor :print_glossary
+
+      # If true, includes SVG diagram references in component sections
+      attr_accessor :print_diagrams
+
+      # Directory for auto-generated SVG diagrams (relative to HTML output directory)
+      attr_accessor :diagrams_dir
+
+      # If true, prints prefix matching namespace of schema components
+      # in XML Instance Representation tables
+      attr_accessor :print_ns_prefixes
+
+      # If true, searches 'included' schemas for schema components
+      # when generating links and XML Instance Representation tables
+      attr_accessor :search_included_schemas
+
+      # If true, searches 'imported' schemas for schema components
+      # when generating links and XML Instance Representation tables
+      attr_accessor :search_imported_schemas
+
+      # File containing the mapping from file locations of external
+      # schemas to file locations of their XHTML documentation
+      attr_accessor :links_file
+
+      # Base URL for resolving links
+      attr_accessor :base_url
+
+      # External CSS stylesheet URL (xs3p specific CSS, not Bootstrap)
+      attr_accessor :external_css_url
+
+      # Link to jQuery
+      attr_accessor :jquery_url
+
+      # Link base to Bootstrap CSS and JS
+      attr_accessor :bootstrap_url
+
+      def initialize
+        # Set defaults from xs3p parameters
+        @title = nil # Use schema filename if nil
+        @sort_by_component = true
+        @print_all_super_types = true
+        @print_all_sub_types = true
+        @print_glossary = true
+        @print_diagrams = true
+        @diagrams_dir = "diagrams"
+        @print_ns_prefixes = true
+        @search_included_schemas = false
+        @search_imported_schemas = false
+        @links_file = nil
+        @base_url = nil
+        @external_css_url = nil
+        @jquery_url = "https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"
+        @bootstrap_url = "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1"
+      end
+
+      # Returns configuration as a hash
+      def to_h
+        {
+          title: @title,
+          sort_by_component: @sort_by_component,
+          print_all_super_types: @print_all_super_types,
+          print_all_sub_types: @print_all_sub_types,
+          print_glossary: @print_glossary,
+          print_diagrams: @print_diagrams,
+          diagrams_dir: @diagrams_dir,
+          print_ns_prefixes: @print_ns_prefixes,
+          search_included_schemas: @search_included_schemas,
+          search_imported_schemas: @search_imported_schemas,
+          links_file: @links_file,
+          base_url: @base_url,
+          external_css_url: @external_css_url,
+          jquery_url: @jquery_url,
+          bootstrap_url: @bootstrap_url,
+        }
+      end
+    end
+  end
+end

data/lib/xseed/documentation/constants.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Xseed
+  module Documentation
+    # Constants used throughout HTML documentation generation
+    # Ported from xs3p core/constants.xsl
+    module Constants
+      # XML Schema Namespace
+      XSD_NS = "http://www.w3.org/2001/XMLSchema"
+
+      # XML Namespace
+      XML_NS = "http://www.w3.org/XML/1998/namespace"
+
+      # Number of spaces to indent from parent element's start tag to
+      # child element's start tag
+      ELEM_INDENT = 3
+
+      # Number of spaces to indent from parent element's start tag to
+      # attribute's tag
+      ATTR_INDENT = 2
+
+      # Title to use if none provided
+      DEFAULT_TITLE = "XML Schema Documentation"
+
+      # Prefixes used for anchor names
+      # Type definitions (both complex and simple)
+      TYPE_PREFIX = "type_"
+      # Attribute declarations
+      ATTR_PREFIX = "attribute_"
+      # Attribute group definitions
+      ATTR_GROUP_PREFIX = "attributeGroup_"
+      # Element declarations
+      ELEM_PREFIX = "element_"
+      # Key definitions
+      KEY_PREFIX = "key_"
+      # Group definitions
+      GROUP_PREFIX = "group_"
+      # Notations
+      NOTATION_PREFIX = "notation_"
+      # Namespace declarations
+      NS_PREFIX = "ns_"
+      # Glossary terms
+      TERM_PREFIX = "term_"
+
+      # Help texts used throughout the document
+      # Hierarchy table
+      HELP_HIERARCHY = "This table shows the schema components type hierarchy."
+
+      # Properties table
+      HELP_PROPERTIES = "This table displays the properties of the schema component."
+
+      # Documentation panel
+      HELP_DOCUMENTATION = "This panel contains the schema components documentation."
+
+      # Instance table
+      HELP_INSTANCE = <<~HELP.strip
+        The XML Instance Representation table shows the schema component's content as an XML instance.
+        <ul>
+        <li>The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].</li>
+        <li>Model group information are shown in gray, e.g. Start Choice ... End Choice.</li>
+        <li>For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in <strong>bold</strong></li>
+        <li>If an element/attribute has a fixed value, the fixed value is shown in green.</li>
+        <li>If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked.</li>
+        </ul>
+      HELP
+
+      # Representation table
+      HELP_REPRESENTATION = "The Schema Component Representation table below displays " \
+                            "the underlying XML representation of the schema component. " \
+                            "(Annotations are not shown.)"
+
+      # Navigation panel width
+      NAV_WIDTH = "270px"
+    end
+  end
+end