card-mod-help 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4dc090b50488cbbbfe0fa501f9219051e8fa46b00a73f5ca6f78364f9f0e9e59
+  data.tar.gz: 4b8c19ac6f7ae2943cbc9d05d9cd43c3e49696ccb690297d125b30b1713a9d2a
+SHA512:
+  metadata.gz: cdf0a54c58eabbecf88311f82c2f9c5174082d5e2cc6f728e1509c87580c32d946dc945de39da681e068f86c8df5d3e340fab459b1f80edf17b46d902de1d6dd
+  data.tar.gz: da6f9c5b42f26bf299793bac30a61318ad07327ccfc4637aba6f1216816e74336e60ed89a773c51f25b668d5abb0b1f608cdeec16af760ca31ba5ee3cc6af700

data/set/all/guide.rb

@@ -0,0 +1,51 @@
+def guide_card
+  guide_card = rule_card(:guide)
+  return unless guide_card
+
+  guide_card = guide_card.first_card if guide_card.type_id == Card::PointerID
+  guide_card if guide_card.ok?(:read)
+end
+
+format :html do
+  view :guide, unknown: true, cache: :never, wrap: :slot do
+    guide
+  end
+
+  def guide
+    guide_text = rule_based_guide
+    return "" unless guide_text.present?
+
+    if (rule_card = card.help_rule_card)
+      edit_link = with_nest_mode(:normal) { nest(rule_card, view: :edit_link) }
+      guide_text = "<span class='d-none'>#{edit_link}</span>#{guide_text}"
+    end
+    wrap_with :div, guide_text, class: classy("guide-text")
+  end
+
+  def alert_guide
+    guide_text = guide
+    return "" unless guide_text.present?
+
+    alert(:secondary, true, false, class: "guide") { guide_text }
+  end
+
+  def raw_guide_text
+    false
+  end
+
+  def rule_based_guide
+    if raw_guide_text
+      with_nest_mode :normal do
+        process_content raw_guide_text, chunk_list: :references
+        # render guide text with current card's format
+        # so current card's context is used in guide card nests
+      end
+    elsif card.guide_card
+      with_nest_mode :normal do
+        nest card.guide_card, view: :core
+      end
+    else
+      ""
+    end
+  end
+end

data/set/all/help.rb

@@ -0,0 +1,49 @@
+def help_rule_card
+  help_card = rule_card(:help)
+  help_card if help_card&.ok?(:read)
+end
+
+format :html do
+  view :help, unknown: true, cache: :never, wrap: :slot do
+    help = help_text
+    return "" unless help.present?
+
+    wrap_with :div, wrap_help_text(help), class: classy("help-text")
+  end
+
+  view :help_text, unknown: true, cache: :never do
+    wrap_help_text help_text
+  end
+
+  def wrap_help_text text
+    help = text
+    if (rule_card = card.help_rule_card)
+      edit_link = with_nest_mode(:normal) { nest(rule_card, view: :edit_link) }
+      help = "<span class='d-none'>#{edit_link}</span>#{text}"
+    end
+    help
+  end
+
+  view :lead do
+    class_up "card-slot", "lead"
+    _view_content
+  end
+
+  def help_text
+    voo.help || rule_based_help
+  end
+
+  def raw_help_text
+    card.try(:raw_help_text) || card.help_rule_card&.content
+  end
+
+  def rule_based_help
+    return "" unless (help_text = raw_help_text)
+
+    with_nest_mode :normal do
+      process_content help_text, chunk_list: :references
+      # render help card with current card's format
+      # so current card's context is used in help card nests
+    end
+  end
+end

data/set/right/guide.rb

@@ -0,0 +1,8 @@
+# include_set Abstract::TemplatedNests
+
+format :html do
+  def raw_help_text
+    # LOCALIZE
+    "Appears in the full editor view to guide users."
+  end
+end

data/set/right/help.rb

@@ -0,0 +1,15 @@
+include_set Abstract::TemplatedNests
+
+format :html do
+  view :popover do
+    popover_link _render_core
+  end
+
+  def quick_editor
+    # TODO: refactor when voo.input_type is ready.  (and use class_up)
+    formgroup "Content", input: :content, help: false do
+      text_field :content, value: card.content,
+                 class: "d0-card-content _submit-after-typing"
+    end
+  end
+end

data/set/self/guide.rb

@@ -0,0 +1,2 @@
+setting_opts group: :editing, position: 3, rule_type_editable: true,
+             short_help_text: "appears in the full editor view to guide users"

data/set/self/help.rb

@@ -0,0 +1,4 @@
+setting_opts group: :editing, position: 1, rule_type_editable: true,
+             short_help_text: "help text people will see when editing",
+             help_text: "[[http://decko.org/custom_help_text|Help text]] "\
+                        "people will see when editing."

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-help
+version: !ruby/object:Gem::Version
+  version: 0.11.0
+platform: ruby
+authors:
+- Ethan McCutchen
+- Philipp Kühl
+- Gerry Gleason
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.0
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- set/all/guide.rb
+- set/all/help.rb
+- set/right/guide.rb
+- set/right/help.rb
+- set/self/guide.rb
+- set/self/help.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: help
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: card help text and guides
+test_files: []