asciidocsy-jekyll-theme 0.3.0.pre.dev

data/_includes/version-handler.html

@@ -0,0 +1,245 @@
+{% comment %}
+Generates the HTML form and the jQuery scripts for:
+  - token [swap]s
+  - class [toggle]s
+  - DOM [amend]ers
+Expects:
+  include.verb: String (swap|toggle|amend)
+  include.form: String (select|buttons)
+  include.opts: Array of Scalars or {slug:<slug>,text:<text>}
+  include.func: String (amenders only); name of predefined function OR .js file
+Optional:
+  include.id: String (becomes form_id)
+  include.pick: String; the slug of the default option
+  include.slug: Token name for dictionary-free swaps
+  include.targ: String; the ID of the target element to amend
+  include.href: Liquid; For URL-based changers, non-variable portion of URL
+  include.args: Object; a way to pass an object to your function template
+  include.icon: String; FontAwesome reference
+  include.text: String; label for form field
+{% endcomment %}
+{% assign handler = handler | default: 0 | plus: 1 %}
+{% assign verb = include.verb %}
+{% assign form = include.form | default: "select" %}
+{% assign pick = include.pick | default: "" %}
+{% capture id_def %}handler-{{handler}}-{{form}}{% endcapture %}
+{% assign form_id = include.id | default: id_def %}
+{% assign func = include.func %}
+{% assign href = include.href %}
+{% assign targ = include.targ %}
+<!-- handler: {{ handler }} ({{ form_id }}) -->
+{% case form %}
+
+  {% when "select" %}
+    {% assign selected = "" %}
+<div class="form-group">
+  {% if include.text %}
+    <label for="{{form_id}}">
+    {% if include.icon %}
+      <i class="icon {{ include.icon }}"></i>
+    {% endif %}
+      {{ include.text }}
+    </label>
+  {% endif %}
+  <select class="form-control" id="{{form_id}}">
+  {% for item in include.opts %}
+    {% assign selected = "" %}
+    {% if item['text'] %}
+      {% assign text = item['text'] %}
+      {% assign value = item['slug'] %}
+    {% else %}
+      {% assign text = item %}
+      {% assign value = item %}
+    {% endif %}
+    {% if include.opt_tpl %}
+      {% assign value = include.opt_tpl | liquify %}
+    {% endif %}
+    <option value="{{ value }}">{{ text }}</option>
+  {% endfor %}
+  </select>
+</div>
+
+  {% when "buttons" %}
+  {% if include.text or include.icon %}
+  <label for="{{ form_id }}">
+    {% if include.icon %}
+      <i class="{{ include.icon }}"></i>
+    {% endif %}
+    {% if include.text %}
+      {{ include.text | asciidocify:'inline' }}
+    {% endif %}
+  </label>
+  {% endif %}
+<div class="btn-group btn-group-toggle {{verb}}-handler" id="{{form_id}}" data-toggle="buttons">
+  {% for item in include.opts %}
+    {% if item['text'] %}
+      {% assign text = item['text'] %}
+      {% assign value = item['slug'] %}
+    {% else %}
+      {% assign text = item %}
+      {% assign value = item %}
+    {% endif %}
+  <label class="btn btn-secondary btn-sm" for="{{value}}">
+    <input type="radio" name="{{form_id}}" id="{{value}}" value="{{ value }}">
+    {{ text }}
+  </label>
+  {% endfor %}
+</div>
+{% endcase %}
+
+<script type="text/javascript">
+{% unless handlers_init %}
+  {% assign handlers_init = true %}
+const urlParams = new URLSearchParams(window.location.search);
+{% endunless %}
+{% if verb == "amend" %}
+/**
+DOM AMENDER
+**/
+$(function(){
+  $('select#{{ form_id }}').on('change', function () {
+  {% if include.file %}
+    {% assign args = include.args %}
+    {% include {{include.file}} args=args %}
+  {% else %}
+    {% case include.func %}
+
+    {% when "change-url" %}
+      /**
+      URL-CHANGER
+      **/
+      var target = $(this).val();
+      window.location = target;
+      $.cookie('{{ form_id }}', target);
+      return false;
+
+    {% when "change-href" %}
+      /**
+      STYLE CHANGER
+      **/
+      var newStyleSheet = {% if href -%}
+        {{ href | liquify }}
+      {%- else -%}
+        $(this).val()
+      {% endif %}
+      $('{{ targ }}').attr("href", newStyleSheet)
+      $.cookie('{{ form_id }}', $(this).val());
+
+    {% else %}
+      {% include {{include.file}} %}
+
+    {% endcase %}
+  {% endif %}
+  });
+});
+{% elsif verb == "toggle" %}
+/**
+CLASS TOGGLER
+**/
+{% elsif verb == "swap" %}
+/**
+TOKEN SWAPPER
+**/
+  {% assign slates = false %}
+  {% unless slate_dict_init %}
+    {% assign slate_dict_init = true %}
+let slateDict = {}
+  {% endunless %}
+  {% if include.opts[0]['slug'] %}
+    {% assign slates = true %}
+  {% endif %}
+  {% for opt in include.opts %}
+    {% if slates %}
+slateDict['{{ opt['slug'] }}'] = {
+      {% assign tokens = "" | split:"," %}
+      {%- for def in include.dict %}
+        {%- assign tok = def[0] %}
+        {%- if opt['dict'][tok] %}
+          {%- assign val = opt['dict'][tok] %}
+        {%- else %}
+          {%- assign val = def[1] %}
+        {%- endif %}
+        "{{ tok }}":"{{ val }}",
+      {%- endfor %}
+      {%- for def in opt['dict'] %}
+        {%- assign tok = def[0] %}
+        {%- unless include.dict[tok] %}
+        "{{ tok }}":"{{ def[1] }}",
+        {%- endunless %}
+      {%- endfor %}
+}
+    {% endif %}
+  {% endfor %}
+  {% if form == "select" %}
+$('#{{ form_id }}').on('change', function() {
+  {% elsif form == "buttons" %}
+$('#{{ form_id }} input').focus(function () {
+  {%- else %}// attach the swap to a toggle
+$('{{ form }} input').focus(function () {
+  {% endif %}
+  var val = $(this).val();
+  if (typeof slateDict[val] !== 'undefined') {
+    for ( let tok in slateDict[val] ) {
+      let token = "<$tok." + tok + ">"
+      let swap = '<span class="tok ' + tok + '">' + slateDict[val][tok] + '</span>'
+      let text = $(this).text();
+      $('main :not(script,.nosub,.nosub code)').contents().filter(function() {
+        return this.nodeType === 3;
+      }).replaceWith(function() {
+        return this.nodeValue.replace(token,swap);
+      });
+      $('.tok.' + tok).html(slateDict[val][tok]);
+    };
+  } else { // found no slateDict for this option
+    let token = "<$tok.{{ include.slug }}>";
+    let swap = '<span class="tok {{ include.slug }}">' + val + '</span>';
+    $('main :not(script,.nosub,.nosub code)').contents().filter(function() {
+      return this.nodeType === 3;
+    }).replaceWith(function() {
+      return this.nodeValue.replace(token,swap);
+    });
+    $('.tok.{{ include.slug }}').html(val);
+  };
+  $.cookie('{{ form_id }}', val);
+});
+{% endif %}
+{% unless verb == "toggle"
+  or verb == "tab"
+  or (verb == "swap"\
+    and form != "buttons"
+    and form != "select")
+%}
+/**
+Set value on page load
+Priority order:
+  1. URL query string parameter
+  2. cookie parameter
+  3. default value from `pick:` property
+  4. first option listed
+**/
+$( document ).ready(function() {
+  var nochoice = false;
+  if ( urlParams.has('{{ form_id }}') ) {
+    var val = urlParams.get('{{ form_id}}')
+  } else if ( $.cookie('{{ form_id }}') ) {
+    var val = ($.cookie('{{ form_id }}'))
+  } else if ( '{{ pick }}' != '' ) {
+    var val = "{{ pick }}"
+  } else {
+    nochoice = true;
+  }
+  {% if form == "select" %}
+    if (nochoice) { var val = $('#{{ form_id }} option:first-child').val() }
+    $('#{{ form_id }}').val(val).change();
+  {% elsif form == "buttons" %}
+    if (nochoice) {
+      var val = $('#{{ form_id }} label:first-child input').val()
+    }
+    $('input[name="{{ form_id }}"][value="' + val + '"]').click()
+  {% elsif form == "none" %}
+    // force action without controls
+  {% endif %}
+  $.cookie('{{ form_id }}', val);
+});
+{% endunless %}
+</script>

data/_includes/versioning-controls.html

@@ -0,0 +1,88 @@
+{% comment %}
+Assembles version-handler features in various spot-specific clusters
+{% endcomment %}
+{% assign all_handlers = site.data.theme.versioning.handlers %}
+{% unless show_handlers %}
+  {% assign default_handlers = site.data.theme.versioning.defaults[layout.kind]['list'] %}
+  {% assign page_handlers = page.version-handlers | split:"," %}
+  {% for hdlr in page_handlers %}
+    {% assign hdlr_split = hdlr | split:"" %}
+    {% if hdlr_split[0] != "-" and hdlr_split[0] != "+" %}
+      {% assign explicit = true %}
+      {% assign show_handlers = page_handlers %}
+      {% break %}
+    {% endif %}
+  {% endfor %}
+  {% unless explicit %}
+    {% assign show_handlers = "" | split:"," %}
+    {% for hdlr in default_handlers %}
+      {% capture minusHdlr %}-{{ hdlr }}{% endcapture %}
+      {% unless page_handlers contains minusHdlr %}
+        {% assign show_handlers = show_handlers | push: hdlr %}
+      {% endunless %}
+    {% endfor %}
+    {% for hdlr in page_handlers %}
+      {% assign hdlr_split = hdlr | split:"" %}
+      {% if hdlr_split[0] == "+" %}
+        {% assign _hdlr = hdlr | replace: "+","" %}
+        {% assign show_handlers = show_handlers | push: _hdlr %}
+      {% endif %}
+    {% endfor %}
+  {% endunless %}
+{% endunless %}
+{% for hdl in show_handlers %}
+  {% assign ctrl = all_handlers[hdl] %}
+  {% if ctrl['spot'] == include.spot %}
+    {% assign ctrl_name = hdl %}
+    {% assign verb = ctrl['verb'] %}
+    {% assign pick = ctrl['swap']['pick'] %}
+    {% assign dict = ctrl['swap']['dict'] %}
+    {% assign form = ctrl['form'] %}
+    {% if ctrl['swap']['data'] %}
+      {% assign opts = "" | split: "," %}
+      {% assign data_str = ctrl['swap']['data'] %}
+      {% include string-eval.liquid string=data_str %}
+      {% assign opts = data_obj %}
+      {% assign opt_tpl = ctrl['swap']['opts'] %}
+    {% else %}
+      {% assign opts = ctrl['swap']['opts'] %}
+    {% endif %}
+    {% assign slug = ctrl['swap']['slug'] %}
+    {% if ctrl['func'] %}
+      {% assign func = ctrl['func'] %}
+      {% if ctrl['func']['name'] or ctrl['func']['file'] %}
+        {% assign func = ctrl['func']['name'] %}
+        {% assign file = ctrl['func']['file'] %}
+        {% assign href = ctrl['func']['href'] %}
+        {% assign targ = ctrl['func']['targ'] %}
+        {% assign args = ctrl['func']['args'] %}
+      {% endif %}
+    {% endif %}
+    {% assign func = ctrl['func']['name'] %}
+    {% assign path = ctrl['func']['href'] %}
+    {% assign targ = ctrl['func']['targ'] %}
+    {% if verb == "toggle" %}
+      {% assign form = "buttons" %}
+    {% endif %}
+    {% assign form_id = ctrl_name %}
+    {% assign text = ctrl['show']['text'] %}
+    {% assign icon  = ctrl['show']['icon'] %}
+    {% include version-handler.html
+      id=form_id
+      verb=verb
+      form=form
+      opts=opts
+      slug=slug
+      dict=dict
+      pick=pick
+      text=text
+      icon=icon
+      func=func
+      file=file
+      targ=targ
+      href=href
+      args=args
+      opt_tpl=opt_tpl
+       %}
+  {% endif %}
+{% endfor %}

data/_layouts/default.html

@@ -0,0 +1,94 @@
+---
+footer: true
+scripts:
+  - jquery
+  - jquery-cookie
+  - bootstrap
+  - popper
+  - anchors
+  - navgoco
+  - bootstrap-toc
+  - highlight-js
+  - algolia-instantsearch
+  - autocomplete
+  - algoliasearch-3
+  - asciidoctor
+  - asciidocsy-tabber
+  - asciidocsy-toggler
+  - asciidocsy-semantics
+  - asciidocsy-tail
+---
+<!DOCTYPE html>
+<html lang="en" class="no-js">
+  <!-- Copyright 2019-2021 Vanessa Sochat-->
+{% include hook.liquid template="default_html" spot="pre_head" %}
+{% include head.html %}
+{% include hook.liquid template="default_html" spot="post_head" %}
+{% if site.services.analytics.google %}
+  {% include google-analytics.html %}
+{% endif %}
+<body data-spy="scroll" data-target="#toc-side">
+  {% include hook.liquid template="default_html" spot="pre_header" %}
+  {% include header.html %}
+  {% include hook.liquid template="default_html" spot="post_header" %}
+  <div class="container-fluid td-outer {{ page.layout }}">
+    <div class="td-main">
+      <div class="row flex-xl-nowrap">
+{% if layout.sidebar-left %}
+        <div id="sidebar-left" class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none"><!-- SUBJECT/PRODUCT REF/NAV -->
+          <div class="sticky-top sticky-offset">
+            <div class="sidebar-top">
+            {% include versioning-controls.html
+              spot="#sidebar-left .sidebar-top" %}
+  {% if site.data.theme.search.subject.show.spot == "#sidebar-left" %}
+             {% include search-form.html search="subject" %}
+  {% endif %}
+            </div>
+            <div class="sidebar-mid">
+            {% include versioning-controls.html
+              spot="#sidebar-left .sidebar-mid" %}
+              {% include nav-subject-menu.html manifest=site.data.manifest %}
+            </div>
+            <div class="sidebar-end">
+              {% include versioning-controls.html
+                spot="#sidebar-left .sidebar-end" %}
+            </div>
+          </div><!-- /.sticky-top -->
+        </div><!-- /#sidebar-left -->
+{% endif %}
+        <main id="main" class="{{ layout.main-class | default: 'col-12 col-md-9 col-xl-8 pl-md-5' }}" role="main">
+          <div class="td-content">
+            {{ content }}
+          </div>
+        </main>
+{% if layout.sidebar-right %}
+        <div id="sidebar-right" class="d-none d-xl-block col-xl-2 td-toc d-print-none"><!-- TOPIC/PAGE REF/NAV -->
+          <div class="sidebar-top">
+            {% include versioning-controls.html spot="#sidebar-right .sidebar-top" %}
+            <div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
+              {% include page-links.html %}
+            </div>
+          </div>
+          <div class="sidebar-mid">
+            {% include versioning-controls.html spot="#sidebar-right .sidebar-mid" %}
+  {% if layout.toc == "sidebar" and site.data.theme.navigation.toc.show.spot == "#sidebar-right" %}
+            <nav id="toc-side" data-spy="affix" data-toggle="toc"></nav>
+  {% endif %}
+          </div>
+          <div class="sidebar-end">
+            {% include versioning-controls.html spot="#sidebar-right .sidebar-end" %}
+    {% if site.data.theme.semantics.role.term.show.spot == "#sidebar-right" %}
+            <nav id="terms-listing"></nav>
+    {% endif %}
+          </div>
+        </div><!-- /#sidebar-right -->
+{% endif %}
+      </div><!-- /.row.flex-xl-nowrap -->
+    </div><!-- /.td-main -->
+{% if layout.footer %}
+    {% include footer.html %}
+{% endif %}
+  </div><!-- /.container-fluid.td-outer -->
+  {% include tail.html %}
+</body>
+</html>

data/_layouts/landing.html

@@ -0,0 +1,28 @@
+---
+footer: false
+kind: page-landing
+sidebar-left: false
+sidebar-right: false
+main-class: landing
+scripts:
+  - jquery
+  - jquery-cookie
+  - bootstrap
+  - popper
+---
+<!DOCTYPE html>
+<html lang="en" class="no-js">
+  <!-- Copyright 2019-2021 Vanessa Sochat-->
+{% include head.html %}
+{% if site.services.analytics.google %}
+  {% include google-analytics.html %}
+{% endif %}
+<body>
+  {% include header.html %}
+  <div class="container-fluid td-outer landing">
+    {{ content }}
+    {% include footer.html %}
+  </div>
+  {% include tail.html %}
+</body>
+</html>

data/_layouts/page.html

@@ -0,0 +1,9 @@
+---
+layout: default
+kind: topic
+sidebar-left: true
+sidebar-right: true
+anchors: true
+---
+<h1>{{ page.title }}</h1>
+{{ content }}

data/_layouts/post.html

@@ -0,0 +1,8 @@
+---
+layout: page
+---
+<!-- Copyright 2019-2021 Vanessa Sochat-->
+<h1 style="margin-bottom:0px">{{ page.title }}</h1>
+{% if page.badges %}{% for badge in page.badges %}<span class="badge badge-{{ badge.type }}">{{ badge.tag }}</span>{% endfor %}{% endif %}
+<span class="post-date" style="font-style: italic;">{{ page.date | date: "%B %d, %Y" }}</span>
+{{ content }}

data/_layouts/reference.html

@@ -0,0 +1,6 @@
+---
+layout: topic
+---
+<div class="container topic-reference api-reference">
+{{content}}
+</div>

data/_layouts/search.html

@@ -0,0 +1,110 @@
+---
+layout: page
+---
+
+<script>
+$(document).ready(function() {
+  $(".search-wrap").remove();
+});
+</script>
+
+<header>
+  <div class="aa-input-container" id="aa-input-container">
+     <input id="search-input" class="aa-input-search" placeholder="Search the {{ site.product-name }} v{{ site.product-version }} documentation">
+     <svg class="aa-input-icon" viewBox="654 -372 1664 1664">
+         <path d="M1806,332c0-123.3-43.8-228.8-131.5-316.5C1586.8-72.2,1481.3-116,1358-116s-228.8,43.8-316.5,131.5  C953.8,103.2,910,208.7,910,332s43.8,228.8,131.5,316.5C1129.2,736.2,1234.7,780,1358,780s228.8-43.8,316.5-131.5  C1762.2,560.8,1806,455.3,1806,332z M2318,1164c0,34.7-12.7,64.7-38,90s-55.3,38-90,38c-36,0-66-12.7-90-38l-343-342  c-119.3,82.7-252.3,124-399,124c-95.3,0-186.5-18.5-273.5-55.5s-162-87-225-150s-113-138-150-225S654,427.3,654,332  s18.5-186.5,55.5-273.5s87-162,150-225s138-113,225-150S1262.7-372,1358-372s186.5,18.5,273.5,55.5s162,87,225,150s113,138,150,225  S2062,236.7,2062,332c0,146.7-41.3,279.7-124,399l343,343C2305.7,1098.7,2318,1128.7,2318,1164z" />
+     </svg>
+  </div>
+</header>
+<main>
+    <div id="aa-hits"></div>
+    <div id="aa-pagination"></div>
+</main>
+
+<script>
+  const search = instantsearch({
+    appId: '{{ site.services.search.algolia.application_id }}',
+    apiKey: '{{ site.services.search.algolia.search_only_api_key }}',
+    indexName: '{{ site.data.theme.search.subject.meta.index }}',
+    searchParameters: {
+      hitsPerPage: 10,
+      typoTolerance: false,
+      advancedSyntax: true
+    }
+  });
+
+  const hitTemplate = function(hit) {
+    // Define target link.
+    var linkValue = window.location.href.substring(0, window.location.href.indexOf('{{site.base_url}}') - 1) + hit.url;
+
+    // Only preview the first 450 characters of the page.
+    if (hit._highlightResult.content && hit._highlightResult.content.value.length > 450) {
+      hit._highlightResult.content.value = hit._highlightResult.content.value.slice(0, 450) + '...'
+    }
+    var title = $('<div/>', {class: 'search-title'});
+    var titleValue;
+    if (hit.title) {
+      titleValue = hit.title;
+    } else {
+      var idx = hit.slug.lastIndexOf("_");
+      titleValue = hit.slug.substring(idx + 1).replace(/-/g, " ");
+      titleValue = titleValue.charAt(0).toUpperCase() + titleValue.slice(1);
+    }
+    title.append($('<a/>', {href: linkValue}).html(titleValue));
+
+    var content = $('<div/>', {class: 'search-item'});
+    content.append(title);
+    content.append($('<div/>', {class: 'search-link'}).html(linkValue));
+    if (hit._highlightResult.content) {
+      content.append($('<div/>', {class: 'search-snippet'}).html(hit._highlightResult.content.value));
+    }
+    return content[0].outerHTML;
+  }
+
+  search.addWidget(
+    instantsearch.widgets.searchBox({
+      container: '#search-input',
+      reset: false,
+      magnifier: false
+    })
+  );
+
+  search.addWidget(
+    instantsearch.widgets.hits({
+      container: '#aa-hits',
+      templates: {
+        item: hitTemplate,
+        empty: "No results found for your search."
+      }
+    })
+  );
+
+  search.addWidget(
+    instantsearch.widgets.pagination({
+      container: '#aa-pagination'
+    })
+  );
+
+  $( document ).ready(function() {
+    var qParam = getUrlParameter('q');
+    if (qParam) {
+      $("#search-input").val(qParam.replace(/\+/g, ' '));
+    }
+    search.start();
+  });
+
+  function getUrlParameter(sParam) {
+    var sPageURL = decodeURIComponent(window.location.search.substring(1)),
+    sURLVariables = sPageURL.split('&'),
+    sParameterName,
+    i;
+
+    for (i = 0; i < sURLVariables.length; i++) {
+      sParameterName = sURLVariables[i].split('=');
+
+      if (sParameterName[0] === sParam) {
+        return sParameterName[1] === undefined ? true : sParameterName[1];
+      }
+    }
+  };
+</script>

data/_layouts/topic.html

@@ -0,0 +1,19 @@
+---
+layout: default
+kind: topic
+sidebar-left: true
+sidebar-right: true
+anchors: true
+toc: sidebar
+---
+{% include breadcrumbs.html %}
+{% include versioning-controls.html spot="#main .topic-top" %}
+<h1>{{ page.title }}</h1>
+{{ content }}
+<div class="row flex topic-footer">
+  {% include versioning-controls.html spot="#main .topic-end" %}
+  {% include see-also.html %}
+{% if site.data.theme.forms.feedback-form.show %}
+  {% include feedback.html %}
+{% endif %}
+</div>