Module: HelpKit

Defined in:
lib/help_kit.rb,
lib/help_kit/engine.rb,
lib/help_kit/version.rb,
app/models/help_kit/tag.rb,
lib/help_kit/configuration.rb,
app/models/help_kit/article.rb,
app/models/help_kit/category.rb,
app/models/help_kit/article_tag.rb,
app/helpers/help_kit/article_helper.rb,
app/helpers/help_kit/category_helper.rb,
app/helpers/help_kit/nested_set_helper.rb,
app/helpers/help_kit/split_view_helper.rb,
app/helpers/help_kit/application_helper.rb,
app/controllers/help_kit/landing_controller.rb,
app/controllers/help_kit/articles_controller.rb,
app/controllers/help_kit/application_controller.rb,
app/controllers/help_kit/admin/landing_controller.rb,
app/controllers/help_kit/admin/categories_controller.rb

Defined Under Namespace

Modules: ApplicationHelper, ArticleHelper, CategoryHelper, NestedSetHelper, SplitViewHelper Classes: ApplicationController, Article, ArticleTag, ArticlesController, Category, Engine, InstallGenerator, LandingController, PygmentizeHTML, Tag

Constant Summary collapse

VERSION = 
"0.0.5"

Class Method Summary collapse

Class Method Details

.authorization_method ⇒ Object 



12
13
14
 
# File 'lib/help_kit/configuration.rb', line 12

def self.authorization_method
  @authorization_method ||= lambda { true }
end

.authorization_method=(val) ⇒ Object 



11
 
# File 'lib/help_kit/configuration.rb', line 11

def self.authorization_method=(val);@authorization_method=val;end

.authorize(&block) ⇒ Object 



17
18
19
 
# File 'lib/help_kit/configuration.rb', line 17

def self.authorize(&block)
  @authorization_method = block
end

.config {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (HelpKit) —

    the object that the method was called on



21
22
23
 
# File 'lib/help_kit/configuration.rb', line 21

def self.config(&block)
  yield(self)
end

.header ⇒ Object 



7
8
9
 
# File 'lib/help_kit/configuration.rb', line 7

def self.header
  @header ||= '<i class="fa fa-book"></i>Knowledge<strong>Base</strong>'
end

.header=(val) ⇒ Object 



6
 
# File 'lib/help_kit/configuration.rb', line 6

def self.header=(val); @header = val;end

.is_authorized? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/help_kit.rb', line 18

def self.is_authorized?
  self.instance_exec(&HelpKit.authorization_method)
end

.site_title ⇒ Object 



4
 
# File 'lib/help_kit/configuration.rb', line 4

def self.site_title; @site_title ||= '5Sigma Help'; end

.site_title=(val) ⇒ Object 



3
 
# File 'lib/help_kit/configuration.rb', line 3

def self.site_title=(val); @site_title=val;end