RubyGems - my_help - Versions diffs - 1.2.2 → 1.2.3 - Mend

my_help 1.2.2 → 1.2.3

Files changed (39) hide show

checksums.yaml +4 -4
data/.yardoc/checksums +4 -4
data/.yardoc/objects/root.dat +0 -0
data/Gemfile.lock +1 -1
data/Rakefile +20 -1
data/lib/my_help/cli.rb +1 -0
data/lib/my_help/config.rb +1 -1
data/lib/my_help/list.rb +5 -3
data/lib/my_help/version.rb +1 -1
data/lib/templates/example.org +3 -5
metadata +2 -30
data/doc/MyHelp/CLI.html +0 -749
data/doc/MyHelp/Config.html +0 -693
data/doc/MyHelp/Control.html +0 -1127
data/doc/MyHelp/Error.html +0 -124
data/doc/MyHelp/GetConfig.html +0 -196
data/doc/MyHelp/Git.html +0 -291
data/doc/MyHelp/Init.html +0 -449
data/doc/MyHelp/List.html +0 -577
data/doc/MyHelp/Md2Hash.html +0 -632
data/doc/MyHelp/Modify.html +0 -393
data/doc/MyHelp/Org2Hash.html +0 -542
data/doc/MyHelp.html +0 -135
data/doc/Org2Yaml.html +0 -497
data/doc/OrgToYaml.html +0 -497
data/doc/_index.html +0 -230
data/doc/class_list.html +0 -51
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -58
data/doc/css/style.css +0 -497
data/doc/file.README.html +0 -181
data/doc/file_list.html +0 -56
data/doc/frames.html +0 -17
data/doc/index.html +0 -181
data/doc/js/app.js +0 -314
data/doc/js/full_list.js +0 -216
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -451
data/doc/top-level-namespace.html +0 -112

data/doc/file_list.html DELETED Viewed

@@ -1,56 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta charset="utf-8" />
-      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
-      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
-      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
-    <title>File List</title>
-    <base id="base_target" target="_parent" />
-  </head>
-  <body>
-    <div id="content">
-      <div class="fixed_header">
-        <h1 id="full_list_header">File List</h1>
-        <div id="full_list_nav">
-            <span><a target="_self" href="class_list.html">
-              Classes
-            </a></span>
-            <span><a target="_self" href="method_list.html">
-              Methods
-            </a></span>
-            <span><a target="_self" href="file_list.html">
-              Files
-            </a></span>
-        </div>
-        <div id="search">Search: <input type="text" /></div>
-      </div>
-      <ul id="full_list" class="file">
-  <li id="object_README" class="odd">
-    <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
-  </li>
-      </ul>
-    </div>
-  </body>
-</html>

data/doc/frames.html DELETED Viewed

@@ -1,17 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="utf-8">
-	<title>Documentation by YARD 0.9.28</title>
-</head>
-<script type="text/javascript">
-  var match = unescape(window.location.hash).match(/^#!(.+)/);
-  var name = match ? match[1] : 'index.html';
-  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
-  window.top.location = name;
-</script>
-<noscript>
-  <h1>Oops!</h1>
-  <h2>YARD requires JavaScript!</h2>
-</noscript>
-</html>

data/doc/index.html DELETED Viewed

@@ -1,181 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  File: README
-    &mdash; Documentation by YARD 0.9.28
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "README";
-  relpath = '';
-</script>
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="_index.html">Index</a> &raquo;
-    <span class="title">File: README</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><div id='filecontents'><h1>概要</h1>
-<p>CUI(CLA)ヘルプのUsage出力を真似て，user独自のhelpを作成・提供するgem.</p>
-<h1>(my_helpで解決しようとする)問題点</h1>
-<p>CUIやshell, 何かのプログラミング言語などを習得しようとする初心者は，
-  commandや文法を覚えるのに苦労します．
-  少しのkey(とっかかり)があると思い出すんですが，
-  うろ覚えでは間違えて路頭に迷います．
-  問題点は，</p>
-<ul>
-  <li>manは基本的に英語</li>
-  <li>manualでは重たい</li>
-  <li>いつもおなじことをwebで検索して</li>
-  <li>同じとこ見ている</li>
-  <li>memoしても，どこへ置いたか忘れる</li>
-</ul>
-<p>などです．</p>
-<h1>特徴</h1>
-<p>これらをCLAとして提供しようというのが，このgemの目的です．
-  仕様としては，</p>
-<ul>
-  <li>userが自分にあったmanを作成</li>
-  <li>雛形を提供</li>
-  <li>おなじformat, looks, 操作, 階層構造</li>
-  <li>すぐに手が届く</li>
-  <li>それらを追加・修正・削除できる</li>
-</ul>
-<p>memoソフトでは，検索が必要となりますが，my_helpは
-  key(記憶のとっかかり)を提供することが目的です．
-  RPGでレベル上げとかアイテムを貯めるようにして，
-  プログラミングでスキルを発展させてください．</p>
-<p>VSCodeやGithub Copilotではcodeの候補を挙げてくれますが，
-  物覚えの悪い作者は，人の名前をitem分けして，こそっと使っています．</p>
-<h1>使用法</h1>
-<h2>インストール</h2>
-<pre class="code ruby"><code class="ruby">
-&gt; gem install my_help
-</code></pre>
-<p>です．</p>
-<h2>簡単な使用法</h2>
-<p>まずは，</p>
-<pre class="code bash"><code class="bash">
-&gt; my_help
-Commands:
-  my_help delete HELP             # delete HELP
-  my_help edit HELP               # edit HELP
-  my_help help [COMMAND]          # Describe available commands or one specific command
-  my_help list [HELP] [ITEM]      # list all helps, specific HELP, or ITEM
-  my_help new HELP                # make new HELP
-  my_help set_editor EDITOR_NAME  # set editor to EDITOR_NAME
-  my_help setup                   # set up the test database
-  my_help version                 # show version
-</code></pre>
-<p>としてください．このlistにNAMEやITEMを加えて行くとわかると思います．</p>
-<pre class="code bash"><code class="bash">
-&gt; my_help list
-&gt; my_help list emacs
-&gt; my_help list emacs -f
-&gt; my_help list emacs file
-</code></pre>
-<p>として動かしてみてください．</p>
-<pre class="code bash"><code class="bash">
-- emacsのキーバインド
--
-特殊キー操作
--   C-f, controlキーを押しながら    &#39;f&#39;
--   M-f, escキーを押した後一度離して&#39;f&#39;
--     操作の中断C-g, 操作の取り消し(Undo) C-x u
-     , head           : head
-     , license        : license
-   -c, cursor         : cursor
-   -e, edit           : edit
-   -s, short_cut      : short_cut
-   -f, file           : file
-   -q, quit           : quit
-   -p, page           : page
-   -w, window         : window
-   -b, buffer         : buffer
-   -m, mode           : mode
-     , query_replace  : query_replace
-   -r, ruby-mode      : ruby-mode
-   -d, dired          : ファイラとして使う
-</code></pre>
-<h2>my_helpがやっていること</h2>
-<p>my_helpの個々のヘルプファイルは&#8217;~/.my_help&#8217;に置かれています．
-  ヘルプファイルのフォーマットはEmacsのorg-modeです．
-  これをEditorで叩いて編集したり，
-  そこから情報を取り出したりしています．
-  単にファイル操作を集約しているだけなのですが，
-  これが面倒で．．．</p>
-<h2>独自のhelpを作る方法</h2>
-<p>独自のhelpを作る方法です．まずは，</p>
-<pre class="code ruby"><code class="ruby">
-$ my_help new new_help
-</code></pre>
-<p>で，new_helpというtemplateが用意されます．</p>
-<pre class="code ruby"><code class="ruby">
-$ my_help edit new_help
-</code></pre>
-<p>で編集してください． Emacs org形式で，格納されています．</p>
-<pre class="code ruby"><code class="ruby">
-$ my_help delete new_help
-</code></pre>
-<p>すると消されます．</p>
-<h2>editorの変更</h2>
-<pre class="code ruby"><code class="ruby">
-$ my_help set_editor vim
-</code></pre>
-<p>でeditorを変更できます．codeとかは確認していますが，
-  それ以外で動いたり，動かなかったりを報告してください．</p>
-<p>OS Xで&#8217;emacs&#8217;とした時にGUI版が立ち上がって嫌だという場合は，
-  &#8216;emacs -nw&#8217;として下さい．</p>
-</div></div>
-      <div id="footer">
-  Generated on Fri Jan  6 13:07:57 2023 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.2).
-</div>
-    </div>
-  </body>
-</html>

data/doc/js/app.js DELETED Viewed

@@ -1,314 +0,0 @@
-(function() {
-var localStorage = {}, sessionStorage = {};
-try { localStorage = window.localStorage; } catch (e) { }
-try { sessionStorage = window.sessionStorage; } catch (e) { }
-function createSourceLinks() {
-    $('.method_details_list .source_code').
-        before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
-    $('.toggleSource').toggle(function() {
-       $(this).parent().nextAll('.source_code').slideDown(100);
-       $(this).text("Hide source");
-    },
-    function() {
-        $(this).parent().nextAll('.source_code').slideUp(100);
-        $(this).text("View source");
-    });
-}
-function createDefineLinks() {
-    var tHeight = 0;
-    $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
-    $('.toggleDefines').toggle(function() {
-        tHeight = $(this).parent().prev().height();
-        $(this).prev().css('display', 'inline');
-        $(this).parent().prev().height($(this).parent().height());
-        $(this).text("(less)");
-    },
-    function() {
-        $(this).prev().hide();
-        $(this).parent().prev().height(tHeight);
-        $(this).text("more...");
-    });
-}
-function createFullTreeLinks() {
-    var tHeight = 0;
-    $('.inheritanceTree').toggle(function() {
-        tHeight = $(this).parent().prev().height();
-        $(this).parent().toggleClass('showAll');
-        $(this).text("(hide)");
-        $(this).parent().prev().height($(this).parent().height());
-    },
-    function() {
-        $(this).parent().toggleClass('showAll');
-        $(this).parent().prev().height(tHeight);
-        $(this).text("show all");
-    });
-}
-function searchFrameButtons() {
-  $('.full_list_link').click(function() {
-    toggleSearchFrame(this, $(this).attr('href'));
-    return false;
-  });
-  window.addEventListener('message', function(e) {
-    if (e.data === 'navEscape') {
-      $('#nav').slideUp(100);
-      $('#search a').removeClass('active inactive');
-      $(window).focus();
-    }
-  });
-  $(window).resize(function() {
-    if ($('#search:visible').length === 0) {
-      $('#nav').removeAttr('style');
-      $('#search a').removeClass('active inactive');
-      $(window).focus();
-    }
-  });
-}
-function toggleSearchFrame(id, link) {
-  var frame = $('#nav');
-  $('#search a').removeClass('active').addClass('inactive');
-  if (frame.attr('src') === link && frame.css('display') !== "none") {
-    frame.slideUp(100);
-    $('#search a').removeClass('active inactive');
-  }
-  else {
-    $(id).addClass('active').removeClass('inactive');
-    if (frame.attr('src') !== link) frame.attr('src', link);
-    frame.slideDown(100);
-  }
-}
-function linkSummaries() {
-  $('.summary_signature').click(function() {
-    document.location = $(this).find('a').attr('href');
-  });
-}
-function summaryToggle() {
-  $('.summary_toggle').click(function(e) {
-    e.preventDefault();
-    localStorage.summaryCollapsed = $(this).text();
-    $('.summary_toggle').each(function() {
-      $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
-      var next = $(this).parent().parent().nextAll('ul.summary').first();
-      if (next.hasClass('compact')) {
-        next.toggle();
-        next.nextAll('ul.summary').first().toggle();
-      }
-      else if (next.hasClass('summary')) {
-        var list = $('<ul class="summary compact" />');
-        list.html(next.html());
-        list.find('.summary_desc, .note').remove();
-        list.find('a').each(function() {
-          $(this).html($(this).find('strong').html());
-          $(this).parent().html($(this)[0].outerHTML);
-        });
-        next.before(list);
-        next.toggle();
-      }
-    });
-    return false;
-  });
-  if (localStorage.summaryCollapsed == "collapse") {
-    $('.summary_toggle').first().click();
-  } else { localStorage.summaryCollapsed = "expand"; }
-}
-function constantSummaryToggle() {
-  $('.constants_summary_toggle').click(function(e) {
-    e.preventDefault();
-    localStorage.summaryCollapsed = $(this).text();
-    $('.constants_summary_toggle').each(function() {
-      $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
-      var next = $(this).parent().parent().nextAll('dl.constants').first();
-      if (next.hasClass('compact')) {
-        next.toggle();
-        next.nextAll('dl.constants').first().toggle();
-      }
-      else if (next.hasClass('constants')) {
-        var list = $('<dl class="constants compact" />');
-        list.html(next.html());
-        list.find('dt').each(function() {
-           $(this).addClass('summary_signature');
-           $(this).text( $(this).text().split('=')[0]);
-          if ($(this).has(".deprecated").length) {
-             $(this).addClass('deprecated');
-          };
-        });
-        // Add the value of the constant as "Tooltip" to the summary object
-        list.find('pre.code').each(function() {
-          console.log($(this).parent());
-          var dt_element = $(this).parent().prev();
-          var tooltip = $(this).text();
-          if (dt_element.hasClass("deprecated")) {
-             tooltip = 'Deprecated. ' + tooltip;
-          };
-          dt_element.attr('title', tooltip);
-        });
-        list.find('.docstring, .tags, dd').remove();
-        next.before(list);
-        next.toggle();
-      }
-    });
-    return false;
-  });
-  if (localStorage.summaryCollapsed == "collapse") {
-    $('.constants_summary_toggle').first().click();
-  } else { localStorage.summaryCollapsed = "expand"; }
-}
-function generateTOC() {
-  if ($('#filecontents').length === 0) return;
-  var _toc = $('<ol class="top"></ol>');
-  var show = false;
-  var toc = _toc;
-  var counter = 0;
-  var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
-  var i;
-  var curli;
-  if ($('#filecontents h1').length > 1) tags.unshift('h1');
-  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
-  var lastTag = parseInt(tags[0][1], 10);
-  $(tags.join(', ')).each(function() {
-    if ($(this).parents('.method_details .docstring').length != 0) return;
-    if (this.id == "filecontents") return;
-    show = true;
-    var thisTag = parseInt(this.tagName[1], 10);
-    if (this.id.length === 0) {
-      var proposedId = $(this).attr('toc-id');
-      if (typeof(proposedId) != "undefined") this.id = proposedId;
-      else {
-        var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
-        if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
-        this.id = proposedId;
-      }
-    }
-    if (thisTag > lastTag) {
-      for (i = 0; i < thisTag - lastTag; i++) {
-        if ( typeof(curli) == "undefined" ) {
-          curli = $('<li/>');
-          toc.append(curli);
-        }
-        toc = $('<ol/>');
-        curli.append(toc);
-        curli = undefined;
-      }
-    }
-    if (thisTag < lastTag) {
-      for (i = 0; i < lastTag - thisTag; i++) {
-        toc = toc.parent();
-        toc = toc.parent();
-      }
-    }
-    var title = $(this).attr('toc-title');
-    if (typeof(title) == "undefined") title = $(this).text();
-    curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
-    toc.append(curli);
-    lastTag = thisTag;
-  });
-  if (!show) return;
-  html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
-  $('#content').prepend(html);
-  $('#toc').append(_toc);
-  $('#toc .hide_toc').toggle(function() {
-    $('#toc .top').slideUp('fast');
-    $('#toc').toggleClass('hidden');
-    $('#toc .title small').toggle();
-  }, function() {
-    $('#toc .top').slideDown('fast');
-    $('#toc').toggleClass('hidden');
-    $('#toc .title small').toggle();
-  });
-}
-function navResizeFn(e) {
-  if (e.which !== 1) {
-    navResizeFnStop();
-    return;
-  }
-  sessionStorage.navWidth = e.pageX.toString();
-  $('.nav_wrap').css('width', e.pageX);
-  $('.nav_wrap').css('-ms-flex', 'inherit');
-}
-function navResizeFnStop() {
-  $(window).unbind('mousemove', navResizeFn);
-  window.removeEventListener('message', navMessageFn, false);
-}
-function navMessageFn(e) {
-  if (e.data.action === 'mousemove') navResizeFn(e.data.event);
-  if (e.data.action === 'mouseup') navResizeFnStop();
-}
-function navResizer() {
-  $('#resizer').mousedown(function(e) {
-    e.preventDefault();
-    $(window).mousemove(navResizeFn);
-    window.addEventListener('message', navMessageFn, false);
-  });
-  $(window).mouseup(navResizeFnStop);
-  if (sessionStorage.navWidth) {
-    navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
-  }
-}
-function navExpander() {
-  var done = false, timer = setTimeout(postMessage, 500);
-  function postMessage() {
-    if (done) return;
-    clearTimeout(timer);
-    var opts = { action: 'expand', path: pathId };
-    document.getElementById('nav').contentWindow.postMessage(opts, '*');
-    done = true;
-  }
-  window.addEventListener('message', function(event) {
-    if (event.data === 'navReady') postMessage();
-    return false;
-  }, false);
-}
-function mainFocus() {
-  var hash = window.location.hash;
-  if (hash !== '' && $(hash)[0]) {
-    $(hash)[0].scrollIntoView();
-  }
-  setTimeout(function() { $('#main').focus(); }, 10);
-}
-function navigationChange() {
-  // This works around the broken anchor navigation with the YARD template.
-  window.onpopstate = function() {
-    var hash = window.location.hash;
-    if (hash !== '' && $(hash)[0]) {
-      $(hash)[0].scrollIntoView();
-    }
-  };
-}
-$(document).ready(function() {
-  navResizer();
-  navExpander();
-  createSourceLinks();
-  createDefineLinks();
-  createFullTreeLinks();
-  searchFrameButtons();
-  linkSummaries();
-  summaryToggle();
-  constantSummaryToggle();
-  generateTOC();
-  mainFocus();
-  navigationChange();
-});
-})();