RubyGems - Almirah - Versions diffs - 0.2.4 → 0.2.6 - Mend

Almirah 0.2.4 → 0.2.6

Files changed (41) hide show

checksums.yaml +4 -4
data/bin/almirah +4 -4
data/lib/almirah/doc_fabric.rb +65 -65
data/lib/almirah/doc_items/blockquote.rb +21 -21
data/lib/almirah/doc_items/code_block.rb +26 -26
data/lib/almirah/doc_items/controlled_paragraph.rb +112 -112
data/lib/almirah/doc_items/controlled_table.rb +224 -224
data/lib/almirah/doc_items/controlled_table_row.rb +22 -22
data/lib/almirah/doc_items/doc_footer.rb +16 -16
data/lib/almirah/doc_items/doc_item.rb +22 -20
data/lib/almirah/doc_items/frontmatter.rb +9 -0
data/lib/almirah/doc_items/heading.rb +93 -93
data/lib/almirah/doc_items/image.rb +27 -27
data/lib/almirah/doc_items/markdown_list.rb +156 -158
data/lib/almirah/doc_items/markdown_table.rb +61 -63
data/lib/almirah/doc_items/paragraph.rb +25 -27
data/lib/almirah/doc_items/text_line.rb +296 -296
data/lib/almirah/doc_items/todo_block.rb +21 -21
data/lib/almirah/doc_parser.rb +378 -330
data/lib/almirah/doc_types/base_document.rb +64 -70
data/lib/almirah/doc_types/coverage.rb +95 -81
data/lib/almirah/doc_types/index.rb +173 -169
data/lib/almirah/doc_types/persistent_document.rb +17 -20
data/lib/almirah/doc_types/protocol.rb +24 -24
data/lib/almirah/doc_types/specification.rb +67 -67
data/lib/almirah/doc_types/traceability.rb +142 -142
data/lib/almirah/dom/doc_section.rb +25 -25
data/lib/almirah/dom/document.rb +78 -72
data/lib/almirah/navigation_pane.rb +16 -16
data/lib/almirah/project.rb +287 -306
data/lib/almirah/project_configuration.rb +41 -41
data/lib/almirah/project_template.rb +298 -0
data/lib/almirah/project_utility.rb +52 -0
data/lib/almirah/search/specifications_db.rb +79 -83
data/lib/almirah/templates/css/main.css +300 -300
data/lib/almirah/templates/css/search.css +40 -40
data/lib/almirah/templates/page.html +42 -42
data/lib/almirah/templates/scripts/main.js +111 -111
data/lib/almirah/templates/scripts/orama_search.js +138 -138
data/lib/almirah.rb +93 -49
metadata +28 -5

data/lib/almirah/templates/page.html CHANGED Viewed

@@ -1,42 +1,42 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-<meta charset="utf-8" />
-<title>{{DOCUMENT_TITLE}}</title>
-<!-- CSS -->
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
-{{STYLES_AND_SCRIPTS}}
-</head>
-<body>
-    <div id="top_nav">
-        <a id="home_menu_item" href="javascript:void(0)" onclick="navigate_to_home()"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
-        <a id="index_menu_item" href="javascript:void(0)" onclick="navigate_to_home()" style="display: none;"><span><i class="fa fa-info" aria-hidden="true"></i></span>&nbsp;Index</a>
-        <a id="document_tree_menu_item" href="javascript:void(0)" onclick="openNav()" style="display: none;" title="Navigation Pane"><span><i class="fa fa-folder-open-o" aria-hidden="true"></i></span></a>
-        <input type="text" id="searchInput" placeholder="Search.." style="display: none;">
-        <a class="split">{{DOCUMENT_TITLE}}</a>
-    </div>
-    <div id="search_dropdown" class="search-results-content" style="display: none;"></div>
-    <div id="main">
-        <div id="closed_nav_pane" href="javascript:void(0)" onclick="openNav()">
-        </div>
-        <div id="nav_pane">
-            {{NAV_PANE}}
-        </div>
-        <div id="content" href="javascript:void(0)" onclick="closeNav()">
-            {{CONTENT}}
-        </div><!-- content -->
-    </div><!-- main -->
-    <div id="footer">
-        Powered by <a target="_blank" rel="noopener" href="https://www.almirah.site/">
-            Almirah Framework
-            {{GEM_VERSION}}
-        </a>
-    </div><!-- footer -->
-    <!-- The modal window for image zoom -->
-    <div id="image_modal_div" class="modal">
-        <span class="modal_close_btn" href="javascript:void(0)" onclick="modal_close_OnClick(this)">&times;</span>
-        <img class="modal_image" id="modal_image_id">
-        <div id="modal_image_caption"></div>
-    </div>
-</body>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8" />
+<title>{{DOCUMENT_TITLE}}</title>
+<!-- CSS -->
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
+{{STYLES_AND_SCRIPTS}}
+</head>
+<body>
+    <div id="top_nav">
+        <a id="home_menu_item" href="javascript:void(0)" onclick="navigate_to_home()"><span><i class="fa fa-home" aria-hidden="true"></i></span>&nbsp;Home</a>
+        <a id="index_menu_item" href="javascript:void(0)" onclick="navigate_to_home()" style="display: none;"><span><i class="fa fa-info" aria-hidden="true"></i></span>&nbsp;Index</a>
+        <a id="document_tree_menu_item" href="javascript:void(0)" onclick="openNav()" style="display: none;" title="Navigation Pane"><span><i class="fa fa-folder-open-o" aria-hidden="true"></i></span></a>
+        <input type="text" id="searchInput" placeholder="Search.." style="display: none;">
+        <a class="split">{{DOCUMENT_TITLE}}</a>
+    </div>
+    <div id="search_dropdown" class="search-results-content" style="display: none;"></div>
+    <div id="main">
+        <div id="closed_nav_pane" href="javascript:void(0)" onclick="openNav()">
+        </div>
+        <div id="nav_pane">
+            {{NAV_PANE}}
+        </div>
+        <div id="content" href="javascript:void(0)" onclick="closeNav()">
+            {{CONTENT}}
+        </div><!-- content -->
+    </div><!-- main -->
+    <div id="footer">
+        Powered by <a target="_blank" rel="noopener" href="https://www.almirah.site/">
+            Almirah Framework
+            {{GEM_VERSION}}
+        </a>
+    </div><!-- footer -->
+    <!-- The modal window for image zoom -->
+    <div id="image_modal_div" class="modal">
+        <span class="modal_close_btn" href="javascript:void(0)" onclick="modal_close_OnClick(this)">&times;</span>
+        <img class="modal_image" id="modal_image_id">
+        <div id="modal_image_caption"></div>
+    </div>
+</body>

data/lib/almirah/templates/scripts/main.js CHANGED Viewed

@@ -1,112 +1,112 @@
-function openNav() {
-    if (document.getElementById("nav_pane").style.visibility == "visible"){
-      document.getElementById("nav_pane").style.visibility = "hidden";
-    }else{
-      document.getElementById("nav_pane").style.visibility = "visible";
-    }
-  }
-  function closeNav() {
-    document.getElementById("nav_pane").style.visibility = "hidden";
-  }
-  window.onload = (event) => {
-    for (var i = 0, n = document.images.length; i < n; i++)
-    {
-      elem = document.images[i];
-      if (elem.width > 640)
-      {
-          elem.style.width = "640px";
-      }
-    }
-    if (document.title == "Document Index"){
-      document.getElementById('document_tree_menu_item').style.display = "none";
-      document.getElementById('home_menu_item').style.display = "block";
-      document.getElementById('index_menu_item').style.display = "none";
-      if (document.URL.includes('http')){
-        document.getElementById("searchInput").style.display = "block";
-      }
-    }else{
-      document.getElementById('home_menu_item').style.display = "none";
-      document.getElementById('index_menu_item').style.display = "block";
-      if (document.title.includes("Traceability Matrix:")){
-        document.getElementById('document_tree_menu_item').style.display = "none";
-      } else {
-        document.getElementById('document_tree_menu_item').style.display = "block";
-      }
-    }
-    // Scroll a bit to make navigated anchor visible
-    //setTimeout(function() {
-    //      window.scrollBy({
-    //      top: -40,
-    //      behavior: "smooth"
-    //      });
-    //  }, 200);
-  };
-  function downlink_OnClick(clicked){
-      clicked.style.display = 'none';
-      id_parts = clicked.id.split("_");
-      required_id = "DLS_" + id_parts[1];
-      document.getElementById(required_id).style.display = 'block';
-  }
-  function coverageLink_OnClick(clicked){
-    clicked.style.display = 'none';
-    id_parts = clicked.id.split("_");
-    required_id = "COVS_" + id_parts[1];
-    document.getElementById(required_id).style.display = 'block';
-  }
-  function upLink_OnClick(clicked){
-    clicked.style.display = 'none';
-    id_parts = clicked.id.split("_");
-    required_id = "ULS_" + id_parts[1];
-    document.getElementById(required_id).style.display = 'block';
-  }
-  function navigate_to_home(){
-      if (document.title != "Document Index")
-      {
-        if (document.URL.includes('protocols')){
-          window.location.href = "./../../../index.html";
-        }else{
-          window.location.href = "./../../index.html";
-        }
-      }else{
-          window.location.href = "./index.html";
-      }
-  }
-  // Modal window for image zoom
-  function image_OnClick(clicked){
-      var modal = document.getElementById('image_modal_div');
-      var modalImg = document.getElementById("modal_image_id");
-      var captionText = document.getElementById("modal_image_caption");
-      modal.style.display = "block";
-      modalImg.src = clicked.src;
-      captionText.innerHTML = clicked.alt;
-  }
-  function modal_close_OnClick(clicked){
-      var modal = document.getElementById('image_modal_div');
-      modal.style.display = "none";
-  }
-  // Navigation Pane Expand/Collapse
-  function nav_toggle_expand_list(el, e){
-    var children = el.children;
-    e.stopPropagation();
-    for (var i = 0; i < children.length; i++) {
-      var list_item = children[i];
-      if (list_item.tagName == "UL"){
-        if (list_item.style.display != "none"){
-          list_item.style.display = "none";
-        }else{
-          list_item.style.display = "block";
-        }
-      }else if (list_item.tagName == "SPAN"){
-        list_item.firstChild.classList.toggle("fa-plus-square-o");
-      }
-    }
+function openNav() {
+    if (document.getElementById("nav_pane").style.visibility == "visible"){
+      document.getElementById("nav_pane").style.visibility = "hidden";
+    }else{
+      document.getElementById("nav_pane").style.visibility = "visible";
+    }
+  }
+  function closeNav() {
+    document.getElementById("nav_pane").style.visibility = "hidden";
+  }
+  window.onload = (event) => {
+    for (var i = 0, n = document.images.length; i < n; i++)
+    {
+      elem = document.images[i];
+      if (elem.width > 640)
+      {
+          elem.style.width = "640px";
+      }
+    }
+    if (document.title == "Document Index"){
+      document.getElementById('document_tree_menu_item').style.display = "none";
+      document.getElementById('home_menu_item').style.display = "block";
+      document.getElementById('index_menu_item').style.display = "none";
+      if (document.URL.includes('http')){
+        document.getElementById("searchInput").style.display = "block";
+      }
+    }else{
+      document.getElementById('home_menu_item').style.display = "none";
+      document.getElementById('index_menu_item').style.display = "block";
+      if (document.title.includes("Traceability Matrix:")){
+        document.getElementById('document_tree_menu_item').style.display = "none";
+      } else {
+        document.getElementById('document_tree_menu_item').style.display = "block";
+      }
+    }
+    // Scroll a bit to make navigated anchor visible
+    //setTimeout(function() {
+    //      window.scrollBy({
+    //      top: -40,
+    //      behavior: "smooth"
+    //      });
+    //  }, 200);
+  };
+  function downlink_OnClick(clicked){
+      clicked.style.display = 'none';
+      id_parts = clicked.id.split("_");
+      required_id = "DLS_" + id_parts[1];
+      document.getElementById(required_id).style.display = 'block';
+  }
+  function coverageLink_OnClick(clicked){
+    clicked.style.display = 'none';
+    id_parts = clicked.id.split("_");
+    required_id = "COVS_" + id_parts[1];
+    document.getElementById(required_id).style.display = 'block';
+  }
+  function upLink_OnClick(clicked){
+    clicked.style.display = 'none';
+    id_parts = clicked.id.split("_");
+    required_id = "ULS_" + id_parts[1];
+    document.getElementById(required_id).style.display = 'block';
+  }
+  function navigate_to_home(){
+      if (document.title != "Document Index")
+      {
+        if (document.URL.includes('protocols')){
+          window.location.href = "./../../../index.html";
+        }else{
+          window.location.href = "./../../index.html";
+        }
+      }else{
+          window.location.href = "./index.html";
+      }
+  }
+  // Modal window for image zoom
+  function image_OnClick(clicked){
+      var modal = document.getElementById('image_modal_div');
+      var modalImg = document.getElementById("modal_image_id");
+      var captionText = document.getElementById("modal_image_caption");
+      modal.style.display = "block";
+      modalImg.src = clicked.src;
+      captionText.innerHTML = clicked.alt;
+  }
+  function modal_close_OnClick(clicked){
+      var modal = document.getElementById('image_modal_div');
+      modal.style.display = "none";
+  }
+  // Navigation Pane Expand/Collapse
+  function nav_toggle_expand_list(el, e){
+    var children = el.children;
+    e.stopPropagation();
+    for (var i = 0; i < children.length; i++) {
+      var list_item = children[i];
+      if (list_item.tagName == "UL"){
+        if (list_item.style.display != "none"){
+          list_item.style.display = "none";
+        }else{
+          list_item.style.display = "block";
+        }
+      }else if (list_item.tagName == "SPAN"){
+        list_item.firstChild.classList.toggle("fa-plus-square-o");
+      }
+    }
   }

data/lib/almirah/templates/scripts/orama_search.js CHANGED Viewed

@@ -1,138 +1,138 @@
-// Do search only on the Index Page
-import { create, search, insert } from 'https://unpkg.com/@orama/orama@latest/dist/index.js'
-// Create DB
-const db = await create({
-    schema: {
-    doc_title: 'string',
-    doc_color: 'string',
-    text: 'string',
-    heading_url: 'string',
-    heading_text: 'string'
-    }
-})
-// Load JSON DB
-const rel_location = window.location.href.split('/').slice(0,-1).join('/');
-const json_location = rel_location + "/data/specifications_db.json";
-const response = await fetch(json_location);
-const data_rows = await response.json();
-let i = 0;
-while (i < data_rows.length) {
-    await insert(db, {
-        document: data_rows[i]["document"],
-        doc_color: data_rows[i]["doc_color"],
-        text: data_rows[i]["text"],
-        heading_url: data_rows[i]["heading_url"],
-        heading_text: data_rows[i]["heading_text"]
-    })
-    i++;
-}
-// Main db search function
-async function search_onKeyUp(){
-    const search_input_text = document.getElementById("searchInput").value;
-    // Close drop down when empty
-    if ( search_input_text == ''){
-        document.getElementById("search_dropdown").style.display = "none";
-    }else{
-        document.getElementById("search_dropdown").style.display = "block";
-    }
-    const searchResult = await search(db, {
-        term: search_input_text,
-        properties: ['text', 'heading_text'],
-        exact: true,
-        });
-    if (searchResult == null){
-        return;
-    }
-    //console.log(searchResult.hits.map((hit) => hit.document));
-    // clear previous search
-    const myNode = document.getElementById("search_dropdown");
-    while (myNode.firstChild) {
-        myNode.removeChild(myNode.lastChild);
-    }
-    if (searchResult.count == 0){
-        const node = document.createElement("div");
-        node.classList.add('search-item');
-        const textnode = document.createTextNode("There are no matches found");
-        node.appendChild(textnode);
-        myNode.appendChild(node);
-    }else{
-        searchResult.hits.forEach ((value, index, array) =>{
-            const doc_title = value.document["document"]
-            const doc_color = value.document["doc_color"]
-            const heading_url = value.document["heading_url"]
-            const heading_text = value.document["heading_text"]
-            const search_text = value.document["text"]
-            const node_div = document.createElement("div");
-            node_div.classList.add('search-item');
-            const table = document.createElement("table");
-            table.classList.add('search-result-table');
-            node_div.appendChild(table);
-            const tbody = document.createElement("tbody");
-            table.appendChild(tbody);
-            // Row 1
-            let row = document.createElement("tr");
-            let cell = document.createElement("td");
-            let i = document.createElement("i");
-                i.classList.add("fa","fa-file-text-o");
-                i.style.backgroundColor = "#" + doc_color;
-                cell.appendChild(i);
-            let textnode = document.createTextNode("\xa0" + doc_title);
-            cell.appendChild(textnode);
-            row.appendChild(cell)
-            cell = document.createElement("td");
-            const a = document.createElement('a');
-            const link = document.createTextNode(heading_text)
-            a.appendChild(link);
-            a.title = heading_text;
-            a.href = heading_url;
-            document.body.appendChild(a);
-            cell.appendChild(a);
-            row.appendChild(cell)
-            tbody.appendChild(row)
-            // Row 2
-            row = document.createElement("tr");
-            cell = document.createElement("td");
-            cell.colSpan = 2;
-            let show_text_parts = search_text.split(" ", 10).join(" ");
-            textnode = document.createTextNode(show_text_parts);
-            cell.appendChild(textnode)
-            row.appendChild(cell)
-            tbody.appendChild(row)
-            myNode.appendChild(node_div);
-        })
-    }
-}
-document.getElementById("searchInput").addEventListener("keyup", search_onKeyUp);
-// Show when focus in
-document.getElementById("searchInput").addEventListener("focusin", (event) => {
-    // clear previous search
-    const element = document.getElementById("search_dropdown");
-    while (element.firstChild) {
-        element.removeChild(element.lastChild);
-    }
-    // show
-    const rect = document.getElementById("searchInput").getBoundingClientRect();
-    element.style.left = rect.left +'px';
-    element.style.top = rect.top + rect.height + 4 +'px';
-    element.style.display = "block";
-});
+// Do search only on the Index Page
+import { create, search, insert } from 'https://unpkg.com/@orama/orama@latest/dist/index.js'
+// Create DB
+const db = await create({
+    schema: {
+    doc_title: 'string',
+    doc_color: 'string',
+    text: 'string',
+    heading_url: 'string',
+    heading_text: 'string'
+    }
+})
+// Load JSON DB
+const rel_location = window.location.href.split('/').slice(0,-1).join('/');
+const json_location = rel_location + "/data/specifications_db.json";
+const response = await fetch(json_location);
+const data_rows = await response.json();
+let i = 0;
+while (i < data_rows.length) {
+    await insert(db, {
+        document: data_rows[i]["document"],
+        doc_color: data_rows[i]["doc_color"],
+        text: data_rows[i]["text"],
+        heading_url: data_rows[i]["heading_url"],
+        heading_text: data_rows[i]["heading_text"]
+    })
+    i++;
+}
+// Main db search function
+async function search_onKeyUp(){
+    const search_input_text = document.getElementById("searchInput").value;
+    // Close drop down when empty
+    if ( search_input_text == ''){
+        document.getElementById("search_dropdown").style.display = "none";
+    }else{
+        document.getElementById("search_dropdown").style.display = "block";
+    }
+    const searchResult = await search(db, {
+        term: search_input_text,
+        properties: ['text', 'heading_text'],
+        exact: true,
+        });
+    if (searchResult == null){
+        return;
+    }
+    //console.log(searchResult.hits.map((hit) => hit.document));
+    // clear previous search
+    const myNode = document.getElementById("search_dropdown");
+    while (myNode.firstChild) {
+        myNode.removeChild(myNode.lastChild);
+    }
+    if (searchResult.count == 0){
+        const node = document.createElement("div");
+        node.classList.add('search-item');
+        const textnode = document.createTextNode("There are no matches found");
+        node.appendChild(textnode);
+        myNode.appendChild(node);
+    }else{
+        searchResult.hits.forEach ((value, index, array) =>{
+            const doc_title = value.document["document"]
+            const doc_color = value.document["doc_color"]
+            const heading_url = value.document["heading_url"]
+            const heading_text = value.document["heading_text"]
+            const search_text = value.document["text"]
+            const node_div = document.createElement("div");
+            node_div.classList.add('search-item');
+            const table = document.createElement("table");
+            table.classList.add('search-result-table');
+            node_div.appendChild(table);
+            const tbody = document.createElement("tbody");
+            table.appendChild(tbody);
+            // Row 1
+            let row = document.createElement("tr");
+            let cell = document.createElement("td");
+            let i = document.createElement("i");
+                i.classList.add("fa","fa-file-text-o");
+                i.style.backgroundColor = "#" + doc_color;
+                cell.appendChild(i);
+            let textnode = document.createTextNode("\xa0" + doc_title);
+            cell.appendChild(textnode);
+            row.appendChild(cell)
+            cell = document.createElement("td");
+            const a = document.createElement('a');
+            const link = document.createTextNode(heading_text)
+            a.appendChild(link);
+            a.title = heading_text;
+            a.href = heading_url;
+            document.body.appendChild(a);
+            cell.appendChild(a);
+            row.appendChild(cell)
+            tbody.appendChild(row)
+            // Row 2
+            row = document.createElement("tr");
+            cell = document.createElement("td");
+            cell.colSpan = 2;
+            let show_text_parts = search_text.split(" ", 10).join(" ");
+            textnode = document.createTextNode(show_text_parts);
+            cell.appendChild(textnode)
+            row.appendChild(cell)
+            tbody.appendChild(row)
+            myNode.appendChild(node_div);
+        })
+    }
+}
+document.getElementById("searchInput").addEventListener("keyup", search_onKeyUp);
+// Show when focus in
+document.getElementById("searchInput").addEventListener("focusin", (event) => {
+    // clear previous search
+    const element = document.getElementById("search_dropdown");
+    while (element.firstChild) {
+        element.removeChild(element.lastChild);
+    }
+    // show
+    const rect = document.getElementById("searchInput").getBoundingClientRect();
+    element.style.left = rect.left +'px';
+    element.style.top = rect.top + rect.height + 4 +'px';
+    element.style.display = "block";
+});