markdown_helper 2.2.0 → 2.3.0

data/markdown/use_cases/include_files/include_page_toc/use_case.md

@@ -62,28 +62,22 @@ Here's a template file that includes them:
 @[:markdown](markdown_0.md)
 
 @[:markdown](markdown_1.md)
-
 ```
 
 The treatment token ```:page_toc``` specifies where the page TOC is to be inserted.
 
-#### CLI
-
-You can use the command-line interface to perform the inclusion.
-
-##### Command
+#### Include Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
 
 ```sh
 markdown_helper include --pristine includer.md included.md
 ```
 
 (Option ```--pristine``` suppresses comment insertion.)
-
-#### API
-
-You can use the API to perform the inclusion.
-
-##### Ruby Code
+</details>
+<details>
+<summary>API</summary>
 
 ```include.rb```:
 ```ruby
@@ -94,11 +88,7 @@ markdown_helper = MarkdownHelper.new(:pristine => true)
 markdown_helper.include('includer.md', 'included.md')
 ```
 
-##### Command
-
-```sh
-ruby include.rb
-```
+</details>
 
 #### File with Inclusion
 
@@ -106,7 +96,6 @@ Here's the finished file with the inclusion:
 
 ```included.md```:
 ```markdown
-<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
 # Page Title
 
 ## Page Contents
@@ -131,7 +120,6 @@ Here's the finished file with the inclusion:
 
 ## Another includer level-two title.
 
-<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
         
 ## Includee 0 level-two title.
 
@@ -140,9 +128,7 @@ Here's the finished file with the inclusion:
 ### Another includee 0 level-three title.
 
 ## Another includee 0 level-two title.
-<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
 
-<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
         
 ## Includee 1 level-two title.
 
@@ -151,16 +137,12 @@ Here's the finished file with the inclusion:
 ### Another includee 1 level-three title.
 
 ## Another includee 1 level-two title.
-<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
-
-<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
 ```
 
 And here's the finished markdown, as rendered on this page:
 
 ---
 
-<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
 # Page Title
 
 ## Page Contents
@@ -185,7 +167,6 @@ And here's the finished markdown, as rendered on this page:
 
 ## Another includer level-two title.
 
-<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
         
 ## Includee 0 level-two title.
 
@@ -194,9 +175,7 @@ And here's the finished markdown, as rendered on this page:
 ### Another includee 0 level-three title.
 
 ## Another includee 0 level-two title.
-<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
 
-<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
         
 ## Includee 1 level-two title.
 
@@ -205,8 +184,6 @@ And here's the finished markdown, as rendered on this page:
 ### Another includee 1 level-three title.
 
 ## Another includee 1 level-two title.
-<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
 
-<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
 
 ---

data/markdown/use_cases/include_files/include_text_as_comment/use_case.md

@@ -27,28 +27,22 @@ Here's a template file that includes it:
 This file includes the code as a comment.
 
 @[:comment](hello.rb)
-
 ```
 
 The treatment token ```:comment``` specifies that the included text is to be treated as a comment.
 
-#### CLI
-
-You can use the command-line interface to perform the inclusion.
-
-##### Command
+#### Include Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
 
 ```sh
 markdown_helper include --pristine includer.md included.md
 ```
 
 (Option ```--pristine``` suppresses comment insertion.)
-
-#### API
-
-You can use the API to perform the inclusion.
-
-##### Ruby Code
+</details>
+<details>
+<summary>API</summary>
 
 ```include.rb```:
 ```ruby
@@ -59,11 +53,7 @@ markdown_helper = MarkdownHelper.new(:pristine => true)
 markdown_helper.include('includer.md', 'included.md')
 ```
 
-##### Command
-
-```sh
-ruby include.rb
-```
+</details>
 
 #### File with Inclusion
 
@@ -82,6 +72,5 @@ This file includes the code as a comment.
    end
 end
 -->
-
 ```
 

data/markdown/use_cases/include_files/include_text_as_details/details.md

@@ -0,0 +1,5 @@
+<summary>My details</summary>
+This is a detail.
+
+This is another.
+

data/markdown/use_cases/include_files/include_text_as_details/included.md

@@ -0,0 +1,10 @@
+This file includes the code as details.
+
+<details>
+<summary>My details</summary>
+This is a detail.
+
+This is another.
+
+</details>
+

data/markdown/use_cases/include_files/include_text_as_details/includer.md

@@ -0,0 +1,4 @@
+This file includes the code as details.
+
+@[:details](details.md)
+

data/markdown/use_cases/include_files/include_text_as_details/use_case.md

@@ -0,0 +1,84 @@
+### Include Text As Details
+
+Use file inclusion to include text as details.
+
+#### File to Be Included
+
+Here's a file containing text to be included:
+
+```details.md```:
+```markdown
+<summary>My details</summary>
+This is a detail.
+
+This is another.
+```
+
+#### Includer File
+
+Here's a template file that includes it:
+
+```includer.md```:
+```markdown
+This file includes the code as details.
+
+@[:details](details.md)
+```
+
+The treatment token ```:details``` specifies that the included text is to be treated as details.
+
+#### Include Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
+
+```sh
+markdown_helper include --pristine includer.md included.md
+```
+
+(Option ```--pristine``` suppresses comment insertion.)
+</details>
+<details>
+<summary>API</summary>
+
+```include.rb```:
+```ruby
+require 'markdown_helper'
+
+# Option :pristine suppresses comment insertion.
+markdown_helper = MarkdownHelper.new(:pristine => true)
+markdown_helper.include('includer.md', 'included.md')
+```
+
+</details>
+
+#### File with Inclusion
+
+Here's the finished file with the included details:
+
+```included.md```:
+```markdown
+This file includes the code as details.
+
+<details>
+<summary>My details</summary>
+This is a detail.
+
+This is another.
+
+</details>
+```
+
+And here are the included details, as rendered on this page.:
+
+---
+
+This file includes the code as details.
+
+<details>
+<summary>My details</summary>
+This is a detail.
+
+This is another.
+
+</details>
+

data/markdown/use_cases/include_files/include_text_as_details/use_case_template.md

@@ -0,0 +1,31 @@
+### Include Text As Details
+
+Use file inclusion to include text as details.
+
+#### File to Be Included
+
+Here's a file containing text to be included:
+
+@[markdown](details.md)
+
+#### Includer File
+
+Here's a template file that includes it:
+
+@[markdown](includer.md)
+
+The treatment token ```:details``` specifies that the included text is to be treated as details.
+
+@[:markdown](../interface.md)
+
+#### File with Inclusion
+
+Here's the finished file with the included details:
+
+@[markdown](included.md)
+
+And here are the included details, as rendered on this page.:
+
+---
+
+@[:markdown](included.md)

data/markdown/use_cases/include_files/include_text_as_pre/use_case.md

@@ -22,28 +22,22 @@ Here's a template file that includes it:
 This file includes the backticked content as pre(formatted).
 
 @[:pre](triple_backtick.md)
-
 ```
 
 The treatment token ```:pre``` specifies that the included text is to be treated as pre-formatted.
 
-#### CLI
-
-You can use the command-line interface to perform the inclusion.
-
-##### Command
+#### Include Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
 
 ```sh
 markdown_helper include --pristine includer.md included.md
 ```
 
 (Option ```--pristine``` suppresses comment insertion.)
-
-#### API
-
-You can use the API to perform the inclusion.
-
-##### Ruby Code
+</details>
+<details>
+<summary>API</summary>
 
 ```include.rb```:
 ```ruby
@@ -54,11 +48,7 @@ markdown_helper = MarkdownHelper.new(:pristine => true)
 markdown_helper.include('includer.md', 'included.md')
 ```
 
-##### Command
-
-```sh
-ruby include.rb
-```
+</details>
 
 #### File with Inclusion
 
@@ -71,6 +61,5 @@ This file includes the backticked content as pre(formatted).
 <pre>
 This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.
 </pre>
-
 ```
 

data/markdown/use_cases/include_files/include_with_added_comments/included.md

@@ -1,5 +1 @@
-<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
-<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_with_added_comments/includee.md -->
 Text to be included.
-<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_with_added_comments/includee.md -->
-<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->

data/markdown/use_cases/include_files/include_with_added_comments/use_case.md

@@ -46,11 +46,7 @@ markdown_helper.include(includer.md, included.md)
 
 ```included.md```:
 ```markdown
-<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
-<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_with_added_comments/includee.md -->
 Text to be included.
-<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_with_added_comments/includee.md -->
-<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
 ```
 
 The file path for the included file is relative to the .git directory.

data/markdown/use_cases/include_files/interface.md

@@ -1,25 +1,16 @@
-#### CLI
-
-You can use the command-line interface to perform the inclusion.
-
-##### Command
+#### Include Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
 
 ```sh
 markdown_helper include --pristine includer.md included.md
 ```
 
 @[:markdown](../pristine.md)
+</details>
+<details>
+<summary>API</summary>
 
-#### API
-
-You can use the API to perform the inclusion.
-
-##### Ruby Code
+@[ruby](../include.rb)
 
-@[ruby](include.rb)
-
-##### Command
-
-```sh
-ruby include.rb
-```
+</details>

data/markdown/use_cases/include_files/nest_inclusions/use_case.md

@@ -27,23 +27,18 @@ File to do nested inclusion.
 @[:markdown](includee.md)
 ```
 
-#### CLI
-
-You can use the command-line interface to perform the inclusion.
-
-##### Command
+#### Include Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
 
 ```sh
 markdown_helper include --pristine includer.md included.md
 ```
 
 (Option ```--pristine``` suppresses comment insertion.)
-
-#### API
-
-You can use the API to perform the inclusion.
-
-##### Ruby Code
+</details>
+<details>
+<summary>API</summary>
 
 ```include.rb```:
 ```ruby
@@ -54,11 +49,7 @@ markdown_helper = MarkdownHelper.new(:pristine => true)
 markdown_helper.include('includer.md', 'included.md')
 ```
 
-##### Command
-
-```sh
-ruby include.rb
-```
+</details>
 
 #### File with Inclusion
 

data/markdown/use_cases/include_files/reuse_text/use_case.md

@@ -18,28 +18,22 @@ Text in includee file.
 Text in includer file.
 
 @[:markdown](includee.md)
-
 ```
 
 The treatment token ```:markdown``` specifies that the included text is to be treated as more markdown.
 
-#### CLI
-
-You can use the command-line interface to perform the inclusion.
-
-##### Command
+#### Include Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
 
 ```sh
 markdown_helper include --pristine includer.md included.md
 ```
 
 (Option ```--pristine``` suppresses comment insertion.)
-
-#### API
-
-You can use the API to perform the inclusion.
-
-##### Ruby Code
+</details>
+<details>
+<summary>API</summary>
 
 ```include.rb```:
 ```ruby
@@ -50,11 +44,7 @@ markdown_helper = MarkdownHelper.new(:pristine => true)
 markdown_helper.include('includer.md', 'included.md')
 ```
 
-##### Command
-
-```sh
-ruby include.rb
-```
+</details>
 
 #### File with Inclusion
 
@@ -65,5 +55,4 @@ Here's the output file, after inclusion.
 Text in includer file.
 
 Text in includee file.
-
 ```

data/markdown/use_cases/use_cases.md

@@ -8,6 +8,7 @@
 * [Include Code Block](include_files/include_code_block/use_case.md#include-code-block)
 * [Include Highlighted Code](include_files/include_highlighted_code/use_case.md#include-highlighted-code)
 * [Include Page TOC](include_files/include_page_toc/use_case.md#include-page-toc)
+* [Include Text As Details](include_files/include_text_as_details/use_case.md#include-text-as-details)
 * [Include Text As Comment](include_files/include_text_as_comment/use_case.md#include-text-as-comment)
 * [Include Text As Pre](include_files/include_text_as_pre/use_case.md#include-text-as-pre)
 * [Include Generated Text](include_files/include_generated_text/use_case.md#include-generated-text)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,70 +109,62 @@ files:
 - markdown/readme/verbatim_ruby_template.md
 - markdown/use_cases/Rakefile
 - markdown/use_cases/include_files/diagnose_circular_includes/diagnose_circular_includes.err
-- markdown/use_cases/include_files/diagnose_circular_includes/include.rb
 - markdown/use_cases/include_files/diagnose_circular_includes/includer.md
 - markdown/use_cases/include_files/diagnose_circular_includes/includer_0.md
 - markdown/use_cases/include_files/diagnose_circular_includes/includer_1.md
 - markdown/use_cases/include_files/diagnose_circular_includes/includer_2.md
 - markdown/use_cases/include_files/diagnose_circular_includes/use_case.md
-- markdown/use_cases/include_files/diagnose_circular_includes/use_case_builder.rb
 - markdown/use_cases/include_files/diagnose_circular_includes/use_case_template.md
 - markdown/use_cases/include_files/diagnose_missing_includee/diagnose_missing_includee.err
-- markdown/use_cases/include_files/diagnose_missing_includee/include.rb
 - markdown/use_cases/include_files/diagnose_missing_includee/includer.md
 - markdown/use_cases/include_files/diagnose_missing_includee/includer_0.md
 - markdown/use_cases/include_files/diagnose_missing_includee/includer_1.md
 - markdown/use_cases/include_files/diagnose_missing_includee/includer_2.md
 - markdown/use_cases/include_files/diagnose_missing_includee/use_case.md
-- markdown/use_cases/include_files/diagnose_missing_includee/use_case_builder.rb
 - markdown/use_cases/include_files/diagnose_missing_includee/use_case_template.md
 - markdown/use_cases/include_files/include.rb
 - markdown/use_cases/include_files/include_code_block/hello.rb
 - markdown/use_cases/include_files/include_code_block/included.md
 - markdown/use_cases/include_files/include_code_block/includer.md
 - markdown/use_cases/include_files/include_code_block/use_case.md
-- markdown/use_cases/include_files/include_code_block/use_case_builder.rb
 - markdown/use_cases/include_files/include_code_block/use_case_template.md
 - markdown/use_cases/include_files/include_generated_text/use_case.md
-- markdown/use_cases/include_files/include_generated_text/use_case_builder.rb
 - markdown/use_cases/include_files/include_generated_text/use_case_template.md
 - markdown/use_cases/include_files/include_highlighted_code/hello.rb
 - markdown/use_cases/include_files/include_highlighted_code/included.md
 - markdown/use_cases/include_files/include_highlighted_code/includer.md
 - markdown/use_cases/include_files/include_highlighted_code/use_case.md
-- markdown/use_cases/include_files/include_highlighted_code/use_case_builder.rb
 - markdown/use_cases/include_files/include_highlighted_code/use_case_template.md
 - markdown/use_cases/include_files/include_markdown/included.md
 - markdown/use_cases/include_files/include_markdown/includer.md
 - markdown/use_cases/include_files/include_markdown/markdown.md
 - markdown/use_cases/include_files/include_markdown/use_case.md
-- markdown/use_cases/include_files/include_markdown/use_case_builder.rb
 - markdown/use_cases/include_files/include_markdown/use_case_template.md
 - markdown/use_cases/include_files/include_page_toc/included.md
 - markdown/use_cases/include_files/include_page_toc/includer.md
 - markdown/use_cases/include_files/include_page_toc/markdown_0.md
 - markdown/use_cases/include_files/include_page_toc/markdown_1.md
 - markdown/use_cases/include_files/include_page_toc/use_case.md
-- markdown/use_cases/include_files/include_page_toc/use_case_builder.rb
 - markdown/use_cases/include_files/include_page_toc/use_case_template.md
 - markdown/use_cases/include_files/include_text_as_comment/hello.rb
 - markdown/use_cases/include_files/include_text_as_comment/included.md
 - markdown/use_cases/include_files/include_text_as_comment/includer.md
 - markdown/use_cases/include_files/include_text_as_comment/use_case.md
-- markdown/use_cases/include_files/include_text_as_comment/use_case_builder.rb
 - markdown/use_cases/include_files/include_text_as_comment/use_case_template.md
+- markdown/use_cases/include_files/include_text_as_details/details.md
+- markdown/use_cases/include_files/include_text_as_details/included.md
+- markdown/use_cases/include_files/include_text_as_details/includer.md
+- markdown/use_cases/include_files/include_text_as_details/use_case.md
+- markdown/use_cases/include_files/include_text_as_details/use_case_template.md
 - markdown/use_cases/include_files/include_text_as_pre/included.md
 - markdown/use_cases/include_files/include_text_as_pre/includer.md
 - markdown/use_cases/include_files/include_text_as_pre/triple_backtick.md
 - markdown/use_cases/include_files/include_text_as_pre/use_case.md
-- markdown/use_cases/include_files/include_text_as_pre/use_case_builder.rb
 - markdown/use_cases/include_files/include_text_as_pre/use_case_template.md
-- markdown/use_cases/include_files/include_use_case.rb
 - markdown/use_cases/include_files/include_with_added_comments/included.md
 - markdown/use_cases/include_files/include_with_added_comments/includee.md
 - markdown/use_cases/include_files/include_with_added_comments/includer.md
 - markdown/use_cases/include_files/include_with_added_comments/use_case.md
-- markdown/use_cases/include_files/include_with_added_comments/use_case_builder.rb
 - markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
 - markdown/use_cases/include_files/interface.md
 - markdown/use_cases/include_files/nest_inclusions/included.md
@@ -180,14 +172,11 @@ files:
 - markdown/use_cases/include_files/nest_inclusions/includer.md
 - markdown/use_cases/include_files/nest_inclusions/nested_includee.md
 - markdown/use_cases/include_files/nest_inclusions/use_case.md
-- markdown/use_cases/include_files/nest_inclusions/use_case_builder.rb
 - markdown/use_cases/include_files/nest_inclusions/use_case_template.md
-- markdown/use_cases/include_files/reuse_text/include.rb
 - markdown/use_cases/include_files/reuse_text/included.md
 - markdown/use_cases/include_files/reuse_text/includee.md
 - markdown/use_cases/include_files/reuse_text/includer.md
 - markdown/use_cases/include_files/reuse_text/use_case.md
-- markdown/use_cases/include_files/reuse_text/use_case_builder.rb
 - markdown/use_cases/include_files/reuse_text/use_case_template.md
 - markdown/use_cases/pristine.md
 - markdown/use_cases/structure.md
@@ -213,8 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Class to help with GitHub markdown.

data/markdown/use_cases/include_files/diagnose_circular_includes/include.rb

@@ -1,5 +0,0 @@
-require 'markdown_helper'
-
-# Option :pristine suppresses comment insertion.
-markdown_helper = MarkdownHelper.new(:pristine => true)
-markdown_helper.include('includer.md', 'included.md')