xseed 1.0.0

data/lib/xseed/documentation/presentation/css_generator.rb

@@ -0,0 +1,510 @@
+# frozen_string_literal: true
+
+module Xseed
+  module Documentation
+    module Presentation
+      # Generates CSS stylesheets for HTML documentation
+      # Ports styles from XS3P css-styles.xsl
+      class CssGenerator
+        NAV_WIDTH = "298px"
+
+        def initialize(config)
+          @config = config
+        end
+
+        def generate
+          <<~CSS
+            /* XSD Documentation Styles */
+            /* Ported from XS3P css-styles.xsl */
+
+            nav, section {
+              display: block;
+            }
+
+            table {
+              border-collapse: collapse;
+              border-spacing: 0;
+            }
+
+            body {
+              margin-left: auto;
+              margin-right: auto;
+              max-width: 100%;
+              font-size: 16px;
+              font-weight: 300;
+              line-height: 1.4em;
+              color: -internal-root-color;
+              background-color: #ffffff;
+              font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+            }
+
+            body main {
+              margin: 0 3em 0 6em;
+            }
+
+            body main {
+              margin: 0;
+            }
+
+            /* HTML5 display-role reset for older browsers */
+            article, aside, details, figcaption, figure,
+            footer, header, hgroup, menu, nav, section {
+              display: block;
+            }
+
+            body {
+              line-height: 1.3;
+            }
+
+            body {
+              margin-left: #{NAV_WIDTH};
+              margin-right: 2em;
+            }
+
+            main {
+              padding-left: 4em;
+              padding-right: 2em;
+            }
+
+            .title-section {
+              padding-left: 4em;
+              padding-top: 2em;
+            }
+
+            h2 p {
+              display: inline;
+            }
+
+            /* Navigation */
+            #toc {
+              font-weight: 400;
+            }
+
+            #toc a {
+              color: black;
+              text-decoration-color: black;
+            }
+
+            #toc ul {
+              margin: 0;
+              padding: 0;
+              list-style: none;
+            }
+
+            #toc ul li a {
+              padding: 5px 10px;
+            }
+
+            #toc ul a {
+              text-decoration: none;
+              display: block;
+            }
+
+            #toc ul a:hover {
+              box-shadow: none;
+              color: black;
+            }
+
+            #toc .h2 {
+              padding-left: 30px;
+            }
+
+            #toc .h3 {
+              padding-left: 50px;
+            }
+
+            #toc .toc-active, #toc li:hover {
+              background: #f7f7f7;
+              box-shadow: inset -5px 0px 10px -5px #f7f7f7 !important;
+            }
+
+            #toc .toc-active a, #toc li:hover a {
+              color: black;
+            }
+
+            @media print {
+              #toc .toc-active, #toc li:hover {
+                background: white;
+                box-shadow: none !important;
+              }
+
+              #toc li:hover a {
+                color: black;
+              }
+            }
+
+            @media screen and (max-width: 768px) {
+              #toc {
+                padding: 0 1.5em;
+                overflow: visible;
+              }
+            }
+
+            #toc .toc-active,
+            #toc li:hover {
+              box-shadow: 0px 1px 0px 0px black !important;
+              background: none;
+            }
+
+            #toc li:before {
+              content: " ";
+              display: none;
+            }
+
+            nav {
+              line-height: 1.2em;
+            }
+
+            @media screen and (min-width: 768px) {
+              nav {
+                position: fixed;
+                top: 0;
+                bottom: 0;
+                left: 0;
+                width: #{NAV_WIDTH};
+                font-size: 0.9em;
+                overflow: auto;
+                padding: 0 0 0 0px;
+                background-color: #fefefe;
+              }
+            }
+
+            @media print {
+              nav {
+                position: relative;
+                width: auto;
+                font-size: 0.9em;
+                overflow: auto;
+                padding: 0;
+                margin-right: 0;
+                background-color: white;
+              }
+            }
+
+            #toggle {
+              margin-top: 0;
+            }
+
+            @media screen and (min-width: 768px) {
+              #toggle {
+                position: fixed;
+                height: 100%;
+                width: 20px;
+                font-weight: bold;
+                background-color: #d8e4ff;
+                color: black !important;
+                cursor: pointer;
+                z-index: 100;
+              }
+
+              #toggle span {
+                text-align: center;
+                width: 100%;
+                position: absolute;
+                top: 50%;
+                transform: translate(0, -50%);
+              }
+            }
+
+            @media screen and (max-width: 768px) {
+              #toggle {
+                display: none;
+              }
+            }
+
+            @media print {
+              #toggle {
+                display: none;
+              }
+            }
+
+            @media screen and (min-width: 768px) {
+              .container {
+                padding-left: 360px;
+              }
+
+              .rule.toc {
+                display: none;
+              }
+
+              h1.toc-contents {
+                margin-top: 1em;
+              }
+
+              ul#toc-list {
+                padding: 0;
+                margin: 0;
+              }
+            }
+
+            ul, ol {
+              margin-left: 2em;
+            }
+
+            #toc-list ul {
+              margin-bottom: 0.25em;
+            }
+
+            #toc-list ol li {
+              list-style-type: none;
+            }
+
+            /* XS3P specific CSS */
+            body {
+              background-color: #FFF;
+            }
+
+            .nav > li.active {
+              background-color: #FFF;
+            }
+
+            .nav > li > a:hover {
+              background-color: rgb(0,0,0, 0.05);
+            }
+
+            .nav-sub-item > a {
+              padding-left: 30px !important;
+            }
+
+            .nav-sub-item strong {
+              font-weight: normal;
+            }
+
+            .nav {
+              background-color: #e4ecff;
+            }
+
+            .xs3p-sidenav {
+              background-color: #e4ecff;
+            }
+
+            code {
+              color: #333;
+            }
+
+            a.name {
+              padding-top: 65px;
+            }
+
+            a:not([href]) {
+              color:#1c476c;
+            }
+
+            a:not([href]):hover {
+              text-decoration: none;
+            }
+
+            h3.xs3p-subsection-heading {
+              margin-bottom: 30px;
+            }
+
+            section, #top {
+              margin-top: -65px;
+              padding-top: 65px;
+            }
+
+            pre {
+              padding: 5px;
+            }
+
+            .xs3p-in-panel-table {
+              margin-bottom: 0px;
+            }
+
+            .xs3p-collapse-button {
+              font-size: 8pt;
+            }
+
+            .panel-heading .xs3p-panel-title:after {
+              font-family: 'Glyphicons Halflings';
+              content: "\\e114";
+              float: left;
+              color: grey;
+              margin-right: 10px;
+            }
+
+            .panel-heading .xs3p-panel-title.collapsed:after {
+              content: "\\e080";
+            }
+
+            .panel-info > .panel-heading .xs3p-panel-title:after {
+              color: white;
+            }
+
+            .xs3p-panel-help {
+              color: #888888;
+              cursor: pointer;
+            }
+
+            .panel-group {
+              margin-bottom: 20px;
+            }
+
+            .btn-doc {
+              padding: 0px;
+              border: 0px none;
+              background: none repeat scroll 0% 0% transparent;
+              line-height: 1;
+              font-size: 12px;
+            }
+
+            .unpre {
+              font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+              font-size: 14px;
+              white-space: normal;
+              word-break: normal;
+              word-wrap: normal;
+            }
+
+            .popover {
+              max-width: 400px;
+            }
+
+            /* Syntax highlighting */
+            .codehilite .err {
+              color: #FFF;
+              background-color: #D2322D;
+              font-weight: bold;
+            }
+
+            .codehilite .c {
+              color: #999;
+            }
+
+            .codehilite .cs {
+              color: #999;
+              font-style: italic;
+            }
+
+            .codehilite .nt {
+              color: #2F6F9F;
+            }
+
+            .codehilite .nn {
+              color: #39B3D7;
+            }
+
+            .codehilite .na {
+              color: #47A447;
+            }
+
+            .codehilite .s {
+              color: #D2322D;
+            }
+
+            .codehilite a {
+              color: inherit !important;
+              text-decoration: underline !important;
+            }
+
+            .codehilite a:hover {
+              opacity: 0.7 !important;
+            }
+
+            dl {
+              margin-bottom: 10px;
+            }
+
+            dt {
+              font-weight: normal;
+              margin-bottom: 10px;
+            }
+
+            dt.header {
+              font-weight: 700;
+            }
+
+            .dl-horizontal dt {
+              white-space: normal;
+            }
+
+            dd.header {
+              font-weight: 700;
+            }
+
+            dd ul {
+              margin-left: 0em;
+            }
+
+            .bs-callout {
+              padding: 20px;
+              padding-top: 10px;
+              padding-bottom: 5px;
+              margin: 20px 0;
+              border: 1px solid #eee;
+              border-left-width: 5px;
+              border-radius: 3px;
+            }
+
+            .bs-callout-danger {
+              border-left-color: #d9534f;
+            }
+
+            .bs-callout-warning {
+              border-left-color: #f0ad4e;
+            }
+
+            .bs-callout-info {
+              border-left-color: #5bc0de;
+            }
+
+            .bs-callout h4 {
+              margin-top: 0;
+              margin-bottom: 5px;
+            }
+
+            .bs-callout-danger h4 {
+              color: #d9534f;
+            }
+
+            .bs-callout-warning h4 {
+              color: #f0ad4e;
+            }
+
+            .bs-callout-info h4 {
+              color: black;
+              font-size: 11pt;
+            }
+
+            /* Table styles */
+            .properties {
+              border-collapse: collapse;
+              width: 100%;
+            }
+
+            .properties th {
+              background: #f0f0f0;
+              text-align: left;
+              padding: 8px;
+            }
+
+            .properties td {
+              border: 1px solid #ddd;
+              padding: 8px;
+            }
+
+            /* Content display */
+            .hierarchy {
+              margin: 10px 0;
+            }
+
+            .instance-sample {
+              background: #f5f5f5;
+              padding: 10px;
+              overflow-x: auto;
+            }
+
+            .xml-code {
+              font-family: monospace;
+              white-space: pre;
+            }
+          CSS
+        end
+
+        def external_css_url
+          @config.external_css_url
+        end
+      end
+    end
+  end
+end

data/lib/xseed/documentation/presentation/javascript_generator.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Xseed
+  module Documentation
+    module Presentation
+      # Generates JavaScript code for HTML documentation
+      # Ports functionality from XS3P javascript.xsl
+      class JavascriptGenerator
+        NAV_WIDTH = "298px"
+
+        def initialize(config)
+          @config = config
+        end
+
+        def generate
+          <<~JAVASCRIPT
+            // XSD Documentation JavaScript
+            // Ported from XS3P javascript.xsl
+
+            document.addEventListener('DOMContentLoaded', function() {
+              // TOC toggle
+              initializeTOC();
+
+              // Tooltips and popovers
+              initializeTooltips();
+
+              // Smooth scrolling
+              initializeSmoothScroll();
+
+              // Bootstrap initialization
+              initializeBootstrap();
+
+              // Markdown processing
+              initializeMarkdown();
+
+              // Sidebar scrolling
+              initializeSidebarScrolling();
+            });
+
+            function initializeTOC() {
+              var duration = 400;
+              $('#toggle').on('click', function(){
+                if( $('nav').is(':visible') ) {
+                  $('nav').animate({ 'left': '-353px' }, duration, function(){
+                    $('nav').hide();
+                  });
+                  $('body').animate({ 'margin-left': '0' }, duration);
+                  $('#toggle > span').text('>');
+                }
+                else {
+                  $('nav').show();
+                  $('nav').animate({ 'left': '0px' }, duration);
+                  $('body').animate({ 'margin-left': '#{NAV_WIDTH}' }, duration);
+                  $('#toggle > span').text('<');
+                }
+              });
+            }
+
+            function initializeTooltips() {
+              $("[data-toggle='tooltip']").tooltip();
+            }
+
+            function initializeSmoothScroll() {
+              // Smooth scrolling for anchor links
+              $('a[href^="#"]').on('click', function(e) {
+                var target = $(this.getAttribute('href'));
+                if (target.length) {
+                  e.preventDefault();
+                  $('html, body').stop().animate({
+                    scrollTop: target.offset().top - 65
+                  }, 500);
+                }
+              });
+            }
+
+            function initializeBootstrap() {
+              // Initialize popovers
+              $("[data-toggle='popover']").popover({ trigger: "hover" });
+
+              // Modal handling
+              $("[data-toggle='modal']").click(function() { return false; });
+
+              $("[data-toggle='modal']").popover({
+                trigger: "hover",
+                html: true,
+                content: function () {
+                  var targetId = $(this).attr('data-target');
+                  return $(targetId).html();
+                }
+              });
+            }
+
+            function initializeMarkdown() {
+              if (typeof Markdown !== 'undefined' && Markdown.Converter) {
+                var c = new Markdown.Converter();
+                $('.xs3p-doc').each(function(i, obj) {
+                  var rawDocID = '#' + $(this).attr('id') + '-raw';
+                  var indent = $(rawDocID).html().match("^\\n[\\t ]*");
+                  var normalized;
+                  if (!(indent === null)) {
+                    normalized = $(rawDocID).html().replace(new RegExp(indent[0], "gm"), "\\n");
+                  } else {
+                    normalized = $(rawDocID).html();
+                  }
+                  $(this).html(c.makeHtml(normalized));
+                  $(this).find('code,pre').each(function(i, block) {
+                    $(this).html($(this).text());
+                  });
+                });
+              }
+            }
+
+            function initializeSidebarScrolling() {
+              $(window).scroll(function() {
+                if ($(".xs3p-sidebar").css("position") == "fixed" && $(window).height() < $(".xs3p-sidebar").height()) {
+                  var perc = $(window).scrollTop() / $("#xs3p-content").height();
+                  var overflow = $(".xs3p-sidebar").height() + 105 - $(window).height();
+                  $(".xs3p-sidebar").css("top", (65 - Math.round(overflow * perc)) + "px");
+                }
+              });
+
+              $(window).resize(function() {
+                if ($(".xs3p-sidebar").css("position") == "fixed") {
+                  $(".xs3p-sidebar").css("top", "65px");
+                }
+              });
+            }
+          JAVASCRIPT
+        end
+
+        def jquery_url
+          @config.jquery_url || default_jquery_url
+        end
+
+        def bootstrap_url
+          @config.bootstrap_url || default_bootstrap_url
+        end
+
+        private
+
+        def default_jquery_url
+          "https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js"
+        end
+
+        def default_bootstrap_url
+          "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1"
+        end
+      end
+    end
+  end
+end